ServiceOfferingInstance offboard request

Description

This API removes a service offering instance from BMC Cloud Lifecycle Management and optionally from BMC Service Automation. This API does not decommission the servers that host the service offering instance. If you want to remove the service offering instance and decommission the servers that host the instance, use the ServiceOfferingInstance decommission request instead.

The following constraints apply to this API:

You can offboard only VMware virtual machine (VM) service offering instances.
Both the provisioned service offering instance and associated compute container must be either running or stopped. You cannot offboard a service offering instance that is in any other state.
You cannot offboard a service offering instance that has load balancer entries. firewall rules, or network paths. You must delete them before sending the offboard request.
You cannot offboard Amazon Elastic Compute Cloud (Amazon EC2) service offering instances.
You cannot offboard VMware vCloud service offering instances.

You cannot offboard VMs that have NAT IP addresses.

API stability classification

Uncommitted

API overview

HTTP method	URI	Return type	Return type multiplicity
`POST`	`csm/ServiceOfferingInstance/guid/offboard`	`void`	Not applicable

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

This API uses only common headers listed in HTTP request and response headers.

Request message body

This API uses the following objects in the request message body JSON.

Top-level objects

Name	Type	Multi- plicity	Description
`callbackURL`	`String`	0..1	URL to call when the operation finishes
`postCallout`	`String`	0..1	Identifier of a callout to run after the operation executes
`preCallout`	`String`	0..1	Identifier of a callout to run before the operation executes
`timeout`	`Integer`	0..1	Timeout setting. For more information about using the timeout, see Synchronous and asynchronous operations. Timeout values: 0: Immediate timeout -1: Uses the system default timeout value 1..*: Times out in the specified number of seconds
`operationParams`	`OperationParameter`	1	Array of input parameters. The following table contains the list of input parameters. For information about setting up the input parameters, see Passing input parameters with an API request.

Input parameters to include in operationParams

Name	Type	Multi- plicity	Description
`retainVM`	`Boolean`	0..1	Indicates whether the entry for the server should be retained in BMC Server Automation after the server is offboarded. Default value: `false`

HTTP response message

Response message headers