Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 1 | # Copyright 2012 OpenStack Foundation |
| 2 | # Copyright 2013 Hewlett-Packard Development Company, L.P. |
Felipe Monteiro | 7c95bef | 2017-02-17 18:49:02 -0500 | [diff] [blame] | 3 | # Copyright 2017 AT&T Corp. |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 4 | # All Rights Reserved. |
| 5 | # |
| 6 | # Licensed under the Apache License, Version 2.0 (the "License"); you may |
| 7 | # not use this file except in compliance with the License. You may obtain |
| 8 | # a copy of the License at |
| 9 | # |
| 10 | # http://www.apache.org/licenses/LICENSE-2.0 |
| 11 | # |
| 12 | # Unless required by applicable law or agreed to in writing, software |
| 13 | # distributed under the License is distributed on an "AS IS" BASIS, WITHOUT |
| 14 | # WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the |
| 15 | # License for the specific language governing permissions and limitations |
| 16 | # under the License. |
| 17 | |
| 18 | import copy |
| 19 | |
| 20 | from oslo_serialization import jsonutils as json |
| 21 | from six.moves.urllib import parse as urllib |
| 22 | |
zwhe | 3beb6cf | 2017-02-09 16:59:41 +0800 | [diff] [blame] | 23 | from tempest.lib.api_schema.response.compute.v2_1 import \ |
| 24 | security_groups as security_groups_schema |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 25 | from tempest.lib.api_schema.response.compute.v2_1 import servers as schema |
Eli Qiao | e07eacc | 2016-03-03 13:49:37 +0800 | [diff] [blame] | 26 | from tempest.lib.api_schema.response.compute.v2_16 import servers as schemav216 |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 27 | from tempest.lib.api_schema.response.compute.v2_19 import servers as schemav219 |
Matt Riedemann | 3e4a46a | 2016-07-27 14:41:32 -0400 | [diff] [blame] | 28 | from tempest.lib.api_schema.response.compute.v2_26 import servers as schemav226 |
Eli Qiao | e07eacc | 2016-03-03 13:49:37 +0800 | [diff] [blame] | 29 | from tempest.lib.api_schema.response.compute.v2_3 import servers as schemav23 |
Sergey Nikitin | 8654e5b | 2017-06-04 22:09:56 +0400 | [diff] [blame] | 30 | from tempest.lib.api_schema.response.compute.v2_47 import servers as schemav247 |
Sergey Nikitin | 0cb4f22 | 2017-02-03 13:16:33 +0400 | [diff] [blame] | 31 | from tempest.lib.api_schema.response.compute.v2_48 import servers as schemav248 |
Markus Zoeller | 69d58b8 | 2017-02-17 10:09:22 +0100 | [diff] [blame] | 32 | from tempest.lib.api_schema.response.compute.v2_6 import servers as schemav26 |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 33 | from tempest.lib.api_schema.response.compute.v2_9 import servers as schemav29 |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 34 | from tempest.lib.common import rest_client |
Ghanshyam | ee9af30 | 2016-02-25 06:12:43 +0900 | [diff] [blame] | 35 | from tempest.lib.services.compute import base_compute_client |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 36 | |
| 37 | |
Ghanshyam | ee9af30 | 2016-02-25 06:12:43 +0900 | [diff] [blame] | 38 | class ServersClient(base_compute_client.BaseComputeClient): |
Ken'ichi Ohmichi | aca816d | 2017-01-27 15:12:17 -0800 | [diff] [blame] | 39 | """Service client for the resource /servers""" |
| 40 | |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 41 | schema_versions_info = [ |
Eli Qiao | e07eacc | 2016-03-03 13:49:37 +0800 | [diff] [blame] | 42 | {'min': None, 'max': '2.2', 'schema': schema}, |
Markus Zoeller | 69d58b8 | 2017-02-17 10:09:22 +0100 | [diff] [blame] | 43 | {'min': '2.3', 'max': '2.5', 'schema': schemav23}, |
| 44 | {'min': '2.6', 'max': '2.8', 'schema': schemav26}, |
Eli Qiao | e07eacc | 2016-03-03 13:49:37 +0800 | [diff] [blame] | 45 | {'min': '2.9', 'max': '2.15', 'schema': schemav29}, |
| 46 | {'min': '2.16', 'max': '2.18', 'schema': schemav216}, |
Matt Riedemann | 3e4a46a | 2016-07-27 14:41:32 -0400 | [diff] [blame] | 47 | {'min': '2.19', 'max': '2.25', 'schema': schemav219}, |
Sergey Nikitin | 8654e5b | 2017-06-04 22:09:56 +0400 | [diff] [blame] | 48 | {'min': '2.26', 'max': '2.46', 'schema': schemav226}, |
Sergey Nikitin | 0cb4f22 | 2017-02-03 13:16:33 +0400 | [diff] [blame] | 49 | {'min': '2.47', 'max': '2.47', 'schema': schemav247}, |
| 50 | {'min': '2.48', 'max': None, 'schema': schemav248}] |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 51 | |
| 52 | def __init__(self, auth_provider, service, region, |
| 53 | enable_instance_password=True, **kwargs): |
| 54 | super(ServersClient, self).__init__( |
| 55 | auth_provider, service, region, **kwargs) |
| 56 | self.enable_instance_password = enable_instance_password |
| 57 | |
| 58 | def create_server(self, **kwargs): |
| 59 | """Create server. |
| 60 | |
Ken'ichi Ohmichi | d9bafc0 | 2016-09-09 09:35:21 -0700 | [diff] [blame] | 61 | For a full list of available parameters, please refer to the official |
| 62 | API reference: |
| 63 | http://developer.openstack.org/api-ref/compute/#create-server |
| 64 | |
| 65 | :param name: Server name |
| 66 | :param imageRef: Image reference (UUID) |
| 67 | :param flavorRef: Flavor reference (UUID or full URL) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 68 | |
| 69 | Most parameters except the following are passed to the API without |
| 70 | any changes. |
| 71 | :param disk_config: The name is changed to OS-DCF:diskConfig |
| 72 | :param scheduler_hints: The name is changed to os:scheduler_hints and |
| 73 | the parameter is set in the same level as the parameter 'server'. |
| 74 | """ |
| 75 | body = copy.deepcopy(kwargs) |
| 76 | if body.get('disk_config'): |
| 77 | body['OS-DCF:diskConfig'] = body.pop('disk_config') |
| 78 | |
| 79 | hints = None |
| 80 | if body.get('scheduler_hints'): |
| 81 | hints = {'os:scheduler_hints': body.pop('scheduler_hints')} |
| 82 | |
| 83 | post_body = {'server': body} |
| 84 | |
| 85 | if hints: |
Jordan Pittier | 81c427d | 2016-04-25 17:02:58 +0200 | [diff] [blame] | 86 | post_body.update(hints) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 87 | |
| 88 | post_body = json.dumps(post_body) |
| 89 | resp, body = self.post('servers', post_body) |
| 90 | |
| 91 | body = json.loads(body) |
| 92 | # NOTE(maurosr): this deals with the case of multiple server create |
| 93 | # with return reservation id set True |
| 94 | if 'reservation_id' in body: |
| 95 | return rest_client.ResponseBody(resp, body) |
| 96 | if self.enable_instance_password: |
| 97 | create_schema = schema.create_server_with_admin_pass |
| 98 | else: |
| 99 | create_schema = schema.create_server |
| 100 | self.validate_response(create_schema, resp, body) |
| 101 | return rest_client.ResponseBody(resp, body) |
| 102 | |
| 103 | def update_server(self, server_id, **kwargs): |
| 104 | """Update server. |
| 105 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 106 | For a full list of available parameters, please refer to the official |
| 107 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 108 | https://developer.openstack.org/api-ref/compute/#update-server |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 109 | |
| 110 | Most parameters except the following are passed to the API without |
| 111 | any changes. |
| 112 | :param disk_config: The name is changed to OS-DCF:diskConfig |
| 113 | """ |
ghanshyam | 910022e | 2016-12-21 13:32:57 +0900 | [diff] [blame] | 114 | if 'disk_config' in kwargs: |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 115 | kwargs['OS-DCF:diskConfig'] = kwargs.pop('disk_config') |
| 116 | |
| 117 | post_body = json.dumps({'server': kwargs}) |
| 118 | resp, body = self.put("servers/%s" % server_id, post_body) |
| 119 | body = json.loads(body) |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 120 | schema = self.get_schema(self.schema_versions_info) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 121 | self.validate_response(schema.update_server, resp, body) |
| 122 | return rest_client.ResponseBody(resp, body) |
| 123 | |
| 124 | def show_server(self, server_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 125 | """Get server details. |
| 126 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 127 | For a full list of available parameters, please refer to the official |
| 128 | API reference: |
| 129 | http://developer.openstack.org/api-ref-compute-v2.1.html#showServer |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 130 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 131 | resp, body = self.get("servers/%s" % server_id) |
| 132 | body = json.loads(body) |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 133 | schema = self.get_schema(self.schema_versions_info) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 134 | self.validate_response(schema.get_server, resp, body) |
| 135 | return rest_client.ResponseBody(resp, body) |
| 136 | |
| 137 | def delete_server(self, server_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 138 | """Delete server. |
| 139 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 140 | For a full list of available parameters, please refer to the official |
| 141 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 142 | https://developer.openstack.org/api-ref/compute/#delete-server |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 143 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 144 | resp, body = self.delete("servers/%s" % server_id) |
| 145 | self.validate_response(schema.delete_server, resp, body) |
| 146 | return rest_client.ResponseBody(resp, body) |
| 147 | |
| 148 | def list_servers(self, detail=False, **params): |
| 149 | """List servers. |
| 150 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 151 | For a full list of available parameters, please refer to the official |
| 152 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 153 | https://developer.openstack.org/api-ref/compute/#list-servers |
| 154 | https://developer.openstack.org/api-ref/compute/#list-servers-detailed |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 155 | """ |
| 156 | |
| 157 | url = 'servers' |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 158 | schema = self.get_schema(self.schema_versions_info) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 159 | _schema = schema.list_servers |
| 160 | |
| 161 | if detail: |
| 162 | url += '/detail' |
| 163 | _schema = schema.list_servers_detail |
| 164 | if params: |
| 165 | url += '?%s' % urllib.urlencode(params) |
| 166 | |
| 167 | resp, body = self.get(url) |
| 168 | body = json.loads(body) |
| 169 | self.validate_response(_schema, resp, body) |
| 170 | return rest_client.ResponseBody(resp, body) |
| 171 | |
| 172 | def list_addresses(self, server_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 173 | """Lists all addresses for a server. |
| 174 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 175 | For a full list of available parameters, please refer to the official |
| 176 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 177 | https://developer.openstack.org/api-ref/compute/#list-ips |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 178 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 179 | resp, body = self.get("servers/%s/ips" % server_id) |
| 180 | body = json.loads(body) |
| 181 | self.validate_response(schema.list_addresses, resp, body) |
| 182 | return rest_client.ResponseBody(resp, body) |
| 183 | |
| 184 | def list_addresses_by_network(self, server_id, network_id): |
| 185 | """Lists all addresses of a specific network type for a server.""" |
| 186 | resp, body = self.get("servers/%s/ips/%s" % |
| 187 | (server_id, network_id)) |
| 188 | body = json.loads(body) |
| 189 | self.validate_response(schema.list_addresses_by_network, resp, body) |
| 190 | return rest_client.ResponseBody(resp, body) |
| 191 | |
| 192 | def action(self, server_id, action_name, |
| 193 | schema=schema.server_actions_common_schema, |
| 194 | **kwargs): |
| 195 | post_body = json.dumps({action_name: kwargs}) |
| 196 | resp, body = self.post('servers/%s/action' % server_id, |
| 197 | post_body) |
| 198 | if body: |
| 199 | body = json.loads(body) |
| 200 | self.validate_response(schema, resp, body) |
| 201 | return rest_client.ResponseBody(resp, body) |
| 202 | |
| 203 | def create_backup(self, server_id, **kwargs): |
| 204 | """Backup a server instance. |
| 205 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 206 | For a full list of available parameters, please refer to the official |
| 207 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 208 | https://developer.openstack.org/api-ref/compute/#create-server-back-up-createbackup-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 209 | """ |
| 210 | return self.action(server_id, "createBackup", **kwargs) |
| 211 | |
| 212 | def change_password(self, server_id, **kwargs): |
| 213 | """Change the root password for the server. |
| 214 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 215 | For a full list of available parameters, please refer to the official |
| 216 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 217 | https://developer.openstack.org/api-ref/compute/#change-administrative-password-changepassword-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 218 | """ |
| 219 | return self.action(server_id, 'changePassword', **kwargs) |
| 220 | |
| 221 | def show_password(self, server_id): |
| 222 | resp, body = self.get("servers/%s/os-server-password" % |
| 223 | server_id) |
| 224 | body = json.loads(body) |
| 225 | self.validate_response(schema.show_password, resp, body) |
| 226 | return rest_client.ResponseBody(resp, body) |
| 227 | |
| 228 | def delete_password(self, server_id): |
| 229 | """Removes the encrypted server password from the metadata server |
| 230 | |
| 231 | Note that this does not actually change the instance server |
| 232 | password. |
| 233 | """ |
| 234 | resp, body = self.delete("servers/%s/os-server-password" % |
| 235 | server_id) |
| 236 | self.validate_response(schema.server_actions_delete_password, |
| 237 | resp, body) |
| 238 | return rest_client.ResponseBody(resp, body) |
| 239 | |
| 240 | def reboot_server(self, server_id, **kwargs): |
| 241 | """Reboot a server. |
| 242 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 243 | For a full list of available parameters, please refer to the official |
| 244 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 245 | https://developer.openstack.org/api-ref/compute/#reboot-server-reboot-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 246 | """ |
| 247 | return self.action(server_id, 'reboot', **kwargs) |
| 248 | |
| 249 | def rebuild_server(self, server_id, image_ref, **kwargs): |
| 250 | """Rebuild a server with a new image. |
| 251 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 252 | For a full list of available parameters, please refer to the official |
| 253 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 254 | https://developer.openstack.org/api-ref/compute/#rebuild-server-rebuild-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 255 | |
| 256 | Most parameters except the following are passed to the API without |
| 257 | any changes. |
| 258 | :param disk_config: The name is changed to OS-DCF:diskConfig |
| 259 | """ |
| 260 | kwargs['imageRef'] = image_ref |
| 261 | if 'disk_config' in kwargs: |
| 262 | kwargs['OS-DCF:diskConfig'] = kwargs.pop('disk_config') |
lanoux | 2746ba0 | 2016-03-16 17:41:01 +0900 | [diff] [blame] | 263 | schema = self.get_schema(self.schema_versions_info) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 264 | if self.enable_instance_password: |
| 265 | rebuild_schema = schema.rebuild_server_with_admin_pass |
| 266 | else: |
| 267 | rebuild_schema = schema.rebuild_server |
| 268 | return self.action(server_id, 'rebuild', |
| 269 | rebuild_schema, **kwargs) |
| 270 | |
| 271 | def resize_server(self, server_id, flavor_ref, **kwargs): |
| 272 | """Change the flavor of a server. |
| 273 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 274 | For a full list of available parameters, please refer to the official |
| 275 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 276 | https://developer.openstack.org/api-ref/compute/#resize-server-resize-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 277 | |
| 278 | Most parameters except the following are passed to the API without |
| 279 | any changes. |
| 280 | :param disk_config: The name is changed to OS-DCF:diskConfig |
| 281 | """ |
| 282 | kwargs['flavorRef'] = flavor_ref |
| 283 | if 'disk_config' in kwargs: |
| 284 | kwargs['OS-DCF:diskConfig'] = kwargs.pop('disk_config') |
| 285 | return self.action(server_id, 'resize', **kwargs) |
| 286 | |
| 287 | def confirm_resize_server(self, server_id, **kwargs): |
| 288 | """Confirm the flavor change for a server. |
| 289 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 290 | For a full list of available parameters, please refer to the official |
| 291 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 292 | https://developer.openstack.org/api-ref/compute/#confirm-resized-server-confirmresize-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 293 | """ |
| 294 | return self.action(server_id, 'confirmResize', |
| 295 | schema.server_actions_confirm_resize, |
| 296 | **kwargs) |
| 297 | |
| 298 | def revert_resize_server(self, server_id, **kwargs): |
| 299 | """Revert a server back to its original flavor. |
| 300 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 301 | For a full list of available parameters, please refer to the official |
| 302 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 303 | https://developer.openstack.org/api-ref/compute/#revert-resized-server-revertresize-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 304 | """ |
| 305 | return self.action(server_id, 'revertResize', **kwargs) |
| 306 | |
| 307 | def list_server_metadata(self, server_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 308 | """Lists all metadata for a server. |
| 309 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 310 | For a full list of available parameters, please refer to the official |
| 311 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 312 | https://developer.openstack.org/api-ref/compute/#list-all-metadata |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 313 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 314 | resp, body = self.get("servers/%s/metadata" % server_id) |
| 315 | body = json.loads(body) |
| 316 | self.validate_response(schema.list_server_metadata, resp, body) |
| 317 | return rest_client.ResponseBody(resp, body) |
| 318 | |
| 319 | def set_server_metadata(self, server_id, meta, no_metadata_field=False): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 320 | """Sets one or more metadata items for a server. |
| 321 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 322 | For a full list of available parameters, please refer to the official |
| 323 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 324 | https://developer.openstack.org/api-ref/compute/#create-or-replace-metadata-items |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 325 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 326 | if no_metadata_field: |
| 327 | post_body = "" |
| 328 | else: |
| 329 | post_body = json.dumps({'metadata': meta}) |
| 330 | resp, body = self.put('servers/%s/metadata' % server_id, |
| 331 | post_body) |
| 332 | body = json.loads(body) |
| 333 | self.validate_response(schema.set_server_metadata, resp, body) |
| 334 | return rest_client.ResponseBody(resp, body) |
| 335 | |
| 336 | def update_server_metadata(self, server_id, meta): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 337 | """Updates one or more metadata items for a server. |
| 338 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 339 | For a full list of available parameters, please refer to the official |
| 340 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 341 | https://developer.openstack.org/api-ref/compute/#update-metadata-items |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 342 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 343 | post_body = json.dumps({'metadata': meta}) |
| 344 | resp, body = self.post('servers/%s/metadata' % server_id, |
| 345 | post_body) |
| 346 | body = json.loads(body) |
| 347 | self.validate_response(schema.update_server_metadata, |
| 348 | resp, body) |
| 349 | return rest_client.ResponseBody(resp, body) |
| 350 | |
| 351 | def show_server_metadata_item(self, server_id, key): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 352 | """Shows details for a metadata item, by key, for a server. |
| 353 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 354 | For a full list of available parameters, please refer to the official |
| 355 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 356 | https://developer.openstack.org/api-ref/compute/#show-metadata-item-details |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 357 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 358 | resp, body = self.get("servers/%s/metadata/%s" % (server_id, key)) |
| 359 | body = json.loads(body) |
| 360 | self.validate_response(schema.set_show_server_metadata_item, |
| 361 | resp, body) |
| 362 | return rest_client.ResponseBody(resp, body) |
| 363 | |
| 364 | def set_server_metadata_item(self, server_id, key, meta): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 365 | """Sets a metadata item, by key, for a server. |
| 366 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 367 | For a full list of available parameters, please refer to the official |
| 368 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 369 | https://developer.openstack.org/api-ref/compute/#create-or-update-metadata-item |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 370 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 371 | post_body = json.dumps({'meta': meta}) |
| 372 | resp, body = self.put('servers/%s/metadata/%s' % (server_id, key), |
| 373 | post_body) |
| 374 | body = json.loads(body) |
| 375 | self.validate_response(schema.set_show_server_metadata_item, |
| 376 | resp, body) |
| 377 | return rest_client.ResponseBody(resp, body) |
| 378 | |
| 379 | def delete_server_metadata_item(self, server_id, key): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 380 | """Deletes a metadata item, by key, from a server. |
| 381 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 382 | For a full list of available parameters, please refer to the official |
| 383 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 384 | https://developer.openstack.org/api-ref/compute/#delete-metadata-item |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 385 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 386 | resp, body = self.delete("servers/%s/metadata/%s" % |
| 387 | (server_id, key)) |
| 388 | self.validate_response(schema.delete_server_metadata_item, |
| 389 | resp, body) |
| 390 | return rest_client.ResponseBody(resp, body) |
| 391 | |
| 392 | def stop_server(self, server_id, **kwargs): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 393 | """Stops a running server and changes its status to SHUTOFF. |
| 394 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 395 | For a full list of available parameters, please refer to the official |
| 396 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 397 | https://developer.openstack.org/api-ref/compute/#stop-server-os-stop-action |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 398 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 399 | return self.action(server_id, 'os-stop', **kwargs) |
| 400 | |
| 401 | def start_server(self, server_id, **kwargs): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 402 | """Starts a stopped server and changes its status to ACTIVE. |
| 403 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 404 | For a full list of available parameters, please refer to the official |
| 405 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 406 | https://developer.openstack.org/api-ref/compute/#start-server-os-start-action |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 407 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 408 | return self.action(server_id, 'os-start', **kwargs) |
| 409 | |
| 410 | def attach_volume(self, server_id, **kwargs): |
zhufl | ff6d0da | 2016-06-12 17:27:12 +0800 | [diff] [blame] | 411 | """Attaches a volume to a server instance. |
| 412 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 413 | For a full list of available parameters, please refer to the official |
| 414 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 415 | https://developer.openstack.org/api-ref/compute/#attach-a-volume-to-an-instance |
zhufl | ff6d0da | 2016-06-12 17:27:12 +0800 | [diff] [blame] | 416 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 417 | post_body = json.dumps({'volumeAttachment': kwargs}) |
| 418 | resp, body = self.post('servers/%s/os-volume_attachments' % server_id, |
| 419 | post_body) |
| 420 | body = json.loads(body) |
| 421 | self.validate_response(schema.attach_volume, resp, body) |
| 422 | return rest_client.ResponseBody(resp, body) |
| 423 | |
| 424 | def update_attached_volume(self, server_id, attachment_id, **kwargs): |
| 425 | """Swaps a volume attached to an instance for another volume""" |
| 426 | post_body = json.dumps({'volumeAttachment': kwargs}) |
| 427 | resp, body = self.put('servers/%s/os-volume_attachments/%s' % |
| 428 | (server_id, attachment_id), |
| 429 | post_body) |
| 430 | self.validate_response(schema.update_attached_volume, resp, body) |
| 431 | return rest_client.ResponseBody(resp, body) |
| 432 | |
| 433 | def detach_volume(self, server_id, volume_id): # noqa |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 434 | """Detaches a volume from a server instance. |
| 435 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 436 | For a full list of available parameters, please refer to the official |
| 437 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 438 | https://developer.openstack.org/api-ref/compute/#detach-a-volume-from-an-instance |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 439 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 440 | resp, body = self.delete('servers/%s/os-volume_attachments/%s' % |
| 441 | (server_id, volume_id)) |
| 442 | self.validate_response(schema.detach_volume, resp, body) |
| 443 | return rest_client.ResponseBody(resp, body) |
| 444 | |
| 445 | def show_volume_attachment(self, server_id, volume_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 446 | """Return details about the given volume attachment. |
| 447 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 448 | For a full list of available parameters, please refer to the official |
| 449 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 450 | https://developer.openstack.org/api-ref/compute/#show-a-detail-of-a-volume-attachment |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 451 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 452 | resp, body = self.get('servers/%s/os-volume_attachments/%s' % ( |
| 453 | server_id, volume_id)) |
| 454 | body = json.loads(body) |
| 455 | self.validate_response(schema.show_volume_attachment, resp, body) |
| 456 | return rest_client.ResponseBody(resp, body) |
| 457 | |
| 458 | def list_volume_attachments(self, server_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 459 | """Returns the list of volume attachments for a given instance. |
| 460 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 461 | For a full list of available parameters, please refer to the official |
| 462 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 463 | https://developer.openstack.org/api-ref/compute/#list-volume-attachments-for-an-instance |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 464 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 465 | resp, body = self.get('servers/%s/os-volume_attachments' % ( |
| 466 | server_id)) |
| 467 | body = json.loads(body) |
| 468 | self.validate_response(schema.list_volume_attachments, resp, body) |
| 469 | return rest_client.ResponseBody(resp, body) |
| 470 | |
| 471 | def add_security_group(self, server_id, **kwargs): |
| 472 | """Add a security group to the server. |
| 473 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 474 | For a full list of available parameters, please refer to the official |
| 475 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 476 | https://developer.openstack.org/api-ref/compute/#add-security-group-to-a-server-addsecuritygroup-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 477 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 478 | return self.action(server_id, 'addSecurityGroup', **kwargs) |
| 479 | |
| 480 | def remove_security_group(self, server_id, **kwargs): |
| 481 | """Remove a security group from the server. |
| 482 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 483 | For a full list of available parameters, please refer to the official |
| 484 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 485 | https://developer.openstack.org/api-ref/compute/#remove-security-group-from-a-server-removesecuritygroup-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 486 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 487 | return self.action(server_id, 'removeSecurityGroup', **kwargs) |
| 488 | |
| 489 | def live_migrate_server(self, server_id, **kwargs): |
| 490 | """This should be called with administrator privileges. |
| 491 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 492 | For a full list of available parameters, please refer to the official |
| 493 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 494 | https://developer.openstack.org/api-ref/compute/#live-migrate-server-os-migratelive-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 495 | """ |
| 496 | return self.action(server_id, 'os-migrateLive', **kwargs) |
| 497 | |
| 498 | def migrate_server(self, server_id, **kwargs): |
| 499 | """Migrate a server to a new host. |
| 500 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 501 | For a full list of available parameters, please refer to the official |
| 502 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 503 | https://developer.openstack.org/api-ref/compute/#migrate-server-migrate-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 504 | """ |
| 505 | return self.action(server_id, 'migrate', **kwargs) |
| 506 | |
| 507 | def lock_server(self, server_id, **kwargs): |
| 508 | """Lock the given server. |
| 509 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 510 | For a full list of available parameters, please refer to the official |
| 511 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 512 | https://developer.openstack.org/api-ref/compute/#lock-server-lock-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 513 | """ |
| 514 | return self.action(server_id, 'lock', **kwargs) |
| 515 | |
| 516 | def unlock_server(self, server_id, **kwargs): |
| 517 | """UNlock the given server. |
| 518 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 519 | For a full list of available parameters, please refer to the official |
| 520 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 521 | https://developer.openstack.org/api-ref/compute/#unlock-server-unlock-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 522 | """ |
| 523 | return self.action(server_id, 'unlock', **kwargs) |
| 524 | |
| 525 | def suspend_server(self, server_id, **kwargs): |
| 526 | """Suspend the provided server. |
| 527 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 528 | For a full list of available parameters, please refer to the official |
| 529 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 530 | https://developer.openstack.org/api-ref/compute/#suspend-server-suspend-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 531 | """ |
| 532 | return self.action(server_id, 'suspend', **kwargs) |
| 533 | |
| 534 | def resume_server(self, server_id, **kwargs): |
| 535 | """Un-suspend the provided server. |
| 536 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 537 | For a full list of available parameters, please refer to the official |
| 538 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 539 | https://developer.openstack.org/api-ref/compute/#resume-suspended-server-resume-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 540 | """ |
| 541 | return self.action(server_id, 'resume', **kwargs) |
| 542 | |
| 543 | def pause_server(self, server_id, **kwargs): |
| 544 | """Pause the provided server. |
| 545 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 546 | For a full list of available parameters, please refer to the official |
| 547 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 548 | https://developer.openstack.org/api-ref/compute/#pause-server-pause-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 549 | """ |
| 550 | return self.action(server_id, 'pause', **kwargs) |
| 551 | |
| 552 | def unpause_server(self, server_id, **kwargs): |
| 553 | """Un-pause the provided server. |
| 554 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 555 | For a full list of available parameters, please refer to the official |
| 556 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 557 | https://developer.openstack.org/api-ref/compute/#unpause-server-unpause-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 558 | """ |
| 559 | return self.action(server_id, 'unpause', **kwargs) |
| 560 | |
| 561 | def reset_state(self, server_id, **kwargs): |
| 562 | """Reset the state of a server to active/error. |
| 563 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 564 | For a full list of available parameters, please refer to the official |
| 565 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 566 | https://developer.openstack.org/api-ref/compute/#reset-server-state-os-resetstate-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 567 | """ |
| 568 | return self.action(server_id, 'os-resetState', **kwargs) |
| 569 | |
| 570 | def shelve_server(self, server_id, **kwargs): |
| 571 | """Shelve the provided server. |
| 572 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 573 | For a full list of available parameters, please refer to the official |
| 574 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 575 | https://developer.openstack.org/api-ref/compute/#shelve-server-shelve-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 576 | """ |
| 577 | return self.action(server_id, 'shelve', **kwargs) |
| 578 | |
| 579 | def unshelve_server(self, server_id, **kwargs): |
| 580 | """Un-shelve the provided server. |
| 581 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 582 | For a full list of available parameters, please refer to the official |
| 583 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 584 | https://developer.openstack.org/api-ref/compute/#unshelve-restore-shelved-server-unshelve-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 585 | """ |
| 586 | return self.action(server_id, 'unshelve', **kwargs) |
| 587 | |
| 588 | def shelve_offload_server(self, server_id, **kwargs): |
| 589 | """Shelve-offload the provided server. |
| 590 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 591 | For a full list of available parameters, please refer to the official |
| 592 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 593 | https://developer.openstack.org/api-ref/compute/#shelf-offload-remove-server-shelveoffload-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 594 | """ |
| 595 | return self.action(server_id, 'shelveOffload', **kwargs) |
| 596 | |
| 597 | def get_console_output(self, server_id, **kwargs): |
| 598 | """Get console output. |
| 599 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 600 | For a full list of available parameters, please refer to the official |
| 601 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 602 | https://developer.openstack.org/api-ref/compute/#show-console-output-os-getconsoleoutput-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 603 | """ |
| 604 | return self.action(server_id, 'os-getConsoleOutput', |
| 605 | schema.get_console_output, **kwargs) |
| 606 | |
Markus Zoeller | 69d58b8 | 2017-02-17 10:09:22 +0100 | [diff] [blame] | 607 | def get_remote_console(self, server_id, console_type, protocol, **kwargs): |
| 608 | """Get a remote console. |
| 609 | |
| 610 | For a full list of available parameters, please refer to the official |
| 611 | API reference: |
| 612 | TODO (markus_z) The api-ref for that isn't yet available, update this |
| 613 | here when the docs in Nova are updated. The old API is at |
| 614 | http://developer.openstack.org/api-ref/compute/#get-serial-console-os-getserialconsole-action |
| 615 | """ |
| 616 | param = { |
| 617 | 'remote_console': { |
| 618 | 'type': console_type, |
| 619 | 'protocol': protocol, |
| 620 | } |
| 621 | } |
| 622 | post_body = json.dumps(param) |
| 623 | resp, body = self.post("servers/%s/remote-consoles" % server_id, |
| 624 | post_body) |
| 625 | body = json.loads(body) |
| 626 | schema = self.get_schema(self.schema_versions_info) |
| 627 | self.validate_response(schema.get_remote_consoles, resp, body) |
| 628 | return rest_client.ResponseBody(resp, body) |
| 629 | |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 630 | def list_virtual_interfaces(self, server_id): |
| 631 | """List the virtual interfaces used in an instance.""" |
| 632 | resp, body = self.get('/'.join(['servers', server_id, |
| 633 | 'os-virtual-interfaces'])) |
| 634 | body = json.loads(body) |
| 635 | self.validate_response(schema.list_virtual_interfaces, resp, body) |
| 636 | return rest_client.ResponseBody(resp, body) |
| 637 | |
| 638 | def rescue_server(self, server_id, **kwargs): |
| 639 | """Rescue the provided server. |
| 640 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 641 | For a full list of available parameters, please refer to the official |
| 642 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 643 | https://developer.openstack.org/api-ref/compute/#rescue-server-rescue-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 644 | """ |
Nolwenn Cauchois | 1eef260 | 2017-01-18 10:04:24 +0100 | [diff] [blame] | 645 | if self.enable_instance_password: |
| 646 | rescue_schema = schema.rescue_server_with_admin_pass |
| 647 | else: |
| 648 | rescue_schema = schema.rescue_server |
| 649 | return self.action(server_id, 'rescue', rescue_schema, **kwargs) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 650 | |
| 651 | def unrescue_server(self, server_id): |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 652 | """Unrescue the provided server. |
| 653 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 654 | For a full list of available parameters, please refer to the official |
| 655 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 656 | https://developer.openstack.org/api-ref/compute/#unrescue-server-unrescue-action |
Lv Fumei | 7e32633 | 2016-07-08 15:18:03 +0800 | [diff] [blame] | 657 | """ |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 658 | return self.action(server_id, 'unrescue') |
| 659 | |
| 660 | def show_server_diagnostics(self, server_id): |
| 661 | """Get the usage data for a server.""" |
| 662 | resp, body = self.get("servers/%s/diagnostics" % server_id) |
Sergey Nikitin | 0cb4f22 | 2017-02-03 13:16:33 +0400 | [diff] [blame] | 663 | body = json.loads(body) |
| 664 | schema = self.get_schema(self.schema_versions_info) |
| 665 | self.validate_response(schema.show_server_diagnostics, resp, body) |
| 666 | return rest_client.ResponseBody(resp, body) |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 667 | |
| 668 | def list_instance_actions(self, server_id): |
| 669 | """List the provided server action.""" |
| 670 | resp, body = self.get("servers/%s/os-instance-actions" % |
| 671 | server_id) |
| 672 | body = json.loads(body) |
| 673 | self.validate_response(schema.list_instance_actions, resp, body) |
| 674 | return rest_client.ResponseBody(resp, body) |
| 675 | |
| 676 | def show_instance_action(self, server_id, request_id): |
| 677 | """Returns the action details of the provided server.""" |
| 678 | resp, body = self.get("servers/%s/os-instance-actions/%s" % |
| 679 | (server_id, request_id)) |
| 680 | body = json.loads(body) |
| 681 | self.validate_response(schema.show_instance_action, resp, body) |
| 682 | return rest_client.ResponseBody(resp, body) |
| 683 | |
| 684 | def force_delete_server(self, server_id, **kwargs): |
| 685 | """Force delete a server. |
| 686 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 687 | For a full list of available parameters, please refer to the official |
| 688 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 689 | https://developer.openstack.org/api-ref/compute/#force-delete-server-forcedelete-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 690 | """ |
| 691 | return self.action(server_id, 'forceDelete', **kwargs) |
| 692 | |
| 693 | def restore_soft_deleted_server(self, server_id, **kwargs): |
| 694 | """Restore a soft-deleted server. |
| 695 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 696 | For a full list of available parameters, please refer to the official |
| 697 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 698 | https://developer.openstack.org/api-ref/compute/#restore-soft-deleted-instance-restore-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 699 | """ |
| 700 | return self.action(server_id, 'restore', **kwargs) |
| 701 | |
| 702 | def reset_network(self, server_id, **kwargs): |
| 703 | """Reset the Network of a server. |
| 704 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 705 | For a full list of available parameters, please refer to the official |
| 706 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 707 | https://developer.openstack.org/api-ref/compute/#reset-networking-on-a-server-resetnetwork-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 708 | """ |
| 709 | return self.action(server_id, 'resetNetwork', **kwargs) |
| 710 | |
| 711 | def inject_network_info(self, server_id, **kwargs): |
| 712 | """Inject the Network Info into server. |
| 713 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 714 | For a full list of available parameters, please refer to the official |
| 715 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 716 | https://developer.openstack.org/api-ref/compute/#inject-network-information-injectnetworkinfo-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 717 | """ |
| 718 | return self.action(server_id, 'injectNetworkInfo', **kwargs) |
| 719 | |
| 720 | def get_vnc_console(self, server_id, **kwargs): |
| 721 | """Get URL of VNC console. |
| 722 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 723 | For a full list of available parameters, please refer to the official |
| 724 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 725 | https://developer.openstack.org/api-ref/compute/#get-vnc-console-os-getvncconsole-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 726 | """ |
| 727 | return self.action(server_id, "os-getVNCConsole", |
| 728 | schema.get_vnc_console, **kwargs) |
| 729 | |
| 730 | def add_fixed_ip(self, server_id, **kwargs): |
| 731 | """Add a fixed IP to server instance. |
| 732 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 733 | For a full list of available parameters, please refer to the official |
| 734 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 735 | https://developer.openstack.org/api-ref/compute/#add-associate-fixed-ip-addfixedip-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 736 | """ |
| 737 | return self.action(server_id, 'addFixedIp', **kwargs) |
| 738 | |
| 739 | def remove_fixed_ip(self, server_id, **kwargs): |
| 740 | """Remove input fixed IP from input server instance. |
| 741 | |
Dong Ma | d12c233 | 2016-10-19 01:36:27 -0700 | [diff] [blame] | 742 | For a full list of available parameters, please refer to the official |
| 743 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 744 | https://developer.openstack.org/api-ref/compute/#remove-disassociate-fixed-ip-removefixedip-action |
Matthew Treinish | 9e26ca8 | 2016-02-23 11:43:20 -0500 | [diff] [blame] | 745 | """ |
| 746 | return self.action(server_id, 'removeFixedIp', **kwargs) |
zwhe | 3beb6cf | 2017-02-09 16:59:41 +0800 | [diff] [blame] | 747 | |
| 748 | def list_security_groups_by_server(self, server_id): |
| 749 | """Lists security groups for a server. |
| 750 | |
| 751 | For a full list of available parameters, please refer to the official |
| 752 | API reference: |
zhufl | 01ae8db | 2017-03-08 10:50:51 +0800 | [diff] [blame] | 753 | https://developer.openstack.org/api-ref/compute/#list-security-groups-by-server |
zwhe | 3beb6cf | 2017-02-09 16:59:41 +0800 | [diff] [blame] | 754 | """ |
| 755 | resp, body = self.get("servers/%s/os-security-groups" % server_id) |
| 756 | body = json.loads(body) |
| 757 | self.validate_response(security_groups_schema.list_security_groups, |
| 758 | resp, body) |
| 759 | return rest_client.ResponseBody(resp, body) |
Felipe Monteiro | 7c95bef | 2017-02-17 18:49:02 -0500 | [diff] [blame] | 760 | |
| 761 | def list_tags(self, server_id): |
| 762 | """Lists all tags for a server. |
| 763 | |
| 764 | For a full list of available parameters, please refer to the official |
| 765 | API reference: |
| 766 | https://developer.openstack.org/api-ref/compute/#list-tags |
| 767 | """ |
| 768 | url = 'servers/%s/tags' % server_id |
| 769 | resp, body = self.get(url) |
| 770 | body = json.loads(body) |
| 771 | schema = self.get_schema(self.schema_versions_info) |
| 772 | self.validate_response(schema.list_tags, resp, body) |
| 773 | return rest_client.ResponseBody(resp, body) |
| 774 | |
| 775 | def update_all_tags(self, server_id, tags): |
| 776 | """Replaces all tags on specified server with the new set of tags. |
| 777 | |
| 778 | For a full list of available parameters, please refer to the official |
| 779 | API reference: |
| 780 | https://developer.openstack.org/api-ref/compute/#replace-tags |
| 781 | |
| 782 | :param tags: List of tags to replace current server tags with. |
| 783 | """ |
| 784 | url = 'servers/%s/tags' % server_id |
| 785 | put_body = {'tags': tags} |
| 786 | resp, body = self.put(url, json.dumps(put_body)) |
| 787 | body = json.loads(body) |
| 788 | schema = self.get_schema(self.schema_versions_info) |
| 789 | self.validate_response(schema.update_all_tags, resp, body) |
| 790 | return rest_client.ResponseBody(resp, body) |
| 791 | |
| 792 | def delete_all_tags(self, server_id): |
| 793 | """Deletes all tags from the specified server. |
| 794 | |
| 795 | For a full list of available parameters, please refer to the official |
| 796 | API reference: |
| 797 | https://developer.openstack.org/api-ref/compute/#delete-all-tags |
| 798 | """ |
| 799 | url = 'servers/%s/tags' % server_id |
| 800 | resp, body = self.delete(url) |
| 801 | schema = self.get_schema(self.schema_versions_info) |
| 802 | self.validate_response(schema.delete_all_tags, resp, body) |
| 803 | return rest_client.ResponseBody(resp, body) |
| 804 | |
| 805 | def check_tag_existence(self, server_id, tag): |
| 806 | """Checks tag existence on the server. |
| 807 | |
| 808 | For a full list of available parameters, please refer to the official |
| 809 | API reference: |
| 810 | https://developer.openstack.org/api-ref/compute/#check-tag-existence |
| 811 | |
| 812 | :param tag: Check for existence of tag on specified server. |
| 813 | """ |
| 814 | url = 'servers/%s/tags/%s' % (server_id, tag) |
| 815 | resp, body = self.get(url) |
| 816 | schema = self.get_schema(self.schema_versions_info) |
| 817 | self.validate_response(schema.check_tag_existence, resp, body) |
| 818 | return rest_client.ResponseBody(resp, body) |
| 819 | |
| 820 | def update_tag(self, server_id, tag): |
| 821 | """Adds a single tag to the server if server has no specified tag. |
| 822 | |
| 823 | For a full list of available parameters, please refer to the official |
| 824 | API reference: |
| 825 | https://developer.openstack.org/api-ref/compute/#add-a-single-tag |
| 826 | |
| 827 | :param tag: Tag to be added to the specified server. |
| 828 | """ |
| 829 | url = 'servers/%s/tags/%s' % (server_id, tag) |
| 830 | resp, body = self.put(url, None) |
| 831 | schema = self.get_schema(self.schema_versions_info) |
| 832 | self.validate_response(schema.update_tag, resp, body) |
| 833 | return rest_client.ResponseBody(resp, body) |
| 834 | |
| 835 | def delete_tag(self, server_id, tag): |
| 836 | """Deletes a single tag from the specified server. |
| 837 | |
| 838 | For a full list of available parameters, please refer to the official |
| 839 | API reference: |
| 840 | https://developer.openstack.org/api-ref/compute/#delete-a-single-tag |
| 841 | |
| 842 | :param tag: Tag to be removed from the specified server. |
| 843 | """ |
| 844 | url = 'servers/%s/tags/%s' % (server_id, tag) |
| 845 | resp, body = self.delete(url) |
| 846 | schema = self.get_schema(self.schema_versions_info) |
| 847 | self.validate_response(schema.delete_tag, resp, body) |
| 848 | return rest_client.ResponseBody(resp, body) |
raiesmh08 | 14158c9 | 2017-03-21 14:23:15 +0530 | [diff] [blame] | 849 | |
| 850 | def evacuate_server(self, server_id, **kwargs): |
| 851 | """Evacuate the given server. |
| 852 | |
| 853 | For a full list of available parameters, please refer to the official |
| 854 | API reference: |
| 855 | https://developer.openstack.org/api-ref/compute/#evacuate-server-evacuate-action |
| 856 | """ |
| 857 | if self.enable_instance_password: |
| 858 | evacuate_schema = schema.evacuate_server_with_admin_pass |
| 859 | else: |
| 860 | evacuate_schema = schema.evacuate_server |
| 861 | |
| 862 | return self.action(server_id, 'evacuate', |
| 863 | evacuate_schema, |
| 864 | **kwargs) |