ServiceOfferingInstance onboard request

Description

This API creates a service offering instance (SOI) for an existing virtual machine (VM). The API supports only single-VM service offering instances. For additional information see Onboarding-existing-VMs-checklist.

The following constraints apply to this API:

• You can onboard only VMs that do not have load balancers or firewalls, that is, you cannot onboard any existing load balancer entries and firewall rules. However, after the VM is onboarded, you can create firewall rules and load balancer entries for the VM.
• You cannot apply options when you onboard a VM. However, after the VM is onboarded, you can use options associated with the SOI.
• This API does not support onboarding VMs that have NAT IP addresses.
• The VM must be configured correctly in BMC Server Automation. For information about enrolling VMs in BMC Server Automation, see Knowledge Base article KA383365 (Support login required).
• The API does not validate the input parameters that it receives. You must ensure that all input parameters are correct.
• The VM must be powered on.
• The VM should have the same name in both BMC Server Automation and VMware vCenter Server. If BMC Server Automation and VMware vCenter Server each use a different name for the VM, include the actualVMName input parameter in the request and set it to the name used in VMware vCenter Server. Console actions such as start, stop, decommission, modify CPU or memory, and attach or detach storage work only for onboarded service offering instances that have the same name in BMC Server Automation and VMware vCenter Server. Only the offboard service offering instance action can be done through the REST API.
• The service blueprint must have only one resource set defined because the API onboards only one VM.
• The number of networks defined in the resource set in the service blueprint must be equal to the number of network interfaces of the VM.
• If a static IP address is already marked as reserved in BMC Network Automation IP address management (IPAM), the VM onboard process fails to reserve the static IP address. Failure to reserve a static IP address triggers a rollback of the onboarding process that frees the allocated IP address. This case occurs only when two VMs in the network have the same static IP address.

API stability classification

Unassigned

API overview

HTTP request message

Query string parameters

This API does not use query string parameters.

Request message headers

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

Request message body

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

The following table lists the input parameters to include in the operationParams object:

HTTP response message

Response message headers

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

Response message body

The response message body contains a Task object.