Unsupported content This version of the documentation is no longer supported. However, the documentation is available for your convenience. You will not be able to leave comments.

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 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
    The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

    Input parameters to include in operationParams
    The [confluence_table-plus] macro is a standalone macro and it cannot be used inline. Click on this message for details.

    HTTP response message

    Response message headers

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

    Response message body

    The response message body contains a Task object.
    Unknown macro: confluence_report-block. Click on this message for details.

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*