ServersΒΆ

Server interface.

class novaclient.v2.servers.Server(manager, info, loaded=False, resp=None)

Bases: novaclient.base.Resource

Populate and bind to a manager.

Parameters:
  • manager – BaseManager object
  • info – dictionary representing resource attributes
  • loaded – prevent lazy-loading if set to True
  • resp – Response or list of Response objects
HUMAN_ID = True
add_fixed_ip(network_id)

Add an IP address on a network.

Parameters:network_id – The ID of the network the IP should be on.
Returns:An instance of novaclient.base.TupleWithMeta
add_floating_ip(address, fixed_address=None)

Add floating IP to an instance

Parameters:
  • address – The IP address or FloatingIP to add to the instance
  • fixed_address – The fixedIP address the FloatingIP is to be associated with (optional)
Returns:

An instance of novaclient.base.TupleWithMeta
add_security_group(security_group)

Add a security group to an instance.

Parameters:security_group – The name of security group to add
Returns:An instance of novaclient.base.DictWithMeta
backup(backup_name, backup_type, rotation)

Backup a server instance.

Parameters:
  • backup_name – Name of the backup image
  • backup_type – The backup type, like ‘daily’ or ‘weekly’
  • rotation – Int parameter representing how many backups to keep around.
Returns:

An instance of novaclient.base.TupleWithMeta
change_password(password)

Update the admin password for a server.

Parameters:password – string to set as the admin password on the server
Returns:An instance of novaclient.base.TupleWithMeta
clear_password()

Get password for a Server.

confirm_resize()

Confirm that the resize worked, thus removing the original server.

Returns:An instance of novaclient.base.TupleWithMeta
create_image(image_name, metadata=None)

Create an image based on this server.

Parameters:
  • image_name – The name to assign the newly create image.
  • metadata – Metadata to assign to the image.
delete()

Delete (i.e. shut down and delete the image) this server.

Returns:An instance of novaclient.base.TupleWithMeta
diagnostics()

Diagnostics – Retrieve server diagnostics.

evacuate(host=None, on_shared_storage=None, password=None)

Evacuate an instance from failed host to specified host.

Parameters:
  • host – Name of the target host
  • on_shared_storage – Specifies whether instance files located on shared storage. After microversion 2.14, this parameter must have its default value of None.
  • password – string to set as admin password on the evacuated server.
Returns:

An instance of novaclient.base.TupleWithMeta
force_delete()

Force delete – Force delete a server.

Returns:An instance of novaclient.base.TupleWithMeta
get_console_output(length=None)

Get text console log output from Server.

Parameters:length – The number of lines you would like to retrieve (as int)
get_mks_console()

Get mks console for a Server.

get_password(private_key=None)

Get password for a Server.

Returns the clear password of an instance if private_key is provided, returns the ciphered password otherwise.

Parameters:private_key – Path to private key file for decryption (optional)
get_rdp_console(console_type)

Get rdp console for a Server.

Parameters:console_type – Type of console (‘rdp-html5’)
get_serial_console(console_type)

Get serial console for a Server.

Parameters:console_type – Type of console (‘serial’)
get_spice_console(console_type)

Get spice console for a Server.

Parameters:console_type – Type of console (‘spice-html5’)
get_vnc_console(console_type)

Get vnc console for a Server.

Parameters:console_type – Type of console (‘novnc’ or ‘xvpvnc’)
interface_attach(port_id, net_id, fixed_ip)

Attach a network interface to an instance.

interface_detach(port_id)

Detach a network interface from an instance.

interface_list()

List interfaces attached to an instance.

list_security_group()

List security group(s) of an instance.

live_migrate(host=None, block_migration=None, disk_over_commit=None)

Migrates a running instance to a new machine.

Parameters:
  • host – destination host name.
  • block_migration – if True, do block_migration, the default value None will be mapped to False for 2.0 - 2.24, ‘auto’ for higher than 2.25
  • disk_over_commit – if True, allow disk over commit, the default value None will be mapped to False. It will not be supported since 2.25
