diff options
| author |   Taka Cho <tc012c@att.com> | 2018-07-26 15:42:32 -0400 |
|---|---|---|
| committer | Taka Cho <tc012c@att.com> | 2018-07-26 15:48:16 -0400 |
| commit | 85838e1d38aa022b3a8b04047d772d3c40c34271 (patch) | |
| tree | 5111a830899b63eea54d1b7f21e429b085eb51df /docs/APPC LCM API Guide/APPC LCM API Guide.rst | |
| parent | 6f85059d13bfdb5aa43de1363e008cd3df96a265 (diff) | |
add new reboot LCM API
In R3, AT&T contributes a new lcm api: reboot
this is for adding reboot LCM API into readdoc
Change-Id: I3bb9e338d78424005aa6b1584073db101ae7f337
Issue-ID: APPC-1034
Signed-off-by: Taka Cho <tc012c@att.com>
Diffstat (limited to 'docs/APPC LCM API Guide/APPC LCM API Guide.rst')
| -rw-r--r-- | docs/APPC LCM API Guide/APPC LCM API Guide.rst | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/APPC LCM API Guide/APPC LCM API Guide.rst b/docs/APPC LCM API Guide/APPC LCM API Guide.rst index 24b7447c7..3015bc799 100644 --- a/docs/APPC LCM API Guide/APPC LCM API Guide.rst +++ b/docs/APPC LCM API Guide/APPC LCM API Guide.rst @@ -582,6 +582,8 @@ Commands, or actions, may be currently supported on all VNF types or a limited s +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ | QuiesceTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) | +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ +| Reboot | | | | Yes | Any (uses OpenStack command) | ++------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ | Rebuild | | | | Yes | Any (uses OpenStack command) | +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+ | Restart | | | | Yes | Any (uses OpenStack command) | @@ -1436,7 +1438,63 @@ The response does not include any payload parameters. A specific error message is returned if there is a timeout error. +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. +**NOTE:** The command implementation is based on OpenStack functionality. For further details, see http://developer.openstack.org/api-ref/compute/. + ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Input Block** | api-ver should be set to 2.00 for current version of Reboot | ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Target URL** | /restconf/operations/appc-provider-lcm:reboot | ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Action** | Reboot | ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Action-identifiers** | Vnf-id, vserver-id | ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Payload Parameters** | See table below | ++------------------------------+-----------------------------------------------------------------------------------------------+ +| **Revision History** | New in R3 release. | ++------------------------------+-----------------------------------------------------------------------------------------------+ + +Payload Parameters + ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ +| **Parameter** | **Description** | **Required?** | **Example** | ++=================+===============================================+=================+=========================================+ +| type | The type of reboot. Values are | No | | +| | HARD and SOFT. If not | | | +| | specified, SOFT reboot is | | "payload": | +| | performed. | | "{\\"type\\": \\"HARD\\", | +| | | | \\"vm-id\\": \\"<VM-ID>\\", | +| | | | \\"identity-url\\": | +| | | | \\"<IDENTITY-URL>\\" | +| | | | }" | ++-----------------+-----------------------------------------------+-----------------+ | +| vm-id | The unique identifier (UUID) of | Yes | | +| | the resource. For backwards- | | | +| | compatibility, this can be the self- | | | +| | link URL of the VM. | | | +| | | | | +| | | | | +| | | | | +| | | | | ++-----------------+-----------------------------------------------+-----------------+ | +| identity-url | The identity url used to access the | Yes | | +| | resource. | | | ++-----------------+-----------------------------------------------+-----------------+-----------------------------------------+ + +Reboot Response +^^^^^^^^^^^^^^^ + +**Success:** A successful Rebuild returns a success status code 400. + +**Failure:** A failed Rebuild returns a failure code 401 and the failure message. Rebuild ------- |