openstack.compute.v2.flavor¶
The Flavor Class¶
The Flavor
class inherits from Resource
.
- class openstack.compute.v2.flavor.Flavor(_synchronized=False, connection=None, **attrs)¶
The base resource
- Parameters
_synchronized (bool) – This is not intended to be used directly. See
new()
andexisting()
.connection (openstack.connection.Connection) – Reference to the Connection being used. Defaults to None to allow Resource objects to be used without an active Connection, such as in unit tests. Use of
self._connection
in Resource code should protect itself with a check for None.
- name¶
The name of this flavor.
- original_name¶
The name of this flavor when returned by server list/show
- description¶
The description of the flavor.
- disk¶
Size of the disk this flavor offers. Type: int
- is_public¶
True
if this is a publicly visible flavor.False
if this is a private image. Type: bool
- ram¶
The amount of RAM (in MB) this flavor offers. Type: int
- vcpus¶
The number of virtual CPUs this flavor offers. Type: int
- swap¶
Size of the swap partitions.
- ephemeral¶
Size of the ephemeral data disk attached to this server. Type: int
- is_disabled¶
True
if this flavor is disabled,False
if not. Type: bool
- rxtx_factor¶
The bandwidth scaling factor this flavor receives on the network.
- extra_specs¶
A dictionary of the flavor’s extra-specs key-and-value pairs.
- classmethod list(session, paginated=True, base_path='/flavors/detail', allow_unknown_params=False, **params)¶
This method is a generator which yields resource objects.
This resource object list generator handles pagination and takes query params for response filtering.
- Parameters
session (
Adapter
) – The session to use for making this request.paginated (bool) –
True
if a GET to this resource returns a paginated series of responses, orFalse
if a GET returns only one page of data. When paginated is False only one page of data will be returned regardless of the API’s support of pagination.base_path (str) – Base part of the URI for listing resources, if different from
base_path
.allow_unknown_params (bool) –
True
to accept, but discard unknown query parameters. This allows getting list of ‘filters’ and passing everything known to the server.False
will result in validation exception when unknown query parameters are passed.params (dict) – These keyword arguments are passed through the
_transpose()
method to find if any of them match expected query parameters to be sent in the params argument toget()
. They are additionally checked against thebase_path
format string to see if any path fragments need to be filled in by the contents of this argument.
- Returns
A generator of
Resource
objects.- Raises
MethodNotSupported
ifResource.allow_list
is not set toTrue
.- Raises
InvalidResourceQuery
if query contains invalid params.
- add_tenant_access(session, tenant)¶
Adds flavor access to a tenant and flavor.
- remove_tenant_access(session, tenant)¶
Removes flavor access to a tenant and flavor.
- get_access(session)¶
Lists tenants who have access to a private flavor
By default, only administrators can manage private flavor access. A private flavor has is_public set to false while a public flavor has is_public set to true.
- Returns
List of dicts with flavor_id and tenant_id attributes
- fetch_extra_specs(session)¶
Fetch extra_specs of the flavor
Starting with 2.61 extra_specs are returned with the flavor details, before that a separate call is required.
- create_extra_specs(session, specs)¶
Creates extra specs for a flavor
- get_extra_specs_property(session, prop)¶
Get individual extra_spec property
- update_extra_specs_property(session, prop, val)¶
Update An Extra Spec For A Flavor
- delete_extra_specs_property(session, prop)¶
Delete An Extra Spec For A Flavor
The FlavorDetail Class¶
The FlavorDetail
class inherits from
Flavor
.
- openstack.compute.v2.flavor.FlavorDetail¶
alias of
openstack.compute.v2.flavor.Flavor