Returns:

An instance of novaclient.base.TupleWithMeta
lock()

Lock – Lock the instance from certain operations.

Returns:An instance of novaclient.base.TupleWithMeta
migrate()

Migrate a server to a new host.

Returns:An instance of novaclient.base.TupleWithMeta
networks

Generate a simplified list of addresses

pause()

Pause – Pause the running server.

Returns:An instance of novaclient.base.TupleWithMeta
reboot(reboot_type='SOFT')

Reboot the server.

Parameters:reboot_type – either REBOOT_SOFT for a software-level reboot, or REBOOT_HARD for a virtual power cycle hard reboot.
Returns:An instance of novaclient.base.TupleWithMeta
rebuild(image, password=None, preserve_ephemeral=False, **kwargs)

Rebuild – shut down and then re-image – this server.

Parameters:
  • image – the Image (or its ID) to re-image with.
  • password – string to set as the admin password on the rebuilt server.
  • preserve_ephemeral – If True, request that any ephemeral device be preserved when rebuilding the instance. Defaults to False.
remove_fixed_ip(address)

Remove an IP address.

Parameters:address – The IP address to remove.
Returns:An instance of novaclient.base.TupleWithMeta
remove_floating_ip(address)

Remove floating IP from an instance

Parameters:address – The IP address or FloatingIP to remove
Returns:An instance of novaclient.base.TupleWithMeta
remove_security_group(security_group)

Remove a security group from an instance.

Returns:An instance of novaclient.base.TupleWithMeta
rescue(password=None, image=None)

Rescue – Rescue the problematic server.

Parameters:
  • password – The admin password to be set in the rescue instance.
  • image – The Image to rescue with.
Returns:

An instance of novaclient.base.TupleWithMeta
reset_network()

Reset network of an instance.

Returns:An instance of novaclient.base.TupleWithMeta
reset_state(state='error')

Reset the state of an instance to active or error.

Returns:An instance of novaclient.base.TupleWithMeta
resize(flavor, **kwargs)

Resize the server’s resources.

Parameters:flavor – the Flavor (or its ID) to resize to.
Returns:An instance of novaclient.base.TupleWithMeta

Until a resize event is confirmed with confirm_resize(), the old server will be kept around and you’ll be able to roll back to the old flavor quickly with revert_resize(). All resizes are automatically confirmed after 24 hours.

restore()

Restore – Restore a server in ‘soft-deleted’ state.

Returns:An instance of novaclient.base.TupleWithMeta
resume()

Resume – Resume the suspended server.

Returns:An instance of novaclient.base.TupleWithMeta
revert_resize()

Revert a previous resize, switching back to the old server.

Returns:An instance of novaclient.base.TupleWithMeta
shelve()

Shelve – Shelve the server.

Returns:An instance of novaclient.base.TupleWithMeta
shelve_offload()

Shelve_offload – Remove a shelved server from the compute node.

Returns:An instance of novaclient.base.TupleWithMeta
start()

Start – Start the paused server.

Returns:An instance of novaclient.base.TupleWithMeta
stop()

Stop – Stop the running server.

Returns:An instance of novaclient.base.TupleWithMeta
suspend()

Suspend – Suspend the running server.

Returns:An instance of novaclient.base.TupleWithMeta
trigger_crash_dump()

Trigger crash dump in an instance

unlock()

Unlock – Remove instance lock.

Returns:An instance of novaclient.base.TupleWithMeta
unpause()

Unpause – Unpause the paused server.

Returns:An instance of novaclient.base.TupleWithMeta
unrescue()

Unrescue – Unrescue the rescued server.

Returns:An instance of novaclient.base.TupleWithMeta
unshelve()

Unshelve – Unshelve the server.

Returns:An instance of novaclient.base.TupleWithMeta
update(name=None, description=None)

Update the name and the description for this server.

Parameters:
  • name – Update the server’s name.
  • description – Update the server’s description( allowed for 2.19-latest).
