blob: f44be2916da50a203c7ff856e14254923f48487a [file] [log] [blame]
ZhiQiang Fan39f97222013-09-20 04:49:44 +08001# Copyright 2012 OpenStack Foundation
nithya-ganesane6a36c82013-02-15 14:38:27 +00002# Copyright 2013 Hewlett-Packard Development Company, L.P.
dwallecke62b9f02012-10-10 23:34:42 -05003# All Rights Reserved.
4#
5# Licensed under the Apache License, Version 2.0 (the "License"); you may
6# not use this file except in compliance with the License. You may obtain
7# a copy of the License at
8#
9# http://www.apache.org/licenses/LICENSE-2.0
10#
11# Unless required by applicable law or agreed to in writing, software
12# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
13# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
14# License for the specific language governing permissions and limitations
15# under the License.
16
Daryl Wallecke5b83d42011-11-10 14:39:02 -060017import json
Daryl Wallecke5b83d42011-11-10 14:39:02 -060018import time
Matthew Treinish26dd0fa2012-12-04 17:14:37 -050019import urllib
Daryl Wallecke5b83d42011-11-10 14:39:02 -060020
Marc Koderer6fbd74f2014-08-04 09:38:19 +020021from tempest.api_schema.response.compute import servers as common_schema
22from tempest.api_schema.response.compute.v2 import servers as schema
Haiwei Xuab924622014-03-05 04:33:51 +090023from tempest.common import rest_client
Attila Fazekas0abbc952013-07-01 19:19:42 +020024from tempest.common import waiters
Matthew Treinish684d8992014-01-30 16:27:40 +000025from tempest import config
Matthew Treinisha83a16e2012-12-07 13:44:02 -050026from tempest import exceptions
27
Matthew Treinish684d8992014-01-30 16:27:40 +000028CONF = config.CONF
29
Daryl Wallecke5b83d42011-11-10 14:39:02 -060030
Haiwei Xuab924622014-03-05 04:33:51 +090031class ServersClientJSON(rest_client.RestClient):
Daryl Wallecke5b83d42011-11-10 14:39:02 -060032
Andrea Frittoli8bbdb162014-01-06 11:06:13 +000033 def __init__(self, auth_provider):
34 super(ServersClientJSON, self).__init__(auth_provider)
35
Matthew Treinish684d8992014-01-30 16:27:40 +000036 self.service = CONF.compute.catalog_type
Daryl Wallecke5b83d42011-11-10 14:39:02 -060037
Rohit Karajgi95446a22011-12-12 06:21:43 -080038 def create_server(self, name, image_ref, flavor_ref, **kwargs):
Daryl Wallecke5b83d42011-11-10 14:39:02 -060039 """
40 Creates an instance of a server.
Rohit Karajgi95446a22011-12-12 06:21:43 -080041 name (Required): The name of the server.
42 image_ref (Required): Reference to the image used to build the server.
43 flavor_ref (Required): The flavor used to build the server.
44 Following optional keyword arguments are accepted:
Daryl Wallecke5b83d42011-11-10 14:39:02 -060045 adminPass: Sets the initial root password.
chris fattarsia6c2a732012-05-02 17:00:19 -070046 key_name: Key name of keypair that was created earlier.
David Kranz28e79de2012-04-12 15:49:41 -040047 meta: A dictionary of values to be used as metadata.
Daryl Wallecke5b83d42011-11-10 14:39:02 -060048 personality: A list of dictionaries for files to be injected into
49 the server.
Rohit Karajgi95446a22011-12-12 06:21:43 -080050 security_groups: A list of security group dicts.
51 networks: A list of network dicts with UUID and fixed_ip.
52 user_data: User data for instance.
53 availability_zone: Availability zone in which to launch instance.
Daryl Wallecke5b83d42011-11-10 14:39:02 -060054 accessIPv4: The IPv4 access address for the server.
55 accessIPv6: The IPv6 access address for the server.
Rohit Karajgi95446a22011-12-12 06:21:43 -080056 min_count: Count of minimum number of instances to launch.
57 max_count: Count of maximum number of instances to launch.
Daryl Wallecke36d5002012-03-28 09:56:10 -050058 disk_config: Determines if user or admin controls disk configuration.
Mauro S. M. Rodriguesc5da4f42013-03-04 23:57:10 -050059 return_reservation_id: Enable/Disable the return of reservation id
Andrey Pavlov2a2fc412014-06-09 11:02:53 +040060 block_device_mapping: Block device mapping for the server.
Daryl Wallecke5b83d42011-11-10 14:39:02 -060061 """
Daryl Wallecke5b83d42011-11-10 14:39:02 -060062 post_body = {
63 'name': name,
64 'imageRef': image_ref,
David Kranz28e79de2012-04-12 15:49:41 -040065 'flavorRef': flavor_ref
Daryl Wallecke5b83d42011-11-10 14:39:02 -060066 }
67
chris fattarsia6c2a732012-05-02 17:00:19 -070068 for option in ['personality', 'adminPass', 'key_name',
Zhongyue Luoe0884a32012-09-25 17:24:17 +080069 'security_groups', 'networks', 'user_data',
70 'availability_zone', 'accessIPv4', 'accessIPv6',
71 'min_count', 'max_count', ('metadata', 'meta'),
Mauro S. M. Rodriguesc5da4f42013-03-04 23:57:10 -050072 ('OS-DCF:diskConfig', 'disk_config'),
Andrey Pavlov2a2fc412014-06-09 11:02:53 +040073 'return_reservation_id', 'block_device_mapping']:
David Kranz28e79de2012-04-12 15:49:41 -040074 if isinstance(option, tuple):
75 post_param = option[0]
76 key = option[1]
77 else:
78 post_param = option
79 key = option
80 value = kwargs.get(key)
Zhongyue Luoe471d6e2012-09-17 17:02:43 +080081 if value is not None:
David Kranz28e79de2012-04-12 15:49:41 -040082 post_body[post_param] = value
raiesmh08cbe21b02014-03-12 17:04:44 +053083 post_body = {'server': post_body}
84
85 if 'sched_hints' in kwargs:
86 hints = {'os:scheduler_hints': kwargs.get('sched_hints')}
87 post_body = dict(post_body.items() + hints.items())
88 post_body = json.dumps(post_body)
vponomaryovf4c27f92014-02-18 10:56:42 +020089 resp, body = self.post('servers', post_body)
Jay Pipes5135bfc2012-01-05 15:46:49 -050090
Daryl Wallecke5b83d42011-11-10 14:39:02 -060091 body = json.loads(body)
Mauro S. M. Rodriguesc5da4f42013-03-04 23:57:10 -050092 # 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 resp, body
Ghanshyam7f989102014-07-29 14:23:26 +090096 if CONF.compute_feature_enabled.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)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600101 return resp, body['server']
102
103 def update_server(self, server_id, name=None, meta=None, accessIPv4=None,
ivan-zhu72d7d5b2013-10-16 17:30:58 +0800104 accessIPv6=None, disk_config=None):
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600105 """
106 Updates the properties of an existing server.
107 server_id: The id of an existing server.
108 name: The name of the server.
109 personality: A list of files to be injected into the server.
110 accessIPv4: The IPv4 access address for the server.
111 accessIPv6: The IPv6 access address for the server.
112 """
113
114 post_body = {}
115
Zhongyue Luoe471d6e2012-09-17 17:02:43 +0800116 if meta is not None:
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600117 post_body['metadata'] = meta
118
Zhongyue Luoe471d6e2012-09-17 17:02:43 +0800119 if name is not None:
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600120 post_body['name'] = name
121
Zhongyue Luoe471d6e2012-09-17 17:02:43 +0800122 if accessIPv4 is not None:
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600123 post_body['accessIPv4'] = accessIPv4
124
Zhongyue Luoe471d6e2012-09-17 17:02:43 +0800125 if accessIPv6 is not None:
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600126 post_body['accessIPv6'] = accessIPv6
127
ivan-zhu72d7d5b2013-10-16 17:30:58 +0800128 if disk_config is not None:
129 post_body['OS-DCF:diskConfig'] = disk_config
130
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600131 post_body = json.dumps({'server': post_body})
vponomaryovf4c27f92014-02-18 10:56:42 +0200132 resp, body = self.put("servers/%s" % str(server_id), post_body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600133 body = json.loads(body)
Ken'ichi Ohmichi29cd5122014-04-28 11:04:52 +0900134 self.validate_response(schema.update_server, resp, body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600135 return resp, body['server']
136
137 def get_server(self, server_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500138 """Returns the details of an existing server."""
chris fattarsi5098fa22012-04-17 13:27:00 -0700139 resp, body = self.get("servers/%s" % str(server_id))
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600140 body = json.loads(body)
Ken'ichi Ohmichi21e4fc72014-05-08 16:46:23 +0900141 self.validate_response(schema.get_server, resp, body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600142 return resp, body['server']
143
144 def delete_server(self, server_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500145 """Deletes the given server."""
Ghanshyam4ac02742014-04-17 19:15:47 +0900146 resp, body = self.delete("servers/%s" % str(server_id))
147 self.validate_response(common_schema.delete_server, resp, body)
148 return resp, body
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600149
150 def list_servers(self, params=None):
Sean Daguef237ccb2013-01-04 15:19:14 -0500151 """Lists all servers for a user."""
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600152
153 url = 'servers'
Matthew Treinish26dd0fa2012-12-04 17:14:37 -0500154 if params:
155 url += '?%s' % urllib.urlencode(params)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600156
chris fattarsi5098fa22012-04-17 13:27:00 -0700157 resp, body = self.get(url)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600158 body = json.loads(body)
Ghanshyam623c38f2014-04-21 17:16:21 +0900159 self.validate_response(common_schema.list_servers, resp, body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600160 return resp, body
161
162 def list_servers_with_detail(self, params=None):
Sean Daguef237ccb2013-01-04 15:19:14 -0500163 """Lists all servers in detail for a user."""
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600164
165 url = 'servers/detail'
Matthew Treinish26dd0fa2012-12-04 17:14:37 -0500166 if params:
167 url += '?%s' % urllib.urlencode(params)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600168
chris fattarsi5098fa22012-04-17 13:27:00 -0700169 resp, body = self.get(url)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600170 body = json.loads(body)
Ghanshyam51744862014-06-13 12:56:24 +0900171 self.validate_response(schema.list_servers_detail, resp, body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600172 return resp, body
173
Zhi Kun Liue5401762013-09-11 20:45:48 +0800174 def wait_for_server_status(self, server_id, status, extra_timeout=0,
175 raise_on_error=True):
Sean Daguef237ccb2013-01-04 15:19:14 -0500176 """Waits for a server to reach a given status."""
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900177 return waiters.wait_for_server_status(self, server_id, status,
Zhi Kun Liue5401762013-09-11 20:45:48 +0800178 extra_timeout=extra_timeout,
179 raise_on_error=raise_on_error)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600180
Jay Pipes051075a2012-04-28 17:39:37 -0400181 def wait_for_server_termination(self, server_id, ignore_error=False):
Sean Daguef237ccb2013-01-04 15:19:14 -0500182 """Waits for server to reach termination."""
Rohit Karajgi4a64d232012-05-17 07:44:37 -0700183 start_time = int(time.time())
184 while True:
185 try:
186 resp, body = self.get_server(server_id)
187 except exceptions.NotFound:
188 return
189
190 server_status = body['status']
Jay Pipes051075a2012-04-28 17:39:37 -0400191 if server_status == 'ERROR' and not ignore_error:
Jay Pipes444c3e62012-10-04 19:26:35 -0400192 raise exceptions.BuildErrorException(server_id=server_id)
Rohit Karajgi4a64d232012-05-17 07:44:37 -0700193
194 if int(time.time()) - start_time >= self.build_timeout:
195 raise exceptions.TimeoutException
196
197 time.sleep(self.build_interval)
198
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600199 def list_addresses(self, server_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500200 """Lists all addresses for a server."""
chris fattarsi5098fa22012-04-17 13:27:00 -0700201 resp, body = self.get("servers/%s/ips" % str(server_id))
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600202 body = json.loads(body)
Ghanshyamd847c582014-05-07 16:21:36 +0900203 self.validate_response(schema.list_addresses, resp, body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600204 return resp, body['addresses']
205
206 def list_addresses_by_network(self, server_id, network_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500207 """Lists all addresses of a specific network type for a server."""
chris fattarsi5098fa22012-04-17 13:27:00 -0700208 resp, body = self.get("servers/%s/ips/%s" %
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800209 (str(server_id), network_id))
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600210 body = json.loads(body)
Ghanshyam9541ad12014-05-07 16:38:43 +0900211 self.validate_response(schema.list_addresses_by_network, resp, body)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600212 return resp, body
213
Ghanshyamd6d30402014-04-02 15:28:37 +0900214 def action(self, server_id, action_name, response_key,
Ghanshyam997c9092014-04-03 19:00:20 +0900215 schema=common_schema.server_actions_common_schema, **kwargs):
Attila Fazekasd4299282013-02-22 13:25:23 +0100216 post_body = json.dumps({action_name: kwargs})
217 resp, body = self.post('servers/%s/action' % str(server_id),
vponomaryovf4c27f92014-02-18 10:56:42 +0200218 post_body)
Attila Fazekasd4299282013-02-22 13:25:23 +0100219 if response_key is not None:
Ghanshyamd6d30402014-04-02 15:28:37 +0900220 body = json.loads(body)
Ghanshyam7ee264a2014-04-02 16:37:57 +0900221 # Check for Schema as 'None' because if we do not have any server
Ghanshyamd6d30402014-04-02 15:28:37 +0900222 # action schema implemented yet then they can pass 'None' to skip
223 # the validation.Once all server action has their schema
224 # implemented then, this check can be removed if every actions are
225 # supposed to validate their response.
Ghanshyam7ee264a2014-04-02 16:37:57 +0900226 # TODO(GMann): Remove the below 'if' check once all server actions
227 # schema are implemented.
Ghanshyamd6d30402014-04-02 15:28:37 +0900228 if schema is not None:
229 self.validate_response(schema, resp, body)
230 body = body[response_key]
Ghanshyam997c9092014-04-03 19:00:20 +0900231 else:
232 self.validate_response(schema, resp, body)
Attila Fazekasd4299282013-02-22 13:25:23 +0100233 return resp, body
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600234
ivan-zhuccc89462013-10-31 16:53:12 +0800235 def create_backup(self, server_id, backup_type, rotation, name):
236 """Backup a server instance."""
237 return self.action(server_id, "createBackup", None,
238 backup_type=backup_type,
239 rotation=rotation,
240 name=name)
241
Attila Fazekasd4299282013-02-22 13:25:23 +0100242 def change_password(self, server_id, adminPass):
243 """Changes the root password for the server."""
244 return self.action(server_id, 'changePassword', None,
245 adminPass=adminPass)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600246
ivan-zhu6de5b042013-10-24 17:21:48 +0800247 def get_password(self, server_id):
248 resp, body = self.get("servers/%s/os-server-password" %
249 str(server_id))
250 body = json.loads(body)
Ghanshyam7fa397c2014-04-01 19:32:38 +0900251 self.validate_response(common_schema.get_password, resp, body)
ivan-zhu6de5b042013-10-24 17:21:48 +0800252 return resp, body
253
254 def delete_password(self, server_id):
255 """
256 Removes the encrypted server password from the metadata server
257 Note that this does not actually change the instance server
258 password.
259 """
Ghanshyam997c9092014-04-03 19:00:20 +0900260 resp, body = self.delete("servers/%s/os-server-password" %
261 str(server_id))
262 self.validate_response(common_schema.server_actions_delete_password,
263 resp, body)
264 return resp, body
ivan-zhu6de5b042013-10-24 17:21:48 +0800265
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600266 def reboot(self, server_id, reboot_type):
Sean Daguef237ccb2013-01-04 15:19:14 -0500267 """Reboots a server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100268 return self.action(server_id, 'reboot', None, type=reboot_type)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600269
Attila Fazekasd4299282013-02-22 13:25:23 +0100270 def rebuild(self, server_id, image_ref, **kwargs):
Sean Daguef237ccb2013-01-04 15:19:14 -0500271 """Rebuilds a server with a new image."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100272 kwargs['imageRef'] = image_ref
273 if 'disk_config' in kwargs:
274 kwargs['OS-DCF:diskConfig'] = kwargs['disk_config']
275 del kwargs['disk_config']
Ghanshyam9c2e50d2014-07-22 21:32:05 +0900276 if CONF.compute_feature_enabled.enable_instance_password:
277 rebuild_schema = schema.rebuild_server_with_admin_pass
278 else:
279 rebuild_schema = schema.rebuild_server
280 return self.action(server_id, 'rebuild', 'server',
281 rebuild_schema, **kwargs)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600282
Attila Fazekasd4299282013-02-22 13:25:23 +0100283 def resize(self, server_id, flavor_ref, **kwargs):
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600284 """Changes the flavor of a server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100285 kwargs['flavorRef'] = flavor_ref
286 if 'disk_config' in kwargs:
287 kwargs['OS-DCF:diskConfig'] = kwargs['disk_config']
288 del kwargs['disk_config']
289 return self.action(server_id, 'resize', None, **kwargs)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600290
Attila Fazekasd4299282013-02-22 13:25:23 +0100291 def confirm_resize(self, server_id, **kwargs):
Sean Daguef237ccb2013-01-04 15:19:14 -0500292 """Confirms the flavor change for a server."""
Ghanshyam997c9092014-04-03 19:00:20 +0900293 return self.action(server_id, 'confirmResize',
294 None, schema.server_actions_confirm_resize,
295 **kwargs)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600296
Attila Fazekasd4299282013-02-22 13:25:23 +0100297 def revert_resize(self, server_id, **kwargs):
Sean Daguef237ccb2013-01-04 15:19:14 -0500298 """Reverts a server back to its original flavor."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100299 return self.action(server_id, 'revertResize', None, **kwargs)
Daryl Wallecke5b83d42011-11-10 14:39:02 -0600300
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600301 def list_server_metadata(self, server_id):
chris fattarsi5098fa22012-04-17 13:27:00 -0700302 resp, body = self.get("servers/%s/metadata" % str(server_id))
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600303 body = json.loads(body)
Ghanshyama8f66532014-04-23 17:18:14 +0900304 self.validate_response(common_schema.list_server_metadata, resp, body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600305 return resp, body['metadata']
306
Chris Yeohd0b52e72013-09-17 22:38:59 +0930307 def set_server_metadata(self, server_id, meta, no_metadata_field=False):
308 if no_metadata_field:
309 post_body = ""
310 else:
311 post_body = json.dumps({'metadata': meta})
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800312 resp, body = self.put('servers/%s/metadata' % str(server_id),
vponomaryovf4c27f92014-02-18 10:56:42 +0200313 post_body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600314 body = json.loads(body)
Haiwei Xu3d2b7af2014-04-12 02:50:26 +0900315 self.validate_response(common_schema.set_server_metadata, resp, body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600316 return resp, body['metadata']
317
318 def update_server_metadata(self, server_id, meta):
319 post_body = json.dumps({'metadata': meta})
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800320 resp, body = self.post('servers/%s/metadata' % str(server_id),
vponomaryovf4c27f92014-02-18 10:56:42 +0200321 post_body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600322 body = json.loads(body)
Ghanshyame8421062014-06-02 15:58:21 +0900323 self.validate_response(common_schema.update_server_metadata,
324 resp, body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600325 return resp, body['metadata']
326
327 def get_server_metadata_item(self, server_id, key):
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800328 resp, body = self.get("servers/%s/metadata/%s" % (str(server_id), key))
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600329 body = json.loads(body)
Ghanshyameaaa6a42014-04-25 18:38:21 +0900330 self.validate_response(schema.set_get_server_metadata_item,
331 resp, body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600332 return resp, body['meta']
333
334 def set_server_metadata_item(self, server_id, key, meta):
335 post_body = json.dumps({'meta': meta})
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800336 resp, body = self.put('servers/%s/metadata/%s' % (str(server_id), key),
vponomaryovf4c27f92014-02-18 10:56:42 +0200337 post_body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600338 body = json.loads(body)
Ghanshyameaaa6a42014-04-25 18:38:21 +0900339 self.validate_response(schema.set_get_server_metadata_item,
340 resp, body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600341 return resp, body['meta']
342
343 def delete_server_metadata_item(self, server_id, key):
chris fattarsi5098fa22012-04-17 13:27:00 -0700344 resp, body = self.delete("servers/%s/metadata/%s" %
Zhongyue Luoe0884a32012-09-25 17:24:17 +0800345 (str(server_id), key))
Ghanshyameaaa6a42014-04-25 18:38:21 +0900346 self.validate_response(common_schema.delete_server_metadata_item,
347 resp, body)
Daryl Walleck73a9e7a2011-11-15 17:43:31 -0600348 return resp, body
Dan Smithc18d8c62012-07-02 08:09:26 -0700349
Attila Fazekasd4299282013-02-22 13:25:23 +0100350 def stop(self, server_id, **kwargs):
351 return self.action(server_id, 'os-stop', None, **kwargs)
Dan Smithc18d8c62012-07-02 08:09:26 -0700352
Attila Fazekasd4299282013-02-22 13:25:23 +0100353 def start(self, server_id, **kwargs):
354 return self.action(server_id, 'os-start', None, **kwargs)
Dan Smithc18d8c62012-07-02 08:09:26 -0700355
356 def attach_volume(self, server_id, volume_id, device='/dev/vdz'):
Sean Daguef237ccb2013-01-04 15:19:14 -0500357 """Attaches a volume to a server instance."""
Zhongyue Luo30a563f2012-09-30 23:43:50 +0900358 post_body = json.dumps({
359 'volumeAttachment': {
360 'volumeId': volume_id,
361 'device': device,
362 }
363 })
Dan Smithc18d8c62012-07-02 08:09:26 -0700364 resp, body = self.post('servers/%s/os-volume_attachments' % server_id,
vponomaryovf4c27f92014-02-18 10:56:42 +0200365 post_body)
Ghanshyam385c4e72014-03-27 11:42:25 +0900366 body = json.loads(body)
367 self.validate_response(schema.attach_volume, resp, body)
Dan Smithc18d8c62012-07-02 08:09:26 -0700368 return resp, body
369
370 def detach_volume(self, server_id, volume_id):
Sean Daguef237ccb2013-01-04 15:19:14 -0500371 """Detaches a volume from a server instance."""
Dan Smithc18d8c62012-07-02 08:09:26 -0700372 resp, body = self.delete('servers/%s/os-volume_attachments/%s' %
373 (server_id, volume_id))
Ghanshyam385c4e72014-03-27 11:42:25 +0900374 self.validate_response(schema.detach_volume, resp, body)
Dan Smithc18d8c62012-07-02 08:09:26 -0700375 return resp, body
sapan-kona775cf632012-06-22 00:32:36 +0530376
Attila Fazekasd4299282013-02-22 13:25:23 +0100377 def add_security_group(self, server_id, name):
Sean Daguef237ccb2013-01-04 15:19:14 -0500378 """Adds a security group to the server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100379 return self.action(server_id, 'addSecurityGroup', None, name=name)
sapan-kona775cf632012-06-22 00:32:36 +0530380
Attila Fazekasd4299282013-02-22 13:25:23 +0100381 def remove_security_group(self, server_id, name):
Sean Daguef237ccb2013-01-04 15:19:14 -0500382 """Removes a security group from the server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100383 return self.action(server_id, 'removeSecurityGroup', None, name=name)
Mate Lakat99ee9142012-09-14 12:34:46 +0100384
385 def live_migrate_server(self, server_id, dest_host, use_block_migration):
Sean Daguef237ccb2013-01-04 15:19:14 -0500386 """This should be called with administrator privileges ."""
Mate Lakat99ee9142012-09-14 12:34:46 +0100387
388 migrate_params = {
389 "disk_over_commit": False,
390 "block_migration": use_block_migration,
391 "host": dest_host
392 }
393
394 req_body = json.dumps({'os-migrateLive': migrate_params})
395
vponomaryovf4c27f92014-02-18 10:56:42 +0200396 resp, body = self.post("servers/%s/action" % str(server_id), req_body)
Ghanshyam997c9092014-04-03 19:00:20 +0900397 self.validate_response(common_schema.server_actions_common_schema,
398 resp, body)
Mate Lakat99ee9142012-09-14 12:34:46 +0100399 return resp, body
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600400
Attila Fazekasd4299282013-02-22 13:25:23 +0100401 def migrate_server(self, server_id, **kwargs):
Sean Daguef237ccb2013-01-04 15:19:14 -0500402 """Migrates a server to a new host."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100403 return self.action(server_id, 'migrate', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600404
Attila Fazekasd4299282013-02-22 13:25:23 +0100405 def lock_server(self, server_id, **kwargs):
Sean Daguef237ccb2013-01-04 15:19:14 -0500406 """Locks the given server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100407 return self.action(server_id, 'lock', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600408
Attila Fazekasd4299282013-02-22 13:25:23 +0100409 def unlock_server(self, server_id, **kwargs):
Sean Daguef237ccb2013-01-04 15:19:14 -0500410 """UNlocks the given server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100411 return self.action(server_id, 'unlock', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600412
Attila Fazekasd4299282013-02-22 13:25:23 +0100413 def suspend_server(self, server_id, **kwargs):
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900414 """Suspends the provided server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100415 return self.action(server_id, 'suspend', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600416
Attila Fazekasd4299282013-02-22 13:25:23 +0100417 def resume_server(self, server_id, **kwargs):
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900418 """Un-suspends the provided server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100419 return self.action(server_id, 'resume', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600420
Attila Fazekasd4299282013-02-22 13:25:23 +0100421 def pause_server(self, server_id, **kwargs):
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900422 """Pauses the provided server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100423 return self.action(server_id, 'pause', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600424
Attila Fazekasd4299282013-02-22 13:25:23 +0100425 def unpause_server(self, server_id, **kwargs):
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900426 """Un-pauses the provided server."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100427 return self.action(server_id, 'unpause', None, **kwargs)
Daryl Walleck3d3f6102012-11-09 15:16:42 -0600428
Attila Fazekasd4299282013-02-22 13:25:23 +0100429 def reset_state(self, server_id, state='error'):
Sean Daguef237ccb2013-01-04 15:19:14 -0500430 """Resets the state of a server to active/error."""
Attila Fazekasd4299282013-02-22 13:25:23 +0100431 return self.action(server_id, 'os-resetState', None, state=state)
Attila Fazekase4cb04c2013-01-29 09:51:58 +0100432
Ken'ichi Ohmichi39437e22013-10-06 00:21:38 +0900433 def shelve_server(self, server_id, **kwargs):
434 """Shelves the provided server."""
435 return self.action(server_id, 'shelve', None, **kwargs)
436
437 def unshelve_server(self, server_id, **kwargs):
438 """Un-shelves the provided server."""
439 return self.action(server_id, 'unshelve', None, **kwargs)
440
Ken'ichi Ohmichi17b7f112014-02-20 06:33:49 +0900441 def shelve_offload_server(self, server_id, **kwargs):
442 """Shelve-offload the provided server."""
443 return self.action(server_id, 'shelveOffload', None, **kwargs)
444
Attila Fazekase4cb04c2013-01-29 09:51:58 +0100445 def get_console_output(self, server_id, length):
Davanum Srinivas8a841c72014-06-19 18:33:14 -0400446 kwargs = {'length': length} if length else {}
Attila Fazekasd4299282013-02-22 13:25:23 +0100447 return self.action(server_id, 'os-getConsoleOutput', 'output',
Davanum Srinivas8a841c72014-06-19 18:33:14 -0400448 common_schema.get_console_output, **kwargs)
Rami Vaknin76bc8bd2013-02-17 16:18:27 +0200449
450 def list_virtual_interfaces(self, server_id):
451 """
452 List the virtual interfaces used in an instance.
453 """
454 resp, body = self.get('/'.join(['servers', server_id,
455 'os-virtual-interfaces']))
Ghanshyam08ce58d2014-04-04 14:51:14 +0900456 body = json.loads(body)
457 self.validate_response(schema.list_virtual_interfaces, resp, body)
458 return resp, body
nithya-ganesane6a36c82013-02-15 14:38:27 +0000459
Yuiko Takada7835d502014-01-15 10:15:03 +0000460 def rescue_server(self, server_id, **kwargs):
nithya-ganesane6a36c82013-02-15 14:38:27 +0000461 """Rescue the provided server."""
Ghanshyam88457912014-07-25 16:02:12 +0900462 return self.action(server_id, 'rescue', 'adminPass',
463 schema.rescue_server, **kwargs)
nithya-ganesane6a36c82013-02-15 14:38:27 +0000464
465 def unrescue_server(self, server_id):
466 """Unrescue the provided server."""
467 return self.action(server_id, 'unrescue', None)
Leo Toyodafaca6ff2013-04-22 16:52:53 +0900468
Zhu Zhuda070852013-09-25 08:07:57 -0500469 def get_server_diagnostics(self, server_id):
470 """Get the usage data for a server."""
471 resp, body = self.get("servers/%s/diagnostics" % str(server_id))
472 return resp, json.loads(body)
473
Leo Toyodafaca6ff2013-04-22 16:52:53 +0900474 def list_instance_actions(self, server_id):
475 """List the provided server action."""
476 resp, body = self.get("servers/%s/os-instance-actions" %
477 str(server_id))
478 body = json.loads(body)
Ghanshyam29966092014-04-07 17:27:41 +0900479 self.validate_response(schema.list_instance_actions, resp, body)
Leo Toyodafaca6ff2013-04-22 16:52:53 +0900480 return resp, body['instanceActions']
481
482 def get_instance_action(self, server_id, request_id):
483 """Returns the action details of the provided server."""
484 resp, body = self.get("servers/%s/os-instance-actions/%s" %
485 (str(server_id), str(request_id)))
486 body = json.loads(body)
Ghanshyam4b41dfd2014-07-17 13:40:38 +0900487 self.validate_response(schema.get_instance_action, resp, body)
Leo Toyodafaca6ff2013-04-22 16:52:53 +0900488 return resp, body['instanceAction']
Lingxian Kongaecc1092013-10-03 16:18:46 +0800489
490 def force_delete_server(self, server_id, **kwargs):
491 """Force delete a server."""
492 return self.action(server_id, 'forceDelete', None, **kwargs)
493
494 def restore_soft_deleted_server(self, server_id, **kwargs):
495 """Restore a soft-deleted server."""
496 return self.action(server_id, 'restore', None, **kwargs)
Ghanshyam Mann79f4a092014-02-27 21:01:31 +0900497
498 def reset_network(self, server_id, **kwargs):
499 """Resets the Network of a server"""
500 return self.action(server_id, 'resetNetwork', None, **kwargs)
501
502 def inject_network_info(self, server_id, **kwargs):
503 """Inject the Network Info into server"""
504 return self.action(server_id, 'injectNetworkInfo', None, **kwargs)
Ghanshyam86d1a572014-03-05 10:19:25 +0900505
506 def get_vnc_console(self, server_id, console_type):
507 """Get URL of VNC console."""
508 return self.action(server_id, "os-getVNCConsole",
Ghanshyamd6d30402014-04-02 15:28:37 +0900509 "console", common_schema.get_vnc_console,
510 type=console_type)
Abhijeet.Jain87dd4452014-04-23 15:51:23 +0530511
512 def create_server_group(self, name, policies):
513 """
514 Create the server group
515 name : Name of the server-group
516 policies : List of the policies - affinity/anti-affinity)
517 """
518 post_body = {
519 'name': name,
520 'policies': policies,
521 }
522
523 post_body = json.dumps({'server_group': post_body})
524 resp, body = self.post('os-server-groups', post_body)
525
526 body = json.loads(body)
Ghanshyamf81f9fa2014-05-23 13:38:56 +0900527 self.validate_response(schema.create_get_server_group, resp, body)
Abhijeet.Jain87dd4452014-04-23 15:51:23 +0530528 return resp, body['server_group']
529
530 def delete_server_group(self, server_group_id):
531 """Delete the given server-group."""
Ghanshyamf81f9fa2014-05-23 13:38:56 +0900532 resp, body = self.delete("os-server-groups/%s" % str(server_group_id))
533 self.validate_response(schema.delete_server_group, resp, body)
534 return resp, body
Abhijeet.Jain87dd4452014-04-23 15:51:23 +0530535
536 def list_server_groups(self):
537 """List the server-groups."""
538 resp, body = self.get("os-server-groups")
539 body = json.loads(body)
Ghanshyam438ed3b2014-06-18 17:25:41 +0900540 self.validate_response(schema.list_server_groups, resp, body)
Abhijeet.Jain87dd4452014-04-23 15:51:23 +0530541 return resp, body['server_groups']
542
543 def get_server_group(self, server_group_id):
544 """Get the details of given server_group."""
545 resp, body = self.get("os-server-groups/%s" % str(server_group_id))
546 body = json.loads(body)
Ghanshyamf81f9fa2014-05-23 13:38:56 +0900547 self.validate_response(schema.create_get_server_group, resp, body)
Abhijeet.Jain87dd4452014-04-23 15:51:23 +0530548 return resp, body['server_group']