ServiceOfferingInstance refresh request
This API refreshes the
ServiceOfferingInstance object specified by the identifier in the URI. It supports the refresh of single and multi-tier service offering instances on the Microsoft Windows and Linux operating systems. The following properties are refreshed:
- Power state
- Operating system information
The following constraints apply to this API:
- The virtual machine (VM) can be in any power state.
- The name of the VM should match the name used for the VM in BMC Service Automation and VMware vCenter Server.
- The network labels defined in the network resources section of the resource set in the service blueprint must match the labels for the network container and pod.
The service offering instance refresh request has the following limitations:
- The request updates only attributes and does not update associations. It does not refresh VMs that have been moved to a different network container or VMware vCenter Server.
- The request does not refresh changes made to IP addresses or host names.
- The request does not update option choices.
The request does not generate new contract lines.
After a service offering instance refresh request finishes, you can obtain updated data for the refreshed properties. To obtain refreshed data for CPU, memory, and power state, send the following request:
The response contains the URI of the associated operating system in the
operatingSystemobject. To obtain data for the operating system, use that URI in the following request:
API stability classification
HTTP request message
Query string parametersThis API does not use query string parameters.
Request message headersThis 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.
URL to call when the operation finishes
Identifier of a callout to run after the operation executes
Identifier of a callout to run before the operation executes
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|
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
VM name used in VMware vCenter Server. Include this parameter when the name used in VMware vCenter Server is different from the name used in BMC Server Automation.
HTTP response message
Response message headersThis API uses only common headers listed in HTTP request and response headers.
Response message body
The response message body contains a
The responses captured in this topic is an example. The responses can change according to your BMC Cloud Lifecycle Management stack.
In the following examples,
guid is the GUID of the service offering instance.
"timeout" : -1,
"preCallout" : "",
"postCallout" : "",
"callbackURL" : ""
"completionTime": "2016/12/26 22:45:48 GMT-12:00",
"creationTime": "2016/12/26 22:34:11 GMT-12:00",