R3 API Documents

Owned by Randa Maher
Last updated: Feb 06, 2019 by Takamune Cho
1 min read

 Documentation can be found on  http://onap.readthedocs.io/en/latest



Reboot API Definition

The Reboot API definition is temporarily inlcuded here until the APPC LCM Guide in Readthedocs is updated for Casablanca:

Reboot

The Reboot is used to reboot a VM.

There are two types supported: HARD and SOFT. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.

A “hard Reboot” should succeed when the VM is any of the non-error initial states (active, stopped, paused, suspended). However, “soft Reboot” succeeds only if the VM was already active.  If the VM was previously stopped, paused, or suspended, the soft Reboot command may fail.

NOTE: The command implementation is based on OpenStack functionality.  For further details, see http://developer.openstack.org/api-ref/compute/.

Reboot Request:



Target URL

/restconf /operations/ appc-provider-lcm:reboot

Action

Reboot

Action-Identifiers

vnf-id, vserver-id

Payload Parameters

See below

Revision History

New in 1806.



Parameter

Description

Required?

Example

type

The type of reboot.  Values are HARD and SOFT.  If not specified, SOFT reboot is performed.

.

No

  {"payload": {

"type": "HARD",

"vm-id": http://1xx.2x.2xx.1xx:8774/v2/64af07e991424b8e9e54eca27d5c0d48/servers/b074cd1b-8d53-412e-a102-351cc51ac10a",

"identity-url": "http://1xx.2x.2xx.1xx:5000/v2.0"     

    }

}



vm-id

The self-link URL of the VM.

Yes

Identity-url

This is the identity-url associated with the cloud-region. (If not provided, APP-C may automatically use an incorrect identity-url.)

Yes



Reboot Response:

Success:

  • A successful Reboot of the VM returns a success status code 400 when completed.

Failure:

  • A failed request to reboot the VM returns a failure code 401 and the failure message.   Failure messages can include:

    • vm-id not available in A&AI

    • identity-url not available in A&AI

    • unauthorized

    • forbidden

    • itemNotFound

    • conflict