Returns:

Server
class novaclient.v2.servers.ServerManager(api)

Bases: novaclient.base.BootingManagerWithFind

add_fixed_ip(server, network_id)

Add an IP address on a network.

Parameters:
  • server – The Server (or its ID) to add an IP to.
  • network_id – The ID of the network the IP should be on.
Returns:

An instance of novaclient.base.TupleWithMeta
add_floating_ip(server, address, fixed_address=None)

Add a floating IP to an instance

Parameters:
  • server – The Server (or its ID) to add an IP to.
  • address – The FloatingIP or string floating address to add.
  • fixed_address – The FixedIP the floatingIP should be associated with (optional)
Returns:

An instance of novaclient.base.TupleWithMeta
add_security_group(server, security_group)

Add a Security Group to an instance

Parameters:
  • server – ID of the instance.
  • security_group – The name of security group to add.
Returns:

An instance of novaclient.base.DictWithMeta
backup(server, backup_name, backup_type, rotation)

Backup a server instance.

Parameters:
  • server – The Server (or its ID) to share onto.
  • backup_name – Name of the backup image
  • backup_type – The backup type, like ‘daily’ or ‘weekly’
  • rotation – Int parameter representing how many backups to keep around.
Returns:

An instance of novaclient.base.TupleWithMeta
change_password(server, password)

Update the password for a server.

Parameters:server – The Server (or its ID) for which the admin password is to be changed
Returns:An instance of novaclient.base.TupleWithMeta
clear_password(server)

Clear the admin password of an instance

Remove the admin password for an instance from the metadata server.

Parameters:server – The Server (or its ID) for which the admin password is to be cleared
confirm_resize(server)

Confirm that the resize worked, thus removing the original server.

Parameters:server – The Server (or its ID) to share onto.
Returns:An instance of novaclient.base.TupleWithMeta
create(name, image, flavor, meta=None, files=None, reservation_id=None, min_count=None, max_count=None, security_groups=None, userdata=None, key_name=None, availability_zone=None, block_device_mapping=None, block_device_mapping_v2=None, nics=None, scheduler_hints=None, config_drive=None, disk_config=None, admin_pass=None, access_ip_v4=None, access_ip_v6=None, **kwargs)

Create (boot) a new server.

Parameters:
  • name – Something to name the server.
  • image – The Image to boot with.
  • flavor – The Flavor to boot onto.
  • meta – A dict of arbitrary key/value metadata to store for this server. Both keys and values must be <=255 characters.
  • files – A dict of files to overwrite on the server upon boot. Keys are file names (i.e. /etc/passwd) and values are the file contents (either as a string or as a file-like object). A maximum of five entries is allowed, and each file must be 10k or less.
  • reservation_id – a UUID for the set of servers being requested.
  • min_count – (optional extension) The minimum number of servers to launch.
  • max_count – (optional extension) The maximum number of servers to launch.
  • security_groups – A list of security group names
  • userdata – user data to pass to be exposed by the metadata server this can be a file type object as well or a string.
  • key_name – (optional extension) name of previously created keypair to inject into the instance.
  • availability_zone – Name of the availability zone for instance placement.
  • block_device_mapping – (optional extension) A dict of block device mappings for this server.
  • block_device_mapping_v2 – (optional extension) A dict of block device mappings for this server.
  • nics – (optional extension) an ordered list of nics to be added to this server, with information about connected networks, fixed IPs, port etc.
  • scheduler_hints – (optional extension) arbitrary key-value pairs specified by the client to help boot an instance
  • config_drive – (optional extension) value for config drive either boolean, or volume-id
  • disk_config – (optional extension) control how the disk is partitioned when the server is created. possible values are ‘AUTO’ or ‘MANUAL’.
  • admin_pass – (optional extension) add a user supplied admin password.
  • access_ip_v4 – (optional extension) add alternative access ip v4
  • access_ip_v6 – (optional extension) add alternative access ip v6
  • description – optional description of the server (allowed since microversion 2.19)
