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 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060
|
# Licensed under the Apache License, Version 2.0 (the "License"); you may
# not use this file except in compliance with the License. You may obtain
# a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
# License for the specific language governing permissions and limitations
# under the License.
import typing as ty
from openstack.common import metadata
from openstack.common import tag
from openstack.compute.v2 import flavor
from openstack.compute.v2 import volume_attachment
from openstack import exceptions
from openstack.image.v2 import image
from openstack import resource
from openstack import utils
# Workaround Python's lack of an undefined sentinel
# https://python-patterns.guide/python/sentinel-object/
class Unset:
def __bool__(self) -> ty.Literal[False]:
return False
UNSET: Unset = Unset()
CONSOLE_TYPE_ACTION_MAPPING = {
'novnc': 'os-getVNCConsole',
'xvpvnc': 'os-getVNCConsole',
'spice-html5': 'os-getSPICEConsole',
'rdp-html5': 'os-getRDPConsole',
'serial': 'os-getSerialConsole',
}
class Server(resource.Resource, metadata.MetadataMixin, tag.TagMixin):
resource_key = 'server'
resources_key = 'servers'
base_path = '/servers'
# capabilities
allow_create = True
allow_fetch = True
allow_commit = True
allow_delete = True
allow_list = True
# Sentinel used to differentiate API called without parameter or None
# Ex unshelve API can be called without an availability_zone or with
# availability_zone = None to unpin the az.
_sentinel = object()
_query_mapping = resource.QueryParameters(
"auto_disk_config",
"availability_zone",
"created_at",
"description",
"flavor",
"hostname",
"image",
"kernel_id",
"key_name",
"launch_index",
"launched_at",
"locked",
"locked_by",
"name",
"node",
"power_state",
"progress",
"project_id",
"ramdisk_id",
"reservation_id",
"root_device_name",
"status",
"task_state",
"terminated_at",
"user_id",
"vm_state",
"sort_key",
"sort_dir",
"pinned_availability_zone",
access_ipv4="access_ip_v4",
access_ipv6="access_ip_v6",
has_config_drive="config_drive",
deleted_only="deleted",
compute_host="host",
is_soft_deleted="soft_deleted",
ipv4_address="ip",
ipv6_address="ip6",
changes_since="changes-since",
changes_before="changes-before",
id="uuid",
all_projects="all_tenants",
**tag.TagMixin._tag_query_parameters,
)
_max_microversion = '2.96'
#: A list of dictionaries holding links relevant to this server.
links = resource.Body('links')
access_ipv4 = resource.Body('accessIPv4')
access_ipv6 = resource.Body('accessIPv6')
#: A dictionary of addresses this server can be accessed through.
#: The dictionary contains keys such as ``private`` and ``public``,
#: each containing a list of dictionaries for addresses of that type.
#: The addresses are contained in a dictionary with keys ``addr``
#: and ``version``, which is either 4 or 6 depending on the protocol
#: of the IP address. *Type: dict*
addresses = resource.Body('addresses', type=dict)
#: When a server is first created, it provides the administrator password.
admin_password = resource.Body('adminPass')
#: A list of an attached volumes. Each item in the list contains at least
#: an "id" key to identify the specific volumes.
attached_volumes = resource.Body(
'os-extended-volumes:volumes_attached',
aka='volumes',
type=list,
list_type=volume_attachment.VolumeAttachment,
default=[],
)
#: The name of the availability zone this server is a part of.
availability_zone = resource.Body('OS-EXT-AZ:availability_zone')
#: Enables fine grained control of the block device mapping for an
#: instance. This is typically used for booting servers from volumes.
block_device_mapping = resource.Body('block_device_mapping_v2')
#: Indicates whether or not a config drive was used for this server.
config_drive = resource.Body('config_drive')
#: The name of the compute host on which this instance is running.
#: Appears in the response for administrative users only.
compute_host = resource.Body('OS-EXT-SRV-ATTR:host')
#: Timestamp of when the server was created.
created_at = resource.Body('created')
#: The description of the server. Before microversion
#: 2.19 this was set to the server name.
description = resource.Body('description')
#: The disk configuration. Either AUTO or MANUAL.
disk_config = resource.Body('OS-DCF:diskConfig')
#: The flavor reference, as a ID or full URL, for the flavor to use for
#: this server.
flavor_id = resource.Body('flavorRef')
#: The flavor property as returned from server.
flavor = resource.Body('flavor', type=flavor.Flavor)
#: Indicates whether a configuration drive enables metadata injection.
#: Not all cloud providers enable this feature.
has_config_drive = resource.Body('config_drive')
#: An ID representing the host of this server.
host_id = resource.Body('hostId')
#: A fault object. Only available when the server status
#: is ERROR or DELETED and a fault occurred.
fault = resource.Body('fault')
#: The host to boot the server on.
host = resource.Body('host')
#: The host status.
host_status = resource.Body('host_status')
#: The hostname set on the instance when it is booted.
#: By default, it appears in the response for administrative users only.
hostname = resource.Body('OS-EXT-SRV-ATTR:hostname')
#: The hypervisor host name. Appears in the response for administrative
#: users only.
hypervisor_hostname = resource.Body('OS-EXT-SRV-ATTR:hypervisor_hostname')
#: The image reference, as a ID or full URL, for the image to use for
#: this server.
image_id = resource.Body('imageRef')
#: The image property as returned from server.
image = resource.Body('image', type=image.Image)
#: The instance name. The Compute API generates the instance name from the
#: instance name template. Appears in the response for administrative users
#: only.
instance_name = resource.Body('OS-EXT-SRV-ATTR:instance_name')
#: The address to use to connect to this server from the current calling
#: context. This will be set to public_ipv6 if the calling host has
#: routable ipv6 addresses, and to private_ipv4 if the Connection was
#: created with private=True. Otherwise it will be set to public_ipv4.
interface_ip = resource.Computed('interface_ip', default='')
# The locked status of the server
is_locked = resource.Body('locked', type=bool)
#: The UUID of the kernel image when using an AMI. Will be null if not.
#: By default, it appears in the response for administrative users only.
kernel_id = resource.Body('OS-EXT-SRV-ATTR:kernel_id')
#: The name of an associated keypair
key_name = resource.Body('key_name')
#: When servers are launched via multiple create, this is the
#: sequence in which the servers were launched. By default, it
#: appears in the response for administrative users only.
launch_index = resource.Body('OS-EXT-SRV-ATTR:launch_index', type=int)
#: The timestamp when the server was launched.
launched_at = resource.Body('OS-SRV-USG:launched_at')
#: The reason the server was locked, if any.
locked_reason = resource.Body('locked_reason')
#: The maximum number of servers to create.
max_count = resource.Body('max_count')
#: The minimum number of servers to create.
min_count = resource.Body('min_count')
#: A networks object. Required parameter when there are multiple
#: networks defined for the tenant. When you do not specify the
#: networks parameter, the server attaches to the only network
#: created for the current tenant.
networks = resource.Body('networks')
#: Personality files. This should be a list of dicts with each dict
#: containing a file name ('name') and a base64-encoded file contents
#: ('contents')
personality = resource.Body('personality', type=list)
#: The availability zone requested during server creation OR pinned
#: availability zone, which is configured using default_schedule_zone
#: config option.
pinned_availability_zone = resource.Body('pinned_availability_zone')
#: The power state of this server.
power_state = resource.Body('OS-EXT-STS:power_state')
#: While the server is building, this value represents the percentage
#: of completion. Once it is completed, it will be 100. *Type: int*
progress = resource.Body('progress', type=int)
#: The ID of the project this server is associated with.
project_id = resource.Body('tenant_id')
#: The private IPv4 address of this server
private_v4 = resource.Computed('private_v4', default='')
#: The private IPv6 address of this server
private_v6 = resource.Computed('private_v6', default='')
#: The public IPv4 address of this server
public_v4 = resource.Computed('public_v4', default='')
#: The public IPv6 address of this server
public_v6 = resource.Computed('public_v6', default='')
#: The UUID of the ramdisk image when using an AMI. Will be null if not.
#: By default, it appears in the response for administrative users only.
ramdisk_id = resource.Body('OS-EXT-SRV-ATTR:ramdisk_id')
#: The reservation id for the server. This is an id that can be
#: useful in tracking groups of servers created with multiple create,
#: that will all have the same reservation_id. By default, it appears
#: in the response for administrative users only.
reservation_id = resource.Body('OS-EXT-SRV-ATTR:reservation_id')
#: The root device name for the instance By default, it appears in the
#: response for administrative users only.
root_device_name = resource.Body('OS-EXT-SRV-ATTR:root_device_name')
#: The dictionary of data to send to the scheduler.
scheduler_hints = resource.Body('OS-SCH-HNT:scheduler_hints', type=dict)
#: A list of applicable security groups. Each group contains keys for
#: description, name, id, and rules.
security_groups = resource.Body(
'security_groups', type=list, list_type=dict
)
#: The UUIDs of the server groups to which the server belongs.
#: Currently this can contain at most one entry.
server_groups = resource.Body('server_groups', type=list)
#: The state this server is in. Valid values include ``ACTIVE``,
#: ``BUILDING``, ``DELETED``, ``ERROR``, ``HARD_REBOOT``, ``PASSWORD``,
#: ``PAUSED``, ``REBOOT``, ``REBUILD``, ``RESCUED``, ``RESIZED``,
#: ``REVERT_RESIZE``, ``SHUTOFF``, ``SOFT_DELETED``, ``STOPPED``,
#: ``SUSPENDED``, ``UNKNOWN``, or ``VERIFY_RESIZE``.
status = resource.Body('status')
#: The task state of this server.
task_state = resource.Body('OS-EXT-STS:task_state')
#: The timestamp when the server was terminated (if it has been).
terminated_at = resource.Body('OS-SRV-USG:terminated_at')
#: A list of trusted certificate IDs, that were used during image
#: signature verification to verify the signing certificate.
trusted_image_certificates = resource.Body(
'trusted_image_certificates', type=list
)
#: Timestamp of when this server was last updated.
updated_at = resource.Body('updated')
#: Configuration information or scripts to use upon launch.
#: Must be Base64 encoded.
user_data = resource.Body('OS-EXT-SRV-ATTR:user_data')
#: The ID of the owners of this server.
user_id = resource.Body('user_id')
#: The VM state of this server.
vm_state = resource.Body('OS-EXT-STS:vm_state')
def _prepare_request(
self,
requires_id=True,
prepend_key=True,
patch=False,
base_path=None,
params=None,
**kwargs,
):
request = super()._prepare_request(
requires_id=requires_id,
prepend_key=prepend_key,
patch=patch,
base_path=base_path,
params=params,
**kwargs,
)
server_body = request.body[self.resource_key]
# Some names exist without prefix on requests but with a prefix
# on responses. If we find that we've populated one of these
# attributes with something and then go to make a request, swap out
# the name to the bare version.
# Availability Zones exist with a prefix on response, but not request
az_key = "OS-EXT-AZ:availability_zone"
if az_key in server_body:
server_body["availability_zone"] = server_body.pop(az_key)
# User Data exists with a prefix on response, but not request
ud_key = "OS-EXT-SRV-ATTR:user_data"
if ud_key in server_body:
server_body["user_data"] = server_body.pop(ud_key)
# Scheduler hints are sent in a top-level scope, not within the
# resource_key scope like everything else. If we try to send
# scheduler_hints, pop them out of the resource_key scope and into
# their own top-level scope.
hint_key = "OS-SCH-HNT:scheduler_hints"
if hint_key in server_body:
request.body[hint_key] = server_body.pop(hint_key)
return request
def _action(self, session, body, microversion=None):
"""Preform server actions given the message body."""
# NOTE: This is using Server.base_path instead of self.base_path
# as both Server and ServerDetail instances can be acted on, but
# the URL used is sans any additional /detail/ part.
url = utils.urljoin(Server.base_path, self.id, 'action')
headers = {'Accept': ''}
# these aren't all necessary "commit" actions (i.e. updates) but it's
# good enough...
if microversion is None:
microversion = self._get_microversion(session, action='commit')
response = session.post(
url,
json=body,
headers=headers,
microversion=microversion,
)
exceptions.raise_from_response(response)
return response
def change_password(self, session, password, *, microversion=None):
"""Change the administrator password to the given password.
:param session: The session to use for making this request.
:param password: The new password.
:returns: None
"""
body = {'changePassword': {'adminPass': password}}
self._action(session, body, microversion=microversion)
def get_password(self, session, *, microversion=None):
"""Get the encrypted administrator password.
:param session: The session to use for making this request.
:returns: The encrypted administrator password.
"""
url = utils.urljoin(Server.base_path, self.id, 'os-server-password')
if microversion is None:
microversion = self._get_microversion(session, action='commit')
response = session.get(url, microversion=microversion)
exceptions.raise_from_response(response)
data = response.json()
return data.get('password')
def clear_password(self, session, *, microversion=None):
"""Clear the administrator password.
This removes the password from the database. It does not actually
change the server password.
:param session: The session to use for making this request.
:returns: None
"""
url = utils.urljoin(Server.base_path, self.id, 'os-server-password')
if microversion is None:
microversion = self._get_microversion(session, action='commit')
response = session.delete(url, microversion=microversion)
exceptions.raise_from_response(response)
def reboot(self, session, reboot_type):
"""Reboot server where reboot_type might be 'SOFT' or 'HARD'.
:param session: The session to use for making this request.
:param reboot_type: The type of reboot. One of: ``SOFT``, ``HARD``.
:returns: None
"""
body = {'reboot': {'type': reboot_type}}
self._action(session, body)
def force_delete(self, session):
"""Force delete the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {'forceDelete': None}
self._action(session, body)
def rebuild(
self,
session,
image,
name=UNSET,
admin_password=UNSET,
preserve_ephemeral=UNSET,
access_ipv4=UNSET,
access_ipv6=UNSET,
metadata=UNSET,
user_data=UNSET,
key_name=UNSET,
description=UNSET,
trusted_image_certificates=UNSET,
hostname=UNSET,
):
"""Rebuild the server with the given arguments.
:param session: The session to use for making this request.
:param image: The image to rebuild to. Either an ID or a
:class:`~openstack.image.v1.image.Image` instance.
:param name: A name to set on the rebuilt server. (Optional)
:param admin_password: An admin password to set on the rebuilt server.
(Optional)
:param preserve_ephemeral: Whether to preserve the ephemeral drive
during the rebuild. (Optional)
:param access_ipv4: An IPv4 address that will be used to access the
rebuilt server. (Optional)
:param access_ipv6: An IPv6 address that will be used to access the
rebuilt server. (Optional)
:param metadata: Metadata to set on the updated server. (Optional)
:param user_data: User data to set on the updated server. (Optional)
:param key_name: A key name to set on the updated server. (Optional)
:param description: The description to set on the updated server.
(Optional) (Requires API microversion 2.19)
:param trusted_image_certificates: The trusted image certificates to
set on the updated server. (Optional) (Requires API microversion
2.78)
:param hostname: The hostname to set on the updated server. (Optional)
(Requires API microversion 2.90)
:returns: The updated server.
"""
action = {'imageRef': resource.Resource._get_id(image)}
if preserve_ephemeral is not UNSET:
action['preserve_ephemeral'] = preserve_ephemeral
if name is not UNSET:
action['name'] = name
if admin_password is not UNSET:
action['adminPass'] = admin_password
if access_ipv4 is not UNSET:
action['accessIPv4'] = access_ipv4
if access_ipv6 is not UNSET:
action['accessIPv6'] = access_ipv6
if metadata is not UNSET:
action['metadata'] = metadata
if user_data is not UNSET:
action['user_data'] = user_data
if key_name is not UNSET:
action['key_name'] = key_name
if description is not UNSET:
action['description'] = description
if trusted_image_certificates is not UNSET:
action['trusted_image_certificates'] = trusted_image_certificates
if hostname is not UNSET:
action['hostname'] = hostname
body = {'rebuild': action}
response = self._action(session, body)
self._translate_response(response)
return self
def resize(self, session, flavor):
"""Resize server to flavor reference.
:param session: The session to use for making this request.
:param flavor: The server to resize to.
:returns: None
"""
body = {'resize': {'flavorRef': flavor}}
self._action(session, body)
def confirm_resize(self, session):
"""Confirm the resize of the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {'confirmResize': None}
self._action(session, body)
def revert_resize(self, session):
"""Revert the resize of the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {'revertResize': None}
self._action(session, body)
def create_image(self, session, name, metadata=None):
"""Create image from server.
:param session: The session to use for making this request.
:param name: The name to use for the created image.
:param metadata: Metadata to set on the created image. (Optional)
:returns: None
"""
action = {'name': name}
if metadata is not None:
action['metadata'] = metadata
body = {'createImage': action}
# You won't believe it - wait, who am I kidding - of course you will!
# Nova returns the URL of the image created in the Location
# header of the response. (what?) But, even better, the URL it responds
# with has a very good chance of being wrong (it is built from
# nova.conf values that point to internal API servers in any cloud
# large enough to have both public and internal endpoints.
# However, nobody has ever noticed this because novaclient doesn't
# actually use that URL - it extracts the id from the end of
# the url, then returns the id. This leads us to question:
# a) why Nova is going to return a value in a header
# b) why it's going to return data that probably broken
# c) indeed the very nature of the fabric of reality
# Although it fills us with existential dread, we have no choice but
# to follow suit like a lemming being forced over a cliff by evil
# producers from Disney.
microversion = None
if utils.supports_microversion(session, '2.45'):
microversion = '2.45'
response = self._action(session, body, microversion)
try:
# There might be a body, there might not be
response_body = response.json()
except Exception:
response_body = None
if response_body and 'image_id' in response_body:
image_id = response_body['image_id']
else:
image_id = response.headers['Location'].rsplit('/', 1)[1]
return image_id
def add_security_group(self, session, security_group_name):
"""Add a security group to the server.
:param session: The session to use for making this request.
:param security_group_name: The security group to add to the server.
:returns: None
"""
body = {"addSecurityGroup": {"name": security_group_name}}
self._action(session, body)
def remove_security_group(self, session, security_group_name):
"""Remove a security group from the server.
:param session: The session to use for making this request.
:param security_group_name: The security group to remove from the
server.
:returns: None
"""
body = {"removeSecurityGroup": {"name": security_group_name}}
self._action(session, body)
def reset_state(self, session, state):
"""Reset server state.
This is admin-only by default.
:param session: The session to use for making this request.
:param state: The state to set on the server.
:returns: None
"""
body = {"os-resetState": {"state": state}}
self._action(session, body)
def add_fixed_ip(self, session, network_id):
"""Add a fixed IP to the server.
This is effectively an alias for adding a network.
:param session: The session to use for making this request.
:param network_id: The network to connect the server to.
:returns: None
"""
body = {"addFixedIp": {"networkId": network_id}}
self._action(session, body)
def remove_fixed_ip(self, session, address):
"""Remove a fixed IP from the server.
This is effectively an alias from removing a port from the server.
:param session: The session to use for making this request.
:param network_id: The address to remove from the server.
:returns: None
"""
body = {"removeFixedIp": {"address": address}}
self._action(session, body)
def add_floating_ip(self, session, address, fixed_address=None):
"""Add a floating IP to the server.
:param session: The session to use for making this request.
:param address: The floating IP address to associate with the server.
:param fixed_address: A fixed IP address with which to associated the
floating IP. (Optional)
:returns: None
"""
body = {"addFloatingIp": {"address": address}}
if fixed_address is not None:
body['addFloatingIp']['fixed_address'] = fixed_address
self._action(session, body)
def remove_floating_ip(self, session, address):
"""Remove a floating IP from the server.
:param session: The session to use for making this request.
:param address: The floating IP address to disassociate from the
server.
:returns: None
"""
body = {"removeFloatingIp": {"address": address}}
self._action(session, body)
def backup(self, session, name, backup_type, rotation):
"""Create a backup of the server.
:param session: The session to use for making this request.
:param name: The name to use for the backup image.
:param backup_type: The type of backup. The value and meaning of this
atribute is user-defined and can be used to separate backups of
different types. For example, this could be used to distinguish
between ``daily`` and ``weekly`` backups.
:param rotation: The number of backups to retain. All images older than
the rotation'th image will be deleted.
:returns: None
"""
body = {
"createBackup": {
"name": name,
"backup_type": backup_type,
"rotation": rotation,
}
}
self._action(session, body)
def pause(self, session):
"""Pause the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"pause": None}
self._action(session, body)
def unpause(self, session):
"""Unpause the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"unpause": None}
self._action(session, body)
def suspend(self, session):
"""Suspend the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"suspend": None}
self._action(session, body)
def resume(self, session):
"""Resume the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"resume": None}
self._action(session, body)
def lock(self, session, locked_reason=None):
"""Lock the server.
:param session: The session to use for making this request.
:param locked_reason: The reason for locking the server.
:returns: None
"""
body: dict[str, ty.Any] = {"lock": None}
if locked_reason is not None:
body["lock"] = {
"locked_reason": locked_reason,
}
self._action(session, body)
def unlock(self, session):
"""Unlock the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"unlock": None}
self._action(session, body)
def rescue(self, session, admin_pass=None, image_ref=None):
"""Rescue the server.
This is admin-only by default.
:param session: The session to use for making this request.
:param admin_pass: A new admin password to set on the rescued server.
(Optional)
:param image_ref: The image to use when rescuing the server. If not
provided, the server will use the existing image. (Optional)
:returns: None
"""
body: dict[str, ty.Any] = {"rescue": {}}
if admin_pass is not None:
body["rescue"]["adminPass"] = admin_pass
if image_ref is not None:
body["rescue"]["rescue_image_ref"] = image_ref
self._action(session, body)
def unrescue(self, session):
"""Unrescue the server.
This is admin-only by default.
:param session: The session to use for making this request.
:returns: None
"""
body = {"unrescue": None}
self._action(session, body)
def evacuate(
self,
session,
host=None,
admin_pass=None,
force=None,
on_shared_storage=None,
):
"""Evacuate the server.
:param session: The session to use for making this request.
:param host: The host to evacuate the instance to. (Optional)
:param admin_pass: The admin password to set on the evacuated instance.
(Optional)
:param force: Whether to force evacuation.
:param on_shared_storage: Whether the host is using shared storage.
(Optional) (Only supported before microversion 2.14)
:returns: None
"""
body: dict[str, ty.Any] = {"evacuate": {}}
if host is not None:
body["evacuate"]["host"] = host
if admin_pass is not None:
body["evacuate"]["adminPass"] = admin_pass
if force is not None:
body["evacuate"]["force"] = force
if on_shared_storage is not None:
body["evacuate"]["onSharedStorage"] = on_shared_storage
self._action(session, body)
def start(self, session):
"""Start the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"os-start": None}
self._action(session, body)
def stop(self, session):
"""Stop the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"os-stop": None}
self._action(session, body)
def restore(self, session):
"""Restore the server.
This is only supported if the server is soft-deleted. This is
cloud-specific.
:param session: The session to use for making this request.
:returns: None
"""
body = {"restore": None}
self._action(session, body)
def shelve(self, session):
"""Shelve the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"shelve": None}
self._action(session, body)
def shelve_offload(self, session):
"""Shelve-offload the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"shelveOffload": None}
self._action(session, body)
def unshelve(self, session, availability_zone=_sentinel, host=None):
"""Unshelve the server.
:param session: The session to use for making this request.
:param availability_zone: If specified the instance will be unshelved
to the availability_zone.
If None is passed the instance defined availability_zone is unpin
and the instance will be scheduled to any availability_zone (free
scheduling).
If not specified the instance will be unshelved to either its
defined availability_zone or any availability_zone
(free scheduling).
:param host: If specified the host to unshelve the instance.
"""
data = {}
if host:
data["host"] = host
if availability_zone is None or isinstance(availability_zone, str):
data["availability_zone"] = availability_zone
body = {'unshelve': data or None}
self._action(session, body)
def migrate(self, session, *, host=None):
"""Migrate the server.
:param session: The session to use for making this request.
:param host: The host to migrate the server to. (Optional)
:returns: None
"""
if host and not utils.supports_microversion(session, '2.56'):
raise ValueError(
"The 'host' option is only supported on microversion 2.56 or "
"greater."
)
body: dict[str, ty.Any] = {"migrate": None}
if host:
body["migrate"] = {"host": host}
self._action(session, body)
def trigger_crash_dump(self, session):
"""Trigger a crash dump for the server.
:param session: The session to use for making this request.
:returns: None
"""
body = {"trigger_crash_dump": None}
self._action(session, body)
def get_console_output(self, session, length=None):
"""Get console output for the server.
:param session: The session to use for making this request.
:param length: The max length of the console output to return.
(Optional)
:returns: None
"""
body: dict[str, ty.Any] = {"os-getConsoleOutput": {}}
if length is not None:
body["os-getConsoleOutput"]["length"] = length
resp = self._action(session, body)
return resp.json()
def get_console_url(self, session, console_type):
"""Get the console URL for the server.
:param session: The session to use for making this request.
:param console_type: The type of console to return. This is
cloud-specific. One of: ``novnc``, ``xvpvnc``, ``spice-html5``,
``rdp-html5``, ``serial``.
:returns: None
"""
action = CONSOLE_TYPE_ACTION_MAPPING.get(console_type)
if not action:
raise ValueError(f"Unsupported console type {console_type}")
body = {action: {'type': console_type}}
resp = self._action(session, body)
return resp.json().get('console')
def live_migrate(
self,
session,
host,
force,
block_migration,
disk_over_commit=False,
):
"""Live migrate the server.
:param session: The session to use for making this request.
:param host: The host to live migrate the server to. (Optional)
:param force: Whether to force the migration. (Optional)
:param block_migration: Whether to do block migration. One of:
``True``, ``False``, ``'auto'``. (Optional)
:param disk_over_commit: Whether to allow disk over-commit on the
destination host. (Optional)
:returns: None
"""
if utils.supports_microversion(session, '2.30'):
return self._live_migrate_30(
session,
host,
force=force,
block_migration=block_migration,
)
elif utils.supports_microversion(session, '2.25'):
return self._live_migrate_25(
session,
host,
force=force,
block_migration=block_migration,
)
else:
return self._live_migrate(
session,
host,
force=force,
block_migration=block_migration,
disk_over_commit=disk_over_commit,
)
def _live_migrate_30(self, session, host, force, block_migration):
microversion = '2.30'
body = {'host': None}
if block_migration is None:
block_migration = 'auto'
body['block_migration'] = block_migration
if host:
body['host'] = host
if force:
body['force'] = force
self._action(
session,
{'os-migrateLive': body},
microversion=microversion,
)
def _live_migrate_25(self, session, host, force, block_migration):
microversion = '2.25'
body = {'host': None}
if block_migration is None:
block_migration = 'auto'
body['block_migration'] = block_migration
if host:
body['host'] = host
if not force:
raise ValueError(
"Live migration on this cloud implies 'force' "
"if the 'host' option has been given and it is not "
"possible to disable. It is recommended to not use 'host' "
"at all on this cloud as it is inherently unsafe, but if "
"it is unavoidable, please supply 'force=True' so that it "
"is clear you understand the risks."
)
self._action(
session,
{'os-migrateLive': body},
microversion=microversion,
)
def _live_migrate(
self,
session,
host,
force,
block_migration,
disk_over_commit,
):
microversion = None
body: dict[str, ty.Any] = {
'host': None,
}
if block_migration == 'auto':
raise ValueError(
"Live migration on this cloud does not support 'auto' as "
"a parameter to block_migration, but only True and False."
)
body['block_migration'] = block_migration or False
body['disk_over_commit'] = disk_over_commit or False
if host:
body['host'] = host
if not force:
raise ValueError(
"Live migration on this cloud implies 'force' "
"if the 'host' option has been given and it is not "
"possible to disable. It is recommended to not use 'host' "
"at all on this cloud as it is inherently unsafe, but if "
"it is unavoidable, please supply 'force=True' so that it "
"is clear you understand the risks."
)
self._action(
session,
{'os-migrateLive': body},
microversion=microversion,
)
def fetch_topology(self, session):
"""Fetch the topology information for the server.
:param session: The session to use for making this request.
:returns: None
"""
utils.require_microversion(session, '2.78')
url = utils.urljoin(Server.base_path, self.id, 'topology')
response = session.get(url)
exceptions.raise_from_response(response)
try:
return response.json()
except ValueError:
pass
def fetch_security_groups(self, session):
"""Fetch security groups of the server.
:param session: The session to use for making this request.
:returns: Updated Server instance.
"""
url = utils.urljoin(Server.base_path, self.id, 'os-security-groups')
response = session.get(url)
exceptions.raise_from_response(response)
try:
data = response.json()
if 'security_groups' in data:
self.security_groups = data['security_groups']
except ValueError:
pass
return self
ServerDetail = Server
|