1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
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
--------
|