create_image(server, image_name, metadata=None)

Snapshot a server.

Parameters:
  • server – The Server (or its ID) to share onto.
  • image_name – Name to give the snapshot image
  • metadata – Metadata to give newly-created image entity
Returns:

An instance of novaclient.base.StrWithMeta (The snapshot image’s UUID)
delete(server)

Delete (i.e. shut down and delete the image) this server.

Parameters:server – The Server (or its ID) to delete
Returns:An instance of novaclient.base.TupleWithMeta
delete_meta(server, keys)

Delete metadata from a server

Parameters:
  • server – The Server to add metadata to
  • keys – A list of metadata keys to delete from the server
Returns:

An instance of novaclient.base.TupleWithMeta
diagnostics(server)

Retrieve server diagnostics.

Parameters:server – The Server (or its ID) for which diagnostics to be returned
Returns:An instance of novaclient.base.TupleWithMeta
evacuate(obj, *args, **kwargs)

Evacuate a server instance.

Parameters:
  • server – The Server (or its ID) to share onto.
  • host – Name of the target host.
  • password – string to set as password on the evacuated server.
Returns:

An instance of novaclient.base.TupleWithMeta
force_delete(server)

Force delete the server.

Parameters:server – The Server (or its ID) to force delete
Returns:An instance of novaclient.base.TupleWithMeta
get(server)

Get a server.

Parameters:server – ID of the Server to get.
Return type:Server
get_console_output(server, length=None)

Get text console log output from Server.

Parameters:
  • server – The Server (or its ID) whose console output you would like to retrieve.
  • length – The number of tail loglines you would like to retrieve.
Returns:

An instance of novaclient.base.StrWithMeta or novaclient.base.UnicodeWithMeta
get_mks_console(obj, *args, **kwargs)

Get a mks console for an instance

Parameters:server – The Server (or its ID) to get console for.
Returns:An instance of novaclient.base.DictWithMeta
get_password(server, private_key=None)

Get admin password of an instance

Returns the admin password of an instance in the clear if private_key is provided, returns the ciphered password otherwise.

Requires that openssl is installed and in the path

Parameters:
  • server – The Server (or its ID) for which the admin password is to be returned
  • private_key – The private key to decrypt password (optional)
Returns:

An instance of novaclient.base.StrWithMeta or novaclient.base.BytesWithMeta or novaclient.base.UnicodeWithMeta
get_rdp_console(obj, *args, **kwargs)

Get a rdp console for an instance

Parameters:
  • server – The Server (or its ID) to get console for.
  • console_type – Type of rdp console to get (‘rdp-html5’)
Returns:

An instance of novaclient.base.DictWithMeta
get_serial_console(obj, *args, **kwargs)

Get a serial console for an instance

Parameters:
  • server – The Server (or its ID) to get console for.
  • console_type – Type of serial console to get (‘serial’)
Returns:

An instance of novaclient.base.DictWithMeta
get_spice_console(obj, *args, **kwargs)

Get a spice console for an instance

Parameters:
  • server – The Server (or its ID) to get console for.
  • console_type – Type of spice console to get (‘spice-html5’)
Returns:

An instance of novaclient.base.DictWithMeta
get_vnc_console(obj, *args, **kwargs)

Get a vnc console for an instance

Parameters:
  • server – The Server (or its ID) to get console for.
  • console_type – Type of vnc console to get (‘novnc’ or ‘xvpvnc’)
Returns:

An instance of novaclient.base.DictWithMeta
interface_attach(server, port_id, net_id, fixed_ip)

Attach a network_interface to an instance.

Parameters:
  • server – The Server (or its ID) to attach to.
  • port_id – The port to attach.
interface_detach(server, port_id)

Detach a network_interface from an instance.

Parameters:
  • server – The Server (or its ID) to detach from.
  • port_id – The port to detach.
Returns:

An instance of novaclient.base.TupleWithMeta
interface_list(server)

List attached network interfaces

