Is there an API to shutdown the ServiceOfferingInstance/Compute or VirtualGuest

Version 2
    Share This:

    This document contains official content from the BMC Software Knowledge Base. It is automatically updated when the knowledge article is modified.


    PRODUCT:

    Cloud Lifecycle Management


    COMPONENT:

    Cloud Lifecycle Management


    APPLIES TO:

    Cloud Lifecycle Management 4.x



    QUESTION:

    Is there an API to shutdown the ServiceOfferingInstance/Compute or VirtualGuest?


    ANSWER:

    Yes, here is an API which can be used to shutdown the service or compute gracefully:

    <Protocol>://<Platform Manager HostName>:<Platform Manager Port>/csm/serviceofferinginstance/<ServiceOfferingInstance Instance ID>/shutdownCompute

    Replace the strings with an actual values and run this API call with following information:

    Method: POST
    Body Details: 

    {
        "preCallout" : "",
        "postCallout" : "",
        "callbackURL" : "",
        "timeout" : 0
    }

    Ps: Make sure to add the Authentication-Token as Header.

    Additional Information: Refer API references for more examples and information on API's available in Cloud Lifecycle Management 4.x
     


    Article Number:

    000128634


    Article Type:

    FAQ/Procedural



      Looking for additional information?    Search BMC Support  or  Browse Knowledge Articles