diff options
author | Sean Dague <sean@dague.net> | 2016-04-12 09:03:46 -0400 |
---|---|---|
committer | Sean Dague <sean@dague.net> | 2016-04-13 07:34:45 -0400 |
commit | d4e27714405e064ba8f62070e8c48d7fa71b6996 (patch) | |
tree | bd8b560fdc3864ea1c121b069926cd6b1d569556 /api-ref/source/servers-admin-action.inc | |
parent | f1fa7eb15a8b4a081d8d8afd3e6d80302c20e39e (diff) | |
download | nova-d4e27714405e064ba8f62070e8c48d7fa71b6996.tar.gz |
Import RST files for documentation
This is the results of the RST conversion from WADL. It creates a
single index plus a bunch of included files which represent sections
of the API document. This is the starting point for fixing the
documentation.
Change-Id: I7d561c2ecdcd864172dedb54a551f17ad3bdfe26
Diffstat (limited to 'api-ref/source/servers-admin-action.inc')
-rw-r--r-- | api-ref/source/servers-admin-action.inc | 217 |
1 files changed, 217 insertions, 0 deletions
diff --git a/api-ref/source/servers-admin-action.inc b/api-ref/source/servers-admin-action.inc new file mode 100644 index 0000000000..b306e9e9cd --- /dev/null +++ b/api-ref/source/servers-admin-action.inc @@ -0,0 +1,217 @@ +.. -*- rst -*- + +========================================================== + Servers - run an administrative action (servers, action) +========================================================== + +Enables administrators to perform an action on a server. Specify the +action in the request body. + +You can change the administrative password for, create a back up of, and +inject network information into a server. + +You can migrate, live-migrate, reset networking on, and reset the state +of a server. + +Create Server Back Up (Createbackup Action) +=========================================== + +.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action + +Creates a back up of a server. + +Specify the ``createBackup`` action in the request body. + +Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +Normal response codes: 202 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - server_id: server_id + - createBackup: createBackup + +**Example Create Server Back Up (Createbackup Action): JSON request** + +.. literalinclude:: ../../doc/api_samples/servers-action-admin/createBackup-req.json + :language: javascript + +Response +^^^^^^^^ + +Inject Network Information (Injectnetworkinfo Action) +===================================================== + +.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action + +Injects network information into a server. + +Specify the ``injectNetworkInfo`` action in the request body. + +Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +Normal response codes: 202 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - server_id: server_id + - injectNetworkInfo: injectNetworkInfo + +**Example Inject Network Information (Injectnetworkinfo Action): JSON request** + +.. literalinclude:: ../../doc/api_samples/servers-action-admin/injectNetworkInfo-req.json + :language: javascript + +Response +^^^^^^^^ + +Migrate Server (Migrate Action) +=============================== + +.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action + +Migrates a server to a host. The scheduler chooses the host. + +Specify the ``migrate`` action in the request body. + +Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +Normal response codes: 202 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - server_id: server_id + - migrate: migrate + +**Example Migrate Server (Migrate Action): JSON request** + +.. literalinclude:: ../../doc/api_samples/servers-action-admin/migrate-req.json + :language: javascript + +Response +^^^^^^^^ + +Live-Migrate Server (Os-Migratelive Action) +=========================================== + +.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action + +Live-migrates a server to a new host without rebooting. + +Use the ``host`` parameter to specify the destination host. If you omit this parameter, the scheduler chooses a host. If a scheduled host is not suitable, the scheduler tries up to ``migrate_max_retries`` rescheduling attempts. + +If both source and destination hosts provide local disks, you can set the ``block_migration`` parameter to ``true``. If either host uses shared storage, the migration fails if you set this parameter to ``true``. + +Policy defaults enable only users with the administrative role to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +Normal response codes: 202 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - server_id: server_id + - host: host + - block_migration: block_migration + - disk_over_commit: disk_over_commit + +**Example Live-Migrate Server (Os-Migratelive Action): JSON request** + +.. literalinclude:: ../../doc/api_samples/servers-action-admin/os-migrateLive-req.json + :language: javascript + +Response +^^^^^^^^ + +Reset Networking On A Server (Resetnetwork Action) +================================================== + +.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action + +Resets networking on a server. + +Specify the ``resetNetwork`` action in the request body. + +Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +Normal response codes: 202 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - server_id: server_id + - resetNetwork: resetNetwork + +**Example Reset Networking On A Server (Resetnetwork Action): JSON request** + +.. literalinclude:: ../../doc/api_samples/servers-action-admin/resetNetwork-req.json + :language: javascript + +Response +^^^^^^^^ + +Reset Server State (Os-Resetstate Action) +========================================= + +.. rest_method:: POST /v2.1/{tenant_id}/servers/{server_id}/action + +Resets the state of a server. + +Specify the ``os-resetState`` action and the ``state`` in the request body. + +Policy defaults enable only users with the administrative role or the owner of the server to perform this operation. Cloud providers can change these permissions through the ``policy.json`` file. + +Normal response codes: 202 + +Error response codes: computeFault(400, 500), serviceUnavailable(503), badRequest(400), +unauthorized(401), forbidden(403), badMethod(405), itemNotFound(404) + +Request +^^^^^^^ + +.. rest_parameters:: parameters.yaml + + - tenant_id: tenant_id + - server_id: server_id + - os-resetState: os-resetState + +**Example Reset Server State (Os-Resetstate Action): JSON request** + +.. literalinclude:: ../../doc/api_samples/servers-action-admin/os-resetState-req.json + :language: javascript + +Response +^^^^^^^^ + |