Parameters:server – The Server (or its ID) to query.
ips(server)

Return IP Addresses associated with the server.

Often a cheaper call then getting all the details for a server.

Parameters:server – The Server (or its ID) for which the IP adresses are to be returned
Returns:An instance of novaclient.base.DictWithMeta
list(detailed=True, search_opts=None, marker=None, limit=None, sort_keys=None, sort_dirs=None)

Get a list of servers.

Parameters:
  • detailed – Whether to return detailed server info (optional).
  • search_opts – Search options to filter out servers which don’t match the search_opts (optional). The search opts format is a dictionary of key / value pairs that will be appended to the query string. For a complete list of keys see: http://developer.openstack.org/api-ref-compute-v2.1.html#listServers
  • marker – Begin returning servers that appear later in the server list than that represented by this server id (optional).
  • limit – Maximum number of servers to return (optional).
  • sort_keys – List of sort keys
  • sort_dirs – List of sort directions
Return type:

list of Server

Examples:

client.servers.list() - returns detailed list of servers

client.servers.list(search_opts={‘status’: ‘ERROR’}) - returns list of servers in error state.

client.servers.list(limit=10) - returns only 10 servers

list_security_group(server)

List Security Group(s) of an instance

Parameters:server – ID of the instance.
live_migrate(obj, *args, **kwargs)

Migrates a running instance to a new machine.

Parameters:
  • server – instance id which comes from nova list.
  • host – destination host name.
  • block_migration – if True, do block_migration, can be set as ‘auto’
Returns:

An instance of novaclient.base.TupleWithMeta
lock(server)

Lock the server.

Parameters:server – The Server (or its ID) to lock
Returns:An instance of novaclient.base.TupleWithMeta
migrate(server)

Migrate a server to a new host.

Parameters:server – The Server (or its ID).
Returns:An instance of novaclient.base.TupleWithMeta
pause(server)

Pause the server.

Parameters:server – The Server (or its ID) to pause
Returns:An instance of novaclient.base.TupleWithMeta
reboot(server, reboot_type='SOFT')

Reboot a server.

Parameters:
  • server – The Server (or its ID) to share onto.
  • reboot_type – either REBOOT_SOFT for a software-level reboot, or REBOOT_HARD for a virtual power cycle hard reboot.
Returns:

An instance of novaclient.base.TupleWithMeta
rebuild(server, image, password=None, disk_config=None, preserve_ephemeral=False, name=None, meta=None, files=None, **kwargs)

Rebuild – shut down and then re-image – a server.

Parameters:
  • server – The Server (or its ID) to share onto.
  • image – the Image (or its ID) to re-image with.
  • password – string to set as password on the rebuilt server.
  • disk_config – partitioning mode to use on the rebuilt server. Valid values are ‘AUTO’ or ‘MANUAL’
  • preserve_ephemeral – If True, request that any ephemeral device be preserved when rebuilding the instance. Defaults to False.
  • name – Something to name the server.
  • meta – A dict of arbitrary key/value metadata to store for this server. Both keys and values must be <=255 characters.
  • files – A dict of files to overwrite on the server upon boot. Keys are file names (i.e. /etc/passwd) and values are the file contents (either as a string or as a file-like object). A maximum of five entries is allowed, and each file must be 10k or less.
  • description – optional description of the server (allowed since microversion 2.19)
Returns:

Server
remove_fixed_ip(server, address)

Remove an IP address.

Parameters:
  • server – The Server (or its ID) to add an IP to.
  • address – The IP address to remove.
Returns:

An instance of novaclient.base.TupleWithMeta
remove_floating_ip(server, address)

Remove a floating IP address.

Parameters:
  • server – The Server (or its ID) to remove an IP from.
  • address – The FloatingIP or string floating address to remove.
Returns:

An instance of novaclient.base.TupleWithMeta
remove_security_group(server, security_group)

Remove a Security Group to an instance

Parameters:
  • server – ID of the instance.
  • security_group – The name of security group to remove.
Returns:

