For details on how to use compute, see Using OpenStack Compute
The compute high-level interface is available through the compute
member of a Connection
object. The
compute
member will only be added if the service is detected.
openstack.compute.v2._proxy.
Proxy
(session)¶find_extension
(name_or_id, ignore_missing=True)¶Find a single extension
Parameters: |
|
---|---|
Returns: | One |
extensions
(**query)¶Retrieve a generator of extensions
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of extension instances. |
Return type: | Extension |
find_flavor
(name_or_id, ignore_missing=True)¶Find a single flavor
Parameters: |
|
---|---|
Returns: | One |
create_flavor
(**attrs)¶Create a new flavor from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Flavor ,
comprised of the properties on the Flavor class. |
---|---|
Returns: | The results of flavor creation |
Return type: | Flavor |
delete_flavor
(flavor, ignore_missing=True)¶Delete a flavor
Parameters: |
|
---|---|
Returns: |
|
get_flavor
(flavor)¶Get a single flavor
Parameters: | flavor – The value can be the ID of a flavor or a
Flavor instance. |
---|---|
Returns: | One Flavor |
Raises: | ResourceNotFound
when no resource can be found. |
flavors
(details=True, **query)¶Return a generator of flavors
Parameters: |
|
---|---|
Returns: | A generator of flavor objects |
update_flavor
(flavor, **attrs)¶Update a flavor
Parameters: | flavor – Either the ID of a flavor or a
Flavor instance. |
---|---|
Attrs kwargs: | The attributes to update on the flavor represented
by value . |
Returns: | The updated flavor |
Return type: | Flavor |
delete_image
(image, ignore_missing=True)¶Delete an image
Parameters: |
|
---|---|
Returns: |
|
find_image
(name_or_id, ignore_missing=True)¶Find a single image
Parameters: |
|
---|---|
Returns: | One |
get_image
(image)¶Get a single image
Parameters: | image – The value can be the ID of an image or a
Image instance. |
---|---|
Returns: | One Image |
Raises: | ResourceNotFound
when no resource can be found. |
images
(details=True, **query)¶Return a generator of images
Parameters: |
|
---|---|
Returns: | A generator of image objects |
get_image_metadata
(image, key=None)¶Return a dictionary of metadata for an image
Parameters: |
|
---|---|
Returns: | A dictionary of the image’s metadata. All keys and values are Unicode text. |
Return type: | dict |
create_image_metadata
(image, **metadata)¶Create metadata for an image
Parameters: |
|
---|---|
Returns: | A dictionary of the metadata that was created on the image. All keys and values are Unicode text. |
Return type: | dict |
replace_image_metadata
(image, **metadata)¶Replace metadata for an image
Parameters: |
|
---|---|
Returns: | A dictionary of the metadata for the image. All keys and values are Unicode text. |
Return type: | dict |
update_image_metadata
(image, **metadata)¶Update metadata for an image
Parameters: |
|
---|---|
Returns: | A dictionary of the metadata for the image. All keys and values are Unicode text. |
Return type: | dict |
delete_image_metadata
(image, key)¶Delete metadata for an image
Parameters: |
|
---|---|
Return type: |
|
create_keypair
(**attrs)¶Create a new keypair from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Keypair ,
comprised of the properties on the Keypair class. |
---|---|
Returns: | The results of keypair creation |
Return type: | Keypair |
delete_keypair
(keypair, ignore_missing=True)¶Delete a keypair
Parameters: |
|
---|---|
Returns: |
|
get_keypair
(keypair)¶Get a single keypair
Parameters: | keypair – The value can be the ID of a keypair or a
Keypair
instance. |
---|---|
Returns: | One Keypair |
Raises: | ResourceNotFound
when no resource can be found. |
find_keypair
(name_or_id, ignore_missing=True)¶Find a single keypair
Parameters: |
|
---|---|
Returns: | One |
keypairs
(**query)¶Return a generator of keypairs
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of keypair objects |
Return type: | Keypair |
update_keypair
(keypair, **attrs)¶Update a keypair
Parameters: | keypair – Either the ID of a keypair or a
Keypair
instance. |
---|---|
Attrs kwargs: | The attributes to update on the keypair represented
by keypair . |
Returns: | The updated keypair |
Return type: | Keypair |
get_limits
()¶Retrieve limits that are applied to the project’s account
Returns: | A Limits object, including both
AbsoluteLimits and
RateLimits |
---|---|
Return type: | Limits |
create_server
(**attrs)¶Create a new server from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a Server ,
comprised of the properties on the Server class. |
---|---|
Returns: | The results of server creation |
Return type: | Server |
delete_server
(server, ignore_missing=True)¶Delete a server
Parameters: |
|
---|---|
Returns: |
|
find_server
(name_or_id, ignore_missing=True)¶Find a single server
Parameters: |
|
---|---|
Returns: | One |
get_server
(server)¶Get a single server
Parameters: | server – The value can be the ID of a server or a
Server instance. |
---|---|
Returns: | One Server |
Raises: | ResourceNotFound
when no resource can be found. |
servers
(details=True, **query)¶Retrieve a generator of servers
Parameters: |
|
---|---|
Returns: | A generator of server instances. |
update_server
(server, **attrs)¶Update a server
Parameters: | server – Either the ID of a server or a
Server instance. |
---|---|
Attrs kwargs: | The attributes to update on the server represented
by server . |
Returns: | The updated server |
Return type: | Server |
create_server_interface
(server, **attrs)¶Create a new server interface from attributes
Parameters: |
|
---|---|
Returns: | The results of server interface creation |
Return type: |
delete_server_interface
(server_interface, server=None, ignore_missing=True)¶Delete a server interface
Parameters: |
|
---|---|
Returns: |
|
get_server_interface
(server_interface, server=None)¶Get a single server interface
Parameters: |
|
---|---|
Returns: | One
|
Raises: |
|
server_interfaces
(server, **query)¶Return a generator of server interfaces
Parameters: |
|
---|---|
Returns: | A generator of ServerInterface objects |
Return type: |
find_server_ip
(name_or_id, ignore_missing=True)¶Find a single server IP
Parameters: |
|
---|---|
Returns: | One |
server_ips
(**query)¶Return a generator of server IPs
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of ServerIP objects |
Return type: | ServerIP |
resize_server
(server, flavor)¶Resize a server
Parameters: |
|
---|---|
Returns: | None |
confirm_resize_server
(server)¶Confirm a pending resize_server action
Parameters: | server – Either the ID of a server or a
Server instance. |
---|---|
Returns: | None |
revert_resize_server
(server)¶Cancel and revert a pending resize_server action
Parameters: | server – Either the ID of a server or a
Server instance. |
---|---|
Returns: | None |
rebuild_server
(server, image, name=None, admin_password=None, **attrs)¶Rebuild a server
Parameters: | |
---|---|
Returns: | The rebuilt server |
Return type: |
availability_zones
(**query)¶Return a generator of availability zones
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of availability zone |
Return type: | :class:`~openstack.compute.v2.availability_zone. |
AvailabilityZone`
get_server_metadata
(server, key=None)¶Return a dictionary of metadata for a server
Parameters: |
|
---|---|
Returns: | A dictionary of the server’s metadata. All keys and values are Unicode text. |
Return type: | dict |
create_server_metadata
(server, **metadata)¶Create metadata for a server
Parameters: |
|
---|---|
Returns: | A dictionary of the metadata that was created on the server. All keys and values are Unicode text. |
Return type: | dict |
replace_server_metadata
(server, **metadata)¶Replace metadata for a server
Parameters: |
|
---|---|
Returns: | A dictionary of the metadata for the server. All keys and values are Unicode text. |
Return type: | dict |
update_server_metadata
(server, **metadata)¶Update metadata for a server
Parameters: |
|
---|---|
Returns: | A dictionary of the metadata for the server. All keys and values are Unicode text. |
Return type: | dict |
delete_server_metadata
(server, key)¶Delete metadata for a server
Parameters: |
|
---|---|
Return type: |
|
create_server_group
(**attrs)¶Create a new server group from attributes
Parameters: | attrs (dict) – Keyword arguments which will be used to create
a ServerGroup ,
comprised of the properties on the ServerGroup class. |
---|---|
Returns: | The results of server group creation |
Return type: | ServerGroup |
delete_server_group
(server_group, ignore_missing=True)¶Delete a server group
Parameters: |
|
---|---|
Returns: |
|
find_server_group
(name_or_id, ignore_missing=True)¶Find a single server group
Parameters: |
|
---|---|
Returns: | One |
get_server_group
(server_group)¶Get a single server group
Parameters: | server_group – The value can be the ID of a server group or a
ServerGroup
instance. |
---|---|
Returns: | A ServerGroup object. |
Raises: | ResourceNotFound
when no resource can be found. |
server_groups
(**query)¶Return a generator of server groups
Parameters: | **query (kwargs) – Optional query parameters to be sent to limit the resources being returned. |
---|---|
Returns: | A generator of ServerGroup objects |
Return type: | ServerGroup |
hypervisors
(**query)¶Return a generator of hypervisor
Returns: | A generator of hypervisor |
---|---|
Return type: | class: ~openstack.compute.v2.hypervisor.Hypervisor |
find_hypervisor
(name_or_id, ignore_missing=True)¶Find a hypervisor from name or id to get the corresponding info
Parameters: | name_or_id – The name or id of a hypervisor |
---|---|
Returns: | One: class:~openstack.compute.v2.hypervisor.Hypervisor object or None |
get_hypervisor
(hypervisor)¶Get a single hypervisor
Parameters: | hypervisor – The value can be the ID of a hypervisor or a
Hypervisor
instance. |
---|---|
Returns: | A Hypervisor object. |
Raises: | ResourceNotFound
when no resource can be found. |
Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.