ServiceOfferingInstance refresh request

Description

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:

  • CPU
  • Memory
  • 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:

    GET /csm/serviceofferinginstance/guid/functionalComponents/resourceSet/compute

    The response contains the URI of the associated operating system in the operatingSystem object. To obtain data for the operating system, use that URI in the following request:

    GET /csm/operatingsystem/guid

    API stability classification

    API overview

    HTTP
    method

    URI

    Return
    type

    Return type
    multiplicity

    POST

    csm/ServiceOfferingInstance/guid

    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

    actualVMName

    String

    0..1

    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 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.

Example

Note

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.

Request URL: /csm/serviceofferinginstance/guid/refresh

HTTP method: POST

Request payload

{

    "timeout" : -1,

    "preCallout" : "",

    "postCallout" : "",

    "callbackURL" : ""

}

Response payload

[

    {

        "cloudClass": "com.bmc.cloud.model.beans.Task",

        "className": "ServiceOfferingInstance",

        "completionTime": "2016/12/26 22:45:48 GMT-12:00",

        "creationTime": "2016/12/26 22:34:11 GMT-12:00",

        "errors": [],

        "guid": "f13387a8-80b8-4d26-b25a-4063a8c4e267",

        "isCallout": false,

        "isError": false,

        "isSuccess": true,

        "operationName": "refresh",

        "results": [],

        "taskInternalUUID": "8a7c8c7a-192e-4e13-bd70-888b5b5c5ffc",

        "taskProgress": 100,

        "taskResultURI": "http://10.1.113.10:9090/csm/task/8a7c8c7a-192e-4e13-bd70-888b5b5c5ffc/result",

        "taskState": "COMPLETED",

        "taskStatusURI": "http://10.1.113.10:9090/csm/task/8a7c8c7a-192e-4e13-bd70-888b5b5c5ffc/status",

        "taskSubState": "task_success",

        "transactionID": "038cf6a7-6342-446b-8d59-1f4fb81c8c6d"

    }

]

Was this page helpful? Yes No Submitting... Thank you

Comments