An instance of novaclient.base.TupleWithMeta
rescue(server, password=None, image=None)

Rescue the server.

Parameters:
  • server – The Server to rescue.
  • password – The admin password to be set in the rescue instance.
  • image – The Image to rescue with.
Returns:

An instance of novaclient.base.TupleWithMeta
reset_network(server)

Reset network of an instance.

Parameters:server – The Server for network is to be reset
Returns:An instance of novaclient.base.TupleWithMeta
reset_state(server, state='error')

Reset the state of an instance to active or error.

Parameters:
  • server – ID of the instance to reset the state of.
  • state – Desired state; either ‘active’ or ‘error’. Defaults to ‘error’.
Returns:

An instance of novaclient.base.TupleWithMeta
resize(server, flavor, disk_config=None, **kwargs)

Resize a server’s resources.

Parameters:
  • server – The Server (or its ID) to share onto.
  • flavor – the Flavor (or its ID) to resize to.
  • disk_config – partitioning mode to use on the rebuilt server. Valid values are ‘AUTO’ or ‘MANUAL’
Returns:

An instance of novaclient.base.TupleWithMeta

Until a resize event is confirmed with confirm_resize(), the old server will be kept around and you’ll be able to roll back to the old flavor quickly with revert_resize(). All resizes are automatically confirmed after 24 hours.

resource_class

alias of Server

restore(server)

Restore soft-deleted server.

Parameters:server – The Server (or its ID) to restore
Returns:An instance of novaclient.base.TupleWithMeta
resume(server)

Resume the server.

Parameters:server – The Server (or its ID) to resume
Returns:An instance of novaclient.base.TupleWithMeta
revert_resize(server)

Revert a previous resize, switching back to the old server.

Parameters:server – The Server (or its ID) to share onto.
Returns:An instance of novaclient.base.TupleWithMeta
set_meta(server, metadata)

Set a servers metadata :param server: The Server to add metadata to :param metadata: A dict of metadata to add to the server

set_meta_item(server, key, value)

Updates an item of server metadata :param server: The Server to add metadata to :param key: metadata key to update :param value: string value

shelve(server)

Shelve the server.

Parameters:server – The Server (or its ID) to shelve
Returns:An instance of novaclient.base.TupleWithMeta
shelve_offload(server)

Remove a shelved instance from the compute node.

Parameters:server – The Server (or its ID) to shelve offload
Returns:An instance of novaclient.base.TupleWithMeta
start(server)

Start the server.

Parameters:server – The Server (or its ID) to start
Returns:An instance of novaclient.base.TupleWithMeta
stop(server)

Stop the server.

Parameters:server – The Server (or its ID) to stop
Returns:An instance of novaclient.base.TupleWithMeta
suspend(server)

Suspend the server.

Parameters:server – The Server (or its ID) to suspend
Returns:An instance of novaclient.base.TupleWithMeta
trigger_crash_dump(obj, *args, **kwargs)

Trigger crash dump in an instance

unlock(server)

Unlock the server.

Parameters:server – The Server (or its ID) to unlock
Returns:An instance of novaclient.base.TupleWithMeta
unpause(server)

Unpause the server.

Parameters:server – The Server (or its ID) to unpause
Returns:An instance of novaclient.base.TupleWithMeta
unrescue(server)

Unrescue the server.

Parameters:server – The Server (or its ID) to unrescue
Returns:An instance of novaclient.base.TupleWithMeta
unshelve(server)

Unshelve the server.

Parameters:server – The Server (or its ID) to unshelve
Returns:An instance of novaclient.base.TupleWithMeta
update(obj, *args, **kwargs)

Update the name or the description for a server.

Parameters:
  • server – The Server (or its ID) to update.
  • name – Update the server’s name.
  • description – Update the server’s description. If it equals to empty string(i.g. “”), the server description will be removed.

Previous topic

Images

Next topic

Hosts

Project Source

This Page

Navigation

© Copyright OpenStack Contributors. Created using Sphinx 1.2.3.