Openstacksdk

OpenStackSDK Documentation
Release 0.52.1.dev3
OpenStack Foundation
Nov 20, 2020

CONTENTS
1 Installation 3
1.1 Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
2 For Users 5
2.1 Getting started with the OpenStack SDK . . . . . . . . . . . . . . . . . . . . . . . . . 5
2.2 Presentations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 535
3 For Contributors 553

3.1 Contributing to the OpenStack SDK . . . . . . . . . . . . . . . . . . . . . . . . . . . . 553
4 openstacksdk 569
5 openstack 571
6 Cloud Layer 573
7 openstack.config 575
8 Links 577
8.1 General Information . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 577
Python Module Index 579
Index 583
i
ii
OpenStackSDK Documentation, Release 0.52.1.dev3
This documentation is split into three sections:

• an installation guide
• a section for users looking to build applications which make use of OpenStack
• a section for those looking to contribute to this project
CONTENTS 1
2 CONTENTS
CHAPTER
ONE
INSTALLATION
1.1 Installation
At the command line:
$ pip install openstacksdk
Or, if you have virtualenv wrapper installed:
$ mkvirtualenv openstacksdk
3
4 Chapter 1. Installation
CHAPTER
TWO
FOR USERS
2.1 Getting started with the OpenStack SDK
For a listing of terms used throughout the SDK, including the names of projects and services supported
by it, see the glossary.
2.1.1 Installation
The OpenStack SDK is available on PyPI under the name openstacksdk. To install it, use pip:
To check the installed version you can call the module with
$ python -m openstack version
2.1.2 User Guides
These guides walk you through how to make use of the libraries we provide to work with each OpenStack
service. If youre looking for a cookbook approach, this is where youll want to begin.
Using os-client-config
Configuring OpenStack SDK Applications
Environment Variables
openstacksdk honors all of the normal OS_* variables. It does not provide backwards compatibility to
service-specific variables such as NOVA_USERNAME.
If you have OpenStack environment variables set, openstacksdk will produce a cloud config object
named envvars containing your values from the environment. If you dont like the name envvars, thats
ok, you can override it by setting OS_CLOUD_NAME.
Service specific settings, like the nova service type, are set with the default service type as a prefix. For
instance, to set a special service_type for trove set
5
export OS_DATABASE_SERVICE_TYPE=rax:database
Config Files
openstacksdk will look for a file called clouds.yaml in the following locations:
• Current Directory
• ~/.config/openstack
• /etc/openstack
The first file found wins.
You can also set the environment variable OS_CLIENT_CONFIG_FILE to an absolute path of a file to
look for and that location will be inserted at the front of the file search list.
The keys are all of the keys youd expect from OS_* - except lower case and without the OS prefix. So,
region name is set with region_name.
Service specific settings, like the nova service type, are set with the default service type as a prefix. For
instance, to set a special service_type for trove (because youre using Rackspace) set:
database_service_type: 'rax:database'
Site Specific File Locations
In addition to ~/.config/openstack and /etc/openstack - some platforms have other locations they like to
put things. openstacksdk will also look in an OS specific config dir
• USER_CONFIG_DIR
• SITE_CONFIG_DIR
USER_CONFIG_DIR is different on Linux, OSX and Windows.
• Linux: ~/.config/openstack
• OSX: ~/Library/Application Support/openstack
• Windows: C:\Users\USERNAME\AppData\Local\OpenStack\openstack
SITE_CONFIG_DIR is different on Linux, OSX and Windows.
• Linux: /etc/openstack
• OSX: /Library/Application Support/openstack
• Windows: C:\ProgramData\OpenStack\openstack
An example config file is probably helpful:
clouds:
mtvexx:
profile: https://vexxhost.com
auth:
username: [email protected]
(continues on next page)
6 Chapter 2. For Users

(continued from previous page)

password: XXXXXXXXX
project_name: [email protected]
region_name: ca-ymq-1
dns_api_version: 1
mordred:
region_name: RegionOne
auth:
username: 'mordred'
password: XXXXXXX
project_name: 'shade'
auth_url: 'https://montytaylor-sjc.openstack.blueboxgrid.com:5001/v2.
,→0'
infra:
profile: rackspace
auth:
username: openstackci
password: XXXXXXXX
project_id: 610275
regions:
- DFW
- ORD
- IAD
You may note a few things. First, since auth_url settings are silly and embarrassingly ugly, known cloud
vendor profile information is included and may be referenced by name or by base URL to the cloud in
question if the cloud serves a vendor profile. One of the benefits of that is that auth_url isnt the only
thing the vendor defaults contain. For instance, since Rackspace lists rax:database as the service type
for trove, openstacksdk knows that so that you dont have to. In case the cloud vendor profile is not
available, you can provide one called clouds-public.yaml, following the same location rules previously
mentioned for the config files.
regions can be a list of regions. When you call get_all_clouds, youll get a cloud config object for each
cloud/region combo.
As seen with dns_service_type, any setting that makes sense to be per-service, like service_type or
endpoint or api_version can be set by prefixing the setting with the default service type. That might
strike you funny when setting service_type and it does me too - but thats just the world we live in.
Auth Settings
Keystone has auth plugins - which means its not possible to know ahead of time which auth settings
are needed. openstacksdk sets the default plugin type to password, which is what things all were before
plugins came about. In order to facilitate validation of values, all of the parameters that exist as a result
of a chosen plugin need to go into the auth dict. For password auth, this includes auth_url, username
and password as well as anything related to domains, projects and trusts.
2.1. Getting started with the OpenStack SDK 7

Splitting Secrets
In some scenarios, such as configuration management controlled environments, it might be easier to have
secrets in one file and non-secrets in another. This is fully supported via an optional file secure.yaml
which follows all the same location rules as clouds.yaml. It can contain anything you put in clouds.yaml
and will take precedence over anything in the clouds.yaml file.
# clouds.yaml
clouds:
internap:
profile: internap
auth:
username: api-55f9a00fb2619
project_name: inap-17037
regions:
- ams01
- nyj01
# secure.yaml
clouds:
internap:
auth:
password: XXXXXXXXXXXXXXXXX
SSL Settings
When the access to a cloud is done via a secure connection, openstacksdk will always verify the SSL
cert by default. This can be disabled by setting verify to False. In case the cert is signed by an unknown
CA, a specific cacert can be provided via cacert. WARNING: verify will always have precedence over
cacert, so when setting a CA cert but disabling verify, the cloud cert will never be validated.
Client certs are also configurable. cert will be the client cert file location. In case the cert key is not
included within the client cert file, its file location needs to be set via key.
# clouds.yaml
clouds:
regular-secure-cloud:
auth:
auth_url: https://signed.cert.domain:5000
...
unknown-ca-with-client-cert-secure-cloud:
auth:
auth_url: https://unknown.ca.but.secure.domain:5000
...
key: /home/myhome/client-cert.key
cert: /home/myhome/client-cert.crt
cacert: /home/myhome/ca.crt
self-signed-insecure-cloud:
auth:
auth_url: https://self.signed.cert.domain:5000
...
verify: False
Note for parity with openstack command-line options the insecure boolean is also recognised (with
the opposite semantics to verify; i.e. True ignores certificate failures). This should be considered depre-
cated for verify.

Cache Settings
Accessing a cloud is often expensive, so its quite common to want to do some client-side caching of those
operations. To facilitate that, openstacksdk understands passing through cache settings to dogpile.cache,
with the following behaviors:
• Listing no config settings means you get a null cache.
• cache.expiration_time and nothing else gets you memory cache.
• Otherwise, cache.class and cache.arguments are passed in
Different cloud behaviors are also differently expensive to deal with. If you want to get really crazy
and tweak stuff, you can specify different expiration times on a per-resource basis by passing values, in
seconds to an expiration mapping keyed on the singular name of the resource. A value of -1 indicates
that the resource should never expire.
openstacksdk does not actually cache anything itself, but it collects and presents the cache information
so that your various applications that are connecting to OpenStack can share a cache should you desire.
cache:
class: dogpile.cache.pylibmc
expiration_time: 3600
arguments:
url:
- 127.0.0.1
expiration:
server: 5
flavor: -1
clouds:
mtvexx:
profile: vexxhost
auth:
password: XXXXXXXXX
dns_api_version: 1
IPv6
IPv6 is the future, and you should always use it if your cloud supports it and if your local network
supports it. Both of those are easily detectable and all friendly software should do the right thing.
However, sometimes a cloud API may return IPv6 information that is not useful to a production de-
ployment. For example, the API may provide an IPv6 address for a server, but not provide that to the
host instance via metadata (configdrive) or standard IPv6 autoconfiguration methods (i.e. the host either
needs to make a bespoke API call, or otherwise statically configure itself).
For such situations, you can set the force_ipv4, or OS_FORCE_IPV4 boolean environment variable.
For example:
clouds:
mtvexx:
profile: vexxhost


auth:
password: XXXXXXXXX
dns_api_version: 1
monty:
profile: fooprovider
force_ipv4: true
auth:
password: XXXXXXXXX
region_name: RegionFoo
The above snippet will tell client programs to prefer the IPv4 address and leave the public_v6 field
of the Server object blank for the fooprovider cloud . You can also set this with a client flag for all
clouds:
client:
force_ipv4: true
Per-region settings
Sometimes you have a cloud provider that has config that is common to the cloud, but also with some
things you might want to express on a per-region basis. For instance, Internap provides a public and
private network specific to the user in each region, and putting the values of those networks into config
can make consuming programs more efficient.
To support this, the region list can actually be a list of dicts, and any setting that can be set at the cloud
level can be overridden for that region.
clouds:
internap:
profile: internap
auth:
password: XXXXXXXXXXXXXXXXX
regions:
- name: ams01
values:
networks:
- name: inap-17037-WAN1654
routes_externally: true
- name: inap-17037-LAN6745
- name: nyj01
values:
networks:

Using openstack.config in an Application
Usage
The simplest and least useful thing you can do is:
python -m openstack.config.loader
Which will print out whatever if finds for your config. If you want to use it from python, which is much
more likely what you want to do, things like:
Get a named cloud.
import openstack.config
cloud_region = openstack.config.OpenStackConfig().get_one(
'internap', region_name='ams01')
print(cloud_region.name, cloud_region.region, cloud_region.config)
Or, get all of the clouds.
cloud_regions = openstack.config.OpenStackConfig().get_all()
for cloud_region in cloud_regions:
print(cloud_region.name, cloud_region.region, cloud_region.config)
argparse
If youre using openstack.config from a program that wants to process command line options, there is a
registration function to register the arguments that both openstack.config and keystoneauth know how to
deal with - as well as a consumption argument.
import argparse
import openstack
parser = argparse.ArgumentParser()
cloud = openstack.connect(options=parser)
Vendor Support
OpenStack presents deployers with many options, some of which can expose differences to end users.
os-client-config tries its best to collect information about various things a user would need to know. The
following is a text representation of the vendor related defaults os-client-config knows about.

Default Values
These are the default behaviors unless a cloud is configured differently.

• Identity uses password authentication
• Identity API Version is 2
• Image API Version is 2
• Volume API Version is 2
• Compute API Version is 2.1
• Images must be in qcow2 format
• Images are uploaded using PUT interface
• Public IPv4 is directly routable via DHCP from Neutron
• IPv6 is not provided
• Floating IPs are not required
• Floating IPs are provided by Neutron
• Security groups are provided by Neutron
• Vendor specific agents are not used
AURO
https://api.auro.io:5000/v2.0
Region Name Location

van1 Vancouver, BC
• Public IPv4 is provided via NAT with Neutron Floating IP
Betacloud
https://api-1.betacloud.de:5000

betacloud-1 Karlsruhe, Germany

• Images must be in raw format

Catalyst
https://api.cloud.catalyst.net.nz:5000/v2.0

nz-por-1 Porirua, NZ
nz_wlg_2 Wellington, NZ

• Compute API Version is 2
City Cloud
https://%(region_name)s.citycloud.com:5000/v3/

Buf1 Buffalo, NY
dx1 Dubai, UAE
Fra1 Frankfurt, DE
Kna1 Karlskrona, SE
Lon1 London, UK
Sto2 Stockholm, SE
tky1 Tokyo, JP

ConoHa
https://identity.%(region_name)s.conoha.io

tyo1 Tokyo, JP
sin1 Singapore
sjc1 San Jose, CA
• Image upload is not supported

DreamCompute
https://iad2.dream.io:5000

RegionOne Ashburn, VA

• IPv6 is provided to every server
Open Telekom Cloud
https://iam.%(region_name)s.otc.t-systems.com/v3

eu-de Germany

• Images must be in vhd format
ELASTX
https://ops.elastx.cloud:5000/v3

se-sto Stockholm, SE

Enter Cloud Suite
https://api.entercloudsuite.com/v2.0

nl-ams1 Amsterdam, NL
it-mil1 Milan, IT
de-fra1 Frankfurt, DE

Fuga
https://identity.api.fuga.io:5000

cystack Netherlands

Internap
https://identity.api.cloud.iweb.com/v2.0

ams01 Amsterdam, NL
da01 Dallas, TX
nyj01 New York, NY
sin01 Singapore
sjc01 San Jose, CA
• Floating IPs are not supported
Limestone Networks
https://auth.cloud.lstn.net:5000/v3

us-dfw-1 Dallas, TX
us-slc Salt Lake City, UT

• IPv6 is provided to every server connected to the Public Internet network
OVH
https://auth.cloud.ovh.net/v3

BHS1 Beauharnois, QC
SBG1 Strassbourg, FR
GRA1 Gravelines, FR
• Images may be in raw format. The qcow2 default is also supported


Rackspace
https://identity.api.rackspacecloud.com/v2.0/

DFW Dallas, TX
HKG Hong Kong
IAD Washington, D.C.
LON London, UK
ORD Chicago, IL
SYD Sydney, NSW
• Database Service Type is rax:database

• Compute Service Name is cloudServersOpenStack
• Images must be in vhd format
• Images must be uploaded using the Glance Task Interface
• Public IPv4 is directly routable via static config by Nova
• IPv6 is provided to every server
• Security groups are not supported
• Uploaded Images need properties to not use vendor agent:: :vm_mode: hvm :xenapi_use_agent:
False
• Block Storage API Version is 2
• The Block Storage API supports version 2 but only version 1 is in the catalog. The Block Storage
endpoint is https://{region_name}.blockstorage.api.rackspacecloud.com/v2/{project_id}
• While passwords are recommended for use, API keys do work as well. The rackspaceauth python
package must be installed, and then the following can be added to clouds.yaml:
auth:
username: myusername
api_key: myapikey
auth_type: rackspace_apikey
SWITCHengines
https://keystone.cloud.switch.ch:5000/v3

LS Lausanne, CH
ZH Zurich, CH



Ultimum
https://console.ultimum-cloud.com:5000/v2.0

RegionOne Prague, CZ
UnitedStack
https://identity.api.ustack.com/v3

bj1 Beijing, CN
gd1 Guangdong, CN

VEXXHOST
http://auth.vexxhost.net

ca-ymq-1 Montreal, QC
sjc1 Santa Clara, CA
• DNS API Version is 1

Zetta
https://identity.api.zetta.io/v3

no-osl1 Oslo, NO
• DNS API Version is 2

Network Config
There are several different qualities that networks in OpenStack might have that might not be able to
be automatically inferred from the available metadata. To help users navigate more complex setups,
os-client-config allows configuring a list of network metadata.
clouds:
amazing:
networks:
- name: blue
- name: purple
default_interface: true
- name: green
routes_externally: false
- name: yellow
nat_destination: true
- name: chartreuse
routes_ipv6_externally: true
- name: aubergine
routes_ipv4_externally: false
routes_ipv6_externally: true
Every entry must have a name field, which can hold either the name or the id of the network.
routes_externally is a boolean field that labels the network as handling north/south traffic off of the
cloud. In a public cloud this might be thought of as the public network, but in private clouds its possible
it might be an RFC1918 address. In either case, its provides IPs to servers that things not on the cloud
can use. This value defaults to false, which indicates only servers on the same network can talk to it.
routes_ipv4_externally and routes_ipv6_externally are boolean fields to help handle routes_externally
in the case where a network has a split stack with different values for IPv4 and IPv6. Either entry, if not
given, defaults to the value of routes_externally.
default_interface is a boolean field that indicates that the network is the one that programs should use.
It defaults to false. An example of needing to use this value is a cloud with two private networks, and
where a user is running ansible in one of the servers to talk to other servers on the private network.
Because both networks are private, there would otherwise be no way to determine which one should be
used for the traffic. There can only be one default_interface per cloud.
nat_destination is a boolean field that indicates which network floating ips should be attached to. It
defaults to false. Normally this can be inferred by looking for a network that has subnets that have a
gateway_ip. But its possible to have more than one network that satisfies that condition, so the user
might want to tell programs which one to pick. There can be only one nat_destination per cloud.
nat_source is a boolean field that indicates which network floating ips should be requested from. It
defaults to false. Normally this can be inferred by looking for a network that is attached to a router. But
its possible to have more than one network that satisfies that condition, so the user might want to tell
programs which one to pick. There can be only one nat_source per cloud.

API Reference
class openstack.config.OpenStackConfig(config_files=None, ven-

dor_files=None, over-
ride_defaults=None,
force_ipv4=None,
envvar_prefix=None, se-
cure_files=None, pw_func=None,
session_constructor=None,
app_name=None, app_version=None,
load_yaml_config=True,
load_envvars=True,
statsd_host=None, statsd_port=None,
statsd_prefix=None, in-
fluxdb_config=None)
get_extra_config(key, defaults=None)
Fetch an arbitrary extra chunk of config, laying in defaults.
Parameters
• key (string) name of the config section to fetch
• defaults (dict) (optional) default values to merge under the found con-
fig
register_argparse_arguments(parser, argv, service_keys=None)
Register all of the common argparse options needed.
Given an argparse parser, register the keystoneauth Session arguments, the keystoneauth
Auth Plugin Options and os-cloud. Also, peek in the argv to see if all of the auth plugin
options should be registered or merely the ones already configured.
Parameters
• argparse.ArgumentParser parser to attach argparse options to
• argv the arguments provided to the application
• service_keys (string) Service or list of services this argparse should
be specialized for, if known. The first item in the list will be used as the
default value for service_type (optional)
:raises exceptions.ConfigException if an invalid auth-type is requested
auth_config_hook(config)
Allow examination of config values before loading auth plugin
OpenStackClient will override this to perform additional checks on auth_type.
option_prompt(config, p_opt)
Prompt user for option that requires a value
magic_fixes(config)
Perform the set of magic argument fixups
get_one(cloud=None, validate=True, argparse=None, **kwargs)
Retrieve a single CloudRegion and merge additional options

Parameters
• cloud (string) The name of the configuration to load from clouds.yaml
• validate (boolean) Validate the config. Setting this to False causes no
auth plugin to be created. Its really only useful for testing.
• argparse (Namespace) An argparse Namespace object; allows direct
passing in of argparse options to be added to the cloud config. Values of
None and will be removed.
• region_name Name of the region of the cloud.
• kwargs Additional configuration options
Returns openstack.config.cloud_region.CloudRegion
Raises keystoneauth1.exceptions.MissingRequiredOptions on missing required
auth parameters
get_one_cloud(cloud=None, validate=True, argparse=None, **kwargs)
Parameters
Returns openstack.config.cloud_region.CloudRegion
auth parameters
get_one_cloud_osc(cloud=None, validate=True, argparse=None, **kwargs)
Parameters
auth parameters

static set_one_cloud(config_file, cloud, set_config=None)

Set a single cloud configuration.
Parameters
• config_file (string) The path to the config file to edit. If this file
does not exist it will be created.
• cloud (string) The name of the configuration to save to clouds.yaml
• set_config (dict) Configuration options to be set
class openstack.config.cloud_region.CloudRegion(name=None, re-
gion_name=None,
config=None,
force_ipv4=False,
auth_plugin=None,
open-
stack_config=None, ses-
sion_constructor=None,
app_name=None,
app_version=None,
session=None, dis-
covery_cache=None,
extra_config=None,
cache_expiration_time=0,
cache_expirations=None,
cache_path=None,
cache_class=’dogpile.cache.null’,
cache_arguments=None,
pass-
word_callback=None,
statsd_host=None,
statsd_port=None,
statsd_prefix=None, in-
fluxdb_config=None,
collec-
tor_registry=None)
The configuration for a Region of an OpenStack Cloud.
A CloudRegion encapsulates the config information needed for connections to all of the services
in a Region of a Cloud.
Parameters
• region_name (str) The default region name for all services in this
CloudRegion. If both region_name and config['region_name']
are specified, the kwarg takes precedence. May
be overridden for a given ${service} via a
${service}_region_name key in the ``config dict.
• config (dict) A dict of configuration values for the CloudRegion and
its services. The key for a ${config_option} for a specific ${service}
should be ${service}_${config_option}. For example, to configure the end-
point_override for the block_storage service, the config dict should contain:

'block_storage_endpoint_override': 'http://...'
To provide a default to be used if no service-specific override is present, just

use the unprefixed ${config_option} as the service key, e.g.:
'interface': 'public'
property full_name
Return a string that can be used as an identifier.
Always returns a valid string. It will have name and region_name or just one of the two if
only one is set, or else unknown.
set_session_constructor(session_constructor)
Sets the Session constructor.
get_requests_verify_args()
Return the verify and cert values for the requests library.
get_services()
Return a list of service types we know something about.
get_endpoint_from_catalog(service_type, interface=None, region_name=None)
Return the endpoint for a given service as found in the catalog.
For values respecting endpoint overrides, see endpoint_for()
Parameters
• service_type Service Type of the endpoint to search for.
• interface Interface of the endpoint to search for. Optional, defaults to
the configured value for interface for this Connection.
• region_name Region Name of the endpoint to search for. Optional, de-
faults to the configured value for region_name for this Connection.
Returns The endpoint of the service, or None if not found.
get_auth()
Return a keystoneauth plugin from the auth credentials.
insert_user_agent()
Set sdk information into the user agent of the Session.
Warning: This method is here to be used by os-client-config. It exists as a hook point so

that os-client-config can provice backwards compatibility and still be in the User Agent
for people using os-client-config directly.
Normal consumers of SDK should use app_name and app_version. However, if someone
else writes a subclass of CloudRegion it may be desirable.
get_session()
Return a keystoneauth session based on the auth credentials.
get_service_catalog()
Helper method to grab the service catalog.

get_session_client(service_type, version=None, constructor=<class ’open-

stack.proxy.Proxy’>, **kwargs)
Return a prepped keystoneauth Adapter for a given service.
This is useful for making direct requests calls against a mounted endpoint. That is, if you
do:
client = get_session_client(compute)
then you can do:
client.get(/flavors)
and it will work like you think.
get_session_endpoint(service_type, min_version=None, max_version=None)
Return the endpoint from config or the catalog.
If a configuration lists an explicit endpoint for a service, return that. Otherwise, fetch the
service catalog from the keystone session and return the appropriate endpoint.
Parameters service_type Official service type of service
get_cache_resource_expiration(resource, default=None)
Get expiration time for a resource
Parameters
• resource Name of the resource type
• default Default value to return if not found (optional, defaults to None)
Returns Expiration time for the resource type as float or default
requires_floating_ip()
Return whether or not this cloud requires floating ips.
Returns True of False if know, None if discovery is needed. If re-
quires_floating_ip is not configured but the cloud is known to not provide
floating ips, will return False.
get_external_networks()
Get list of network names for external networks.
get_external_ipv4_networks()
Get list of network names for external IPv4 networks.
Get list of network names for external IPv6 networks.
get_internal_networks()
Get list of network names for internal networks.
get_internal_ipv4_networks()
Get list of network names for internal IPv4 networks.
Get list of network names for internal IPv6 networks.
get_default_network()
Get network used for default interactions.

get_nat_destination()
Get network used for NAT destination.
get_nat_source()
Get network used for NAT source.
get_client_config(name=None, defaults=None)
Get config settings for a named client.
Settings will also be looked for in a section called client. If settings are found in both, they
will be merged with the settings from the named section winning over the settings from
client section, and both winning over provided defaults.
Parameters
• name (string) Name of the config section to look for.
• defaults (dict) Default settings to use.
Returns A dict containing merged settings from the named section, the client sec-
tion and the defaults.
Connect
In order to work with an OpenStack cloud you first need to create a Connection to it using your cre-
dentials. A Connection can be created in 3 ways, using the class itself, Config Files, or Environment
Variables. It is recommended to always use Config Files as the same config can be used across tools and
languages.
Create Connection
To create a Connection instance, use the connect() factory function.
def create_connection(auth_url, region, project_name, username, password,

user_domain, project_domain):
return openstack.connect(
auth_url=auth_url,
project_name=project_name,
username=username,
password=password,
region_name=region,
user_domain_name=user_domain,
project_domain_name=project_domain,
app_name='examples',
app_version='1.0',
)
Full example at connect.py
Note: To enable logging, see the Logging user guide.

Next
Now that you can create a connection, continue with the User Guides to work with an OpenStack service.
Connect From Config
In order to work with an OpenStack cloud you first need to create a Connection to it using your
credentials. A Connection can be created in 3 ways, using the class itself (see Connect), a file, or
environment variables as illustrated below. The SDK uses os-client-config to handle the configuration.
Create Connection From A File
Default Location
To create a connection from a file you need a YAML file to contain the configuration.
clouds:
test_cloud:
auth:
auth_url: http://xxx.xxx.xxx.xxx:5000/v2.0/
username: demo
password: secrete
project_name: demo
rackspace:
cloud: rackspace
auth:
username: joe
password: joes-password
project_name: 123123
region_name: IAD
example:
image_name: fedora-20.x86_64
flavor_name: m1.small
network_name: private
To use a configuration file called clouds.yaml in one of the default locations:

• ~/.config/openstack
• /etc/openstack
call from_config(). The from_config function takes three optional arguments:
• cloud_name allows you to specify a cloud from your clouds.yaml file.
• cloud_config allows you to pass in an existing openstack.config.loader.
OpenStackConfig` object.
• options allows you to specify a namespace object with options to be added to the cloud config.

class Opts:
def __init__(self, cloud_name='devstack-admin', debug=False):
self.cloud = cloud_name
self.debug = debug
# Use identity v3 API for examples.
self.identity_api_version = '3'
def create_connection_from_config():
return openstack.connect(cloud=TEST_CLOUD)
def create_connection_from_args():
parser = argparse.ArgumentParser()
return openstack.connect(options=parser)
Note: To enable logging, set debug=True in the options object.
User Defined Location
To use a configuration file in a user defined location set the environment variable
OS_CLIENT_CONFIG_FILE to the absolute path of a file.:
export OS_CLIENT_CONFIG_FILE=/path/to/my/config/my-clouds.yaml
and call from_config() with the cloud_name of the cloud configuration to use, .
Next
Now that you can create a connection, continue with the User Guides for an OpenStack service.
Logging
Note: TODO(shade) This document is written from a shade POV. It needs to be combined with the
existing logging guide, but also the logging systems need to be rationalized.
openstacksdk uses Python Logging. As openstacksdk is a library, it does not configure logging handlers
automatically, expecting instead for that to be the purview of the consuming application.

Simple Usage
For consumers who just want to get a basic logging setup without thinking about it too deeply, there is a
helper method. If used, it should be called before any other openstacksdk functionality.
openstack.enable_logging(debug=False, http_debug=False, path=None,
stream=None, format_stream=False, for-
mat_template=’%(asctime)s %(levelname)s: %(name)s
%(message)s’, handlers=None)
Enable logging output.
Helper function to enable logging. This function is available for debugging purposes and for
folks doing simple applications who want an easy just make it work for me. For more complex
applications or for those who want more flexibility, the standard library logging package will
receive these messages in any handlers you create.
Parameters
• debug (bool) Set this to True to receive debug messages.
• http_debug (bool) Set this to True to receive debug messages including
HTTP requests and responses. This implies debug=True.
• path (str) If a path is specified, logging output will written to that file in
addition to sys.stderr. The path is passed to logging.FileHandler, which will
append messages the file (and create it if needed).
• stream One of None `` or ``sys.stdout or sys.stderr. If it is
None, nothing is logged to a stream. If it isnt None, console output is logged
to this stream.
• format_stream (bool) If format_stream is False, the default, apply
format_template to path but not to stream outputs. If True, apply
format_template to stream outputs as well.
• format_template (str) Template to pass to logging.Formatter.
Return type None
import openstack
openstack.enable_logging()
The stream parameter controls the stream where log message are written to. It defaults to sys.stdout
which will result in log messages being written to STDOUT. It can be set to another output stream, or to
None to disable logging to the console.
The path parameter sets up logging to log to a file. By default, if path is given and stream is not,
logging will only go to path.
You can combine the path and stream parameters to log to both places simultaneously.
To log messages to a file called openstack.log and the console on stdout:
import sys
import openstack
openstack.enable_logging(
debug=True, path='openstack.log', stream=sys.stdout)

openstack.enable_logging also sets up a few other loggers and squelches some warnings or log messages
that are otherwise uninteresting or unactionable by an openstacksdk user.
Advanced Usage
openstacksdk logs to a set of different named loggers.

Most of the logging is set up to log to the root openstack logger. There are additional sub-loggers
that are used at times, primarily so that a user can decide to turn on or off a specific type of logging.
They are listed below.
openstack.config Issues pertaining to configuration are logged to the openstack.config logger.
openstack.iterate_timeout When openstacksdk needs to poll a resource, it does so in a loop that waits
between iterations and ultimately times out. The openstack.iterate_timeout logger
emits messages for each iteration indicating it is waiting and for how long. These can be useful to
see for long running tasks so that one can know things are not stuck, but can also be noisy.
openstack.fnmatch openstacksdk will try to use fnmatch on given name_or_id arguments. Its a best
effort attempt, so pattern misses are logged to openstack.fnmatch. A user may not be
intending to use an fnmatch pattern - such as if they are trying to find an image named Fedora
24 [official], so these messages are logged separately.
HTTP Tracing
HTTP Interactions are handled by keystoneauth. If you want to enable HTTP tracing while using open-
stacksdk and are not using openstack.enable_logging, set the log level of the keystoneauth logger
to DEBUG.
For more information see https://docs.openstack.org/keystoneauth/latest/using-sessions.html#logging
Python Logging
Python logging is a standard feature of Python and is documented fully in the Python Documentation,
which varies by version of Python.
For more information on Python Logging for Python v2, see https://docs.python.org/2/library/logging.
html.
For more information on Python Logging for Python v3, see https://docs.python.org/3/library/logging.
html.
Statistics reporting
openstacksdk offers possibility to report statistics on individual API requests/responses in different for-
mats. Statsd allows reporting of the response times in the statsd format. InfluxDB allows a more event-
oriented reporting of the same data. Prometheus reporting is a bit different and requires the application
using SDK to take care of the metrics exporting, while openstacksdk prepares the metrics.
Due to the nature of the statsd protocol lots of tools consuming the metrics do the data aggregation and
processing in the configurable time frame (mean value calculation for a 1 minute time frame). For the
case of periodic tasks this might not be very useful. A better fit for using openstacksdk as a library is an

event-recording, where duration of an individual request is stored and all required calculations are done
if necessary in the monitoring system based required timeframe, or the data is simply shown as is with
no analytics. A comparison article describes differences in those approaches.
Simple Usage
To receive metrics add a following section to the config file (clouds.yaml):
metrics:
statsd:
host: __statsd_server_host__
port: __statsd_server_port__
clouds:
..
In order to enable InfluxDB reporting following configuration need to be done in the clouds.yaml file
metrics:
influxdb:
host: __influxdb_server_host__
port: __influxdb_server_port__
use_udp: __True|False__
username: __influxdb_auth_username__
password: __influxdb_auth_password__
database: __influxdb_db_name__
measurement: __influxdb_measurement_name__
timeout: __infludb_requests_timeout__
clouds:
..
Metrics will be reported only when corresponding client libraries ( statsd for statsd reporting, influxdb
for influxdb reporting correspondingly). When those libraries are not available reporting will be silently
ignored.
InfluxDB reporting allows setting additional tags into the metrics based on the selected cloud.
clouds:
my_cloud:
profile: some_profile
...
additional_metric_tags:
environment: production
Microversions
As openstacksdk rolls out support for consuming microversions, it will do so on a call by call basis as
needed. Just like with major versions, openstacksdk should have logic to handle each microversion for
a given REST call it makes, with the following rules in mind:
• If an activity openstack performs can be done differently or more efficiently with a new microver-
sion, the support should be added to openstack.cloud and to the appropriate Proxy class.
• openstacksdk should always attempt to use the latest microversion it is aware of for a given call,
unless a microversion removes important data.

• Microversion selection should under no circumstances be exposed to the user in python API calls
in the Resource layer or the openstack.cloud layer.
• Microversion selection is exposed to the user in the REST layer via the microversion argu-
ment to each REST call.
• A user of the REST layer may set the default microversion by set-
ting {service_type}_default_microversion in clouds.yaml or
OS_{service_type|upper}_DEFAULT_MICROVERSION environment variable.
Note: Setting the default microversion in any circumstance other than when using the REST layer is
highly discouraged. Both of the higher layers in openstacksdk provide data normalization as well as
logic about which REST call to make. Setting the default microversion could change the behavior of the
service in question in such a way that openstacksdk does not understand. If there is a feature of a service
that needs a microversion and it is not already transparently exposed in openstacksdk, please file a bug.
• If a feature is only exposed for a given microversion and cannot be simulated for older clouds
without that microversion, it is ok to add it, but a clear error message should be given to the user
that the given feature is not available on their cloud. (A message such as This cloud supports
a maximum microversion of XXX for service YYY and this feature only exists on clouds with
microversion ZZZ. Please contact your cloud provider for information about when this feature
might be available)
• When adding a feature that only exists behind a new microversion, every effort should be made to
figure out how to provide the same functionality if at all possible, even if doing so is inefficient.
If an inefficient workaround is employed, a warning should be provided to the user. (the users
workaround to skip the inefficient behavior would be to stop using that openstacksdk API call)
An example of this is the nova get me a network feature. The logic of get me a network can be
done client-side, albeit less efficiently. Adding support for the get me a network feature via nova
microversion should also add support for doing the client-side workaround.
• If openstacksdk is aware of logic for more than one microversion, it should always attempt to use
the latest version available for the service for that call.
• Objects returned from openstacksdk should always go through normalization and thus should
always conform to openstacksdks documented data model. The objects should never look different
to the user regardless of the microversion used for the REST call.
• If a microversion adds new fields to an object, those fields should be added to openstacksdks data
model contract for that object and the data should either be filled in by performing additional
REST calls if the data is available that way, or the field should have a default value of None which
the user can be expected to test for when attempting to use the new value.
• If a microversion removes fields from an object that are part of the existing data model contract,
care should be taken to not use the new microversion for that call unless forced to by lack of
availablity of the old microversion on the cloud in question. In the case where an old microversion
is no longer available, care must be taken to either find the data from another source and fill it in,
or to put a value of None into the field and document for the user that on some clouds the value
may not exist.
• If a microversion removes a field and the outcome is particularly intractable and impossible to
work around without fundamentally breaking users, an issue should be raised with the service
team in question. Hopefully a resolution can be found during the period while clouds still have
the old microversion.

• As new calls or objects are added, it is important to check in with the service team in question on
the expected stability of the object. If there are known changes expected in the future, even if they
may be a few years off, openstacksdk should take care to not add committments to its data model
for those fields/features. It is ok for openstacksdk to not have something.
Note: openstacksdk does not currently have any sort of experimental opt-in API that would allow
exposing things to a user that may not be supportable under the normal compatibility contract. If
a conflict arises in the future where there is a strong desire for a feature but also a lack of certainty
about its stability over time, an experimental API may want to be explored but concrete use cases
should arise before such a thing is started.
Using OpenStack Baremetal
Before working with the Bare Metal service, youll need to create a connection to your OpenStack cloud
by following the Connect user guide. This will provide you with the conn variable used in the examples
below.
Table of Contents
• CRUD operations
– List Nodes
• Provisioning operations
– Manage and inspect Node
– Provide Node
The primary resource of the Bare Metal service is the node.

Below are a few usage examples. For a reference to all the available methods, see Baremetal API.
CRUD operations
List Nodes
A node is a bare metal machine.
def list_nodes(conn):
print("List Nodes:")
for node in conn.baremetal.nodes():

print(node)
Full example: baremetal resource list

Provisioning operations
Provisioning actions are the main way to manipulate the nodes. See Bare Metal service states documen-
tation for details.
Manage and inspect Node
Managing a node in the enroll provision state validates the management (IPMI, Redfish, etc) creden-
tials and moves the node to the manageable state. Managing a node in the available state moves
it to the manageable state. In this state additional actions, such as configuring RAID or inspecting,
are available.
Inspecting a node detects its properties by either talking to its BMC or by booting a special ramdisk.
def manage_and_inspect_node(conn, uuid):

node = conn.baremetal.find_node(uuid)
print('Before:', node.provision_state)
conn.baremetal.set_node_provision_state(node, 'manage')
conn.baremetal.wait_for_nodes_provision_state([node], 'manageable')
conn.baremetal.set_node_provision_state(node, 'inspect')
res = conn.baremetal.wait_for_nodes_provision_state([node], 'manageable
,→')
print('After:', res[0].provision_state)
Full example: baremetal provisioning
Provide Node
Providing a node in the manageable provision state makes it available for deployment.
def provide_node(conn, uuid):

node = conn.baremetal.find_node(uuid)
print('Before:', node.provision_state)
conn.baremetal.set_node_provision_state(node, 'provide')
res = conn.baremetal.wait_for_nodes_provision_state([node], 'available
,→')
print('After:', res[0].provision_state)
Full example: baremetal provisioning
Using OpenStack Block Storage
Before working with the Block Storage service, youll need to create a connection to your OpenStack
cloud by following the Connect user guide. This will provide you with the conn variable used in the
examples below.

Using OpenStack Clustering
Before working with the Clustering service, youll need to create a connection to your OpenStack cloud
by following the Connect user guide. This will provide you with the conn variable used by all examples
in this guide.
The primary abstractions/resources of the Clustering service are:
Working with Profile Types
A profile is a template used to create and manage nodes, i.e. objects exposed by other OpenStack
services. A profile encodes the information needed for node creation in a property named spec.
List Profile Types
To examine the known profile types:
def list_profile_types(conn):
print("List Profile Types:")
for pt in conn.clustering.profile_types():
print(pt.to_dict())
Full example: manage profile type
Get Profile Type
To get the details about a profile type, you need to provide the name of it.
def get_profile_type(conn):
print("Get Profile Type:")
pt = conn.clustering.get_profile_type('os.nova.server-1.0')
print(pt.to_dict())
Full example: manage profile type
Managing Profiles
A profile type can be treated as the meta-type of a Profile object. A registry of profile types is built
when the Cluster service starts. When creating a Profile object, you will indicate the profile type used in
its spec property.

List Profiles
To examine the list of profiles:
def list_profiles(conn):
print("List Profiles:")
for profile in conn.clustering.profiles():

print(profile.to_dict())
for profile in conn.clustering.profiles(sort='name:asc'):

When listing profiles, you can specify the sorting option using the sort parameter and you can do
pagination using the limit and marker parameters.
Full example: manage profile
Create Profile
When creating a profile, you will provide a dictionary with keys and values specified according to the
profile type referenced.
def create_profile(conn):
print("Create Profile:")
spec = {
'profile': 'os.nova.server',
'version': 1.0,
'name': 'os_server',
'properties': {
'name': SERVER_NAME,
'flavor': FLAVOR_NAME,
'image': IMAGE_NAME,
'networks': {
'network': NETWORK_NAME
}
}
}
profile = conn.clustering.create_profile(spec)
Optionally, you can specify a metadata keyword argument that contains some key-value pairs to be
associated with the profile.

Find Profile
To find a profile based on its name or ID:
def find_profile(conn):
print("Find Profile:")
profile = conn.clustering.find_profile('os_server')
The Cluster service doesnt allow updating the spec of a profile. The only way to achieve that is to
create a new profile.
Get Profile
To get a profile based on its name or ID:
def get_profile(conn):
print("Get Profile:")
profile = conn.clustering.get_profile('os_server')
Update Profile
After a profile is created, most of its properties are immutable. Still, you can update a profiles name
and/or metadata.
def update_profile(conn):
print("Update Profile:")
profile = conn.clustering.update_profile('os_server', name='old_server

,→ ')
The Cluster service doesnt allow updating the spec of a profile. The only way to achieve that is to
create a new profile.

Delete Profile
A profile can be deleted after creation, provided that it is not referenced by any active clusters or nodes.
If you attempt to delete a profile that is still in use, you will get an error message.
def delete_profile(conn):
print("Delete Profile:")
conn.clustering.delete_profile('os_server')
print("Profile deleted.")
Managing Clusters
Clusters are first-class citizens in Senlin service design. A cluster is defined as a collection of homo-
geneous objects. The homogeneous here means that the objects managed (aka. Nodes) have to be
instantiated from the same profile type.
List Clusters
To examine the list of receivers:
def list_cluster(conn):
print("List clusters:")
for cluster in conn.clustering.clusters():

print(cluster.to_dict())
for cluster in conn.clustering.clusters(sort='name:asc'):

When listing clusters, you can specify the sorting option using the sort parameter and you can do
Full example: manage cluster
Create Cluster
When creating a cluster, you will provide a dictionary with keys and values according to the cluster type
referenced.
def create_cluster(conn):
print("Create cluster:")
spec = {
"name": CLUSTER_NAME,
"profile_id": PROFILE_ID,
"min_size": 0,
"max_size": -1,
"desired_capacity": 1,
}

cluster = conn.clustering.create_cluster(**spec)
associated with the cluster.
Get Cluster
To get a cluster based on its name or ID:
def get_cluster(conn):
print("Get cluster:")
cluster = conn.clustering.get_cluster(CLUSTER_ID)
Find Cluster
To find a cluster based on its name or ID:
def find_cluster(conn):
print("Find cluster:")
cluster = conn.clustering.find_cluster(CLUSTER_ID)
Update Cluster
After a cluster is created, most of its properties are immutable. Still, you can update a clusters name
and/or params.
def update_cluster(conn):
print("Update cluster:")
spec = {
"name": "Test_Cluster001",
"profile_id": "c0e3a680-e270-4eb8-9361-e5c9503fba0a",
"profile_only": True,
}
cluster = conn.clustering.update_cluster(CLUSTER_ID, **spec)

Delete Cluster
A cluster can be deleted after creation, When there are nodes in the cluster, the Senlin engine will launch
a process to delete all nodes from the cluster and destroy them before deleting the cluster object itself.
def delete_cluster(conn):
print("Delete cluster:")
conn.clustering.delete_cluster(CLUSTER_ID)
print("Cluster deleted.")
# cluster support force delete

conn.clustering.delete_cluster(CLUSTER_ID, False, True)
print("Cluster deleted")
Add Nodes to Cluster
Add some existing nodes into the specified cluster.
def add_nodes_to_cluster(conn):
print("Add nodes to cluster:")
node_ids = [NODE_ID]
res = conn.clustering.add_nodes_to_cluster(CLUSTER_ID, node_ids)
print(res)
Remove Nodes from Cluster
Remove nodes from specified cluster.
def remove_nodes_from_cluster(conn):
print("Remove nodes from a cluster:")
node_ids = [NODE_ID]
res = conn.clustering.remove_nodes_from_cluster(CLUSTER_ID, node_ids)
print(res)
Replace Nodes in Cluster
Replace some existing nodes in the specified cluster.
def replace_nodes_in_cluster(conn):
print("Replace the nodes in a cluster with specified nodes:")
old_node = NODE_ID
new_node = "cd803d4a-015d-4223-b15f-db29bad3146c"
spec = {
old_node: new_node
}
res = conn.clustering.replace_nodes_in_cluster(CLUSTER_ID, **spec)
print(res)

Cluster Scale Out
Inflate the size of a cluster.
def scale_out_cluster(conn):
print("Inflate the size of a cluster:")
res = conn.clustering.scale_out_cluster(CLUSTER_ID, 1)
print(res)
Cluster Scale In
Shrink the size of a cluster.
def scale_out_cluster(conn):
print("Inflate the size of a cluster:")
res = conn.clustering.scale_out_cluster(CLUSTER_ID, 1)
print(res)
Cluster Resize
Resize of cluster.
def resize_cluster(conn):
print("Resize of cluster:")
spec = {
'min_size': 1,
'max_size': 6,
'adjustment_type': 'EXACT_CAPACITY',
'number': 2
}
res = conn.clustering.resize_cluster(CLUSTER_ID, **spec)
print(res)
Attach Policy to Cluster
Once a policy is attached (bound) to a cluster, it will be enforced when related actions are performed on
that cluster, unless the policy is (temporarily) disabled on the cluster
def attach_policy_to_cluster(conn):
print("Attach policy to a cluster:")
spec = {'enabled': True}

res = conn.clustering.attach_policy_to_cluster(
CLUSTER_ID, POLICY_ID, **spec)
print(res)

Detach Policy from Cluster
Once a policy is attached to a cluster, it can be detached from the cluster at users request.
def detach_policy_from_cluster(conn):
print("Detach a policy from a cluster:")
res = conn.clustering.detach_policy_from_cluster(CLUSTER_ID, POLICY_ID)

print(res)
Cluster Check
Check cluster health status, Cluster members can be check.
def check_cluster(conn):
print("Check cluster:")
res = conn.clustering.check_cluster(CLUSTER_ID)
print(res)
Cluster Recover
To restore a specified cluster, members in the cluster will be checked.
def recover_cluster(conn):
print("Recover cluster:")
spec = {'check': True}

res = conn.clustering.recover_cluster(CLUSTER_ID, **spec)
print(res)
Managing Nodes
Node is a logical object managed by the Senlin service. A node can be a member of at most one cluster
at any time. A node can be an orphan node which means it doesnt belong to any clusters.
List Nodes
To examine the list of Nodes:
def list_nodes(conn):
print("List Nodes:")
for node in conn.clustering.nodes():

print(node.to_dict())
for node in conn.clustering.nodes(sort='asc:name'):

When listing nodes, you can specify the sorting option using the sort parameter and you can do
Full example: manage node
Create Node
When creating a node, you will provide a dictionary with keys and values according to the node type
referenced.
def create_node(conn):
print("Create Node:")
spec = {
'name': NODE_NAME,
'profile_id': PROFILE_ID,
}
node = conn.clustering.create_node(**spec)
associated with the node.
Get Node
To get a node based on its name or ID:
def get_node(conn):
print("Get Node:")
node = conn.clustering.get_node(NODE_ID)
Find Node
To find a node based on its name or ID:
def find_node(conn):
print("Find Node:")
node = conn.clustering.find_node(NODE_ID)

Update Node
After a node is created, most of its properties are immutable. Still, you can update a nodes name and/or
params.
def update_node(conn):
print("Update Node:")
spec = {
'name': 'Test_Node01',
'profile_id': 'c0e3a680-e270-4eb8-9361-e5c9503fba0b',
}
node = conn.clustering.update_node(NODE_ID, **spec)

Delete Node
A node can be deleted after creation, provided that it is not referenced by any active clusters. If you
attempt to delete a node that is still in use, you will get an error message.
def delete_node(conn):
print("Delete Node:")
conn.clustering.delete_node(NODE_ID)
print("Node deleted.")
# node support force delete
conn.clustering.delete_node(NODE_ID, False, True)
print("Node deleted")
Check Node
If the underlying physical resource is not healthy, the node will be set to ERROR status.
def check_node(conn):
print("Check Node:")
node = conn.clustering.check_node(NODE_ID)
print(node)

Recover Node
To restore a specified node.
def recover_node(conn):
print("Recover Node:")
spec = {'check': True}

node = conn.clustering.recover_node(NODE_ID, **spec)
print(node)
Working with Policy Types
A policy is a template that encodes the information needed for specifying the rules that are
checked/enforced before/after certain actions are performed on a cluster. The rules are encoded in a
property named spec.
List Policy Types
To examine the known policy types:
def list_policy_types(conn):
print("List Policy Types:")
for pt in conn.clustering.policy_types():
print(pt.to_dict())
Full example: manage policy type
Get Policy Type
To retrieve the details about a policy type, you need to provide the name of it.
def get_policy_type(conn):
print("Get Policy Type:")
pt = conn.clustering.get_policy_type('senlin.policy.deletion-1.0')
print(pt.to_dict())
Full example: manage policy type

Managing Policies
A policy type can be treated as the meta-type of a Policy object. A registry of policy types is built when
the Cluster service starts. When creating a Policy object, you will indicate the policy type used in its
spec property.
List Policies
To examine the list of policies:
def list_policies(conn):
print("List Policies:")
for policy in conn.clustering.policies():

print(policy.to_dict())
for policy in conn.clustering.policies(sort='name:asc'):

When listing policies, you can specify the sorting option using the sort parameter and you can do
Full example: manage policy
Create Policy
When creating a policy, you will provide a dictionary with keys and values according to the policy type
referenced.
def create_policy(conn):
print("Create Policy:")
attrs = {
'name': 'dp01',
'spec': {
'policy': 'senlin.policy.deletion',
'version': 1.0,
'properties': {
'criteria': 'oldest_first',
'destroy_after_deletion': True,
}
}
}
policy = conn.clustering.create_policy(attrs)
associated with the policy.

Find Policy
To find a policy based on its name or ID:
def find_policy(conn):
print("Find Policy:")
policy = conn.clustering.find_policy('dp01')
Get Policy
To get a policy based on its name or ID:
def get_policy(conn):
print("Get Policy:")
policy = conn.clustering.get_policy('dp01')
Update Policy
After a policy is created, most of its properties are immutable. Still, you can update a policys name
and/or metadata.
def update_policy(conn):
print("Update Policy:")
policy = conn.clustering.update_policy('dp01', name='dp02')

The Cluster service doesnt allow updating the spec of a policy. The only way to achieve that is to
create a new policy.
Delete Policy
A policy can be deleted after creation, provided that it is not referenced by any active clusters or nodes.
If you attempt to delete a policy that is still in use, you will get an error message.
def delete_policy(conn):
print("Delete Policy:")
conn.clustering.delete_policy('dp01')
print("Policy deleted.")

Managing Receivers
Receivers are the event sinks associated to senlin clusters. When certain events (or alarms) are seen by
a monitoring software, the software can notify the senlin clusters of those events (or alarms). When
senlin receives those notifications, it can automatically trigger some predefined operations with preset
parameter values.
List Receivers
To examine the list of receivers:
def list_receivers(conn):
print("List Receivers:")
for receiver in conn.clustering.receivers():

print(receiver.to_dict())
for receiver in conn.clustering.receivers(sort='name:asc'):

When listing receivers, you can specify the sorting option using the sort parameter and you can do
Full example: manage receiver
Create Receiver
When creating a receiver, you will provide a dictionary with keys and values according to the receiver
type referenced.
def create_receiver(conn):
print("Create Receiver:")
# Build the receiver attributes and create the recever.

spec = {
"action": "CLUSTER_SCALE_OUT",
"cluster_id": CLUSTER_ID,
"name": FAKE_NAME,
"params": {
"count": "1"
},
"type": "webhook"
}
receiver = conn.clustering.create_receiver(**spec)
associated with the receiver.

Get Receiver
To get a receiver based on its name or ID:
def get_receiver(conn):
print("Get Receiver:")
receiver = conn.clustering.get_receiver(FAKE_NAME)
Find Receiver
To find a receiver based on its name or ID:
def find_receiver(conn):
print("Find Receiver:")
receiver = conn.clustering.find_receiver(FAKE_NAME)
Update Receiver
After a receiver is created, most of its properties are immutable. Still, you can update a receivers name
and/or params.
def update_receiver(conn):
print("Update Receiver:")
spec = {
"name": "test_receiver2",
"params": {
"count": "2"
}
}
receiver = conn.clustering.update_receiver(FAKE_NAME, **spec)

Delete Receiver
A receiver can be deleted after creation, provided that it is not referenced by any active clusters. If you
attempt to delete a receiver that is still in use, you will get an error message.
def delete_receiver(conn):
print("Delete Receiver:")
conn.clustering.delete_receiver(FAKE_NAME)
print("Receiver deleted.")
Working with Actions
An action is an abstraction of some logic that can be executed by a worker thread. Most of the operations
supported by Senlin are executed asynchronously, which means they are queued into database and then
picked up by certain worker thread for execution.
List Actions
To examine the list of actions:
def list_actions(conn):
print("List Actions:")
for actions in conn.clustering.actions():

print(actions.to_dict())
for actions in conn.clustering.actions(sort='name:asc'):

print(actions.to_dict())
When listing actions, you can specify the sorting option using the sort parameter and you can do
Full example: manage action
Get Action
To get a action based on its name or ID:
def get_action(conn):
print("Get Action:")
action = conn.clustering.get_action(ACTION_ID)
print(action.to_dict())

Working with Events
An event is a record generated during engine execution. Such an event captures what has happened
inside the senlin-engine. The senlin-engine service generates event records when it is performing some
actions or checking policies.
List Events
To examine the list of events:
def list_events(conn):
print("List Events:")
for events in conn.clustering.events():

print(events.to_dict())
for events in conn.clustering.events(sort='name:asc'):

print(events.to_dict())
When listing events, you can specify the sorting option using the sort parameter and you can do
Full example: manage event
Get Event
To get a event based on its name or ID:
def get_event(conn):
print("Get Event:")
event = conn.clustering.get_event(EVENT_ID)
print(event.to_dict())
Using OpenStack Compute
Before working with the Compute service, youll need to create a connection to your OpenStack cloud
below.
Table of Contents
• List Servers
• List Images
• List Flavors
• List Networks
• Create Key Pair

• Create Server
The primary resource of the Compute service is the server.
List Servers
A server is a virtual machine that provides access to a compute instance being run by your cloud
provider.
def list_servers(conn):
print("List Servers:")
for server in conn.compute.servers():

print(server)
Full example: compute resource list
List Images
An image is the operating system you want to use for your server.
def list_images(conn):
print("List Images:")
for image in conn.compute.images():

print(image)
List Flavors
A flavor is the resource configuration for a server. Each flavor is a unique combination of disk, memory,
vCPUs, and network bandwidth.
def list_flavors(conn):
print("List Flavors:")
for flavor in conn.compute.flavors():

print(flavor)

List Networks
A network provides connectivity to servers.
def list_networks(conn):
print("List Networks:")
for network in conn.network.networks():

print(network)
Full example: network resource list
Create Key Pair
A key pair is the public key and private key of publickey cryptography. They are used to encrypt and
decrypt login information when connecting to your server.
def create_keypair(conn):
keypair = conn.compute.find_keypair(KEYPAIR_NAME)
if not keypair:
print("Create Key Pair:")
keypair = conn.compute.create_keypair(name=KEYPAIR_NAME)
print(keypair)
try:
os.mkdir(SSH_DIR)
except OSError as e:
if e.errno != errno.EEXIST:
raise e
with open(PRIVATE_KEYPAIR_FILE, 'w') as f:

f.write("%s" % keypair.private_key)
os.chmod(PRIVATE_KEYPAIR_FILE, 0o400)
return keypair
Full example: compute resource create
Create Server
At minimum, a server requires a name, an image, a flavor, and a network on creation. You can discover
the names and IDs of these attributes by listing them as above and then using the find methods to get the
appropriate resources.
Ideally youll also create a server using a keypair so you can login to that server with the private key.
Servers take time to boot so we call wait_for_server to wait for it to become active.

def create_server(conn):
print("Create Server:")
image = conn.compute.find_image(IMAGE_NAME)
flavor = conn.compute.find_flavor(FLAVOR_NAME)
network = conn.network.find_network(NETWORK_NAME)
keypair = create_keypair(conn)
server = conn.compute.create_server(
name=SERVER_NAME, image_id=image.id, flavor_id=flavor.id,
networks=[{"uuid": network.id}], key_name=keypair.name)
server = conn.compute.wait_for_server(server)
print("ssh -i {key} root@{ip}".format(

key=PRIVATE_KEYPAIR_FILE,
ip=server.access_ipv4))
Full example: compute resource create
Using OpenStack Database
Before working with the Database service, youll need to create a connection to your OpenStack cloud
below.
Using OpenStack DNS
Before working with the DNS service, youll need to create a connection to your OpenStack cloud by
following the Connect user guide. This will provide you with the conn variable used in the examples
below.
List Zones
def list_zones(conn):
print("List Zones:")
for zone in conn.dns.zones():

print(zone)
Full example: dns resource list

Using OpenStack Identity
Before working with the Identity service, youll need to create a connection to your OpenStack cloud by
below.
The OpenStack Identity service is the default identity management system for OpenStack. The Identity
service authentication process confirms the identity of a user and an incoming request by validating a
set of credentials that the user supplies. Initially, these credentials are a user name and password or a
user name and API key. When the Identity service validates user credentials, it issues an authentication
token that the user provides in subsequent requests. An authentication token is an alpha-numeric text
string that enables access to OpenStack APIs and resources. A token may be revoked at any time and is
valid for a finite duration.
List Users
A user is a digital representation of a person, system, or service that uses OpenStack cloud services. The
Identity service validates that incoming requests are made by the user who claims to be making the call.
Users have a login and can access resources by using assigned tokens. Users can be directly assigned to
a particular project and behave as if they are contained in that project.
def list_users(conn):
print("List Users:")
for user in conn.identity.users():

print(user)
Full example: identity resource list
List Credentials
Credentials are data that confirms the identity of the user. For example, user name and password, user
name and API key, or an authentication token that the Identity service provides.
def list_credentials(conn):
print("List Credentials:")
for credential in conn.identity.credentials():

print(credential)

List Projects
A project is a container that groups or isolates resources or identity objects.
def list_projects(conn):
print("List Projects:")
for project in conn.identity.projects():

print(project)
List Domains
A domain is an Identity service API v3 entity and represents a collection of projects and users that
defines administrative boundaries for the management of Identity entities. Users can be granted the
administrator role for a domain. A domain administrator can create projects, users, and groups in a
domain and assign roles to users and groups in a domain.
def list_domains(conn):
print("List Domains:")
for domain in conn.identity.domains():

print(domain)
List Groups
A group is an Identity service API v3 entity and represents a collection of users that are owned by a
domain. A group role granted to a domain or project applies to all users in the group. Adding users
to, or removing users from, a group respectively grants, or revokes, their role and authentication to the
associated domain or project.
def list_groups(conn):
print("List Groups:")
for group in conn.identity.groups():

print(group)

List Services
A service is an OpenStack service, such as Compute, Object Storage, or Image service, that provides
one or more endpoints through which users can access resources and perform operations.
def list_services(conn):
print("List Services:")
for service in conn.identity.services():

print(service)
List Endpoints
An endpoint is a network-accessible address, usually a URL, through which you can access a service.
def list_endpoints(conn):
print("List Endpoints:")
for endpoint in conn.identity.endpoints():

print(endpoint)
List Regions
A region is an Identity service API v3 entity and represents a general division in an OpenStack deploy-
ment. You can associate zero or more sub-regions with a region to make a tree-like structured hierarchy.
def list_regions(conn):
print("List Regions:")
for region in conn.identity.regions():

print(region)
Using OpenStack Image
Before working with the Image service, youll need to create a connection to your OpenStack cloud by
below.
The primary resource of the Image service is the image.

List Images
An image is a collection of files for a specific operating system that you use to create or rebuild a server.
OpenStack provides pre-built images. You can also create custom images, or snapshots, from servers
that you have launched. Images come in different formats and are sometimes called virtual machine
images.
def list_images(conn):
print("List Images:")
for image in conn.image.images():

print(image)
Full example: image resource list
Create Image
Create an image by uploading its data and setting its attributes.
def upload_image(conn):
print("Upload Image:")
# Load fake image data for the example.

data = 'This is fake image data.'
# Build the image attributes and upload the image.

image_attrs = {
'name': EXAMPLE_IMAGE_NAME,
'data': data,
'disk_format': 'raw',
'container_format': 'bare',
'visibility': 'public',
}
conn.image.upload_image(**image_attrs)
Full example: image resource create
Create Image via interoperable image import process
Create an image then use interoperable image import process to download data from a web URL.
For more information about the image import process, please check interoperable image import
def import_image(conn):
print("Import Image:")
# Url where glance can download the image

uri = 'https://download.cirros-cloud.net/0.4.0/' \
'cirros-0.4.0-x86_64-disk.img'
# Build the image attributes and import the image.

image_attrs = {
'name': EXAMPLE_IMAGE_NAME,


'disk_format': 'qcow2',
'container_format': 'bare',
'visibility': 'public',
}
image = conn.image.create_image(**image_attrs)
conn.image.import_image(image, method="web-download", uri=uri)
Full example: image resource import
Downloading an Image with stream=True
As images are often very large pieces of data, storing their entire contents in the memory of your appli-
cation can be less than desirable. A more efficient method may be to iterate over a stream of the response
data.
By choosing to stream the response content, you determine the chunk_size that is appropriate for
your needs, meaning only that many bytes of data are read for each iteration of the loop until all data has
been consumed. See requests.Response.iter_content() for more information.
When you choose to stream an image download, openstacksdk is no longer able to compute the check-
sum of the response data for you. This example shows how you might do that yourself, in a very similar
manner to how the library calculates checksums for non-streamed responses.
def download_image_stream(conn):
print("Download Image via streaming:")
# Find the image you would like to download.

image = conn.image.find_image("myimage")
# As the actual download now takes place outside of the library

# and in your own code, you are now responsible for checking
# the integrity of the data. Create an MD5 has to be computed
# after all of the data has been consumed.
md5 = hashlib.md5()
with open("myimage.qcow2", "wb") as local_image:

response = conn.image.download_image(image, stream=True)
# Read only 1024 bytes of memory at a time until

# all of the image data has been consumed.
for chunk in response.iter_content(chunk_size=1024):
# With each chunk, add it to the hash to be computed.

md5.update(chunk)
local_image.write(chunk)
# Now that you've consumed all of the data the response gave you,
# ensure that the checksums of what the server offered and
# what you downloaded are the same.
if response.headers["Content-MD5"] != md5.hexdigest():
raise Exception("Checksum mismatch in downloaded content")

Downloading an Image with stream=False
If you wish to download an images contents all at once and to memory, simply set stream=False,
which is the default.
def download_image(conn):
print("Download Image:")
# Find the image you would like to download.

image = conn.image.find_image("myimage")
with open("myimage.qcow2", "w") as local_image:

response = conn.image.download_image(image)
# Response will contain the entire contents of the Image.

local_image.write(response)
Full example: image resource download
Delete Image
Delete an image.
def delete_image(conn):
print("Delete Image:")
example_image = conn.image.find_image(EXAMPLE_IMAGE_NAME)
conn.image.delete_image(example_image, ignore_missing=False)
Full example: image resource delete
Using OpenStack Key Manager
Before working with the Key Manager service, youll need to create a connection to your OpenStack
examples below.
Table of Contents
• Create a Secret
• List Secrets
• Get Secret Payload
Note: Some interactions with the Key Manager service differ from that of other services in that re-
sources do not have a proper id parameter, which is necessary to make some calls. Instead, resources
have a separately named id attribute, e.g., the Secret resource has secret_id.
The examples below outline when to pass in those id values.

Create a Secret
The Key Manager service allows you to create new secrets by passing the attributes of the Secret to
the create_secret() method.
def create_secret(conn):
print("Create a secret:")
conn.key_manager.create_secret(name="My public key",

secret_type="public",
expiration="2020-02-28T23:59:59",
payload="ssh rsa...",
payload_content_type="text/plain")
List Secrets
Once you have stored some secrets, they are available for you to list via the secrets() method. This
method returns a generator, which yields each Secret.
def list_secrets(conn):
print("List Secrets:")
for secret in conn.key_manager.secrets():

print(secret)
The secrets() method can also make more advanced queries to limit the secrets that are returned.
def list_secrets_query(conn):
print("List Secrets:")
for secret in conn.key_manager.secrets(

secret_type="symmetric",
expiration="gte:2020-01-01T00:00:00"):
print(secret)
Get Secret Payload
Once you have received a Secret, you can obtain the payload for it by passing the secrets id value to
the secrets() method. Use the secret_id attribute when making this request.
def get_secret_payload(conn):
print("Get a secret's payload:")
# Assuming you have an object `s` which you perhaps received from
# a conn.key_manager.secrets() call...
secret = conn.key_manager.get_secret(s.secret_id)
print(secret.payload)

Using OpenStack Message
Before working with the Message service, youll need to create a connection to your OpenStack cloud by
below.
Using OpenStack Network
Before working with the Network service, youll need to create a connection to your OpenStack cloud by
below.
Table of Contents
• List Networks
• List Subnets
• List Ports
• List Security Groups
• List Routers
• List Network Agents
• Create Network
• Open a Port
• Accept Pings
• Delete Network
The primary resource of the Network service is the network.
List Networks
A network is an isolated Layer 2 networking segment. There are two types of networks, project and
provider networks. Project networks are fully isolated and are not shared with other projects. Provider
networks map to existing physical networks in the data center and provide external network access for
servers. Only an OpenStack administrator can create provider networks. Networks can be connected via
routers.
def list_networks(conn):
print("List Networks:")
for network in conn.network.networks():

print(network)

List Subnets
A subnet is a block of IP addresses and associated configuration state. Subnets are used to allocate IP
addresses when new ports are created on a network.
def list_subnets(conn):
print("List Subnets:")
for subnet in conn.network.subnets():

print(subnet)
List Ports
A port is a connection point for attaching a single device, such as the NIC of a server, to a network. The
port also describes the associated network configuration, such as the MAC and IP addresses to be used
on that port.
def list_ports(conn):
print("List Ports:")
for port in conn.network.ports():

print(port)
List Security Groups
A security group acts as a virtual firewall for servers. It is a container for security group rules which
specify the type of network traffic and direction that is allowed to pass through a port.
def list_security_groups(conn):
print("List Security Groups:")
for port in conn.network.security_groups():

print(port)
List Routers
A router is a logical component that forwards data packets between networks. It also provides Layer 3
and NAT forwarding to provide external network access for servers on project networks.
def list_routers(conn):
print("List Routers:")
for router in conn.network.routers():

print(router)

List Network Agents
A network agent is a plugin that handles various tasks used to implement virtual networks. These
agents include neutron-dhcp-agent, neutron-l3-agent, neutron-metering-agent, and neutron-lbaas-agent,
among others.
def list_network_agents(conn):
print("List Network Agents:")
for agent in conn.network.agents():

print(agent)
Create Network
Create a project network and subnet. This network can be used when creating a server and allows the
server to communicate with others servers on the same project network.
def create_network(conn):
print("Create Network:")
example_network = conn.network.create_network(
name='openstacksdk-example-project-network')
print(example_network)
example_subnet = conn.network.create_subnet(
name='openstacksdk-example-project-subnet',
network_id=example_network.id,
ip_version='4',
cidr='10.0.2.0/24',
gateway_ip='10.0.2.1')
print(example_subnet)
Full example: network resource create
Open a Port
When creating a security group for a network, you will need to open certain ports to allow communica-
tion via them. For example, you may need to enable HTTPS access on port 443.
def open_port(conn):
print("Open a port:")
example_sec_group = conn.network.create_security_group(
name='openstacksdk-example-security-group')
print(example_sec_group)
example_rule = conn.network.create_security_group_rule(
security_group_id=example_sec_group.id,


direction='ingress',
remote_ip_prefix='0.0.0.0/0',
protocol='HTTPS',
port_range_max='443',
port_range_min='443',
ethertype='IPv4')
print(example_rule)
Full example: network security group create
Accept Pings
In order to ping a machine on your network within a security group, you will need to create a rule to
allow inbound ICMP packets.
def allow_ping(conn):
print("Allow pings:")
example_sec_group = conn.network.create_security_group(
name='openstacksdk-example-security-group2')
print(example_sec_group)
example_rule = conn.network.create_security_group_rule(
security_group_id=example_sec_group.id,
direction='ingress',
remote_ip_prefix='0.0.0.0/0',
protocol='icmp',
port_range_max=None,
port_range_min=None,
ethertype='IPv4')
print(example_rule)
Full example: network security group create
Delete Network
Delete a project network and its subnets.
def delete_network(conn):
print("Delete Network:")
example_network = conn.network.find_network(
'openstacksdk-example-project-network')
for example_subnet in example_network.subnet_ids:

conn.network.delete_subnet(example_subnet, ignore_missing=False)
conn.network.delete_network(example_network, ignore_missing=False)
Full example: network resource delete

Using OpenStack Object Store
Before working with the Object Store service, youll need to create a connection to your OpenStack
examples below.
Table of Contents
• Working with Containers

– Listing Containers
– Creating Containers
– Working with Container Metadata
• Working with Objects
– Listing Objects
– Getting Object Data
– Uploading Objects
– Working with Object Metadata
The primary resources of the Object Store service are containers and objects.
Working with Containers
Listing Containers
To list existing containers, use the containers() method.
>>> for cont in conn.object_store.containers():

... print cont
...
openstack.object_store.v1.container.Container: {u'count': 5,
u'bytes': 500, u'name': u'my container'}
u'bytes': 0, u'name': u'empty container'}
u'bytes': 1000000, u'name': u'another container'}
The containers method returns a generator which yields Container objects. It handles pagination
for you, which can be adjusted via the limit argument. By default, the containers method will
yield as many containers as the service will return, and it will continue requesting until it receives no
more.
>>> for cont in conn.object_store.containers(limit=500):

... print(cont)
...
<500 Containers>
... another request transparently made to the Object Store service


<500 more Containers>
...
Creating Containers
To create a container, use the create_container() method.
>>> cont = conn.object_store.create_container(name="new container")

>>> cont
openstack.object_store.v1.container.Container: {'name': u'new container'}
Working with Container Metadata
To get the metadata for a container, use the get_container_metadata() method. This method
either takes the name of a container, or a Container object, and it returns a Container object with all
of its metadata attributes set.
>>> cont = conn.object_store.get_container_metadata("new container")

openstack.object_store.v1.container.Container: {'content-length': '0',
'x-container-object-count': '0', 'name': u'new container',
'accept-ranges': 'bytes',
'x-trans-id': 'tx22c5de63466e4c05bb104-0054740c39',
'date': 'Tue, 25 Nov 2014 04:57:29 GMT',
'x-timestamp': '1416889793.23520', 'x-container-read': '.r:mysite.com',
'x-container-bytes-used': '0', 'content-type': 'text/plain; charset=utf-8'}
To set the metadata for a container, use the set_container_metadata() method. This method
takes a Container object. For example, to grant another user write access to this container, you can
set the write_ACL on a resource and pass it to set_container_metadata.
>>> cont.write_ACL = "big_project:another_user"

>>> conn.object_store.set_container_metadata(cont)
openstack.object_store.v1.container.Container: {'content-length': '0',
'x-container-object-count': '0',
'name': u'my new container', 'accept-ranges': 'bytes',
'x-trans-id': 'txc3ee751f971d41de9e9f4-0054740ec1',
'date': 'Tue, 25 Nov 2014 05:08:17 GMT',
'x-timestamp': '1416889793.23520', 'x-container-read': '.r:mysite.com',
'x-container-bytes-used': '0', 'content-type': 'text/plain; charset=utf-8',
'x-container-write': 'big_project:another_user'}

Working with Objects
Objects are held in containers. From an API standpoint, you work with them using similarly named
methods, typically with an additional argument to specify their container.
Listing Objects
To list the objects that exist in a container, use the objects() method.
If you have a Container object, you can pass it to objects.
>>> print cont.name

pictures
>>> for obj in conn.object_store.objects(cont):
... print obj
...
openstack.object_store.v1.container.Object:
{u'hash': u'0522d4ccdf9956badcb15c4087a0c4cb',
u'name': u'pictures/selfie.jpg', u'bytes': 15744,
'last-modified': u'2014-10-31T06:33:36.618640',
u'last_modified': u'2014-10-31T06:33:36.618640',
u'content_type': u'image/jpeg', 'container': u'pictures',
'content-type': u'image/jpeg'}
...
Similar to the containers() method, objects returns a generator which yields Object objects
stored in the container. It also handles pagination for you, which you can adjust with the limit param-
eter, otherwise making each request for the maximum that your Object Store will return.
If you have the name of a container instead of an object, you can also pass that to the objects method.
>>> for obj in conn.object_store.objects("pictures".decode("utf8"),

limit=100):
... print obj
...
<100 Objects>
... another request transparently made to the Object Store service
<100 more Objects>
Getting Object Data
Once you have an Object, you get the data stored inside of it with the get_object_data()
method.
>>> print ob.name

message.txt
>>> data = conn.object_store.get_object_data(ob)
>>> print data
Hello, world!
Additionally, if you want to save the object to disk, the download_object() convenience method
takes an Object and a path to write the contents to.

>>> conn.object_store.download_object(ob, "the_message.txt")
Uploading Objects
Once you have data youd like to store in the Object Store service, you use the upload_object()
method. This method takes the data to be stored, along with at least an object name and the
container it is to be stored in.
>>> hello = conn.object_store.upload_object(container="messages",

name="helloworld.txt",
data="Hello, world!")
>>> print hello
openstack.object_store.v1.container.Object: {'content-length': '0',
'container': u'messages', 'name': u'helloworld.txt',
'last-modified': 'Tue, 25 Nov 2014 17:39:29 GMT',
'etag': '5eb63bbbe01eeed093cb22bb8f5acdc3',
'x-trans-id': 'tx3035d41b03334aeaaf3dd-005474bed0',
'date': 'Tue, 25 Nov 2014 17:39:28 GMT',
'content-type': 'text/html; charset=UTF-8'}
Working with Object Metadata
Working with metadata on objects is identical to how its done with containers. You use the
get_object_metadata() and set_object_metadata() methods.
The metadata attributes to be set can be found on the Object object.
>>> secret.delete_after = 300

>>> secret = conn.object_store.set_object_metadata(secret)
We set the delete_after value to 500 seconds, causing the object to be deleted in 300 seconds, or
five minutes. That attribute corresponds to the X-Delete-After header value, which you can see is
returned when we retrieve the updated metadata.
>>> conn.object_store.get_object_metadata(ob)
openstack.object_store.v1.container.Object: {'content-length': '11',
'container': u'Secret Container',
'name': u'selfdestruct.txt', 'x-delete-after': 300,
'accept-ranges': 'bytes', 'last-modified': 'Tue, 25 Nov 2014 17:50:45 GMT',
'etag': '5eb63bbbe01eeed093cb22bb8f5acdc3',
'x-timestamp': '1416937844.36805',
'x-trans-id': 'tx5c3fd94adf7c4e1b8f334-005474c17b',
'date': 'Tue, 25 Nov 2014 17:50:51 GMT', 'content-type': 'text/plain'}

Using OpenStack Orchestration
Before working with the Orchestration service, youll need to create a connection to your OpenStack
examples below.
2.1.3 API Documentation
Service APIs are exposed through a two-layered approach. The classes exposed through our Connection
interface are the place to start if youre an application developer consuming an OpenStack cloud. The
Resource interface is the layer upon which the Connection is built, with Connection methods accepting
and returning Resource objects.
The Cloud Abstraction layer has a data model.
Data Model
shade has a very strict policy on not breaking backwards compatability ever. However, with the data
structures returned from OpenStack, there are places where the resource structures from OpenStack
are returned to the user somewhat directly, leaving a shade user open to changes/differences in result
content.
To combat that, shade normalizes the return structure from OpenStack in many places, and the results of
that normalization are listed below. Where shade performs normalization, a user can count on any fields
declared in the docs as being completely safe to use - they are as much a part of shades API contract as
any other Python method.
Some OpenStack objects allow for arbitrary attributes at the root of the object. shade will pass those
through so as not to break anyone who may be counting on them, but as they are arbitrary shade can
make no guarantees as to their existence. As part of normalization, shade will put any attribute from an
OpenStack resource that is not in its data model contract into an attribute called properties. The contents
of properties are defined to be an arbitrary collection of key value pairs with no promises as to any
particular key ever existing.
If a user passes strict=True to the shade constructor, shade will not pass through arbitrary objects to the
root of the resource, and will instead only put them in the properties dict. If a user is worried about
accidentally writing code that depends on an attribute that is not part of the API contract, this can be a
useful tool. Keep in mind all data can still be accessed via the properties dict, but any code touching
anything in the properties dict should be aware that the keys found there are highly user/cloud specific.
Any key that is transformed as part of the shade data model contract will not wind up with an entry in
properties - only keys that are unknown.

Location
A Location defines where a resource lives. It includes a cloud name and a region name, an availability
zone as well as information about the project that owns the resource.
The project information may contain a project id, or a combination of one or more of a project name
with a domain name or id. If a project id is present, it should be considered correct.
Some resources do not carry ownership information with them. For those, the project information will
be filled in from the project the user currently has a token for.
Some resources do not have information about availability zones, or may exist region wide. Those
resources will have None as their availability zone.
If all of the project information is None, then
Location = dict(
cloud=str(),
region_name=str(),
zone=str() or None,
project=dict(
id=str() or None,
name=str() or None,
domain_id=str() or None,
domain_name=str() or None))
Resources
Flavor
A flavor for a Nova Server.
Flavor = dict(
location=Location(),
id=str(),
name=str(),
is_public=bool(),
is_disabled=bool(),
ram=int(),
vcpus=int(),
disk=int(),
ephemeral=int(),
swap=int(),
rxtx_factor=float(),
extra_specs=dict(),
properties=dict())

Flavor Access
An access entry for a Nova Flavor.
FlavorAccess = dict(
flavor_id=str(),
project_id=str())
Image
A Glance Image.
Image = dict(
id=str(),
name=str(),
min_ram=int(),
min_disk=int(),
size=int(),
virtual_size=int(),
container_format=str(),
disk_format=str(),
checksum=str(),
created_at=str(),
updated_at=str(),
owner=str(),
is_public=bool(),
is_protected=bool(),
visibility=str(),
status=str(),
locations=list(),
direct_url=str() or None,
tags=list(),
properties=dict())
Keypair
A keypair for a Nova Server.
Keypair = dict(
name=str(),
id=str(),
public_key=str(),
fingerprint=str(),
type=str(),
user_id=str(),
private_key=str() or None
properties=dict())

Security Group
A Security Group from either Nova or Neutron

SecurityGroup = dict(
id=str(),
name=str(),
description=str(),
security_group_rules=list(),
properties=dict())
Security Group Rule
A Security Group Rule from either Nova or Neutron

SecurityGroupRule = dict(
id=str(),
direction=str(), # oneof('ingress', 'egress')
ethertype=str(),
port_range_min=int() or None,
port_range_max=int() or None,
protocol=str() or None,
remote_ip_prefix=str() or None,
security_group_id=str() or None,
remote_group_id=str() or None
properties=dict())
Server
A Server from Nova

Server = dict(
id=str(),
name=str(),
image=dict() or str(),
flavor=dict(),
volumes=list(), # Volume
interface_ip=str(),
has_config_drive=bool(),
accessIPv4=str(),
accessIPv6=str(),
addresses=dict(), # string, list(Address)
created=str(),
created_at=str(),
key_name=str(),
metadata=dict(), # string, string
private_v4=str(),
progress=int(),
public_v4=str(),
public_v6=str(),


security_groups=list(), # SecurityGroup
status=str(),
updated=str(),
user_id=str(),
host_id=str() or None,
power_state=str() or None,
task_state=str() or None,
vm_state=str() or None,
launched_at=str() or None,
terminated_at=str() or None,
task_state=str() or None,
block_device_mapping=dict() or None,
instance_name=str() or None,
hypervisor_name=str() or None,
tags=list(),
personality=str() or None,
scheduler_hints=str() or None,
user_data=str() or None,
properties=dict())
ComputeLimits
Limits and current usage for a project in Nova
ComputeLimits = dict(
max_personality=int(),
max_personality_size=int(),
max_server_group_members=int(),
max_server_groups=int(),
max_server_meta=int(),
max_total_cores=int(),
max_total_instances=int(),
max_total_keypairs=int(),
max_total_ram_size=int(),
total_cores_used=int(),
total_instances_used=int(),
total_ram_used=int(),
total_server_groups_used=int(),
properties=dict())
ComputeUsage
Current usage for a project in Nova
ComputeUsage = dict(
started_at=str(),
stopped_at=str(),
server_usages=list(),
max_personality=int(),
max_personality_size=int(),


max_server_group_members=int(),
max_server_groups=int(),
max_server_meta=int(),
max_total_cores=int(),
max_total_instances=int(),
max_total_keypairs=int(),
max_total_ram_size=int(),
total_cores_used=int(),
total_hours=int(),
total_instances_used=int(),
total_local_gb_usage=int(),
total_memory_mb_usage=int(),
total_ram_used=int(),
total_server_groups_used=int(),
total_vcpus_usage=int(),
properties=dict())
ServerUsage
Current usage for a server in Nova
ComputeUsage = dict(
started_at=str(),
ended_at=str(),
flavor=str(),
hours=int(),
instance_id=str(),
local_gb=int(),
memory_mb=int(),
name=str(),
state=str(),
uptime=int(),
vcpus=int(),
properties=dict())
Floating IP
A Floating IP from Neutron or Nova
FloatingIP = dict(
id=str(),
description=str(),
attached=bool(),
fixed_ip_address=str() or None,
floating_ip_address=str() or None,
network=str() or None,
port=str() or None,
router=str(),
status=str(),
created_at=str() or None,
updated_at=str() or None,


revision_number=int() or None,
properties=dict())
Volume
A volume from cinder.
Volume = dict(
id=str(),
name=str(),
description=str(),
size=int(),
attachments=list(),
status=str(),
migration_status=str() or None,
host=str() or None,
replication_driver=str() or None,
replication_status=str() or None,
replication_extended_status=str() or None,
snapshot_id=str() or None,
created_at=str(),
source_volume_id=str() or None,
consistencygroup_id=str() or None,
volume_type=str() or None,
metadata=dict(),
is_bootable=bool(),
is_encrypted=bool(),
can_multiattach=bool(),
properties=dict())
VolumeType
A volume type from cinder.
VolumeType = dict(
id=str(),
name=str(),
description=str() or None,
is_public=bool(),
qos_specs_id=str() or None,
extra_specs=dict(),
properties=dict())

VolumeTypeAccess
A volume type access from cinder.
VolumeTypeAccess = dict(
volume_type_id=str(),
project_id=str(),
properties=dict())
ClusterTemplate
A Cluster Template from magnum.
ClusterTemplate = dict(
apiserver_port=int(),
cluster_distro=str(),
coe=str(),
created_at=str(),
dns_nameserver=str(),
docker_volume_size=int(),
external_network_id=str(),
fixed_network=str() or None,
flavor_id=str(),
http_proxy=str() or None,
https_proxy=str() or None,
id=str(),
image_id=str(),
insecure_registry=str(),
is_public=bool(),
is_registry_enabled=bool(),
is_tls_disabled=bool(),
keypair_id=str(),
labels=dict(),
master_flavor_id=str() or None,
name=str(),
network_driver=str(),
no_proxy=str() or None,
server_type=str(),
volume_driver=str(),
properties=dict())

MagnumService
A Magnum Service from magnum
MagnumService = dict(
binary=str(),
created_at=str(),
disabled_reason=str() or None,
host=str(),
id=str(),
report_count=int(),
state=str(),
properties=dict())
Stack
A Stack from Heat
Stack = dict(
id=str(),
name=str(),
created_at=str(),
deleted_at=str(),
updated_at=str(),
description=str(),
action=str(),
identifier=str(),
is_rollback_enabled=bool(),
notification_topics=list(),
outputs=list(),
owner=str(),
parameters=dict(),
parent=str(),
stack_user_project_id=str(),
status=str(),
status_reason=str(),
tags=dict(),
tempate_description=str(),
timeout_mins=int(),
properties=dict())
Identity Resources
Identity Resources are slightly different.

They are global to a cloud, so location.availability_zone and location.region_name and will always be
None. If a deployer happens to deploy OpenStack in such a way that users and projects are not shared
amongst regions, that necessitates treating each of those regions as separate clouds from shades POV.
The Identity Resources that are not Project do not exist within a Project, so all of the values in
location.project will be None.

Project
A Project from Keystone (or a tenant if Keystone v2)

Location information for Project has some additional specific semantics. If the project has a parent
project, that will be in location.project.id, and if it doesnt that should be None.
If the Project is associated with a domain that will be in location.project.domain_id in addi-
tion to the normal domain_id regardless of the current users token scope.
Project = dict(
id=str(),
name=str(),
description=str(),
is_enabled=bool(),
is_domain=bool(),
domain_id=str(),
properties=dict())
Role
A Role from Keystone
Project = dict(
id=str(),
name=str(),
domain_id=str(),
properties=dict())
Connection Interface
A Connection instance maintains your cloud config, session and authentication information providing
you with a set of higher-level interfaces to work with OpenStack services.
Connection
The Connection class is the primary interface to the Python SDK. It maintains a context for a con-
nection to a region of a cloud provider. The Connection has an attribute to access each OpenStack
service.
At a minimum, the Connection class needs to be created with a config or the parameters to build one.
While the overall system is very flexible, there are four main use cases for different ways to create a
Connection.
• Using config settings and keyword arguments as described in Configuring OpenStack SDK Appli-
cations
• Using only keyword arguments passed to the constructor ignoring config files and environment
variables.

• Using an existing authenticated keystoneauth1.session.Session, such as might exist inside of an

OpenStack service operational context.
• Using an existing CloudRegion.
Using config settings
For users who want to create a Connection making use of named clouds in clouds.yaml files,
OS_ environment variables and python keyword arguments, the openstack.connect() factory
function is the recommended way to go:
import openstack
conn = openstack.connect(cloud='example', region_name='earth1')
If the application in question is a command line application that should also accept command line ar-
guments, an argparse.Namespace can be passed to openstack.connect() that will have relevant
arguments added to it and then subsequently consumed by the constructor:
import argparse
import openstack
options = argparse.ArgumentParser(description='Awesome OpenStack App')

conn = openstack.connect(options=options)
Using Only Keyword Arguments
If the application wants to avoid loading any settings from clouds.yaml or environment variables,
use the Connection constructor directly. As long as the cloud argument is omitted or None, the
Connection constructor will not load settings from files or the environment.
Note: This is a different default behavior than the connect() factory function. In connect() if
cloud is omitted or None, a default cloud will be loaded, defaulting to the envvars cloud if it exists.
from openstack import connection
conn = connection.Connection(
region_name='example-region',
auth=dict(
auth_url='https://auth.example.com',
username='amazing-user',
password='super-secret-password',
project_id='33aa1afc-03fe-43b8-8201-4e0d3b4b8ab5',
user_domain_id='054abd68-9ad9-418b-96d3-3437bb376703'),
compute_api_version='2',
identity_interface='internal')
Per-service settings as needed by keystoneauth1.adapter.Adapter such as api_version,

service_name, and interface can be set, as seen above, by prefixing them with the offi-
cial service-type name of the service. region_name is a setting for the entire CloudRegion
and cannot be set per service.

From existing authenticated Session
For applications that already have an authenticated Session, simply passing it to the Connection
constructor is all that is needed:
session=session,
region_name='example-region',
compute_api_version='2',
identity_interface='internal')
From oslo.conf CONF object
For applications that have an oslo.config CONF object that has been populated with keystoneauth1.
loading.register_adapter_conf_options in groups named by the OpenStack services
project name, it is possible to construct a Connection with the CONF object and an authenticated Session.
Note: This is primarily intended for use by OpenStack services to talk amongst themselves.
session=session,
oslo_conf=CONF)
From existing CloudRegion
If you already have an CloudRegion you can pass it in instead:

config = openstack.config.get_cloud_region(
cloud='example', region_name='earth')
conn = connection.Connection(config=config)
Using the Connection
Services are accessed through an attribute named after the services official service-type.

List
An iterator containing a list of all the projects is retrieved in this manner:
projects = conn.identity.projects()
Find or create
If you wanted to make sure you had a network named zuul, you would first try to find it and if that fails,
you would create it:
network = conn.network.find_network("zuul")
if network is None:
network = conn.network.create_network(name="zuul")
Additional information about the services can be found in the Service Proxies documentation.
from_config
openstack.connection.from_config(cloud=None, config=None, options=None,

**kwargs)
Create a Connection using openstack.config
Parameters
• cloud (str) Use the cloud configuration details when creating the Connec-
tion.
• config (openstack.config.cloud_region.CloudRegion) An
existing CloudRegion configuration. If no config is provided, open-
stack.config.OpenStackConfig will be called, and the provided name will be
used in determining which clouds configuration details will be used in cre-
ation of the Connection instance.
• options (argparse.Namespace) Allows direct passing in of op-
tions to be added to the cloud config. This does not have to be an
actual instance of argparse.Namespace, despite the naming of the open-
stack.config.loader.OpenStackConfig.get_one argument to which it is passed.
Return type Connection

Connection Object
class openstack.connection.Connection(cloud=None, config=None, ses-

sion=None, app_name=None,
app_version=None, ex-
tra_services=None, strict=False,
use_direct_get=False,
task_manager=None, rate_limit=None,
oslo_conf=None, service_types=None,
global_request_id=None,
strict_proxies=False,
pool_executor=None, **kwargs)
Create a connection to a cloud.
A connection needs information about how to connect, how to authenticate and how to select the
appropriate services to use.
The recommended way to provide this information is by referencing a named cloud config from an
existing clouds.yaml file. The cloud name envvars may be used to consume a cloud configured
via OS_ environment variables.
A pre-existing CloudRegion object can be passed in lieu of a cloud name, for cases where the
user already has a fully formed CloudRegion and just wants to use it.
Similarly, if for some reason the user already has a Session and wants to use it, it may be passed
in.
Parameters
• cloud (str) Name of the cloud from config to use.
• config (CloudRegion) CloudRegion object representing the config for
the region of the cloud in question.
• session (Session) A session object compatible with Session.
• app_name (str) Name of the application to be added to User Agent.
• app_version (str) Version of the application to be added to User Agent.
• extra_services List of ServiceDescription objects describing
services that openstacksdk otherwise does not know about.
• use_direct_get (bool) For get methods, make specific REST calls for
server-side filtering instead of making list calls and filtering client-side. De-
fault false.
• task_manager Ignored. Exists for backwards compat during transition.
Rate limit parameters should be passed directly to the rate_limit parameter.
• rate_limit Client-side rate limit, expressed in calls per second. The pa-
rameter can either be a single float, or it can be a dict with keys as service-type
and values as floats expressing the calls per second for that service. Defaults
to None, which means no rate-limiting is performed.
• oslo_conf (ConfigOpts An oslo.config CONF object
that has been populated with keystoneauth1.loading.
register_adapter_conf_options in groups named by the
OpenStack services project name.) An oslo.config CONF object.

• service_types A list/set of service types this Connection should support.

All other service types will be disabled (will error if used). Currently only
supported in conjunction with the “oslo_conf“ kwarg.
• global_request_id A Request-id to send with all interactions.
• strict_proxies (bool Throw an openstack.exceptions.
ServiceDiscoveryException if the endpoint for a given service
doesnt work. This is useful for OpenStack services using sdk to talk to other
OpenStack services where it can be expected that the deployer config is
correct and errors should be reported immediately. Default false.) If True,
check proxies on creation and raise ServiceDiscoveryException if the service
is unavailable.
• pool_executor (Executor A futurist Executor object to be used for
concurrent background activities. Defaults to None in which case a Thread-
PoolExecutor will be created if needed.)
• kwargs If a config is not provided, the rest of the parameters provided are
assumed to be arguments to be passed to the CloudRegion constructor.
add_service(service)
Add a service to the Connection.
Attaches an instance of the Proxy class contained in ServiceDescription. The
Proxy will be attached to the Connection by its service_type and by any aliases
that may be specified.
Parameters service (openstack.service_description.
ServiceDescription) Object describing the service to be attached. As
a convenience, if service is a string it will be treated as a service_type
and a basic ServiceDescription will be created.
authorize()
Authorize this Connection
Note: This method is optional. When an application makes a call to any OpenStack service,
this method allows you to request a token manually before attempting to do anything else.
Returns A string token.

Raises HttpException if the authorization fails due to reasons like the creden-
tials provided are unable to be authorized or the auth_type argument is missing,
etc.
close()
Release any resources held open.
add_auto_ip(server, wait=False, timeout=60, reuse=True)
Add a floating IP to a server.
This method is intended for basic usage. For advanced network architecture (e.g. multiple
external networks or servers with multiple interfaces), use other floating IP methods.
This method can reuse available IPs, or allocate new IPs to the current project.

Parameters
• server a server dictionary.
• reuse Whether or not to attempt to reuse IPs, defaults to True.
• wait (optional) Wait for the address to appear as assigned to the server.
Defaults to False.
• timeout (optional) Seconds to wait, defaults to 60. See the wait param-
eter.
• reuse Try to reuse existing ips. Defaults to True.
Returns Floating IP address attached to server.
add_flavor_access(flavor_id, project_id)
Grant access to a private flavor for a project/tenant.
Parameters
• flavor_id (string) ID of the private flavor.
• project_id (string) ID of the project/tenant.
Raises OpenStackCloudException on operation error.
add_host_to_aggregate(name_or_id, host_name)
Add a host to an aggregate.
Parameters
• name_or_id Name or ID of the host aggregate.
• host_name Host to add.
add_ip_list(server, ips, wait=False, timeout=60, fixed_address=None)
Attach a list of IPs to a server.
Parameters
• server a server object
• ips list of floating IP addresses or a single address
Defaults to False.
eter.
• fixed_address (optional) Fixed address of the server to attach the IP to
Returns The updated server munch.Munch
Raises OpenStackCloudException, on operation error.
add_router_interface(router, subnet_id=None, port_id=None)
Attach a subnet to an internal router interface.
Either a subnet ID or port ID must be specified for the internal interface. Supplying both
will result in an error.

Parameters
• router (dict) The dict object of the router being changed
• subnet_id (string) The ID of the subnet to use for the interface
• port_id (string) The ID of the port to use for the interface
Returns A munch.Munch with the router ID (ID), subnet ID (subnet_id), port
ID (port_id) and tenant ID (tenant_id).
add_server_security_groups(server, security_groups)
Add security groups to a server.
Add existing security groups to an existing server. If the security groups are already present
on the server this will continue unaffected.
Returns False if server or security groups are undefined, True otherwise.
add_user_to_group(name_or_id, group_name_or_id)
Add a user to a group.
Parameters
• name_or_id (string) User name or ID
• group_name_or_id (string) Group name or ID
Raises OpenStackCloudException if something goes wrong during the
OpenStack API call
add_volume_type_access(name_or_id, project_id)
Grant access on a volume_type to a project.
Parameters
• name_or_id ID or name of a volume_type
• project_id A project id
NOTE: the call works even if the project does not exist.
attach_port_to_machine(name_or_id, port_name_or_id)
Attach a virtual port to the bare metal machine.
Parameters
• name_or_id (string) A machine name or UUID.
• port_name_or_id (string) A port name or UUID. Note that this is a
Network service port, not a bare metal NIC.
Returns Nothing.
attach_volume(server, volume, device=None, wait=True, timeout=None)
Attach a volume to a server.

This will attach a volume, described by the passed in volume dict (as returned by
get_volume()), to the server described by the passed in server dict (as returned by
get_server()) on the named device on the server.
If the volume is already attached to the server, or generally not available, then an exception
is raised. To re-attach to a server, but under a different device, the user must detach it first.
Parameters
• server The server dict to attach to.
• volume The volume dict to attach.
• device The device name where the volume will attach.
• wait If true, waits for volume to be attached.
• timeout Seconds to wait for volume attachment. None is forever.
Returns a volume attachment object.
Raises OpenStackCloudTimeout if wait time exceeded.
available_floating_ip(network=None, server=None)
Get a floating IP from a network or a pool.
Return the first available floating IP or allocate a new one.
Parameters
• network Name or ID of the network.
• server Server the IP is for if known
Returns a (normalized) structure with a floating IP address description.
bind_accelerator_request(uuid, properties)
Bind an accelerator to VM. :param uuid: The uuid of the accelerator_request to be binded.
:param properties: The info of VM that will bind the accelerator. :returns: True if bind
succeeded, False otherwise.
connect_as(**kwargs)
Make a new OpenStackCloud object with new auth context.
Take the existing settings from the current cloud and construct a new OpenStackCloud object
with some of the auth settings overridden. This is useful for getting an object to perform tasks
with as another user, or in the context of a different project.
conn = openstack.connect(cloud='example')
# Work normally
servers = conn.list_servers()
conn2 = conn.connect_as(username='different-user', password='')
# Work as different-user
servers = conn2.list_servers()
Parameters kwargs keyword arguments can contain anything that would nor-
mally go in an auth dict. They will override the same settings from the parent
cloud as appropriate. Entries that do not want to be overridden can be ommit-
ted.

connect_as_project(project)
Make a new OpenStackCloud object with a new project.
Take the existing settings from the current cloud and construct a new OpenStackCloud object
with the project settings overridden. This is useful for getting an object to perform tasks with
as another user, or in the context of a different project.
cloud = openstack.connect(cloud='example')
# Work normally
servers = cloud.list_servers()
cloud2 = cloud.connect_as_project('different-project')
# Work in different-project
servers = cloud2.list_servers()
Parameters project Either a project name or a project dict as returned by

list_projects.
create_accelerator_request(attrs)
Create an accelerator_request. :param attrs: The info of accelerator_request to be created.
:returns: A munch.Munch of the created accelerator_request.
create_aggregate(name, availability_zone=None)
Create a new host aggregate.
Parameters
• name Name of the host aggregate being created
• availability_zone Availability zone to assign hosts
Returns a dict representing the new host aggregate.
create_baymodel(name, image_id=None, keypair_id=None, coe=None, **kwargs)
Create a cluster template.
Parameters
• name (string) Name of the cluster template.
• image_id (string) Name or ID of the image to use.
• keypair_id (string) Name or ID of the keypair to use.
• coe (string) Name of the coe for the cluster template.
Other arguments will be passed in kwargs.
Returns a dict containing the cluster template description
OpenStack API call
create_cluster_template(name, image_id=None, keypair_id=None, coe=None,
**kwargs)
Parameters


OpenStack API call
create_coe_cluster(name, cluster_template_id, **kwargs)
Create a COE cluster based on given cluster template.
Parameters
• name (string) Name of the cluster.
• image_id (string) ID of the cluster template to use.
Returns a dict containing the cluster description
OpenStack API call
create_coe_cluster_template(name, image_id=None, keypair_id=None,
coe=None, **kwargs)
Parameters
OpenStack API call
create_container(name, public=False)
Create an object-store container.
Parameters
• name (str) Name of the container to create.
• public (bool) Whether to set this container to be public. Defaults to
False.
create_device_profile(attrs)
Create a device_profile. :param attrs: The info of device_profile to be created. :returns: A
munch.Munch of the created device_profile.

create_directory_marker_object(container, name, **headers)

Create a zero-byte directory marker object
Note: This method is not needed in most cases. Modern swift does not require directory
marker objects. However, some swift installs may need these.
When using swift Static Web and Web Listings to serve static content one may need to create
a zero-byte object to represent each directory. Doing so allows Web Listings to generate an
index of the objects inside of it, and allows Static Web to render index.html files that are
inside the directory.
Parameters
• container The name of the container.
• name Name for the directory marker object within the container.
• headers These will be passed through to the object creation API as HTTP
Headers.
create_domain(name, description=None, enabled=True)
Create a domain.
Parameters
• name The name of the domain.
• description A description of the domain.
• enabled Is the domain enabled or not (default True).
Returns a munch.Munch containing the domain representation.
Raises OpenStackCloudException if the domain cannot be created.
create_endpoint(service_name_or_id, url=None, interface=None, region=None, en-
abled=True, **kwargs)
Create a Keystone endpoint.
Parameters
• service_name_or_id Service name or id for this endpoint.
• url URL of the endpoint
• interface Interface type of the endpoint
• public_url Endpoint public URL.
• internal_url Endpoint internal URL.
• admin_url Endpoint admin URL.
• region Endpoint region.
• enabled Whether the endpoint is enabled
NOTE: Both v2 (public_url, internal_url, admin_url) and v3 (url, interface) calling se-
mantics are supported. But you can only use one of them at a time.
Returns a list of munch.Munch containing the endpoint description

Raises OpenStackCloudException if the service cannot be found or if something

goes wrong during the OpenStack API call.
create_firewall_group(**kwargs)
Creates firewall group. The keys egress_firewall_policy and ingress_firewall_policy are
looked up and mapped as egress_firewall_policy_id and ingress_firewall_policy_id respec-
tively. Port name or ids list is transformed to port ids list before the POST request.
Parameters
• admin_state_up (bool) State of firewall group. Will block all traffic
if set to False. Defaults to True.
• description Human-readable description.
• egress_firewall_policy Name or id of egress firewall policy.
• ingress_firewall_policy Name or id of ingress firewall policy.
• name Human-readable name.
• ports (list[str]) List of associated ports (name or id)
• project_id Project id.
• shared Visibility to other projects. Defaults to False.
Raises BadRequestException if parameters are malformed
Raises DuplicateResource on multiple matches
Raises ResourceNotFound if (ingress-, egress-) firewall policy or a port is not
found.
Returns created firewall group
Return type FirewallGroup
create_firewall_policy(**kwargs)
Create firewall policy.
Parameters
• audited (bool) Status of audition of firewall policy. Set to False each
time the firewall policy or the associated firewall rules are changed. Has to
be explicitly set to True.
• firewall_rules (list[str]) List of associated firewall rules.
• shared (bool) Visibility to other projects. Defaults to False.
Raises ResourceNotFound if a resource from firewall_list not found
Returns created firewall policy
Return type FirewallPolicy

create_firewall_rule(**kwargs)
Creates firewall rule.
Parameters
• action Action performed on traffic. Valid values: allow, deny Defaults to
deny.
• destination_firewall_group_id ID of destination firewall
group.
• destination_ip_address IPv4-, IPv6 address or CIDR.
• destination_port Port or port range (e.g. 80:90)
• enabled (bool) Status of firewall rule. You can disable rules without
disassociating them from firewall policies. Defaults to True.
• ip_version (int) IP Version. Valid values: 4, 6 Defaults to 4.
• protocol IP protocol. Valid values: icmp, tcp, udp, null
• shared (bool) Visibility to other projects. Defaults to False.
• source_firewall_group_id ID of source firewall group.
• source_ip_address IPv4-, IPv6 address or CIDR.
• source_port Port or port range (e.g. 80:90)
Returns created firewall rule
Return type FirewallRule
create_flavor(name, ram, vcpus, disk, flavorid=’auto’, ephemeral=0, swap=0,
rxtx_factor=1.0, is_public=True)
Create a new flavor.
Parameters
• name Descriptive name of the flavor
• ram Memory in MB for the flavor
• vcpus Number of VCPUs for the flavor
• disk Size of local disk in GB
• flavorid ID for the flavor (optional)
• ephemeral Ephemeral space size in GB
• swap Swap space in MB
• rxtx_factor RX/TX factor
• is_public Make flavor accessible to the public

Returns A munch.Munch describing the new flavor.

create_floating_ip(network=None, server=None, fixed_address=None,
nat_destination=None, port=None, wait=False, timeout=60)
Allocate a new floating IP from a network or a pool.
Parameters
• network Name or ID of the network that the floating IP should come
from.
• server (optional) Server dict for the server to create the IP for and to
which it should be attached.
• fixed_address (optional) Fixed IP to attach the floating ip to.
• nat_destination (optional) Name or ID of the network that the fixed
IP to attach the floating IP to should be on.
• port (optional) The port ID that the floating IP should be attached
to. Specifying a port conflicts with specifying a server, fixed_address or
nat_destination.
• wait (optional) Whether to wait for the IP to be active. Defaults to False.
Only applies if a server is provided.
• timeout (optional) How long to wait for the IP to be active. Defaults to
60. Only applies if a server is provided.
Returns a floating IP address
create_group(name, description, domain=None)
Create a group.
Parameters
• name (string) Group name.
• description (string) Group description.
• domain (string) Domain name or ID for the group.
Returns A munch.Munch containing the group description.
Raises OpenStackCloudException: if something goes wrong during the
OpenStack API call.
create_image(name, filename=None, container=None, md5=None,
sha256=None, disk_format=None, container_format=None,
disable_vendor_agent=True, wait=False, timeout=3600, al-
low_duplicates=False, meta=None, volume=None, **kwargs)
Upload an image.
Parameters
• name (str) Name of the image to create. If it is a pathname of an image,
the name will be constructed from the extensionless basename of the path.

• filename (str) The path to the file to upload, if needed. (optional,

defaults to None)
• container (str) Name of the container in swift where images should
be uploaded for import if the cloud requires such a thing. (optiona, defaults
to images)
• md5 (str) md5 sum of the image file. If not given, an md5 will be calcu-
lated.
• sha256 (str) sha256 sum of the image file. If not given, an md5 will be
calculated.
• disk_format (str) The disk format the image is in. (optional, defaults
to the os-client-config config value for this cloud)
• container_format (str) The container format the image is in. (op-
tional, defaults to the os-client-config config value for this cloud)
• disable_vendor_agent (bool) Whether or not to append metadata
flags to the image to inform the cloud in question to not expect a vendor
agent to be runing. (optional, defaults to True)
• wait (bool) If true, waits for image to be created. Defaults to true -
however, be aware that one of the upload methods is always synchronous.
• timeout Seconds to wait for image creation. None is forever.
• allow_duplicates If true, skips checks that enforce unique image
name. (optional, defaults to False)
• meta A dict of key/value pairs to use for metadata that bypasses automatic
type conversion.
• volume Name or ID or volume object of a volume to create an image from.
Mutually exclusive with (optional, defaults to None)
Additional kwargs will be passed to the image creation as additional metadata for the im-
age and will have all values converted to string except for min_disk, min_ram, size and
virtual_size which will be converted to int.
If you are sure you have all of your data types correct or have an advanced need to be explicit,
use meta. If you are just a normal consumer, using kwargs is likely the right choice.
If a value is in meta and kwargs, meta wins.
Returns A munch.Munch of the Image object
Raises OpenStackCloudException if there are problems uploading
create_image_snapshot(name, server, wait=False, timeout=3600, **metadata)
Create an image by snapshotting an existing server.
..note:: On most clouds this is a cold snapshot - meaning that the server in question will be
shutdown before taking the snapshot. It is possible that its a live snapshot - but there is
no way to know as a user, so caveat emptor.
Parameters
• name Name of the image to be created

• server Server name or ID or dict representing the server to be snapshotted

• wait If true, waits for image to be created.
• metadata Metadata to give newly-created image entity
Raises OpenStackCloudException if there are problems uploading
create_keypair(name, public_key=None)
Create a new keypair.
Parameters
• name Name of the keypair being created.
• public_key Public key for the new keypair.
create_network(name, shared=False, admin_state_up=True, external=False,
provider=None, project_id=None, availability_zone_hints=None,
port_security_enabled=None, mtu_size=None, dns_domain=None)
Create a network.
Parameters
• name (string) Name of the network being created.
• shared (bool) Set the network as shared.
• admin_state_up (bool) Set the network administrative state to up.
• external (bool) Whether this network is externally accessible.
• provider (dict) A dict of network provider options. Example:
{ 'network_type': 'vlan', 'segmentation_id': 'vlan1' }
• project_id (string) Specify the project ID this network will be cre-

ated on (admin-only).
• availability_zone_hints (types.ListType) A list of avail-
ability zone hints.
• port_security_enabled (bool) Enable / Disable port security
• mtu_size (int) maximum transmission unit value to address fragmen-
tation. Minimum value is 68 for IPv4, and 1280 for IPv6.
• dns_domain (string) Specify the DNS domain associated with this
network.
Returns The network object.
create_object(container, name, filename=None, md5=None, sha256=None,
segment_size=None, use_slo=True, metadata=None, gener-
ate_checksums=None, data=None, **headers)
Create a file object.

Automatically uses large-object segments if needed.

Parameters
• container The name of the container to store the file in. This container
will be created if it does not exist already.
• name Name for the object within the container.
• filename The path to the local file whose contents will be uploaded.
Mutually exclusive with data.
• data The content to upload to the object. Mutually exclusive with file-
name.
• md5 A hexadecimal md5 of the file. (Optional), if it is known and can be
passed here, it will save repeating the expensive md5 process. It is assumed
to be accurate.
• sha256 A hexadecimal sha256 of the file. (Optional) See md5.
• segment_size Break the uploaded object into segments of this many
bytes. (Optional) Shade will attempt to discover the maximum value for this
from the server if it is not specified, or will use a reasonable default.
Headers.
• use_slo If the object is large enough to need to be a Large Object, use a
static rather than dynamic object. Static Objects will delete segment objects
when the manifest object is deleted. (optional, defaults to True)
• generate_checksums Whether to generate checksums on the client
side that get added to headers for later prevention of double uploads of iden-
tical data. (optional, defaults to True)
• metadata This dict will get changed into headers that set metadata of the
object
create_port(network_id, **kwargs)
Create a port
Parameters
• network_id The ID of the network. (Required)
• name A symbolic name for the port. (Optional)
• admin_state_up The administrative status of the port, which is up (true,
default) or down (false). (Optional)
• mac_address The MAC address. (Optional)
• fixed_ips List of ip_addresses and subnet_ids. See subnet_id and
ip_address. (Optional) For example:
[
{
"ip_address": "10.29.29.13",


"subnet_id": "a78484c4-c380-4b47-85aa-21c51a2d8cbd"
}, ...
]
• subnet_id If you specify only a subnet ID, OpenStack Networking allo-

cates an available IP from that subnet to the port. (Optional) If you specify
both a subnet ID and an IP address, OpenStack Networking tries to allocate
the specified address to the port.
• ip_address If you specify both a subnet ID and an IP address, Open-
Stack Networking tries to allocate the specified address to the port.
• security_groups List of security group UUIDs. (Optional)
• allowed_address_pairs Allowed address pairs list (Optional) For
example:
[
{
"ip_address": "23.23.23.1",
"mac_address": "fa:16:3e:c4:cd:3f"
}, ...
]
• extra_dhcp_opts Extra DHCP options. (Optional). For example:
[
{
"opt_name": "opt name1",
"opt_value": "value1"
}, ...
]
• device_owner The ID of the entity that uses this port. For example, a
DHCP agent. (Optional)
• device_id The ID of the device that uses this port. For example, a virtual
server. (Optional)
• vnic_type (binding) The type of the created port. (Optional)
• port_security_enabled The security port state created on the net-
work. (Optional)
• qos_policy_id The ID of the QoS policy to apply for port.
Returns a munch.Munch describing the created port.
create_project(name, description=None, domain_id=None, enabled=True)
Create a project.
create_qos_bandwidth_limit_rule(policy_name_or_id, max_kbps, **kwargs)
Create a QoS bandwidth limit rule.
Parameters

• policy_name_or_id (string) Name or ID of the QoS policy to

which rule should be associated.
• max_kbps (int) Maximum bandwidth limit value (in kilobits per sec-
ond).
• max_burst_kbps (int) Maximum burst value (in kilobits).
• direction (string) Ingress or egress. The direction in which the traf-
fic will be limited.
Returns The QoS bandwidth limit rule.
create_qos_dscp_marking_rule(policy_name_or_id, dscp_mark)
Create a QoS DSCP marking rule.
Parameters
• dscp_mark (int) DSCP mark value
Returns The QoS DSCP marking rule.
create_qos_minimum_bandwidth_rule(policy_name_or_id, min_kbps,
**kwargs)
Create a QoS minimum bandwidth limit rule.
Parameters
• min_kbps (int) Minimum bandwidth value (in kilobits per second).
fic will be available.
Returns The QoS minimum bandwidth rule.
create_qos_policy(**kwargs)
Create a QoS policy.
Parameters
• name (string) Name of the QoS policy being created.
• description (string) Description of created QoS policy.
• shared (bool) Set the QoS policy as shared.
• default (bool) Set the QoS policy as default for project.
• project_id (string) Specify the project ID this QoS policy will be
created on (admin-only).
Returns The QoS policy object.


create_recordset(zone, name, recordset_type, records, description=None,
ttl=None)
Create a recordset.
Parameters
• zone Name, ID or openstack.dns.v2.zone.Zone instance of the
zone managing the recordset.
• name Name of the recordset
• recordset_type Type of the recordset
• records List of the recordset definitions
• description Description of the recordset
• ttl TTL value of the recordset
Returns a dict representing the created recordset.
create_role(name, **kwargs)
Create a Keystone role.
Parameters
• name (string) The name of the role.
• domain_id domain id (v3)
Returns a munch.Munch containing the role description
Raises OpenStackCloudException if the role cannot be created
create_router(name=None, admin_state_up=True, ext_gateway_net_id=None, en-
able_snat=None, ext_fixed_ips=None, project_id=None, availabil-
ity_zone_hints=None)
Create a logical router.
Parameters
• name (string) The router name.
• admin_state_up (bool) The administrative state of the router.
• ext_gateway_net_id (string) Network ID for the external gate-
way.
• enable_snat (bool) Enable Source NAT (SNAT) attribute.
• ext_fixed_ips List of dictionaries of desired IP and/or subnet on the
external network. Example:
[
{
"subnet_id": "8ca37218-28ff-41cb-9b10-039601ea7e6b
,→ ",
"ip_address": "192.168.10.2"
}
]

• project_id (string) Project ID for the router.

• availability_zone_hints (types.ListType) A list of avail-
ability zone hints.
Returns The router object.
create_security_group(name, description, project_id=None, stateful=None)
Create a new security group
Parameters
• name (string) A name for the security group.
• description (string) Describes the security group.
• project_id (string) Specify the project ID this security group will
be created on (admin-only).
• stateful (string) Whether the security group is stateful or not.
Returns A munch.Munch representing the new security group.
Raises OpenStackCloudUnavailableFeature if security groups are not supported
on this cloud.
create_security_group_rule(secgroup_name_or_id, port_range_min=None,
port_range_max=None, protocol=None, re-
mote_ip_prefix=None, remote_group_id=None,
direction=’ingress’, ethertype=’IPv4’,
project_id=None)
Create a new security group rule
Parameters
• secgroup_name_or_id (string) The security group name or ID to
associate with this security group rule. If a non-unique group name is given,
an exception is raised.
• port_range_min (int) The minimum port number in the range that is
matched by the security group rule. If the protocol is TCP or UDP, this value
must be less than or equal to the port_range_max attribute value. If nova is
used by the cloud provider for security groups, then a value of None will be
transformed to -1.
• port_range_max (int) The maximum port number in the range that
is matched by the security group rule. The port_range_min attribute con-
strains the port_range_max attribute. If nova is used by the cloud provider
for security groups, then a value of None will be transformed to -1.
• protocol (string) The protocol that is matched by the security group
rule. Valid values are None, tcp, udp, and icmp.
• remote_ip_prefix (string) The remote IP prefix to be associated
with this security group rule. This attribute matches the specified IP prefix
as the source IP address of the IP packet.

• remote_group_id (string) The remote group ID to be associated

with this security group rule.
• direction (string) Ingress or egress: The direction in which the secu-
rity group rule is applied. For a compute instance, an ingress security group
rule is applied to incoming (ingress) traffic for that instance. An egress rule
is applied to traffic leaving the instance.
• ethertype (string) Must be IPv4 or IPv6, and addresses represented
in CIDR must match the ingress or egress rules.
• project_id (string) Specify the project ID this security group will
be created on (admin-only).
Returns A munch.Munch representing the new security group rule.
create_server(name, image=None, flavor=None, auto_ip=True, ips=None,
ip_pool=None, root_volume=None, terminate_volume=False,
wait=False, timeout=180, reuse_ips=True, network=None,
boot_from_volume=False, volume_size=’50’, boot_volume=None,
volumes=None, nat_destination=None, group=None, **kwargs)
Create a virtual server instance.
Parameters
• name Something to name the server.
• image Image dict, name or ID to boot with. image is required unless
boot_volume is given.
• flavor Flavor dict, name or ID to boot onto.
• auto_ip Whether to take actions to find a routable IP for the server. (de-
faults to True)
• ips List of IPs to attach to the server (defaults to None)
• ip_pool Name of the network or floating IP pool to get an address from.
(defaults to None)
• root_volume Name or ID of a volume to boot from (defaults to None -
deprecated, use boot_volume)
• boot_volume Name or ID of a volume to boot from (defaults to None)
• terminate_volume If booting from a volume, whether it should be
deleted when the server is destroyed. (defaults to False)
• volumes (optional) A list of volumes to attach to the server
• meta (optional) A dict of arbitrary key/value metadata to store for this
server. Both keys and values must be <=255 characters.
• files (optional, deprecated) 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 in-
ject into the instance.
• availability_zone Name of the availability zone for instance place-
ment.
• block_device_mapping (optional) A dict of block device mappings
for this server.
• block_device_mapping_v2 (optional) A dict of block device map-
pings 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 speci-
fied 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.
Defaults to False.
eter.
• reuse_ips (optional) Whether to attempt to reuse pre-existing floating
ips should a floating IP be needed (defaults to True)
• network (optional) Network dict or name or ID to attach the server to.
Mutually exclusive with the nics parameter. Can also be a list of network
names or IDs or network dicts.
• boot_from_volume Whether to boot from volume. boot_volume im-
plies True, but boot_from_volume=True with no boot_volume is valid and
will create a volume from the image and use that.
• volume_size When booting an image from volume, how big should the
created volume be? Defaults to 50.
• nat_destination Which network should a created floating IP be at-
tached to, if its not possible to infer from the clouds configuration. (Op-
tional, defaults to None)

• group ServerGroup dict, name or id to boot the server in. If a group is

provided in both scheduler_hints and in the group param, the group param
will win. (Optional, defaults to None)
Returns A munch.Munch representing the created server.
create_server_group(name, policies=[], policy=None)
Create a new server group.
Parameters
• name Name of the server group being created
• policies List of policies for the server group.
Returns a dict representing the new server group.
create_service(name, enabled=True, **kwargs)
Create a service.
Parameters
• name Service name.
• type Service type. (type or service_type required.)
• service_type Service type. (type or service_type required.)
• description Service description (optional).
• enabled Whether the service is enabled (v3 only)
Returns a munch.Munch containing the services description, i.e. the following
attributes:: - id: <service id> - name: <service name> - type: <service type> -
service_type: <service type> - description: <service description>
OpenStack API call.
create_stack(name, tags=None, template_file=None, template_url=None, tem-
plate_object=None, files=None, rollback=True, wait=False, time-
out=3600, environment_files=None, **parameters)
Create a stack.
Parameters
• name (string) Name of the stack.
• tags List of tag(s) of the stack. (optional)
• template_file (string) Path to the template.
• template_url (string) URL of template.
• template_object (string) URL to retrieve template object.
• files (dict) dict of additional file content to include.
• rollback (boolean) Enable rollback on create failure.
• wait (boolean) Whether to wait for the delete to finish.

• timeout (int) Stack create timeout in seconds.

• environment_files Paths to environment files to apply.
Other arguments will be passed as stack parameters which will take precedence over any
parameters specified in the environments.
Only one of template_file, template_url, template_object should be specified.
Returns a dict containing the stack description
OpenStack API call
create_subnet(network_name_or_id, cidr=None, ip_version=4, enable_dhcp=False,
subnet_name=None, tenant_id=None, allocation_pools=None, gate-
way_ip=None, disable_gateway_ip=False, dns_nameservers=None,
host_routes=None, ipv6_ra_mode=None, ipv6_address_mode=None,
prefixlen=None, use_default_subnetpool=False, **kwargs)
Create a subnet on a specified network.
Parameters
• network_name_or_id (string) The unique name or ID of the at-
tached network. If a non-unique name is supplied, an exception is raised.
• cidr (string) The CIDR.
• ip_version (int) The IP version, which is 4 or 6.
• enable_dhcp (bool) Set to True if DHCP is enabled and False if
disabled. Default is False.
• subnet_name (string) The name of the subnet.
• tenant_id (string) The ID of the tenant who owns the network. Only
administrative users can specify a tenant ID other than their own.
• allocation_pools A list of dictionaries of the start and end addresses
for the allocation pools. For example:
[
{
"start": "192.168.199.2",
"end": "192.168.199.254"
}
]
• gateway_ip (string) The gateway IP address. When you specify both

allocation_pools and gateway_ip, you must ensure that the gateway IP does
not overlap with the specified allocation pools.
• disable_gateway_ip (bool) Set to True if gateway IP address is
disabled and False if enabled. It is not allowed with gateway_ip. Default
is False.
• dns_nameservers A list of DNS name servers for the subnet. For ex-
ample:
[ "8.8.8.7", "8.8.8.8" ]

• host_routes A list of host route dictionaries for the subnet. For exam-
ple:
[
{
"destination": "0.0.0.0/0",
"nexthop": "123.456.78.9"
},
{
"destination": "192.168.0.0/24",
"nexthop": "192.168.0.1"
}
]
• ipv6_ra_mode (string) IPv6 Router Advertisement mode. Valid val-

ues are: dhcpv6-stateful, dhcpv6-stateless, or slaac.
• ipv6_address_mode (string) IPv6 address mode. Valid values are:
dhcpv6-stateful, dhcpv6-stateless, or slaac.
• prefixlen (string) The prefix length to use for subnet allocation from
a subnet pool.
• use_default_subnetpool (bool) Use the default subnetpool for
ip_version to obtain a CIDR. It is required to pass None to the cidr
argument when enabling this option.
• kwargs Key value pairs to be passed to the Neutron API.
Returns The new subnet object.
create_user(name, password=None, email=None, default_project=None, en-
abled=True, domain_id=None, description=None)
Create a user.
create_volume(size, wait=True, timeout=None, image=None, bootable=None,
**kwargs)
Create a volume.
Parameters
• size Size, in GB of the volume to create.
• name (optional) Name for the volume.
• description (optional) Name for the volume.
• wait If true, waits for volume to be created.
• timeout Seconds to wait for volume creation. None is forever.
• image (optional) Image name, ID or object from which to create the vol-
ume
• bootable (optional) Make this volume bootable. If set, wait will also be
set to true.
• kwargs Keyword arguments as expected for cinder client.
Returns The created volume object.


create_volume_backup(volume_id, name=None, description=None, force=False,
wait=True, timeout=None, incremental=False, snap-
shot_id=None)
Create a volume backup.
Parameters
• volume_id the ID of the volume to backup.
• name name of the backup, one will be generated if one is not provided
• description description of the backup, one will be generated if one is
not provided
• force If set to True the backup will be created even if the volume is
attached to an instance, if False it will not
• wait If true, waits for volume backup to be created.
• timeout Seconds to wait for volume backup creation. None is forever.
• incremental If set to true, the backup will be incremental.
• snapshot_id The UUID of the source snapshot to back up.
Returns The created volume backup object.
create_volume_snapshot(volume_id, force=False, wait=True, timeout=None,
**kwargs)
Create a volume.
Parameters
• volume_id the ID of the volume to snapshot.
• force If set to True the snapshot will be created even if the volume is
attached to an instance, if False it will not
• name name of the snapshot, one will be generated if one is not provided
• description description of the snapshot, one will be generated if one is
not provided
• wait If true, waits for volume snapshot to be created.
• timeout Seconds to wait for volume snapshot creation. None is forever.
Returns The created volume object.
create_zone(name, zone_type=None, email=None, description=None, ttl=None, mas-
ters=None)
Create a new zone.

Parameters
• name Name of the zone being created.
• zone_type Type of the zone (primary/secondary)
• email Email of the zone owner (only applies if zone_type is primary)
• description Description of the zone
• ttl TTL (Time to live) value in seconds
• masters Master nameservers (only applies if zone_type is secondary)
Returns a dict representing the created zone.
property current_location
Return a munch.Munch explaining the current cloud location.
property current_project
Return a munch.Munch describing the current project
property current_project_id
Get the current project ID.
Returns the project_id of the current token scope. None means that the token is domain
scoped or unscoped.
Raises
• keystoneauth1.exceptions.auth.AuthorizationFailure
if a new token fetch fails.
• keystoneauth1.exceptions.auth_plugins.
MissingAuthPlugin if a plugin is not available.
property current_user_id
Get the id of the currently logged-in user from the token.
delete_accelerator_request(name_or_id, filters)
Delete a accelerator_request. :param name_or_id: The Name(or uuid) of accelera-
tor_request. :param filters: dict of filter conditions to push down :returns: True if delete
succeeded, False otherwise.
delete_aggregate(name_or_id)
Delete a host aggregate.
Parameters name_or_id Name or ID of the host aggregate to delete.
Returns True if delete succeeded, False otherwise.
delete_autocreated_image_objects(container=None, segment_prefix=None)
Delete all objects autocreated for image uploads.
This method should generally not be needed, as shade should clean up the objects it uses for
object-based image creation. If something goes wrong and it is found that there are leaked
objects, this method can be used to delete any objects that shade has created on the users
behalf in service of image uploads.

Parameters
• container (str) Name of the container. Defaults to images.
• segment_prefix (str) Prefix for the image segment names to delete.
If not given, all image upload segments present are deleted.
delete_baymodel(name_or_id)
Delete a cluster template.
Parameters name_or_id Name or unique ID of the cluster template.
Returns True if the delete succeeded, False if the cluster template was not found.
delete_cluster_template(name_or_id)
delete_coe_cluster(name_or_id)
Delete a COE cluster.
Parameters name_or_id Name or unique ID of the cluster.
Returns True if the delete succeeded, False if the cluster was not found.
delete_coe_cluster_template(name_or_id)
delete_compute_quotas(name_or_id)
Delete quota for a project
Parameters name_or_id project name or id
Raises OpenStackCloudException if its not a valid project or the nova client call
failed
Returns dict with the quotas
delete_container(name)
Delete an object-store container.
Parameters name (str) Name of the container to delete.
delete_device_profile(name_or_id, filters)
Delete a device_profile. :param name_or_id: The Name(or uuid) of device_profile to be
deleted. :param filters: dict of filter conditions to push down :returns: True if delete suc-
ceeded, False otherwise.

delete_domain(domain_id=None, name_or_id=None)
Delete a domain.
Parameters
• domain_id ID of the domain to delete.
• name_or_id Name or ID of the domain to delete.
OpenStack API call.
delete_endpoint(id)
Delete a Keystone endpoint.
Parameters id Id of the endpoint to delete.
OpenStack API call.
delete_firewall_group(name_or_id, filters=None)
Deletes firewall group. Prints debug message in case to-be-deleted resource was not found.
Parameters
• name_or_id firewall group name or id
• filters (dict) optional filters
Returns True if resource is successfully deleted, False otherwise.
Return type bool
delete_firewall_policy(name_or_id, filters=None)
Deletes firewall policy. Prints debug message in case to-be-deleted resource was not found.
Parameters
• name_or_id firewall policy name or id
Return type bool
delete_firewall_rule(name_or_id, filters=None)
Deletes firewall rule. Prints debug message in case to-be-deleted resource was not found.
Parameters
• name_or_id firewall rule name or id

Return type bool

delete_flavor(name_or_id)
Delete a flavor
Parameters name_or_id ID or name of the flavor to delete.
delete_floating_ip(floating_ip_id, retry=1)
Deallocate a floating IP from a project.
Parameters
• floating_ip_id a floating IP address ID.
• retry number of times to retry. Optional, defaults to 1, which is in ad-
dition to the initial delete call. A value of 0 will also cause no checking of
results to occur.
Returns True if the IP address has been deleted, False if the IP address was not
found.
delete_group(name_or_id, **kwargs)
Delete a group
Parameters
• name_or_id ID or name of the group to delete.
• domain_id domain id.
OpenStack API call.
delete_image(name_or_id, wait=False, timeout=3600, delete_objects=True)
Delete an existing image.
Parameters
• name_or_id Name of the image to be deleted.
• wait If True, waits for image to be deleted.
• timeout Seconds to wait for image deletion. None is forever.
• delete_objects If True, also deletes uploaded swift objects.
Raises OpenStackCloudException if there are problems deleting.
delete_keypair(name)
Delete a keypair.
Parameters name Name of the keypair to delete.


delete_network(name_or_id)
Delete a network.
Parameters name_or_id Name or ID of the network being deleted.
delete_network_quotas(name_or_id)
Delete network quotas for a project
Raises OpenStackCloudException if its not a valid project or the network client
call failed
delete_object(container, name, meta=None)
Delete an object from a container.
Parameters
• container (string) Name of the container holding the object.
• name (string) Name of the object to delete.
• meta (dict) Metadata for the object in question. (optional, will be fetched
if not provided)
Returns True if delete succeeded, False if the object was not found.
delete_port(name_or_id)
Delete a port
Parameters name_or_id ID or name of the port to delete.
delete_project(name_or_id, domain_id=None)
Delete a project.
Parameters
• name_or_id (string) Project name or ID.
• domain_id (string) Domain ID containing the project(identity v3
only).
Returns True if delete succeeded, False if the project was not found.
OpenStack API call
delete_qos_bandwidth_limit_rule(policy_name_or_id, rule_id)
Delete a QoS bandwidth limit rule.
Parameters


which rule is associated.
• rule_id (string) ID of rule to update.
delete_qos_dscp_marking_rule(policy_name_or_id, rule_id)
Delete a QoS DSCP marking rule.
Parameters
delete_qos_minimum_bandwidth_rule(policy_name_or_id, rule_id)
Delete a QoS minimum bandwidth rule.
Parameters
• rule_id (string) ID of rule to delete.
delete_qos_policy(name_or_id)
Delete a QoS policy.
Parameters name_or_id Name or ID of the policy being deleted.
delete_recordset(zone, name_or_id)
Delete a recordset.
Parameters
• name_or_id Name or ID of the recordset being deleted.
delete_role(name_or_id, **kwargs)
Delete a Keystone role.
Parameters
• id (string) Name or id of the role to delete.


OpenStack API call.
delete_router(name_or_id)
Delete a logical router.
If a name, instead of a unique UUID, is supplied, it is possible that we could find more than
one matching router since names are not required to be unique. An error will be raised in
this case.
Parameters name_or_id Name or ID of the router being deleted.
delete_security_group(name_or_id)
Delete a security group
Parameters name_or_id (string) The name or unique ID of the security
group.
on this cloud.
delete_security_group_rule(rule_id)
Delete a security group rule
Parameters rule_id (string) The unique ID of the security group rule.
on this cloud.
delete_server(name_or_id, wait=False, timeout=180, delete_ips=False,
delete_ip_retry=1)
Delete a server instance.
Parameters
• name_or_id name or ID of the server to delete
• wait (bool) If true, waits for server to be deleted.
• timeout (int) Seconds to wait for server deletion.
• delete_ips (bool) If true, deletes any floating IPs associated with the
instance.
• delete_ip_retry (int) Number of times to retry deleting any floating
ips, should the first try be unsuccessful.
Returns True if delete succeeded, False otherwise if the server does not exist.

delete_server_group(name_or_id)
Delete a server group.
Parameters name_or_id Name or ID of the server group to delete
Returns True if delete succeeded, False otherwise
delete_server_metadata(name_or_id, metadata_keys)
Delete metadata from a server instance.
Parameters
• name_or_id (str) The name or ID of the server instance to update.
• metadata_keys A list with the keys to be deleted from the server in-
stance.
delete_service(name_or_id)
Delete a Keystone service.
Parameters name_or_id Service name or id.
OpenStack API call
delete_stack(name_or_id, wait=False)
Delete a stack
Parameters
• name_or_id (string) Stack name or ID.
• wait (boolean) Whether to wait for the delete to finish
Returns True if delete succeeded, False if the stack was not found.
OpenStack API call
delete_subnet(name_or_id)
Delete a subnet.
If a name, instead of a unique UUID, is supplied, it is possible that we could find more than
one matching subnet since names are not required to be unique. An error will be raised in
this case.
Parameters name_or_id Name or ID of the subnet being deleted.
delete_unattached_floating_ips(retry=1)
Safely delete unattached floating ips.
If the cloud can safely purge any unattached floating ips without race conditions, do so.

Safely here means a specific thing. It means that you are not running this while another
process that might do a two step create/attach is running. You can safely run this method
while another process is creating servers and attaching floating IPs to them if either that
process is using add_auto_ip from shade, or is creating the floating IPs by passing in a
server to the create_floating_ip call.
Parameters retry number of times to retry. Optional, defaults to 1, which is in
addition to the initial delete call. A value of 0 will also cause no checking of
results to occur.
Returns Number of Floating IPs deleted, False if none
delete_volume(name_or_id=None, wait=True, timeout=None, force=False)
Delete a volume.
Parameters
• name_or_id Name or unique ID of the volume.
• wait If true, waits for volume to be deleted.
• timeout Seconds to wait for volume deletion. None is forever.
• force Force delete volume even if the volume is in deleting or er-
ror_deleting state.
delete_volume_backup(name_or_id=None, force=False, wait=False, time-
out=None)
Delete a volume backup.
Parameters
• name_or_id Name or unique ID of the volume backup.
• force Allow delete in state other than error or available.
• wait If true, waits for volume backup to be deleted.
• timeout Seconds to wait for volume backup deletion. None is forever.
delete_volume_quotas(name_or_id)
Delete volume quotas for a project
Raises OpenStackCloudException if its not a valid project or the cinder client call
failed
delete_volume_snapshot(name_or_id=None, wait=False, timeout=None)
Delete a volume snapshot.
Parameters

• name_or_id Name or unique ID of the volume snapshot.

• wait If true, waits for volume snapshot to be deleted.
• timeout Seconds to wait for volume snapshot deletion. None is forever.
delete_zone(name_or_id)
Delete a zone.
Parameters name_or_id Name or ID of the zone being deleted.
detach_ip_from_server(server_id, floating_ip_id)
Detach a floating IP from a server.
Parameters
• server_id ID of a server.
• floating_ip_id Id of the floating IP to detach.
Returns True if the IP has been detached, or False if the IP wasnt attached to any
server.
detach_port_from_machine(name_or_id, port_name_or_id)
Detach a virtual port from the bare metal machine.
Parameters
• name_or_id (string) A machine name or UUID.
• port_name_or_id (string) A port name or UUID. Note that this is a
Network service port, not a bare metal NIC.
Returns Nothing.
detach_volume(server, volume, wait=True, timeout=None)
Detach a volume from a server.
Parameters
• server The server dict to detach from.
• volume The volume dict to detach.
• wait If true, waits for volume to be detached.
• timeout Seconds to wait for volume detachment. None is forever.
download_image(name_or_id, output_path=None, output_file=None,
chunk_size=1024)
Download an image by name or ID

Parameters
• name_or_id (str) Name or ID of the image.
• output_path the output path to write the image to. Either this or out-
put_file must be specified
• output_file a file object (or file-like object) to write the image data to.
Only write() will be called on this object. Either this or output_path must be
specified
• chunk_size (int) size in bytes to read from the wire and buffer at one
time. Defaults to 1024
Raises OpenStackCloudException in the event download_image is called without
exactly one of either output_path or output_file
Raises OpenStackCloudResourceNotFound if no images are found matching the
name or ID provided
endpoint_for(service_type, interface=None, region_name=None)
Return the endpoint for a given service.
Respects config values for Connection, including *_endpoint_override. For direct
values from the catalog regardless of overrides, see get_endpoint_from_catalog()
Parameters
• service_type Service Type of the endpoint to search for.
• interface Interface of the endpoint to search for. Optional, defaults to
the configured value for interface for this Connection.
• region_name Region Name of the endpoint to search for. Optional, de-
faults to the configured value for region_name for this Connection.
Returns The endpoint of the service, or None if not found.
get_aggregate(name_or_id, filters=None)
Get an aggregate by name or ID.
Parameters
• name_or_id Name or ID of the aggregate.
• filters (dict) A dictionary of meta data to use for further filtering.
Elements of this dictionary may, themselves, be dictionaries. Example:
{
'availability_zone': 'nova',
'metadata': {
'cpu_allocation_ratio': '1.0'
}
}
Returns An aggregate dict or None if no matching aggregate is found.

get_baymodel(name_or_id, filters=None, detail=False)
Get a cluster template by name or ID.
Parameters

• name_or_id Name or ID of the cluster template.

• filters A dictionary of meta data to use for further filtering. Elements
of this dictionary may, themselves, be dictionaries. Example:
{
'last_name': 'Smith',
'other': {
'gender': 'Female'
}
}
OR A string containing a jmespath expression for further filtering. Exam-

ple:: [?last_name==‘Smith‘] | [?other.gender]==‘Female‘]
Returns A cluster template dict or None if no matching cluster template is found.
get_cluster_template(name_or_id, filters=None, detail=False)
Parameters
{
'other': {
'gender': 'Female'
}
}

get_coe_cluster(name_or_id, filters=None)
Get a COE cluster by name or ID.
Parameters
• name_or_id Name or ID of the cluster.
{
'other': {
'gender': 'Female'
}
}

Returns A cluster dict or None if no matching cluster is found.

get_coe_cluster_certificate(cluster_id)
Get details about the CA certificate for a cluster by name or ID.
Parameters cluster_id ID of the cluster.
Returns Details about the CA certificate for the given cluster.
get_coe_cluster_template(name_or_id, filters=None, detail=False)
Parameters
{
'other': {
'gender': 'Female'
}
}

get_compute_limits(name_or_id=None)
Get compute limits for a project
Parameters name_or_id (optional) project name or ID to get limits for if dif-
ferent from the current project
Raises OpenStackCloudException if its not a valid project
Returns Munch object with the limits
get_compute_quotas(name_or_id)
Get quota for a project
Returns Munch object with the quotas
get_compute_usage(name_or_id, start=None, end=None)
Get usage for a specific project
Parameters
• name_or_id project name or id
• start datetime.datetime or string. Start date in UTC Defaults to
2010-07-06T12:00:00Z (the date the OpenStack project was started)
• end datetime.datetime or string. End date in UTC. Defaults to now
Returns Munch object with the usage

get_container(name, skip_cache=False)
Get metadata about a container.
Parameters
• name (str) Name of the container to get metadata for.
• skip_cache (bool) Ignore the cache of container metadata for this con-
tainer.o Defaults to False.
get_container_access(name)
Get the control list from a container.
Parameters name (str) Name of the container.
get_default_network()
Return the network that is configured to be the default interface.
Returns A network dict if one is found
get_domain(domain_id=None, name_or_id=None, filters=None)
Get exactly one Keystone domain.
Parameters
• name_or_id domain name or id.
• filters (dict) A dict containing additional filters to use. Keys to search
on are id, name, enabled and description.
Returns a munch.Munch containing the domain description, or None if not
found. Each munch.Munch contains the following attributes:: - id: <domain
id> - name: <domain name> - description: <domain description>
OpenStack API call.
get_endpoint(id, filters=None)
Get exactly one Keystone endpoint.
Parameters
• id endpoint id.
• filters a dict containing additional filters to use. e.g. {region: region-
a.geo-1}
Returns a munch.Munch containing the endpoint description. i.e. a munch.
Munch containing the following attributes:: - id: <endpoint id> - region:
<endpoint region> - public_url: <endpoint public url> - internal_url: <end-
point internal url> (optional) - admin_url: <endpoint admin url> (optional)
get_external_ipv4_floating_networks()
Return the networks that are configured to route northbound.
Returns A list of network munch.Munch if one is found

get_external_networks()
This should be avoided in favor of the specific ipv4/ipv6 method, but is here for backwards
compatibility.
get_firewall_group(name_or_id, filters=None)
Retrieves firewall group.
Parameters
Returns firewall group or None if not found
get_firewall_policy(name_or_id, filters=None)
Retrieves a single firewall policy.
Parameters
Returns firewall policy or None if not found
get_firewall_rule(name_or_id, filters=None)
Retrieves a single firewall rule.
Parameters
Returns firewall rule dict or None if not found
get_flavor(name_or_id, filters=None, get_extra=True)
Get a flavor by name or ID.
Parameters
• name_or_id Name or ID of the flavor.


{
'other': {
'gender': 'Female'
}
}

• get_extra Whether or not the list_flavors call should get the extra flavor
specs.
Returns A flavor munch.Munch or None if no matching flavor is found.
get_flavor_by_id(id, get_extra=False)
Get a flavor by ID
Parameters
• id ID of the flavor.
• get_extra Whether or not the list_flavors call should get the extra flavor
specs.
Returns A flavor munch.Munch.
get_flavor_by_ram(ram, include=None, get_extra=True)
Get a flavor based on amount of RAM available.
Finds the flavor with the least amount of RAM that is at least as much as the specified
amount. If include is given, further filter based on matching flavor name.
Parameters
• ram (int) Minimum amount of RAM.
• include (string) If given, will return a flavor whose name contains
this string as a substring.
get_floating_ip(id, filters=None)
Get a floating IP by ID
Parameters
• id ID of the floating IP.
{
'other': {
'gender': 'Female'
}
}


Returns A floating IP munch.Munch or None if no matching floating IP is
found.
get_floating_ip_by_id(id)
Get a floating ip by ID
Parameters id ID of the floating ip.
Returns A floating ip munch.Munch.
get_group(name_or_id, filters=None, **kwargs)
Get exactly one Keystone group.
Parameters
• id Group name or id.
• filters A dict containing additional filters to use.
OpenStack API call.
get_image(name_or_id, filters=None)
Get an image by name or ID.
Parameters
• name_or_id Name or ID of the image.
{
'other': {
'gender': 'Female'
}
}

Returns An image munch.Munch or None if no matching image is found
get_image_by_id(id)
Get a image by ID
Parameters id ID of the image.
Returns An image munch.Munch.
Return the networks that are configured to not route northbound.

get_internal_networks()
This should be avoided in favor of the specific ipv4/ipv6 method, but is here for backwards
compatibility.
get_keypair(name_or_id, filters=None)
Get a keypair by name or ID.
Parameters
• name_or_id Name or ID of the keypair.
{
'other': {
'gender': 'Female'
}
}

Returns A keypair munch.Munch or None if no matching keypair is found.
get_machine(name_or_id)
Get Machine by name or uuid
Search the baremetal host out by utilizing the supplied id value which can consist of a name
or UUID.
Parameters name_or_id A node name or UUID that will be looked up.
Returns munch.Munch representing the node found or None if no nodes are
found.
get_machine_by_mac(mac)
Get machine by port MAC address
Parameters mac Port MAC address to query in order to return a node.
Returns munch.Munch representing the node found or None if the node is not
found.
get_nat_destination()
Return the network that is configured to be the NAT destination.
get_nat_source()
Return the network that is configured to be the NAT destination.


get_network(name_or_id, filters=None)
Get a network by name or ID.
Parameters
• name_or_id Name or ID of the network.
{
'other': {
'gender': 'Female'
}
}

Returns A network munch.Munch or None if no matching network is found.
get_network_by_id(id)
Get a network by ID
Parameters id ID of the network.
Returns A network munch.Munch.
get_network_extensions()
Get Cloud provided network extensions
Returns set of Neutron extension aliases
get_network_quotas(name_or_id, details=False)
Get network quotas for a project
Parameters
• details if set to True it will return details about usage of quotas by given
project
get_nic_by_mac(mac)
Get bare metal NIC by its hardware address (usually MAC).
get_object(container, obj, query_string=None, resp_chunk_size=1024, outfile=None,
stream=False)
Get the headers and body of an object
Parameters
• container (string) name of the container.
• obj (string) name of the object.

• query_string (string) query args for uri. (delimiter, prefix, etc.)

• resp_chunk_size (int) chunk size of data to read. Only used if the
results are being written to a file or stream is True. (optional, defaults to 1k)
• outfile Write the object to a file instead of returning the contents. If this
option is given, body in the return tuple will be None. outfile can either be a
file path given as a string, or a File like object.
Returns Tuple (headers, body) of the object, or None if the object is not found
(404).
get_object_raw(container, obj, query_string=None, stream=False)
Get a raw response object for an object.
Parameters
• stream (bool) Whether to stream the response or not.
Returns A requests.Response
get_object_segment_size(segment_size)
Get a segment size that will work given capabilities
get_port(name_or_id, filters=None)
Get a port by name or ID.
Parameters
• name_or_id Name or ID of the port.
{
'other': {
'gender': 'Female'
}
}

Returns A port munch.Munch or None if no matching port is found.
get_port_by_id(id)
Get a port by ID
Parameters id ID of the port.
Returns A port munch.Munch.

get_project(name_or_id, filters=None, domain_id=None)

Get exactly one project.
Parameters
• name_or_id project name or ID.
• filters a dict containing additional filters to use.
• domain_id domain ID (identity v3 only).
Returns a list of munch.Munch containing the project description.
OpenStack API call.
get_qos_bandwidth_limit_rule(policy_name_or_id, rule_id)
Get a QoS bandwidth limit rule by name or ID.
Parameters
• rule_id ID of the rule.
Returns A bandwidth limit rule munch.Munch or None if no matching rule is
found.
get_qos_dscp_marking_rule(policy_name_or_id, rule_id)
Get a QoS DSCP marking rule by name or ID.
Parameters
found.
get_qos_minimum_bandwidth_rule(policy_name_or_id, rule_id)
Get a QoS minimum bandwidth rule by name or ID.
Parameters
found.
get_qos_policy(name_or_id, filters=None)
Get a QoS policy by name or ID.
Parameters
• name_or_id Name or ID of the policy.

{
'other': {
'gender': 'Female'
}
}

Returns A policy munch.Munch or None if no matching network is found.
get_qos_rule_type_details(rule_type, filters=None)
Get a QoS rule type details by rule type name.
Parameters rule_type (string) Name of the QoS rule type.
Returns A rule type details munch.Munch or None if no matching rule type is
found.
get_recordset(zone, name_or_id)
Get a recordset by name or ID.
Parameters
• name_or_id Name or ID of the recordset
Returns A recordset dict or None if no matching recordset is found.
get_role(name_or_id, filters=None, **kwargs)
Get exactly one Keystone role.
Parameters
• id role name or id.
Returns
a single munch.Munch containing the role description. Each munch.
Munch contains the following attributes:
- id: <role id>

- name: <role name>
- description: <role description>

OpenStack API call.
get_router(name_or_id, filters=None)
Get a router by name or ID.
Parameters
• name_or_id Name or ID of the router.


{
'other': {
'gender': 'Female'
}
}

Returns A router munch.Munch or None if no matching router is found.
get_security_group(name_or_id, filters=None)
Get a security group by name or ID.
Parameters
• name_or_id Name or ID of the security group.
{
'other': {
'gender': 'Female'
}
}

Returns A security group munch.Munch or None if no matching security group
is found.
get_security_group_by_id(id)
Get a security group by ID
Parameters id ID of the security group.
Returns A security group munch.Munch.
get_server(name_or_id=None, filters=None, detailed=False, bare=False,
all_projects=False)
Get a server by name or ID.
Parameters
• name_or_id Name or ID of the server.
{
'other': {
'gender': 'Female'


}
}

• detailed Whether or not to add detailed additional information. Defaults
to False.
• bare Whether to skip adding any additional information to the server
record. Defaults to False, meaning the addresses dict will be populated as
needed from neutron. Setting to True implies detailed = False.
• all_projects Whether to get server from all projects or just the current
auth scoped project.
Returns A server munch.Munch or None if no matching server is found.
get_server_by_id(id)
Get a server by ID.
Parameters id ID of the server.
Returns A server dict or None if no matching server is found.
get_server_console(server, length=None)
Get the console log for a server.
Parameters
• server The server to fetch the console log for. Can be either a server dict
or the Name or ID of the server.
• length (int) The number of lines you would like to retrieve from the
end of the log. (optional, defaults to all)
Returns A string containing the text of the console log or an empty string if the
cloud does not support console logs.
Raises OpenStackCloudException if an invalid server argument is given or if
something else unforseen happens
get_server_group(name_or_id=None, filters=None)
Get a server group by name or ID.
Parameters
• name_or_id Name or ID of the server group.
{
'policy': 'affinity',
}

Returns A server groups dict or None if no matching server group is found.

get_service(name_or_id, filters=None)
Get exactly one Keystone service.
Parameters
• name_or_id Name or id of the desired service.
• filters a dict containing additional filters to use. e.g. {type: network}
Returns a munch.Munch containing the services description, i.e. the following
attributes:: - id: <service id> - name: <service name> - type: <service type> -
description: <service description>
OpenStack API call or if multiple matches are found.
get_stack(name_or_id, filters=None, resolve_outputs=True)
Get exactly one stack.
Parameters
• name_or_id Name or ID of the desired stack.
• filters a dict containing additional filters to use. e.g. {stack_status:
CREATE_COMPLETE}
• resolve_outputs If True, then outputs for this stack will be resolved
Returns a munch.Munch containing the stack description
OpenStack API call or if multiple matches are found.
get_subnet(name_or_id, filters=None)
Get a subnet by name or ID.
Parameters
• name_or_id Name or ID of the subnet.
{
'other': {
'gender': 'Female'
}
}
Returns A subnet munch.Munch or None if no matching subnet is found.

get_subnet_by_id(id)
Get a subnet by ID
Parameters id ID of the subnet.
Returns A subnet munch.Munch.
get_user(name_or_id, filters=None, **kwargs)
Get exactly one user.
Parameters

• name_or_id (string) user name or ID.

• domain_id Domain ID. (v3)
• filters a dict containing additional filters to use. OR A string
containing a jmespath expression for further filtering. Example::
[?last_name==‘Smith‘] | [?other.gender]==‘Female‘]
Returns a single munch.Munch containing the user description.
OpenStack API call.
get_user_by_id(user_id, normalize=True)
Get a user by ID.
Parameters
• user_id (string) user ID
• normalize (bool) Flag to control dict normalization
Returns a single munch.Munch containing the user description
get_volume(name_or_id, filters=None)
Get a volume by name or ID.
Parameters
• name_or_id Name or ID of the volume.
{
'other': {
'gender': 'Female'
}
}

Returns A volume munch.Munch or None if no matching volume is found.
get_volume_attach_device(volume, server_id)
Return the device name a volume is attached to for a server.
This can also be used to verify if a volume is attached to a particular server.
Parameters
• volume Volume dict
• server_id ID of server to check
Returns Device name if attached, None if volume is not attached.
get_volume_backup(name_or_id, filters=None)
Get a volume backup by name or ID.
Returns A backup munch.Munch or None if no matching backup is found.

get_volume_by_id(id)
Get a volume by ID
Parameters id ID of the volume.
Returns A volume munch.Munch.
get_volume_limits(name_or_id=None)
Get volume limits for a project
Parameters name_or_id (optional) project name or ID to get limits for if dif-
ferent from the current project
Returns Munch object with the limits
get_volume_quotas(name_or_id)
Get volume quotas for a project
get_volume_snapshot(name_or_id, filters=None)
Get a volume by name or ID.
Parameters
• name_or_id Name or ID of the volume snapshot.
{
'other': {
'gender': 'Female'
}
}

get_volume_snapshot_by_id(snapshot_id)
Takes a snapshot_id and gets a dict of the snapshot that maches that ID.
Note: This is more efficient than get_volume_snapshot.
param: snapshot_id: ID of the volume snapshot.
get_volume_type(name_or_id, filters=None)
Get a volume type by name or ID.
Parameters
• name_or_id Name or ID of the volume.


{
'other': {
'gender': 'Female'
}
}

get_volume_type_access(name_or_id)
Return a list of volume_type_access.
Parameters name_or_id Name or ID of the volume type.
get_zone(name_or_id, filters=None)
Get a zone by name or ID.
Parameters
• name_or_id Name or ID of the zone
• filters A dictionary of meta data to use for further filtering
Returns A zone dict or None if no matching zone is found.
global_request(global_request_id)
Make a new Connection object with a global request id set.
Take the existing settings from the current Connection and construct a new Connection ob-
ject with the global_request_id overridden.
from oslo_context import context

cloud = openstack.connect(cloud='example')
# Work normally
servers = cloud.list_servers()
cloud2 = cloud.global_request(context.generate_request_id())
# cloud2 sends all requests with global_request_id set
servers = cloud2.list_servers()
Additionally, this can be used as a context manager:
from oslo_context import context

c = openstack.connect(cloud='example')
# Work normally
servers = c.list_servers()
with c.global_request(context.generate_request_id()) as c2:
# c2 sends all requests with global_request_id set
servers = c2.list_servers()
Parameters global_request_id The global_request_id to send.

grant_role(name_or_id, user=None, group=None, project=None, domain=None,

wait=False, timeout=60)
Grant a role to a user.
Parameters
• name_or_id (string) The name or id of the role.
• user (string) The name or id of the user.
• group (string) The name or id of the group. (v3)
• project (string) The name or id of the project.
• domain (string) The id of the domain. (v3)
• wait (bool) Wait for role to be granted
• timeout (int) Timeout to wait for role to be granted
NOTE: domain is a required argument when the grant is on a project, user or group
specified by name. In that situation, they are all considered to be in that domain. If
different domains are in use in the same role grant, it is required to specify those by ID.
NOTE: for wait and timeout, sometimes granting roles is not instantaneous.
NOTE: project is required for keystone v2

Returns True if the role is assigned, otherwise False
Raises OpenStackCloudException if the role cannot be granted
insert_rule_into_policy(name_or_id, rule_name_or_id, insert_after=None, in-
sert_before=None, filters=None)
Adds firewall rule to the firewall_rules list of a firewall policy. Short-circuits and returns the
firewall policy early if the firewall rule id is already present in the firewall_rules list. This
method doesnt do re-ordering. If you want to move a firewall rule or down the list, you have
to remove and re-add it.
Parameters
• rule_name_or_id firewall rule name or id
• insert_after rule name or id that should precede added rule
• insert_before rule name or id that should succeed added rule
Raises ResourceNotFound if firewall policy or any of the firewall rules (inserted,
after, before) is not found.
Returns updated firewall policy
inspect_machine(name_or_id, wait=False, timeout=3600)
Inspect a Barmetal machine

Engages the Ironic node inspection behavior in order to collect metadata about the baremetal
machine.
Parameters
• name_or_id String representing machine name or UUID value in order
to identify the machine.
• wait Boolean value controlling if the method is to wait for the desired
state to be reached or a failure to occur.
• timeout Integer value, defautling to 3600 seconds, for the$ wait state to
reach completion.
Returns munch.Munch representing the current state of the machine upon exit
of the method.
is_object_stale(container, name, filename, file_md5=None, file_sha256=None)
Check to see if an object matches the hashes of a file.
Parameters
• container Name of the container.
• name Name of the object.
• filename Path to the file.
• file_md5 Pre-calculated md5 of the file contents. Defaults to None which
means calculate locally.
• file_sha256 Pre-calculated sha256 of the file contents. Defaults to
None which means calculate locally.
is_user_in_group(name_or_id, group_name_or_id)
Check to see if a user is in a group.
Parameters
Returns True if user is in the group, False otherwise
OpenStack API call
list_accelerator_requests(filters=None)
List all accelerator_requests. :param filters: (optional) dict of filter conditions to push down
:returns: A list of accelerator request info.
list_aggregates(filters={})
List all available host aggregates.
Returns A list of aggregate dicts.
list_containers(full_listing=True, prefix=None)
List containers.
Parameters full_listing Ignored. Present for backwards compat
Returns list of Munch of the container objects


list_deployables(filters=None)
List all available deployables. :param filters: (optional) dict of filter conditions to push down
:returns: A list of deployable info.
list_device_profiles(filters=None)
List all device_profiles. :param filters: (optional) dict of filter conditions to push down
:returns: A list of device profile info.
list_devices(filters=None)
List all devices. :param filters: (optional) dict of filter conditions to push down :returns: A
list of device info.
list_domains(**filters)
List Keystone domains.
Returns a list of munch.Munch containing the domain description.
OpenStack API call.
list_endpoints()
List Keystone endpoints.
Returns a list of munch.Munch containing the endpoint description
OpenStack API call.
list_firewall_groups(filters=None)
Lists firewall groups.
Parameters filters (dict) optional filters
Returns list of firewall groups
Return type list[FirewallGroup]
list_firewall_policies(filters=None)
Lists firewall policies.
Returns list of firewall policies
Return type list[FirewallPolicy]
list_firewall_rules(filters=None)
Lists firewall rules.
Returns list of firewall rules
Return type list[FirewallRule]
list_flavor_access(flavor_id)
List access from a private flavor for a project/tenant.
Parameters flavor_id (string) ID of the private flavor.
Returns a list of munch.Munch containing the access description


list_floating_ip_pools()
List all available floating IP pools.
NOTE: This function supports the nova-net view of the world. nova-net has been deprecated,
so its highly recommended to switch to using neutron. get_external_ipv4_floating_networks
is what you should almost certainly be using.
Returns A list of floating IP pool munch.Munch.
list_floating_ips(filters=None)
List all available floating IPs.
Parameters filters (optional) dict of filter conditions to push down
Returns A list of floating IP munch.Munch.
list_hypervisors(filters={})
List all hypervisors
Returns A list of hypervisor munch.Munch.
list_keypairs(filters=None)
List all available keypairs.
Returns A list of munch.Munch containing keypair info.
list_machines()
List Machines.
Returns list of munch.Munch representing machines.
list_magnum_services()
List all Magnum services. :returns: a list of dicts containing the service details.
list_networks(filters=None)
List all available networks.
Returns A list of munch.Munch containing network info.
list_nics()
Return a list of all bare metal ports.
list_nics_for_machine(uuid)
Returns a list of ports present on the machine node.
Parameters uuid String representing machine UUID value in order to identify
the machine.
Returns A list of ports.
list_objects(container, full_listing=True, prefix=None)
List objects.
Parameters
• container Name of the container to list objects in.
• full_listing Ignored. Present for backwards compat

• prefix (string) only objects with this prefix will be returned. (op-
tional)
Returns list of Munch of the objects
list_ports(filters=None)
List all available ports.
Returns A list of port munch.Munch.
list_ports_attached_to_machine(name_or_id)
List virtual ports attached to the bare metal machine.
Parameters name_or_id (string) A machine name or UUID.
Returns List of munch.Munch representing the ports.
list_qos_bandwidth_limit_rules(policy_name_or_id, filters=None)
List all available QoS bandwidth limit rules.
Parameters
• policy_name_or_id (string) Name or ID of the QoS policy from
from rules should be listed.
• filters (optional) dict of filter conditions to push down
Returns A list of munch.Munch containing rule info.
Raises OpenStackCloudResourceNotFound if QoS policy will not be
found.
list_qos_dscp_marking_rules(policy_name_or_id, filters=None)
List all available QoS DSCP marking rules.
Parameters
found.
list_qos_minimum_bandwidth_rules(policy_name_or_id, filters=None)
List all available QoS minimum bandwidth rules.
Parameters


found.
list_qos_policies(filters=None)
List all available QoS policies.
Returns A list of policies munch.Munch.
list_qos_rule_types(filters=None)
List all available QoS rule types.
Returns A list of rule types munch.Munch.
list_recordsets(zone)
List all available recordsets.
Parameters zone Name, ID or openstack.dns.v2.zone.Zone instance
of the zone managing the recordset.
Returns A list of recordsets.
list_role_assignments(filters=None)
List Keystone role assignments
Parameters filters (dict) Dict of filter conditions. Acceptable keys are:
• user (string) - User ID to be used as query filter.
• group (string) - Group ID to be used as query filter.
• project (string) - Project ID to be used as query filter.
• domain (string) - Domain ID to be used as query filter.
• role (string) - Role ID to be used as query filter.
• os_inherit_extension_inherited_to (string) - Return inherited role assign-
ments for either projects or domains
• effective (boolean) - Return effective role assignments.
• include_subtree (boolean) - Include subtree
user and group are mutually exclusive, as are domain and project.
NOTE: For keystone v2, only user, project, and role are used. Project and
user are both required in filters.
Returns
a list of munch.Munch containing the role assignment description. Contains
the following attributes:
- id: <role id>

- user|group: <user or group id>
- project|domain: <project or domain id>

OpenStack API call.

list_roles(**kwargs)
List Keystone roles.
Parameters domain_id domain id for listing roles (v3)
Returns a list of munch.Munch containing the role description.
OpenStack API call.
list_router_interfaces(router, interface_type=None)
List all interfaces for a router.
Parameters
• router (dict) A router dict object.
• interface_type (string) One of None, internal, or external. Con-
trols whether all, internal interfaces or external interfaces are returned.
Returns A list of port munch.Munch objects.
list_routers(filters=None)
List all available routers.
Returns A list of router munch.Munch.
list_security_groups(filters=None)
List all available security groups.
Returns A list of security group munch.Munch.
list_server_groups()
List all available server groups.
Returns A list of server group dicts.
list_server_security_groups(server)
List all security groups associated with the given server.
Returns A list of security group munch.Munch.
list_servers(detailed=False, all_projects=False, bare=False, filters=None)
List all available servers.
Parameters
to False.
• all_projects Whether to list servers from all projects or just the current
auth scoped project.
• filters Additional query parameters passed to the API server.
Returns A list of server munch.Munch.

list_services()
List all Keystone services.
Returns a list of munch.Munch containing the services description
OpenStack API call.
list_subnets(filters=None)
List all available subnets.
Returns A list of subnet munch.Munch.
list_volume_backups(detailed=True, search_opts=None)
List all volume backups.
Parameters
• detailed (bool) Also list details for each entry
• search_opts (dict) Search options A dictionary of meta data to use
for further filtering. Example:
{
'name': 'my-volume-backup',
'status': 'available',
'volume_id': 'e126044c-7b4c-43be-a32a-c9cbbc9ddb56
,→',
'all_tenants': 1
}
Returns A list of volume backups munch.Munch.

list_volume_snapshots(detailed=True, search_opts=None)
List all volume snapshots.
Returns A list of volume snapshots munch.Munch.
list_zones(filters=None)
List all available zones.
Returns A list of zones dicts.
node_set_provision_state(name_or_id, state, configdrive=None, wait=False,
timeout=3600)
Set Node Provision State
Enables a user to provision a Machine and optionally define a config drive to be utilized.
Parameters
• name_or_id (string) The Name or UUID value representing the
baremetal node.
• state (string) The desired provision state for the baremetal node.
• configdrive (string) An optional URL or file or path representing
the configdrive. In the case of a directory, the client API will create a prop-
erly formatted configuration drive file and post the file contents to the API
for deployment.

• wait (boolean) A boolean value, defaulted to false, to control if the

method will wait for the desire end state to be reached before returning.
• timeout (integer) Integer value, defaulting to 3600 seconds, repre-
senting the amount of time to wait for the desire end state to be reached.
Returns munch.Munch representing the current state of the machine upon exit
of the method.
patch_machine(name_or_id, patch)
Patch Machine Information
This method allows for an interface to manipulate node entries within Ironic.
Parameters
• name_or_id (string) A machine name or UUID to be updated.
• patch The JSON Patch document is a list of dictonary objects that comply
with RFC 6902 which can be found at https://tools.ietf.org/html/rfc6902.
Example patch construction:
patch=[]
patch.append({
'op': 'remove',
'path': '/instance_info'
})
patch.append({
'op': 'replace',
'path': '/name',
'value': 'newname'
})
patch.append({
'op': 'add',
'path': '/driver_info/username',
'value': 'administrator'
})

Returns munch.Munch representing the newly updated node.
pformat(resource)
Wrapper around pformat that groks munch objects
pprint(resource)
Wrapper around pprint that groks munch objects
project_cleanup(dry_run=True, wait_timeout=120, status_queue=None, fil-
ters=None, resource_evaluation_fn=None)
Cleanup the project resources.
Cleanup all resources in all services, which provide cleanup methods.
Parameters
• dry_run (bool) Cleanup or only list identified resources.

• wait_timeout (int) Maximum amount of time given to each service

to comlete the cleanup.
• status_queue (queue) a threading queue object used to get current
process status. The queue contain processed resources.
• filters (dict) Additional filters for the cleanup (only resources match-
ing all filters will be deleted, if there are no other dependencies).
• resource_evaluation_fn A callback function, which will be in-
voked for each resurce and must return True/False depending on whether
resource need to be deleted or not.
range_search(data, filters)
Perform integer range searches across a list of dictionaries.
Given a list of dictionaries, search across the list using the given dictionary keys and a range
of integer values for each key. Only dictionaries that match ALL search filters across the
entire original data set will be returned.
It is not a requirement that each dictionary contain the key used for searching. Those without
the key will be considered non-matching.
The range values must be string values and is either a set of digits representing an integer for
matching, or a range operator followed by a set of digits representing an integer for matching.
If a range operator is not given, exact value matching will be used. Valid operators are one
of: <,>,<=,>=
Parameters
• data List of dictionaries to be searched.
• filters Dict describing the one or more range searches to perform. If
more than one search is given, the result will be the members of the origi-
nal data set that match ALL searches. An example of filtering by multiple
ranges:
{"vcpus": "<=5", "ram": "<=2048", "disk": "1"}
Returns A list subset of the original data set.

Raises OpenStackCloudException on invalid range expressions.
register_machine(nics, wait=False, timeout=3600, lock_timeout=600, **kwargs)
Register Baremetal with Ironic
Allows for the registration of Baremetal nodes with Ironic and population of pertinant node
information or configuration to be passed to the Ironic API for the node.
This method also creates ports for a list of MAC addresses passed in to be utilized for boot
and potentially network configuration.
If a failure is detected creating the network ports, any ports created are deleted, and the node
is removed from Ironic.
Parameters
• nics An array of MAC addresses that represent the network interfaces for
the node to be created.
Example:

[
{'mac': 'aa:bb:cc:dd:ee:01'},
{'mac': 'aa:bb:cc:dd:ee:02'}
]
• wait Boolean value, defaulting to false, to wait for the node to reach the
available state where the node can be provisioned. It must be noted, when
set to false, the method will still wait for locks to clear before sending the
next required command.
• timeout Integer value, defautling to 3600 seconds, for the wait state to
reach completion.
• lock_timeout Integer value, defaulting to 600 seconds, for locks to
clear.
• kwargs Key value pairs to be passed to the Ironic API, including uuid,
name, chassis_uuid, driver_info, parameters.
Returns Returns a munch.Munch representing the new baremetal node.
remove_flavor_access(flavor_id, project_id)
Revoke access from a private flavor for a project/tenant.
Parameters
• flavor_id (string) ID of the private flavor.
• project_id (string) ID of the project/tenant.
remove_host_from_aggregate(name_or_id, host_name)
Remove a host from an aggregate.
Parameters
• name_or_id Name or ID of the host aggregate.
• host_name Host to remove.
remove_machine_from_maintenance(name_or_id)
Remove Baremetal Machine from Maintenance State
Similarly to set_machine_maintenance_state, this method removes a machine from mainte-
nance state. It must be noted that this method simpily calls set_machine_maintenace_state
for the name_or_id requested and sets the state to False.
Parameters name_or_id (string) The Name or UUID value representing
the baremetal node.
Returns None
remove_router_interface(router, subnet_id=None, port_id=None)
Detach a subnet from an internal router interface.

At least one of subnet_id or port_id must be supplied.

If you specify both subnet and port ID, the subnet ID must correspond to the subnet ID of
the first IP address on the port specified by the port ID. Otherwise an error occurs.
Parameters
• router (dict) The dict object of the router being changed
• subnet_id (string) The ID of the subnet to use for the interface
• port_id (string) The ID of the port to use for the interface
Returns None on success
remove_rule_from_policy(name_or_id, rule_name_or_id, filters=None)
Remove firewall rule from firewall policys firewall_rules list. Short-circuits and returns
firewall policy early if firewall rule is already absent from the firewall_rules list.
Parameters
• rule_name_or_id firewall rule name or id
Raises ResourceNotFound if firewall policy is not found
remove_server_security_groups(server, security_groups)
Remove security groups from a server
Remove existing security groups from an existing server. If the security groups are not
present on the server this will continue unaffected.
Returns False if server or security groups are undefined, True otherwise.
remove_user_from_group(name_or_id, group_name_or_id)
Remove a user from a group.
Parameters
OpenStack API call
remove_volume_type_access(name_or_id, project_id)
Revoke access on a volume_type to a project.
Parameters
• name_or_id ID or name of a volume_type

• project_id A project id
revoke_role(name_or_id, user=None, group=None, project=None, domain=None,
wait=False, timeout=60)
Revoke a role from a user.
Parameters
• name_or_id (string) The name or id of the role.
• user (string) The name or id of the user.
• group (string) The name or id of the group. (v3)
• project (string) The name or id of the project.
• domain (string) The id of the domain. (v3)
• wait (bool) Wait for role to be revoked
• timeout (int) Timeout to wait for role to be revoked
NOTE: for wait and timeout, sometimes revoking roles is not instantaneous.
NOTE: project is required for keystone v2

Returns True if the role is revoke, otherwise False
Raises OpenStackCloudException if the role cannot be removed
search_aggregates(name_or_id=None, filters=None)
Seach host aggregates.
Parameters
• name aggregate name or id.
Returns a list of dicts containing the aggregates
OpenStack API call.
search_baymodels(name_or_id=None, filters=None, detail=False)
Search cluster templates.
Parameters
• name_or_id cluster template name or ID.
• detail a boolean to control if we need summarized or detailed output.
Returns a list of dict containing the cluster templates
OpenStack API call.
search_cluster_templates(name_or_id=None, filters=None, detail=False)

Parameters
OpenStack API call.
search_coe_cluster_templates(name_or_id=None, filters=None, de-
tail=False)
Parameters
OpenStack API call.
search_coe_clusters(name_or_id=None, filters=None)
Search COE cluster.
Parameters
• name_or_id cluster name or ID.
Returns a list of dict containing the cluster
OpenStack API call.
search_containers(name=None, filters=None)
Search containers.
Parameters
• name (string) container name.
Returns a list of munch.Munch containing the containers.
OpenStack API call.
search_domains(filters=None, name_or_id=None)
Search Keystone domains.

Parameters
• name_or_id domain name or id
• filters (dict) A dict containing additional filters to use. Keys to search
on are id, name, enabled and description.
Returns a list of munch.Munch containing the domain description. Each
munch.Munch contains the following attributes:: - id: <domain id> - name:
<domain name> - description: <domain description>
OpenStack API call.
search_endpoints(id=None, filters=None)
List Keystone endpoints.
Parameters
• id endpoint id.
• filters a dict containing additional filters to use. e.g. {region: region-
a.geo-1}
Returns a list of munch.Munch containing the endpoint description. Each dict
contains the following attributes:: - id: <endpoint id> - region: <endpoint
region> - public_url: <endpoint public url> - internal_url: <endpoint internal
url> (optional) - admin_url: <endpoint admin url> (optional)
OpenStack API call.
search_groups(name_or_id=None, filters=None, **kwargs)
Search Keystone groups.
Parameters
• name Group name or id.
• filters A dict containing additional filters to use.
Returns A list of munch.Munch containing the group description.
OpenStack API call.
search_networks(name_or_id=None, filters=None)
Search networks
Parameters
• name_or_id Name or ID of the desired network.
• filters a dict containing additional filters to use. e.g. {router:external:
True}
Returns a list of munch.Munch containing the network description.
OpenStack API call.

search_objects(container, name=None, filters=None)

Search objects.
Parameters
• name (string) object name.
Returns a list of munch.Munch containing the objects.
OpenStack API call.
search_ports(name_or_id=None, filters=None)
Search ports
Parameters
• name_or_id Name or ID of the desired port.
• filters a dict containing additional filters to use. e.g. {device_id:
2711c67a-b4a7-43dd-ace7-6187b791c3f0}
Returns a list of munch.Munch containing the port description.
OpenStack API call.
search_projects(name_or_id=None, filters=None, domain_id=None)
Backwards compatibility method for search_projects
search_projects originally had a parameter list that was name_or_id, filters and list had do-
main_id first. This method exists in this form to allow code written with positional parameter
to still work. But really, use keyword arguments.
search_qos_bandwidth_limit_rules(policy_name_or_id, rule_id=None, fil-
ters=None)
Search QoS bandwidth limit rules
Parameters
which rules should be associated.
• rule_id (string) ID of searched rule.
• filters a dict containing additional filters to use. e.g. {max_kbps: 1000}
Returns a list of munch.Munch containing the bandwidth limit rule descrip-
tions.
OpenStack API call.
search_qos_dscp_marking_rules(policy_name_or_id, rule_id=None, fil-
ters=None)
Search QoS DSCP marking rules
Parameters


• filters a dict containing additional filters to use. e.g. {dscp_mark: 32}
Returns a list of munch.Munch containing the dscp marking rule descriptions.
OpenStack API call.
search_qos_minimum_bandwidth_rules(policy_name_or_id, rule_id=None, fil-
ters=None)
Search QoS minimum bandwidth rules
Parameters
• filters a dict containing additional filters to use. e.g. {min_kbps: 1000}
Returns a list of munch.Munch containing the bandwidth limit rule descrip-
tions.
OpenStack API call.
search_qos_policies(name_or_id=None, filters=None)
Search QoS policies
Parameters
• name_or_id Name or ID of the desired policy.
• filters a dict containing additional filters to use. e.g. {shared: True}
Returns a list of munch.Munch containing the network description.
OpenStack API call.
search_roles(name_or_id=None, filters=None, **kwargs)
Seach Keystone roles.
Parameters
• name (string) role name or id.
• filters (dict) a dict containing additional filters to use.
Returns
a list of munch.Munch containing the role description. Each munch.Munch
contains the following attributes:
- id: <role id>

- name: <role name>
- description: <role description>


OpenStack API call.
search_routers(name_or_id=None, filters=None)
Search routers
Parameters
• name_or_id Name or ID of the desired router.
• filters a dict containing additional filters to use. e.g. {admin_state_up:
True}
Returns a list of munch.Munch containing the router description.
OpenStack API call.
search_server_groups(name_or_id=None, filters=None)
Seach server groups.
Parameters
• name server group name or ID.
Returns a list of dicts containing the server groups
OpenStack API call.
search_services(name_or_id=None, filters=None)
Search Keystone services.
Parameters
• name_or_id Name or id of the desired service.
• filters a dict containing additional filters to use. e.g. {type: network}.
Returns a list of munch.Munch containing the services description
OpenStack API call.
search_stacks(name_or_id=None, filters=None)
Search stacks.
Parameters
• name_or_id Name or ID of the desired stack.
• filters a dict containing additional filters to use. e.g. {stack_status:
CREATE_COMPLETE}
Returns a list of munch.Munch containing the stack description.
OpenStack API call.
search_subnets(name_or_id=None, filters=None)
Search subnets

Parameters
• name_or_id Name or ID of the desired subnet.
• filters a dict containing additional filters to use. e.g. {enable_dhcp:
True}
Returns a list of munch.Munch containing the subnet description.
OpenStack API call.
search_users(name_or_id=None, filters=None, **kwargs)
Search users.
Parameters
• name_or_id (string) user name or ID.
• domain_id Domain ID. (v3)
Returns a list of munch.Munch containing the users
OpenStack API call.
set_aggregate_metadata(name_or_id, metadata)
Set aggregate metadata, replacing the existing metadata.
Parameters
• name_or_id Name of the host aggregate to update
• metadata Dict containing metadata to replace (Use {key: None} to re-
move a key)
Returns a dict representing the new host aggregate.
set_compute_quotas(name_or_id, **kwargs)
Set a quota in a project
Parameters
• kwargs key/value pairs of quota name and quota value
Raises OpenStackCloudException if the resource to set the quota does not exist.
set_container_access(name, access)
Set the access control list on a container.
Parameters
• name (str) Name of the container.
• access (str) ACL string to set on the container. Can also be public
or private which will be translated into appropriate ACL strings.

set_flavor_specs(flavor_id, extra_specs)
Add extra specs to a flavor
Parameters
• flavor_id (string) ID of the flavor to update.
• extra_specs (dict) Dictionary of key-value pairs.
Raises OpenStackCloudResourceNotFound if flavor ID is not found.
set_machine_maintenance_state(name_or_id, state=True, reason=None)
Set Baremetal Machine Maintenance State
Sets Baremetal maintenance state and maintenance reason.
Parameters
baremetal node.
• state (boolean) The desired state of the node. True being in mainte-
nance where as False means the machine is not in maintenance mode. This
value defaults to True if not explicitly set.
• reason (string) An optional freeform string that is supplied to the
baremetal API to allow for notation as to why the node is in maintenance
state.
Returns None
set_machine_power_off(name_or_id)
De-activate baremetal machine power
This is a method that sets the node power state to off.
Params string name_or_id A string representing the baremetal node to have
power turned to an off state.
Returns
set_machine_power_on(name_or_id)
Activate baremetal machine power
This is a method that sets the node power state to on.
power turned to an on state.
Returns None
set_machine_power_reboot(name_or_id)
De-activate baremetal machine power
This is a method that sets the node power state to reboot, which in essence changes the
machine power state to off, and that back to on.


power turned to an off state.
Returns None
set_network_quotas(name_or_id, **kwargs)
Set a network quota in a project
Parameters
set_server_metadata(name_or_id, metadata)
Set metadata in a server instance.
Parameters
• name_or_id (str) The name or ID of the server instance to update.
• metadata (dict) A dictionary with the key=value pairs to set in the
server instance. It only updates the key=value pairs provided. Existing ones
will remain untouched.
set_volume_bootable(name_or_id, bootable=True)
Set a volumes bootable flag.
Parameters
• name_or_id Name, unique ID of the volume or a volume dict.
• bootable (bool) Whether the volume should be bootable. (Defaults to
True)
set_volume_quotas(name_or_id, **kwargs)
Set a volume quota in a project
Parameters
sign_coe_cluster_certificate(cluster_id, csr)
Sign client key and generate the CA certificate for a cluster
Parameters
• cluster_id UUID of the cluster.

• csr Certificate Signing Request (CSR) for authenticating client key.The

CSR will be used by Magnum to generate a signed certificate that client will
use to communicate with the cluster.
Returns a dict representing the signed certs.
stream_object(container, obj, query_string=None, resp_chunk_size=1024)
Download the content via a streaming iterator.
Parameters
• resp_chunk_size (int) chunk size of data to read. Only used if the
results are
Returns An iterator over the content or None if the object is not found.
unbind_accelerator_request(uuid, properties)
Unbind an accelerator from VM. :param uuid: The uuid of the accelerator_request to be
unbinded. :param properties: The info of VM that will unbind the accelerator. :returns:True
if unbind succeeded, False otherwise.
unregister_machine(nics, uuid, wait=None, timeout=600)
Unregister Baremetal from Ironic
Removes entries for Network Interfaces and baremetal nodes from an Ironic API
Parameters
• nics An array of strings that consist of MAC addresses to be removed.
• uuid (string) The UUID of the node to be deleted.
• wait DEPRECATED, do not use.
• timeout Integer value, representing seconds with a default value of 600,
which controls the maximum amount of time to block until a lock is released
on machine.
Raises OpenStackCloudException on operation failure.
unset_flavor_specs(flavor_id, keys)
Delete extra specs from a flavor
Parameters
• flavor_id (string) ID of the flavor to update.
• keys List of spec keys to delete.
Raises OpenStackCloudResourceNotFound if flavor ID is not found.

update_aggregate(name_or_id, **kwargs)
Update a host aggregate.
Parameters
• name_or_id Name or ID of the aggregate being updated.
• name New aggregate name
• availability_zone Availability zone to assign to hosts
Returns a dict representing the updated host aggregate.
update_baymodel(name_or_id, operation, **kwargs)
Update a cluster template.
Parameters
• name_or_id Name or ID of the cluster template being updated.
• operation Operation to perform - add, remove, replace.
Other arguments will be passed with kwargs.
Returns a dict representing the updated cluster template.
update_cluster_template(name_or_id, operation, **kwargs)
Parameters
update_coe_cluster(name_or_id, operation, **kwargs)
Update a COE cluster.
Parameters
• name_or_id Name or ID of the COE cluster being updated.
Returns a dict representing the updated cluster.
update_coe_cluster_template(name_or_id, operation, **kwargs)
Parameters


update_container(name, headers)
Update the metadata in a container.
Parameters
• name (str) Name of the container to create.
• headers (dict) Key/Value headers to set on the container.
update_firewall_group(name_or_id, filters=None, **kwargs)
Updates firewall group. To unset egress- or ingress firewall policy, set egress_firewall_policy
or ingress_firewall_policy to None. You can also set egress_firewall_policy_id and
ingress_firewall_policy_id directly, which will skip the policy lookups.
Parameters
• kwargs firewall group update parameters See create_firewall_group doc-
string for valid parameters.
Raises ResourceNotFound if firewall group, a firewall policy (egress, ingress) or
port is not found
Returns updated firewall group
update_firewall_policy(name_or_id, filters=None, **kwargs)
Updates firewall policy.
Parameters
• kwargs firewall policy update parameters See create_firewall_policy doc-
string for valid parameters.
Raises ResourceNotFound if resource is not found

update_firewall_rule(name_or_id, filters=None, **kwargs)

Updates firewall rule.
Parameters
• kwargs firewall rule update parameters. See create_firewall_rule docstring
for valid parameters.
Raises NotFoundException if resource is not found
Returns updated firewall rule
update_group(name_or_id, name=None, description=None, **kwargs)
Update an existing group
Parameters
• name (string) New group name.
• description (string) New group description.
OpenStack API call.
update_machine(name_or_id, **attrs)
Update a machine with new configuration information
A user-friendly method to perform updates of a machine, in whole or part.
Parameters
• name_or_id (string) A machine name or UUID to be updated.
• attrs Attributes to updated on the machine.
Returns munch.Munch containing a machine sub-dictonary consisting of the
updated data returned from the API update operation, and a list named changes
which contains all of the API paths that received updates.
update_network(name_or_id, **kwargs)
Update a network.
Parameters
• name_or_id (string) Name or ID of the network being updated.
• name (string) New name of the network.
• shared (bool) Set the network as shared.
• admin_state_up (bool) Set the network administrative state to up.

• external (bool) Whether this network is externally accessible.

• provider (dict) A dict of network provider options. Example:
{ 'network_type': 'vlan', 'segmentation_id': 'vlan1' }
• mtu_size (int) New maximum transmission unit value to address frag-

mentation. Minimum value is 68 for IPv4, and 1280 for IPv6.
• port_security_enabled (bool) Enable or disable port security.
• dns_domain (string) Specify the DNS domain associated with this
network.
Returns The updated network object.
update_object(container, name, metadata=None, **headers)
Update the metadata of an object
Parameters
• container The name of the container the object is in
object
• headers These will be passed through to the object update API as HTTP
Headers.
update_port(name_or_id, **kwargs)
Update a port
Note: to unset an attribute use None value. To leave an attribute untouched just omit it.
Parameters
• name_or_id name or ID of the port to update. (Required)
• name A symbolic name for the port. (Optional)
• admin_state_up The administrative status of the port, which is up
(true) or down (false). (Optional)
• fixed_ips List of ip_addresses and subnet_ids. (Optional) If you spec-
ify only a subnet ID, OpenStack Networking allocates an available IP from
that subnet to the port. If you specify both a subnet ID and an IP address,
OpenStack Networking tries to allocate the specified address to the port. For
example:
[
{
"ip_address": "10.29.29.13",
"subnet_id": "a78484c4-c380-4b47-85aa-21c51a2d8cbd"
}, ...
]

• security_groups List of security group UUIDs. (Optional)

• allowed_address_pairs Allowed address pairs list (Optional) For
example:
[
{
"ip_address": "23.23.23.1",
"mac_address": "fa:16:3e:c4:cd:3f"
}, ...
]
• extra_dhcp_opts Extra DHCP options. (Optional). For example:
[
{
"opt_name": "opt name1",
"opt_value": "value1"
}, ...
]
• device_owner The ID of the entity that uses this port. For example, a
DHCP agent. (Optional)
• device_id The ID of the resource this port is attached to.
• vnic_type (binding) The type of the created port. (Optional)
• port_security_enabled The security port state created on the net-
work. (Optional)
• qos_policy_id The ID of the QoS policy to apply for port.
Returns a munch.Munch describing the updated port.
update_qos_bandwidth_limit_rule(policy_name_or_id, rule_id, **kwargs)
Update a QoS bandwidth limit rule.
Parameters
• max_kbps (int) Maximum bandwidth limit value (in kilobits per sec-
ond).
• max_burst_kbps (int) Maximum burst value (in kilobits).
fic will be limited.
Returns The updated QoS bandwidth limit rule.
update_qos_dscp_marking_rule(policy_name_or_id, rule_id, **kwargs)
Update a QoS DSCP marking rule.

Parameters
• dscp_mark (int) DSCP mark value
Returns The updated QoS bandwidth limit rule.
update_qos_minimum_bandwidth_rule(policy_name_or_id, rule_id, **kwargs)
Update a QoS minimum bandwidth rule.
Parameters
• min_kbps (int) Minimum bandwidth value (in kilobits per second).
fic will be available.
Returns The updated QoS minimum bandwidth rule.
update_qos_policy(name_or_id, **kwargs)
Update an existing QoS policy.
Parameters
• name_or_id (string) Name or ID of the QoS policy to update.
• policy_name (string) The new name of the QoS policy.
• description (string) The new description of the QoS policy.
• shared (bool) If True, the QoS policy will be set as shared.
• default (bool) If True, the QoS policy will be set as default for project.
Returns The updated QoS policy object.
update_recordset(zone, name_or_id, **kwargs)
Update a recordset.
Parameters
• name_or_id Name or ID of the recordset being updated.
• records List of the recordset definitions
• description Description of the recordset
• ttl TTL (Time to live) value in seconds of the recordset

Returns a dict representing the updated recordset.

update_role(name_or_id, name, **kwargs)
Update a Keystone role.
Parameters
• name_or_id Name or id of the role to update
• name (string) The new role name
• domain_id domain id
Returns a munch.Munch containing the role description
Raises OpenStackCloudException if the role cannot be created
update_router(name_or_id, name=None, admin_state_up=None,
ext_gateway_net_id=None, enable_snat=None, ext_fixed_ips=None,
routes=None)
Update an existing logical router.
Parameters
• name_or_id (string) The name or UUID of the router to update.
• name (string) The new router name.
• admin_state_up (bool) The administrative state of the router.
• ext_gateway_net_id (string) The network ID for the external
gateway.
• enable_snat (bool) Enable Source NAT (SNAT) attribute.
• ext_fixed_ips List of dictionaries of desired IP and/or subnet on the
external network. Example:
[
{
"subnet_id": "8ca37218-28ff-41cb-9b10-039601ea7e6b
,→ ",
"ip_address": "192.168.10.2"
}
]
• routes (list) A list of dictionaries with destination and nexthop param-

eters. To clear all routes pass an empty list ([]).
Example:
[
{
"destination": "179.24.1.0/24",
"nexthop": "172.24.3.99"
}
]
Returns The router object.


update_security_group(name_or_id, **kwargs)
Update a security group
Parameters
• name_or_id (string) Name or ID of the security group to update.
• name (string) New name for the security group.
• description (string) New description for the security group.
Returns A munch.Munch describing the updated security group.
update_server(name_or_id, detailed=False, bare=False, **kwargs)
Update a server.
Parameters
• name_or_id Name of the server to be updated.
to False.
Name New name for the server
Description New description for the server
Returns a dictionary representing the updated server.
update_stack(name_or_id, template_file=None, template_url=None, tem-
plate_object=None, files=None, rollback=True, tags=None,
wait=False, timeout=3600, environment_files=None, **parameters)
Update a stack.
Parameters
• name_or_id (string) Name or ID of the stack to update.
• template_file (string) Path to the template.
• template_url (string) URL of template.
• template_object (string) URL to retrieve template object.
• files (dict) dict of additional file content to include.
• rollback (boolean) Enable rollback on update failure.
• wait (boolean) Whether to wait for the delete to finish.
• timeout (int) Stack update timeout in seconds.
• environment_files Paths to environment files to apply.
Other arguments will be passed as stack parameters which will take precedence over any
parameters specified in the environments.

Only one of template_file, template_url, template_object should be specified.

Returns a dict containing the stack description
OpenStack API calls
update_subnet(name_or_id, subnet_name=None, enable_dhcp=None, gate-
way_ip=None, disable_gateway_ip=None, allocation_pools=None,
dns_nameservers=None, host_routes=None)
Update an existing subnet.
Parameters
• name_or_id (string) Name or ID of the subnet to update.
• subnet_name (string) The new name of the subnet.
• enable_dhcp (bool) Set to True if DHCP is enabled and False if
disabled.
• gateway_ip (string) The gateway IP address. When you specify both
allocation_pools and gateway_ip, you must ensure that the gateway IP does
not overlap with the specified allocation pools.
• disable_gateway_ip (bool) Set to True if gateway IP address is
disabled and False if enabled. It is not allowed with gateway_ip. Default
is False.
• allocation_pools A list of dictionaries of the start and end addresses
for the allocation pools. For example:
[
{
"start": "192.168.199.2",
"end": "192.168.199.254"
}
]
• dns_nameservers A list of DNS name servers for the subnet. For ex-
ample:
[ "8.8.8.7", "8.8.8.8" ]
• host_routes A list of host route dictionaries for the subnet. For exam-
ple:
[
{
"destination": "0.0.0.0/0",
"nexthop": "123.456.78.9"
},
{
"destination": "192.168.0.0/24",
"nexthop": "192.168.0.1"
}
]
Returns The updated subnet object.


update_zone(name_or_id, **kwargs)
Update a zone.
Parameters
• name_or_id Name or ID of the zone being updated.
• email Email of the zone owner (only applies if zone_type is primary)
• description Description of the zone
• ttl TTL (Time to live) value in seconds
• masters Master nameservers (only applies if zone_type is secondary)
Returns a dict representing the updated zone.
validate_machine(name_or_id, for_deploy=True)
Validate parameters of the machine.
Parameters
baremetal node.
• for_deploy (bool) If True, validate readiness for deployment, other-
wise validate only the power management properties.
Raises ValidationException
wait_for_baremetal_node_lock(node, timeout=30)
Wait for a baremetal node to have no lock.
DEPRECATED, use wait_for_node_reservation on the baremetal proxy.
Raises OpenStackCloudException upon client failure.
Returns None
wait_for_server(server, auto_ip=True, ips=None, ip_pool=None, reuse=True, time-
out=180, nat_destination=None)
Wait for a server to reach ACTIVE status.
Transitioning from Profile
Support exists for users coming from older releases of OpenStack SDK who have been using the
Profile interface.

Transition from Profile
Note: This section describes migrating code from a previous interface of openstacksdk and can be
ignored by people writing new code.
If you have code that currently uses the Profile object and/or an authenticator instance from
an object based on openstack.auth.base.BaseAuthPlugin, that code should be updated to
use the CloudRegion object instead.
Important: Profile is going away. Existing code using it should be migrated as soon as possible.
Writing Code that Works with Both
These examples should all work with both the old and new interface, with one caveat. With the old
interface, the CloudConfig object comes from the os-client-config library, and in the new
interface that has been moved into the SDK. In order to write code that works with both the old and new
interfaces, use the following code to import the config namespace:
try:
from openstack import config as occ
except ImportError:
from os_client_config import config as occ
The examples will assume that the config module has been imported in that manner.
Note: Yes, there is an easier and less verbose way to do all of these. These are verbose to handle both
the old and new interfaces in the same codebase.
Replacing authenticator
There is no direct replacement for openstack.auth.base.BaseAuthPlugin.

openstacksdk uses the keystoneauth library for authentication and HTTP interactions. key-
stoneauth has auth plugins that can be used to control how authentication is done. The auth_type
config parameter can be set to choose the correct authentication method to be used.
Replacing Profile
The right way to replace the use of openstack.profile.Profile depends a bit on what
youre trying to accomplish. Common patterns are listed below, but in general the approach is ei-
ther to pass a cloud name to the openstack.connection.Connection constructor, or to construct a open-
stack.config.cloud_region.CloudRegion object and pass it to the constructor.
All of the examples on this page assume that you want to support old and new interfaces simultane-
ously. There are easier and less verbose versions of each that are available if you can just make a clean
transition.

Getting a Connection to a named cloud from clouds.yaml
If you want is to construct a openstack.connection.Connection based on parameters configured in a

clouds.yaml file, or from environment variables:
import openstack.connection
conn = connection.from_config(cloud_name='name-of-cloud-you-want')
Getting a Connection from python arguments avoiding clouds.yaml
If, on the other hand, you want to construct a openstack.connection.Connection, but are in a context
where reading config from a clouds.yaml file is undesirable, such as inside of a Service:
• create a openstack.config.loader.OpenStackConfig object, telling it to not load yaml files. Option-
ally pass an app_name and app_version which will be added to user-agent strings.
• get a openstack.config.cloud_region.CloudRegion object from it
• get a openstack.connection.Connection
try:
except ImportError:
loader = occ.OpenStackConfig(
load_yaml_files=False,
app_name='spectacular-app',
app_version='1.0')
cloud_region = loader.get_one_cloud(
region_name='my-awesome-region',
auth_type='password',
auth=dict(
user_domain_name='example-domain',
project_name='astounding-project',
user_project_name='example-domain',
))
conn = connection.from_config(cloud_config=cloud_region)
Note: app_name and app_version are completely optional, and auth_type defaults to password. They
are shown here for clarity as to where they should go if they want to be set.

Getting a Connection from python arguments and optionally clouds.yaml
If you want to make a connection from python arguments and want to allow one of them to optionally
be cloud to allow selection of a named cloud, its essentially the same as the previous example, except
without load_yaml_files=False.
try:
except ImportError:
loader = occ.OpenStackConfig(
app_name='spectacular-app',
app_version='1.0')
cloud_region = loader.get_one_cloud(
region_name='my-awesome-region',
auth_type='password',
auth=dict(
user_domain_name='example-domain',
project_name='astounding-project',
user_project_name='example-domain',
))
conn = connection.from_config(cloud_config=cloud_region)
Parameters to get_one_cloud
The most important things to note are:

• auth_type specifies which kind of authentication plugin to use. It controls how authentication
is done, as well as what parameters are required.
• auth is a dictionary containing the parameters needed by the auth plugin. The most common
information it needs are user, project, domain, auth_url and password.
• The rest of the keyword arguments to openstack.config.loader.OpenStackConfig.
get_one_cloud are either parameters needed by the keystoneauth Session object, which con-
trol how HTTP connections are made, or parameters needed by the keystoneauth Adapter object,
which control how services are found in the Keystone Catalog.
For keystoneauth Adapter parameters, since there is one openstack.connection.Connection object but
many services, per-service parameters are formed by using the official service_type of the ser-
vice in question. For instance, to override the endpoint for the compute service, the parameter
compute_endpoint_override would be used.
region_name in openstack.profile.Profile was a per-service parameter. This is no longer
a valid concept. An openstack.connection.Connection is a connection to a region of a cloud. If you are
in an extreme situation where you have one service in one region and a different service in a different
region, you must use two different openstack.connection.Connection objects.
Note: service_type, although a parameter for keystoneauth1.adapter.Adapter, is not a valid pa-

rameter for get_one_cloud. service_type is the key by which services are referred, so saying com-
pute_service_type=henry doesnt have any meaning.
Once you have a Connection instance, services are accessed through instances of Proxy or subclasses
of it that exist as attributes on the Connection.
Service Proxies
The following service proxies exist on the Connection. The service proxies are all always present on
the Connection object, but the combination of your CloudRegion and the catalog of the cloud in
question control which services can be used.
Accelerator API
The Accelerator Class
The accelerator high-level interface is available through the accelerator member of a

Connection object. The accelerator member will only be added if the service is detected.
Device Operations
class openstack.accelerator.v2._proxy.Proxy(session, statsd_client=None,

statsd_prefix=None,
prometheus_counter=None,
prometheus_histogram=None,
influxdb_config=None, in-
fluxdb_client=None, *args,
**kwargs)
devices(**query)
Retrieve a generator of devices.
Parameters query (kwargs) Optional query parameters to be sent to restrict
the devices to be returned. Available parameters include: * hostname: The
hostname of the device. * type: The type of the device. * vendor: The vendor
ID of the device. * sort: A list of sorting keys separated by commas. Each
sorting key can optionally be attached with a sorting direction modifier which
can be asc or desc. * limit: Requests a specified size of returned items from
the query. Returns a number of items up to the specified limit value. * marker:
Specifies the ID of the last-seen item. Use the limit parameter to make an
initial limited request and use the ID of the last-seen item from the response as
the marker parameter value in a subsequent limited request.
Returns A generator of device instances.
get_device(uuid, fields=None)
Get a single device.
Parameters uuid The value can be the UUID of a device.
Returns One Device

Raises ResourceNotFound when no deployable matching the criteria could

be found.
Deployable Operations

**kwargs)
deployables(**query)
Retrieve a generator of deployables.
the deployables to be returned.
Returns A generator of deployable instances.
get_deployable(uuid, fields=None)
Get a single deployable.
Parameters uuid The value can be the UUID of a deployable.
Returns One Deployable
Raises ResourceNotFound when no deployable matching the criteria could
be found.
update_deployable(uuid, patch)
Reconfig the FPGA with new bitstream.
Parameters
• uuid The value can be the UUID of a deployable
• patch The infomation of to reconfig.
Returns The results of FPGA reconfig.
Device Profile Operations

**kwargs)
device_profiles(**query)
Retrieve a generator of device profiles.


the device profiles to be returned.
Returns A generator of device profile instances.
create_device_profile(**attrs)
Create a device_profiles.
Parameters attrs (kwargs) a list of device_profiles.
Returns The list of created device profiles
delete_device_profile(name_or_id, ignore_missing=True)
Delete an device profile
Parameters
• name_or_id The value can be either the ID of an device profile.
• ignore_missing (bool) When set to False ResourceNotFound
will be raised when the device profile does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent device profile.
Returns None
get_device_profile(uuid, fields=None)
Get a single device profile.
Parameters uuid The value can be the UUID of a device profile.
Returns One :class: ~openstack.accelerator.v2.device_profile.DeviceProfile
Raises ResourceNotFound when no device profile matching the criteria could
be found.
Accelerator Request Operations

**kwargs)
accelerator_requests(**query)
Retrieve a generator of accelerator requests.
the accelerator requests to be returned.
Returns A generator of accelerator request instances.
create_accelerator_request(**attrs)
Create an ARQs for a single device profile.
Parameters attrs (kwargs) request body.

delete_accelerator_request(name_or_id, ignore_missing=True)
Delete an device profile :param name_or_id: The value can be either the ID of an accelerator
request. :param bool ignore_missing: When set to False ResourceNotFound will be
raised when the device profile does not exist. When set to True, no exception will be set
when attempting to delete a nonexistent accelerator request. :returns: None
get_accelerator_request(uuid, fields=None)
Get a single accelerator request. :param uuid: The value can
be the UUID of a accelerator request. :returns: One :class:
~openstack.accelerator.v2.accelerator_request.AcceleratorRequest :raises:
ResourceNotFound when no accelerator request matching the criteria could be
found.
update_accelerator_request(uuid, properties)
Bind/Unbind an accelerator to VM. :param uuid: The uuid of the accelerator_request to be
binded/unbinded. :param properties: The info of VM that will bind/unbind the accelerator.
:returns: True if bind/unbind succeeded, False otherwise.
Baremetal API
For details on how to use baremetal, see Using OpenStack Baremetal
The Baremetal Class
The baremetal high-level interface is available through the baremetal member of a Connection
object. The baremetal member will only be added if the service is detected.
Node Operations
class openstack.baremetal.v1._proxy.Proxy(session, statsd_client=None,

**kwargs)
nodes(details=False, **query)
Retrieve a generator of nodes.
Parameters
• details A boolean indicating whether the detailed information for every
node should be returned.
• query (dict) Optional query parameters to be sent to restrict the nodes
returned. Available parameters include:
– associated: Only return those which are, or are not, associated with
an instance_id.

– conductor_group: Only return those in the specified

conductor_group.
– driver: Only return those with the specified driver.
– fault: Only return those with the specified fault type.
– fields: A list containing one or more fields to be returned in the re-
sponse. This may lead to some performance gain because other fields of
the resource are not refreshed.
– instance_id: Only return the node with this specific instance UUID
or an empty set if not found.
– is_maintenance: Only return those with maintenance set to
True or False.
– limit: Requests at most the specified number of nodes be returned from
the query.
– marker: Specifies the ID of the last-seen node. Use the limit param-
eter to make an initial limited request and use the ID of the last-seen node
from the response as the marker value in a subsequent limited request.
– provision_state: Only return those nodes with the specified
provision_state.
– resource_class: Only return those with the specified
resource_class.
– sort_dir: Sorts the response by the requested sort direction. A valid
value is asc (ascending) or desc (descending). Default is asc. You
can specify multiple pairs of sort key and sort direction query parameters.
If you omit the sort direction in a pair, the API uses the natural sorting
direction of the server attribute that is provided as the sort_key.
– sort_key: Sorts the response by the this attribute value. Default is id.
You can specify multiple pairs of sort key and sort direction query pa
rameters. If you omit the sort direction in a pair, the API uses the natural
sorting direction of the server attribute that is provided as the sort_key.
Returns A generator of Node
create_node(**attrs)
Create a new node from attributes.
Parameters attrs (dict) Keyword arguments that will be used to create a
Node.
Returns The results of node creation.
Return type Node.
find_node(name_or_id, ignore_missing=True)
Find a single node.
Parameters
• name_or_id (str) The name or ID of a node.

• ignore_missing (bool) When set to False, an exception of

ResourceNotFound will be raised when the node does not exist. When
set to True‘, None will be returned when attempting to find a nonexistent
node.
Returns One Node object or None.
get_node(node, fields=None)
Get a specific node.
Parameters
• node The value can be the name or ID of a node or a Node instance.
• fields Limit the resource fields to fetch.
Returns One Node
Raises ResourceNotFound when no node matching the name or ID could be
found.
update_node(node, retry_on_conflict=True, **attrs)
Update a node.
Parameters
• retry_on_conflict (bool) Whether to retry HTTP CONFLICT er-
ror. Most of the time it can be retried, since it is caused by the node being
locked. However, when setting instance_id, this is a normal code and
should not be retried.
• attrs (dict) The attributes to update on the node represented by the
node parameter.
Returns The updated node.
Return type Node
patch_node(node, patch, reset_interfaces=None, retry_on_conflict=True)
Apply a JSON patch to the node.
Parameters
• patch JSON patch to apply.
• reset_interfaces (bool) whether to reset the node hardware inter-
faces to their defaults. This works only when changing drivers. Added in
API microversion 1.45.
• retry_on_conflict (bool) Whether to retry HTTP CONFLICT er-
ror. Most of the time it can be retried, since it is caused by the node being
locked. However, when setting instance_id, this is a normal code and
should not be retried.
See Update Node for details.
Return type Node

set_node_provision_state(node, target, config_drive=None, clean_steps=None,

rescue_password=None, wait=False, timeout=None)
Run an action modifying nodes provision state.
This call is asynchronous, it will return success as soon as the Bare Metal service acknowl-
edges the request.
Parameters
• target Provisioning action, e.g. active, provide. See the Bare Metal
service documentation for available actions.
• config_drive Config drive to pass to the node, only valid for active`
and ``rebuild targets. You can use functions from openstack.
baremetal.configdrive to build it.
• clean_steps Clean steps to execute, only valid for clean target.
• rescue_password Password for the rescue operation, only valid for
rescue target.
• wait Whether to wait for the node to get into the expected state. The
expected state is determined from a combination of the current provision
state and target.
• timeout If wait is set to True, specifies how much (in seconds) to wait
for the expected state to be reached. The value of None (the default) means
no client-side timeout.
Returns The updated Node
Raises ValueError if config_drive, clean_steps or
rescue_password are provided with an invalid target.
wait_for_nodes_provision_state(nodes, expected_state, timeout=None,
abort_on_failed_state=True, fail=True)
Wait for the nodes to reach the expected state.
Parameters
• nodes List of nodes - name, ID or Node instance.
• expected_state The expected provisioning state to reach.
• abort_on_failed_state If True (the default), abort waiting if any
node reaches a failure state which does not match the expected one. Note
that the failure state for enroll -> manageable transition is enroll
again.
• fail If set to False this call will not raise on timeouts and provisioning
failures.
Returns If fail is True (the default), the list of Node instances that reached the
requested state. If fail is False, a WaitResult named tuple.

Raises ResourceFailure if a node reaches an error state and

abort_on_failed_state is True.
Raises ResourceTimeout on timeout.
set_node_power_state(node, target, wait=False, timeout=None)
Run an action modifying nodes power state.
edges the request.
Parameters
• target Target power state, one of PowerAction or a string.
• wait Whether to wait for the node to get into the expected state.
wait_for_node_power_state(node, expected_state, timeout=None)
Wait for the node to reach the power state.
Parameters
• timeout How much (in seconds) to wait for the target state to be reached.
The value of None (the default) means no timeout.
wait_for_node_reservation(node, timeout=None)
Wait for a lock on the node to be released.
Bare metal nodes in ironic have a reservation lock that is used to represent that a conductor
has locked the node while performing some sort of action, such as changing configuration
as a result of a machine state change.
This lock can occur during power syncronization, and prevents updates to objects attached
to the node, such as ports.
Note that nothing prevents a conductor from acquiring the lock again after this call returns,
so it should be treated as best effort.
Returns immediately if there is no reservation on the node.
Parameters
• timeout How much (in seconds) to wait for the lock to be released. The
value of None (the default) means no timeout.
validate_node(node, required=(’boot’, ’deploy’, ’power’))
Validate required information on a node.
Parameters

• node The value can be either the name or ID of a node or a Node instance.
• required List of interfaces that are required to pass validation. The de-
fault value is the list of minimum required interfaces for provisioning.
Returns dict mapping interface names to ValidationResult objects.
Raises ValidationException if validation fails for a required interface.
set_node_maintenance(node, reason=None)
Enable maintenance mode on the node.
Parameters
• reason Optional reason for maintenance.
Returns This Node instance.
unset_node_maintenance(node)
Disable maintenance mode on the node.
Parameters node The value can be either the name or ID of a node or a Node
instance.
delete_node(node, ignore_missing=True)
Delete a node.
Parameters
• ignore_missing (bool) When set to False, an exception
ResourceNotFound will be raised when the node could not be found.
When set to True, no exception will be raised when attempting to delete a
non-existent node.
Returns The instance of the node which was deleted.
Return type Node.
Port Operations

**kwargs)
ports(details=False, **query)
Retrieve a generator of ports.
Parameters


port should be returned.
• query (dict) Optional query parameters to be sent to restrict the ports
returned. Available parameters include:
– address: Only return ports with the specified physical hardware ad-
dress, typically a MAC address.
– driver: Only return those with the specified driver.
– limit: Requests at most the specified number of ports be returned from
the query.
– marker: Specifies the ID of the last-seen port. Use the limit parame-
ter to make an initial limited request and use the ID of the last-seen port
from the response as the marker value in a subsequent limited request.
– node:only return the ones associated with this specific node (name or
UUID), or an empty set if not found.
– node_id:only return the ones associated with this specific node UUID,
or an empty set if not found.
– portgroup: only return the ports associated with this specific Port-
group (name or UUID), or an empty set if not found. Added in API mi-
croversion 1.24.
– sort_key: Sorts the response by the this attribute value. Default is
id. You can specify multiple pairs of sort key and sort direction query
parameters. If you omit the sort direction in a pair, the API uses the natural
Returns A generator of port instances.
create_port(**attrs)
Create a new port from attributes.
Port.
Returns The results of port creation.
Return type Port.
find_port(name_or_id, ignore_missing=True)
Find a single port.
Parameters
• name_or_id (str) The ID of a port.


ResourceNotFound will be raised when the port does not exist. When
set to True‘, None will be returned when attempting to find a nonexistent
port.
Returns One Port object or None.
get_port(port, fields=None)
Get a specific port.
Parameters
• port The value can be the ID of a port or a Port instance.
Returns One Port
Raises ResourceNotFound when no port matching the name or ID could be
found.
update_port(port, **attrs)
Update a port.
Parameters
• port Either the ID of a port or an instance of Port.
• attrs (dict) The attributes to update on the port represented by the
port parameter.
Returns The updated port.
Return type Port
patch_port(port, patch)
Apply a JSON patch to the port.
Parameters
• port The value can be the ID of a port or a Port instance.
Returns The updated port.
Return type Port
delete_port(port, ignore_missing=True)
Delete a port.
Parameters
• port The value can be either the ID of a port or a Port instance.
ResourceNotFound will be raised when the port could not be found.
non-existent port.
Returns The instance of the port which was deleted.
Return type Port.

Port Group Operations

**kwargs)
port_groups(details=False, **query)
Retrieve a generator of port groups.
Parameters
port group should be returned.
• query (dict) Optional query parameters to be sent to restrict the port
groups returned. Available parameters include:
– address: Only return portgroups with the specified physical hardware
address, typically a MAC address.
– limit: Requests at most the specified number of portgroups returned
from the query.
– marker: Specifies the ID of the last-seen portgroup. Use the limit
parameter to make an initial limited request and use the ID of the last-
seen portgroup from the response as the marker value in a subsequent
limited request.
Returns A generator of port group instances.
create_port_group(**attrs)
Create a new portgroup from attributes.
PortGroup.

Returns The results of portgroup creation.

Return type PortGroup.
find_port_group(name_or_id, ignore_missing=True)
Find a single port group.
Parameters
• name_or_id (str) The name or ID of a portgroup.
ResourceNotFound will be raised when the port group does not exist.
When set to True‘, None will be returned when attempting to find a nonex-
istent port group.
Returns One PortGroup object or None.
get_port_group(port_group, fields=None)
Get a specific port group.
Parameters
• port_group The value can be the name or ID of a chassis or a
PortGroup instance.
Returns One PortGroup
Raises ResourceNotFound when no port group matching the name or ID
could be found.
update_port_group(port_group, **attrs)
Update a port group.
Parameters
• port_group Either the name or the ID of a port group or an instance of
PortGroup.
• attrs (dict) The attributes to update on the port group represented by
the port_group parameter.
Returns The updated port group.
Return type PortGroup
patch_port_group(port_group, patch)
Apply a JSON patch to the port_group.
Parameters
• port_group The value can be the ID of a port group or a PortGroup
instance.
Returns The updated port group.
Return type PortGroup
delete_port_group(port_group, ignore_missing=True)
Delete a port group.

Parameters
• port_group The value can be either the name or ID of a port group or a
PortGroup instance.
ResourceNotFound will be raised when the port group could not be
found. When set to True, no exception will be raised when attempting to
delete a non-existent port group.
Returns The instance of the port group which was deleted.
Return type PortGroup.
Driver Operations

**kwargs)
drivers(details=False)
Retrieve a generator of drivers.
Parameters details (bool) A boolean indicating whether the detailed infor-
mation for every driver should be returned.
Returns A generator of driver instances.
get_driver(driver)
Get a specific driver.
Parameters driver The value can be the name of a driver or a Driver in-
stance.
Returns One Driver
Raises ResourceNotFound when no driver matching the name could be found.
Chassis Operations

**kwargs)
chassis(details=False, **query)
Retrieve a generator of chassis.

Parameters
chassis should be returned.
• query (dict) Optional query parameters to be sent to restrict the chassis
to be returned. Available parameters include:
– limit: Requests at most the specified number of items be returned from
the query.
– marker: Specifies the ID of the last-seen chassis. Use the limit pa-
rameter to make an initial limited request and use the ID of the last-seen
chassis from the response as the marker value in a subsequent limited
request.
Returns A generator of chassis instances.
create_chassis(**attrs)
Create a new chassis from attributes.
Chassis.
Returns The results of chassis creation.
Return type Chassis.
find_chassis(name_or_id, ignore_missing=True)
Find a single chassis.
Parameters
• name_or_id (str) The ID of a chassis.
ResourceNotFound will be raised when the chassis does not exist.
When set to True‘, None will be returned when attempting to find a nonex-
istent chassis.
Returns One Chassis object or None.
get_chassis(chassis, fields=None)
Get a specific chassis.
Parameters

• chassis The value can be the ID of a chassis or a Chassis instance.

Returns One Chassis
Raises ResourceNotFound when no chassis matching the name or ID could
be found.
update_chassis(chassis, **attrs)
Update a chassis.
Parameters
• chassis Either the ID of a chassis, or an instance of Chassis.
• attrs (dict) The attributes to update on the chassis represented by the
chassis parameter.
Returns The updated chassis.
Return type Chassis
patch_chassis(chassis, patch)
Apply a JSON patch to the chassis.
Parameters
• chassis The value can be the ID of a chassis or a Chassis instance.
Returns The updated chassis.
Return type Chassis
delete_chassis(chassis, ignore_missing=True)
Delete a chassis.
Parameters
• chassis The value can be either the ID of a chassis or a Chassis in-
stance.
ResourceNotFound will be raised when the chassis could not be found.
non-existent chassis.
Returns The instance of the chassis which was deleted.
Return type Chassis.

VIF Operations

**kwargs)
attach_vif_to_node(node, vif_id, retry_on_conflict=True)

Attach a VIF to the node.
The exact form of the VIF ID depends on the network interface used by the node. In the
most common case it is a Network service port (NOT a Bare Metal port) ID. A VIF can only
be attached to one node at a time.
Parameters
• vif_id (string) Backend-specific VIF ID.
• retry_on_conflict Whether to retry HTTP CONFLICT errors. This
can happen when either the VIF is already used on a node or the node is
locked. Since the latter happens more often, the default value is True.
Returns None
Raises NotSupported if the server does not support the VIF API.
detach_vif_from_node(node, vif_id, ignore_missing=True)
Detach a VIF from the node.
most common case it is a Network service port (NOT a Bare Metal port) ID.
Parameters
will be raised when the VIF does not exist. Otherwise, False is returned.
Returns True if the VIF was detached, otherwise False.
list_node_vifs(node)
List IDs of VIFs attached to the node.
Parameters node The value can be either the name or ID of a node or a Node
instance.
Returns List of VIF IDs as strings.

Allocation Operations

**kwargs)
allocations(**query)
Retrieve a generator of allocations.
Parameters query (dict) Optional query parameters to be sent to restrict the
allocation to be returned. Available parameters include:
• fields: A list containing one or more fields to be returned in the response.
This may lead to some performance gain because other fields of the resource
are not refreshed.
• limit: Requests at most the specified number of items be returned from
the query.
• marker: Specifies the ID of the last-seen allocation. Use the limit pa-
rameter to make an initial limited request and use the ID of the last-seen
allocation from the response as the marker value in a subsequent limited
request.
• sort_dir: Sorts the response by the requested sort direction. A valid
value is asc (ascending) or desc (descending). Default is asc. You can
specify multiple pairs of sort key and sort direction query parameters. If you
omit the sort direction in a pair, the API uses the natural sorting direction of
the server attribute that is provided as the sort_key.
• sort_key: Sorts the response by the this attribute value. Default is id.
You can specify multiple pairs of sort key and sort direction query parame-
ters. If you omit the sort direction in a pair, the API uses the natural sorting
Returns A generator of allocation instances.
create_allocation(**attrs)
Create a new allocation from attributes.
Allocation.
Returns The results of allocation creation.
Return type Allocation.
get_allocation(allocation, fields=None)
Get a specific allocation.
Parameters

• allocation The value can be the name or ID of an allocation or a

Allocation instance.
Returns One Allocation
Raises ResourceNotFound when no allocation matching the name or ID could
be found.
update_allocation(allocation, **attrs)
Update an allocation.
Parameters
• attrs (dict) The attributes to update on the allocation represented by
the allocation parameter.
Returns The updated allocation.
Return type Allocation
patch_allocation(allocation, patch)
Apply a JSON patch to the allocation.
Parameters
Returns The updated allocation.
Return type Allocation
delete_allocation(allocation, ignore_missing=True)
Delete an allocation.
Parameters
ResourceNotFound will be raised when the allocation could not be
found. When set to True, no exception will be raised when attempting
to delete a non-existent allocation.
Returns The instance of the allocation which was deleted.
wait_for_allocation(allocation, timeout=None, ignore_error=False)
Wait for the allocation to become active.
Parameters

• timeout How much (in seconds) to wait for the allocation. The value of
None (the default) means no client-side timeout.
• ignore_error If True, this call will raise an exception if the allocation
reaches the error state. Otherwise the error state is considered successful
and the call returns.
Returns The instance of the allocation.
Raises ResourceFailure if allocation fails and ignore_error is False.
Volume Connector Operations

**kwargs)
volume_connectors(details=False, **query)
Retrieve a generator of volume_connector.
Parameters
volume_connector should be returned.
• query (dict) Optional query parameters to be sent to restrict the vol-
ume_connectors returned. Available parameters include:
– limit: Requests at most the specified number of volume_connector be
returned from the query.
– marker: Specifies the ID of the last-seen volume_connector. Use the
limit parameter to make an initial limited request and use the ID of the
last-seen volume_connector from the response as the marker value in
subsequent limited request.
– sort_dir:Sorts the response by the requested sort direction. A valid


Returns A generator of volume_connector instances.
create_volume_connector(**attrs)
Create a new volume_connector from attributes.
:class: ~openstack.baremetal.v1.volume_connector.VolumeConnector.
Returns The results of volume_connector creation.
Rtype::class ~openstack.baremetal.v1.volume_connector.VolumeConnector.
find_volume_connector(vc_id, ignore_missing=True)
Find a single volume connector.
Parameters
• vc_id (str) The ID of a volume connector.
ResourceNotFound will be raised when the volume connector does not
exist. When set to True‘, None will be returned when attempting to find a
nonexistent volume connector.
Returns One :class: ~openstack.baremetal.v1.volumeconnector.VolumeConnector
object or None.
get_volume_connector(volume_connector, fields=None)
Get a specific volume_connector.
Parameters
• volume_connector The value can be the ID of a volume_connector or
a :class: ~openstack.baremetal.v1.volume_connector.VolumeConnector in-
stance.
• fields Limit the resource fields to fetch.‘
Returns One :class: ~openstack.baremetal.v1.volume_connector.VolumeConnector
Raises ResourceNotFound when no volume_connector matching the name or
ID could be found.‘
update_volume_connector(volume_connector, **attrs)
Update a volume_connector.
:param volume_connector:Either the ID of a volume_connector or an instance of :param
dict attrs: The attributes to update on the volume_connector represented by the
volume_connector parameter.‘
Returns The updated volume_connector.
patch_volume_connector(volume_connector, patch)
Apply a JSON patch to the volume_connector.

Parameters
• volume_connector The value can be the ID of a volume_connector or
a :class: ~openstack.baremetal.v1.volume_connector.VolumeConnector in-
stance.
Returns The updated volume_connector.
delete_volume_connector(volume_connector, ignore_missing=True)
Delete an volume_connector.
Parameters
• volume_connector The value can be either the ID of
a volume_connector.VolumeConnector or a :class: ~open-
stack.baremetal.v1.volume_connector.VolumeConnector instance.
ResourceNotFound will be raised when the volume_connector could
not be found. When set to True, no exception will be raised when attempt-
ing to delete a non-existent volume_connector.
Returns The instance of the volume_connector which was deleted.
Volume Target Operations

**kwargs)
volume_targets(details=False, **query)
Retrieve a generator of volume_target.
Parameters
volume_target should be returned.
• query (dict) Optional query parameters to be sent to restrict the vol-
ume_targets returned. Available parameters include:
– limit: Requests at most the specified number of volume_connector be
returned from the query.

– marker: Specifies the ID of the last-seen volume_target. Use the limit

parameter to make an initial limited request and use the ID of the last-
seen volume_target from the response as the marker value in subsequent
limited request.
– sort_dir:Sorts the response by the requested sort direction. A valid
Returns A generator of volume_target instances.
create_volume_target(**attrs)
Create a new volume_target from attributes.
:class: ~openstack.baremetal.v1.volume_target.VolumeTarget.
Returns The results of volume_target creation.
Rtype::class ~openstack.baremetal.v1.volume_target.VolumeTarget.
find_volume_target(vt_id, ignore_missing=True)
Find a single volume target.
Parameters
• vt_id (str) The ID of a volume target.
ResourceNotFound will be raised when the volume connector does not
exist. When set to True‘, None will be returned when attempting to find a
nonexistent volume target.
Returns One :class: ~openstack.baremetal.v1.volumetarget.VolumeTarget object
or None.
get_volume_target(volume_target, fields=None)
Get a specific volume_target.
Parameters
• volume_target The value can be the ID of a volume_target or a :class:
~openstack.baremetal.v1.volume_target.VolumeTarget instance.
• fields Limit the resource fields to fetch.‘
Returns One :class: ~openstack.baremetal.v1.volume_target.VolumeTarget
Raises ResourceNotFound when no volume_target matching the name or ID
could be found.‘

update_volume_target(volume_target, **attrs)
Update a volume_target.
:param volume_target:Either the ID of a volume_target or an instance of :param dict at-
trs: The attributes to update on the volume_target represented by the volume_target
parameter.‘
Returns The updated volume_target.
patch_volume_target(volume_target, patch)
Apply a JSON patch to the volume_target.
Parameters
• volume_target The value can be the ID of a volume_target or a :class:
~openstack.baremetal.v1.volume_target.VolumeTarget instance.
Returns The updated volume_target.
delete_volume_target(volume_target, ignore_missing=True)
Delete an volume_target.
Parameters
• volume_target The value can be either the ID
of a volume_target.VolumeTarget or a :class: ~open-
stack.baremetal.v1.volume_target.VolumeTarget instance.
ResourceNotFound will be raised when the volume_target could not
be found. When set to True, no exception will be raised when attempting
to delete a non-existent volume_target.
Returns The instance of the volume_target which was deleted.
Utilities
Building config drives
Helpers for building configdrive compatible with the Bare Metal service.

Baremetal Introspection API
The Baremetal Introspection Proxy
The baremetal introspection high-level interface is available through the

baremetal_introspection member of a Connection object. The
baremetal_introspection member will only be added if the service is detected.
Introspection Process Operations
class openstack.baremetal_introspection.v1._proxy.Proxy(session,
statsd_client=None,
in-
fluxdb_config=None,
in-
fluxdb_client=None,
*args,
**kwargs)
introspections(**query)
Retrieve a generator of introspection records.
Parameters query (dict) Optional query parameters to be sent to restrict the
records to be returned. Available parameters include:
• fields: A list containing one or more fields to be returned in the response.
This may lead to some performance gain because other fields of the resource
are not refreshed.
the query.
• marker: Specifies the ID of the last-seen introspection. Use the limit
parameter to make an initial limited request and use the ID of the last-seen
introspection from the response as the marker value in a subsequent lim-
ited request.
• sort_dir: Sorts the response by the requested sort direction. A valid
value is asc (ascending) or desc (descending). Default is asc. You can
specify multiple pairs of sort key and sort direction query parameters. If you
omit the sort direction in a pair, the API uses the natural sorting direction of
the server attribute that is provided as the sort_key.
• sort_key: Sorts the response by the this attribute value. Default is id.
You can specify multiple pairs of sort key and sort direction query parame-
ters. If you omit the sort direction in a pair, the API uses the natural sorting
Returns A generator of Introspection objects

start_introspection(node, manage_boot=None)
Create a new introspection from attributes.
Parameters
• manage_boot (bool) Whether to manage boot parameters for the node.
Defaults to the server default (which is True).
Returns Introspection instance.
get_introspection(introspection)
Get a specific introspection.
Parameters introspection The value can be the name or ID of an introspec-
tion (matching bare metal node name or ID) or an Introspection instance.
Raises ResourceNotFound when no introspection matching the name or ID
could be found.
get_introspection_data(introspection, processed=True)
Get introspection data.
Parameters
• introspection The value can be the name or ID of an introspection
(matching bare metal node name or ID) or an Introspection instance.
• processed Whether to fetch the final processed data (the default) or the
raw unprocessed data as received from the ramdisk.
Returns introspection data from the most recent successful run.
Return type dict
abort_introspection(introspection, ignore_missing=True)
Abort an introspection.
Note that the introspection is not aborted immediately, you may use wait_for_introspection
with ignore_error=True.
Parameters
ResourceNotFound will be raised when the introspection could not be
found. When set to True, no exception will be raised when attempting to
abort a non-existent introspection.
Returns nothing
wait_for_introspection(introspection, timeout=None, ignore_error=False)
Wait for the introspection to finish.
Parameters

• timeout How much (in seconds) to wait for the introspection. The value
of None (the default) means no client-side timeout.
• ignore_error If True, this call will raise an exception if the intro-
spection reaches the error state. Otherwise the error state is considered
successful and the call returns.
Raises ResourceFailure if introspection fails and ignore_error is
False.
Block Storage API
For details on how to use block_storage, see Using OpenStack Block Storage
The BlockStorage Class
The block_storage high-level interface is available through the block_storage member of a

Connection object. The block_storage member will only be added if the service is detected.
Volume Operations
class openstack.block_storage.v2._proxy.Proxy(session,
statsd_client=None,
**kwargs)
get_volume(volume)
Get a single volume
Parameters volume The value can be the ID of a volume or a Volume instance.
Returns One Volume
Raises ResourceNotFound when no resource can be found.
volumes(details=True, **query)
Retrieve a generator of volumes
Parameters
• details (bool) When set to False no extended attributes will be re-
turned. The default, True, will cause objects with additional attributes to
be returned.
• query (kwargs) Optional query parameters to be sent to limit the vol-
umes being returned. Available parameters include:

– name: Name of the volume as a string.

– all_projects: Whether return the volumes in all projects
– status: Value of the status of the volume so that you can filter on
available for example.
Returns A generator of volume objects.
create_volume(**attrs)
Create a new volume from attributes
Parameters attrs (dict) Keyword arguments which will be used to create a
Volume, comprised of the properties on the Volume class.
Returns The results of volume creation
Return type Volume
delete_volume(volume, ignore_missing=True)
Delete a volume
Parameters
• volume The value can be either the ID of a volume or a Volume instance.
will be raised when the volume does not exist. When set to True, no ex-
ception will be set when attempting to delete a nonexistent volume.
Returns None
Backup Operations
statsd_client=None,
**kwargs)
backups(details=True, **query)
Retrieve a generator of backups
Parameters
• details (bool) When set to False no additional details will be re-
turned. The default, True, will cause objects with additional attributes to
be returned.
• query (dict) Optional query parameters to be sent to limit the resources
being returned:
– offset: pagination marker
– limit: pagination limit

– sort_key: Sorts by an attribute. A valid value is name, status, con-

tainer_format, disk_format, size, id, created_at, or updated_at. Default
is created_at. The API uses the natural sorting direction of the sort_key
attribute value.
– sort_dir: Sorts by one or more sets of attribute and sort direction
combinations. If you omit the sort direction in a set, default is desc.
Returns A generator of backup objects.
get_backup(backup)
Get a backup
Parameters backup The value can be the ID of a backup or a Backup instance.
Returns Backup instance
Return type Backup
create_backup(**attrs)
Create a new Backup from attributes with native API
Backup comprised of the properties on the Backup class.
Returns The results of Backup creation
Return type Backup
delete_backup(backup, ignore_missing=True)
Delete a CloudBackup
Parameters
• backup The value can be the ID of a backup or a Backup instance
will be raised when the zone does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent zone.
Returns None
restore_backup(backup, volume_id, name)
Restore a Backup to volume
Parameters
• backup The value can be the ID of a backup or a Backup instance
• volume_id The ID of the volume to restore the backup to.
• name The name for new volume creation to restore.
Returns Updated backup instance
Return type Backup

Type Operations
statsd_client=None,
**kwargs)
get_type(type)
Get a single type
Parameters type The value can be the ID of a type or a Type instance.
Returns One Type
types(**query)
Retrieve a generator of volume types
Returns A generator of volume type objects.
create_type(**attrs)
Create a new type from attributes
Type, comprised of the properties on the Type class.
Returns The results of type creation
Return type Type
delete_type(type, ignore_missing=True)
Delete a type
Parameters
• type The value can be either the ID of a type or a Type instance.
will be raised when the type does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent type.
Returns None

Snapshot Operations
statsd_client=None,
**kwargs)
get_snapshot(snapshot)
Get a single snapshot
Parameters snapshot The value can be the ID of a snapshot or a Snapshot
instance.
Returns One Snapshot
snapshots(details=True, **query)
Retrieve a generator of snapshots
Parameters
• details (bool) When set to False Snapshot objects will be re-
turned. The default, True, will cause SnapshotDetail objects to be
returned.
• query (kwargs) Optional query parameters to be sent to limit the snap-
shots being returned. Available parameters include:
– name: Name of the snapshot as a string.
– all_projects: Whether return the snapshots in all projects.
– volume_id: volume id of a snapshot.
– status: Value of the status of the snapshot so that you can filter on
available for example.
Returns A generator of snapshot objects.
create_snapshot(**attrs)
Create a new snapshot from attributes
Snapshot, comprised of the properties on the Snapshot class.
Returns The results of snapshot creation
Return type Snapshot
delete_snapshot(snapshot, ignore_missing=True)
Delete a snapshot
Parameters
• snapshot The value can be either the ID of a snapshot or a Snapshot
instance.


will be raised when the snapshot does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent snapshot.
Returns None
Stats Operations
statsd_client=None,
**kwargs)
backend_pools()
Returns a generator of cinder Back-end storage pools
:returns A generator of cinder Back-end storage pools objects
Cluster API
The Cluster Class
The cluster high-level interface is available through the cluster member of a Connection object.
The cluster member will only be added if the service is detected.
Build Info Operations
class openstack.clustering.v1._proxy.Proxy(session, statsd_client=None,

**kwargs)
get_build_info()
Get build info for service engine and API
Returns A dictionary containing the API and engine revision string.

Profile Type Operations

**kwargs)
profile_types(**query)
Get a generator of profile types.
Returns A generator of objects that are of type ProfileType
get_profile_type(profile_type)
Get the details about a profile type.
Parameters profile_type The name of the profile_type to retrieve or an ob-
ject of ProfileType.
Returns A ProfileType object.
Raises ResourceNotFound when no profile_type matching the name could be
found.
Profile Operations

**kwargs)
create_profile(**attrs)
Create a new profile from attributes.
Profile, it is comprised of the properties on the Profile class.
Returns The results of profile creation.
Return type Profile.
delete_profile(profile, ignore_missing=True)
Delete a profile.
Parameters
• profile The value can be either the name or ID of a profile or a Profile
instance.
ResourceNotFound will be raised when the profile could not be found.


non-existent profile.
Returns None
find_profile(name_or_id, ignore_missing=True)
Find a single profile.
Parameters
• name_or_id (str) The name or ID of a profile.
will be raised when the resource does not exist. When set to True, None
will be returned when attempting to find a nonexistent resource.
Returns One Profile object or None
get_profile(profile)
Get a single profile.
Parameters profile The value can be the name or ID of a profile or a
Profile instance.
Returns One Profile
Raises ResourceNotFound when no profile matching the criteria could be
found.
profiles(**query)
Retrieve a generator of profiles.
the profiles to be returned. Available parameters include:
• name: The name of a profile.
• type: The type name of a profile.
• metadata: A list of key-value pairs that are associated with a profile.
• sort: A list of sorting keys separated by commas. Each sorting key can
optionally be attached with a sorting direction modifier which can be asc
or desc.
• limit: Requests a specified size of returned items from the query. Re-
turns a number of items up to the specified limit value.
• marker: Specifies the ID of the last-seen item. Use the limit parameter
to make an initial limited request and use the ID of the last-seen item
from the response as the marker parameter value in a subsequent limited
request.
• global_project: A boolean value indicating whether profiles from all
projects will be returned.
Returns A generator of profile instances.
update_profile(profile, **attrs)
Update a profile.
Parameters

• profile Either the name or the ID of the profile, or an instance of

Profile.
• attrs The attributes to update on the profile represented by the value
parameter.
Returns The updated profile.
Return type Profile
validate_profile(**attrs)
Validate a profile spec.
ProfileValidate, it is comprised of the properties on the Profile class.
Returns The results of profile validation.
Return type ProfileValidate.
Policy Type Operations

**kwargs)
policy_types(**query)
Get a generator of policy types.
Returns A generator of objects that are of type PolicyType
get_policy_type(policy_type)
Get the details about a policy type.
Parameters policy_type The name of a poicy_type or an object of
PolicyType.
Returns A PolicyType object.
Raises ResourceNotFound when no policy_type matching the name could be
found.
Policy Operations

**kwargs)

create_policy(**attrs)
Create a new policy from attributes.
Policy, it is comprised of the properties on the Policy class.
Returns The results of policy creation.
Return type Policy.
delete_policy(policy, ignore_missing=True)
Delete a policy.
Parameters
• policy The value can be either the name or ID of a policy or a Policy
instance.
ResourceNotFound will be raised when the policy could not be found.
non-existent policy.
Returns None
find_policy(name_or_id, ignore_missing=True)
Find a single policy.
Parameters
• name_or_id (str) The name or ID of a policy.
will be raised when the specified policy does not exist. When set to True,
None will be returned when attempting to find a nonexistent policy.
Returns A policy object or None.
Return type Policy
get_policy(policy)
Get a single policy.
Parameters policy The value can be the name or ID of a policy or a Policy
instance.
Returns A policy object.
Return type Policy
Raises ResourceNotFound when no policy matching the criteria could be
found.
policies(**query)
Retrieve a generator of policies.
the policies to be returned. Available parameters include:
• name: The name of a policy.
• type: The type name of a policy.

or desc.
request.
• global_project: A boolean value indicating whether policies from all
Returns A generator of policy instances.
update_policy(policy, **attrs)
Update a policy.
Parameters
• policy Either the name or the ID of a policy, or an instance of Policy.
• attrs The attributes to update on the policy represented by the value
parameter.
Returns The updated policy.
Return type Policy
validate_policy
Cluster Operations

**kwargs)
create_cluster(**attrs)
Create a new cluster from attributes.
Cluster, it is comprised of the properties on the Cluster class.
Returns The results of cluster creation.
Return type Cluster.
delete_cluster(cluster, ignore_missing=True, force_delete=False)
Delete a cluster.
Parameters

• cluster The value can be either the name or ID of a cluster or a

Cluster instance.
ResourceNotFound will be raised when the cluster could not be found.
non-existent cluster.
• force_delete (bool) When set to True, the cluster deletion will be
forced immediately.
Returns The instance of the Cluster which was deleted.
Return type Cluster.
find_cluster(name_or_id, ignore_missing=True)
Find a single cluster.
Parameters
• name_or_id (str) The name or ID of a cluster.
Returns One Cluster object or None
get_cluster(cluster)
Get a single cluster.
Parameters cluster The value can be the name or ID of a cluster or a
Cluster instance.
Returns One Cluster
Raises ResourceNotFound when no cluster matching the criteria could be
found.
clusters(**query)
Retrieve a generator of clusters.
the clusters to be returned. Available parameters include:
• name: The name of a cluster.
• status: The current status of a cluster.
or desc.
request.

• global_project: A boolean value indicating whether clusters from all

Returns A generator of cluster instances.
update_cluster(cluster, **attrs)
Update a cluster.
Parameters
• cluster Either the name or the ID of the cluster, or an instance of
Cluster.
• attrs The attributes to update on the cluster represented by the cluster
parameter.
Returns The updated cluster.
Return type Cluster
add_nodes_to_cluster(cluster, nodes)
Add nodes to a cluster.
Parameters
Cluster.
• nodes List of nodes to be added to the cluster.
Returns A dict containing the action initiated by this operation.
remove_nodes_from_cluster(cluster, nodes, **params)
Remove nodes from a cluster.
Parameters
Cluster.
• nodes List of nodes to be removed from the cluster.
• params (kwargs) Optional query parameters to be sent to restrict the
nodes to be returned. Available parameters include:
– destroy_after_deletion: A boolean value indicating whether the
deleted nodes to be destroyed right away.
replace_nodes_in_cluster(cluster, nodes)
Replace the nodes in a cluster with specified nodes.
Parameters
Cluster.
• nodes List of nodes to be deleted/added to the cluster.
scale_out_cluster(cluster, count=None)
Inflate the size of a cluster.

Parameters
Cluster.
• count Optional parameter specifying the number of nodes to be added.
scale_in_cluster(cluster, count=None)
Shrink the size of a cluster.
Parameters
Cluster.
• count Optional parameter specifying the number of nodes to be removed.
resize_cluster(cluster, **params)
Resize of cluster.
Parameters
Cluster.
• params (dict) A dictionary providing the parameters for the resize ac-
tion.
attach_policy_to_cluster(cluster, policy, **params)
Attach a policy to a cluster.
Parameters
Cluster.
• policy Either the name or the ID of a policy.
• params (dict) A dictionary containing the properties for the policy to be
attached.
detach_policy_from_cluster(cluster, policy)
Detach a policy from a cluster.
Parameters
Cluster.
update_cluster_policy(cluster, policy, **params)
Change properties of a policy which is bound to the cluster.

Parameters
Cluster.
• params (dict) A dictionary containing the new properties for the policy.
collect_cluster_attrs(cluster, path)
Collect attribute values across a cluster.
Parameters
• cluster The value can be either the ID of a cluster or a Cluster in-
stance.
• path A Json path string specifying the attribute to collect.
Returns A dictionary containing the list of attribute values.
check_cluster(cluster, **params)
Check a cluster.
Parameters
stance.
• params (dict) A dictionary providing the parameters for the check ac-
tion.
Returns A dictionary containing the action ID.
recover_cluster(cluster, **params)
recover a cluster.
Parameters
stance.
• params (dict) A dictionary providing the parameters for the recover
action.
perform_operation_on_cluster(cluster, operation, **params)
Perform an operation on the specified cluster.
Parameters
stance.
• operation A string specifying the operation to be performed.
• params (dict) A dictionary providing the parameters for the operation.

cluster_policies(cluster, **query)
Retrieve a generator of cluster-policy bindings.
Parameters
• cluster The value can be the name or ID of a cluster or a Cluster
instance.
• query (kwargs) Optional query parameters to be sent to restrict the poli-
cies to be returned. Available parameters include:
– enabled: A boolean value indicating whether the policy is enabled on
the cluster.
Returns A generator of cluster-policy binding instances.
get_cluster_policy(cluster_policy, cluster)
Get a cluster-policy binding.
Parameters
• cluster_policy The value can be the name or ID of a policy or a
Policy instance.
• cluster The value can be the name or ID of a cluster or a Cluster
instance.
Returns a cluster-policy binding object.
Return type CLusterPolicy
Raises ResourceNotFound when no cluster-policy binding matching the cri-
teria could be found.
Node Operations

**kwargs)
create_node(**attrs)
Create a new node from attributes.
Node, it is comprised of the properties on the Node class.
Returns The results of node creation.
Return type Node.
delete_node(node, ignore_missing=True, force_delete=False)
Delete a node.
Parameters


ResourceNotFound will be raised when the node could not be found.
non-existent node.
• force_delete (bool) When set to True, the node deletion will be
forced immediately.
Returns The instance of the Node which was deleted.
Return type Node.
find_node(name_or_id, ignore_missing=True)
Find a single node.
Parameters
• name_or_id (str) The name or ID of a node.
will be raised when the specified node does not exist. when set to True,
None will be returned when attempting to find a nonexistent policy
Returns One Node object or None.
get_node(node, details=False)
Get a single node.
Parameters
• details An optional argument that indicates whether the server should
return more details when retrieving the node data.
Returns One Node
Raises ResourceNotFound when no node matching the name or ID could be
found.
nodes(**query)
Retrieve a generator of nodes.
the nodes to be returned. Available parameters include:
• cluster_id: A string including the name or ID of a cluster to which the
resulted node(s) is a member.
• name: The name of a node.
• status: The current status of a node.
or desc.
the query.
• marker: Specifies the ID of the last-seen node. Use the limit parameter
to make an initial limited request and use the ID of the last-seen node


request.
• global_project: A boolean value indicating whether nodes from all
Returns A generator of node instances.
update_node(node, **attrs)
Update a node.
Parameters
• node Either the name or the ID of the node, or an instance of Node.
• attrs The attributes to update on the node represented by the node pa-
rameter.
Return type Node
check_node(node, **params)
Check the health of the specified node.
Parameters
• node The value can be either the ID of a node or a Node instance.
• params (dict) A dictionary providing the parametes to the check action.
recover_node(node, **params)
Recover the specified node into healthy status.
Parameters
• params (dict) A dict supplying parameters to the recover action.
adopt_node(preview=False, **attrs)
Adopting an existing resource as a node.
Parameters
• preview A boolean indicating whether this is a preview operation which
means only the profile to be used is returned rather than creating a node
object using that profile.
• attrs (dict) Keyword parameters for node adoption. Valid parameters
include:
– type: (Required) A string containing the profile type and version to
be used for node adoption. For example, os.nova.sever-1.0.
– identity: (Required) A string including the name or ID of an
OpenStack resource to be adopted as a Senlin node.
– name: (Optional) The name of node to be created. Omitting this pa-
rameter will have the node named automatically.

– snapshot: (Optional) A boolean indicating whether a snapshot of the

target resource should be created if possible. Default is False.
– metadata: (Optional) A dictionary of arbitrary key-value pairs to be
associated with the adopted node.
– overrides: (Optional) A dictionary of key-value pairs to be used to
override attributes derived from the target resource.
Returns The result of node adoption. If preview is set to False (default), returns a
Node object, otherwise a Dict is returned containing the profile to be used for
the new node.
perform_operation_on_node(node, operation, **params)
Perform an operation on the specified node.
Parameters
• operation A string specifying the operation to be performed.
• params (dict) A dictionary providing the parameters for the operation.
Receiver Operations

**kwargs)
create_receiver(**attrs)
Create a new receiver from attributes.
Receiver, it is comprised of the properties on the Receiver class.
Returns The results of receiver creation.
Return type Receiver.
update_receiver(receiver, **attrs)
Update a receiver.
Parameters
• receiver The value can be either the name or ID of a receiver or a
Receiver instance.
• attrs The attributes to update on the receiver parameter. Valid attribute
names include name, action and params.
Returns The updated receiver.
Return type Receiver

delete_receiver(receiver, ignore_missing=True)
Delete a receiver.
Parameters
• receiver The value can be either the name or ID of a receiver or a
Receiver instance.
ResourceNotFound will be raised when the receiver could not be found.
non-existent receiver.
Returns None
find_receiver(name_or_id, ignore_missing=True)
Find a single receiver.
Parameters
• name_or_id (str) The name or ID of a receiver.
will be raised when the specified receiver does not exist. When set to True,
None will be returned when attempting to find a nonexistent receiver.
Returns A receiver object or None.
get_receiver(receiver)
Get a single receiver.
Parameters receiver The value can be the name or ID of a receiver or a
Receiver instance.
Returns A receiver object.
Raises ResourceNotFound when no receiver matching the criteria could be
found.
receivers(**query)
Retrieve a generator of receivers.
Parameters query (kwargs) Optional query parameters for restricting the re-
ceivers to be returned. Available parameters include:
• name: The name of a receiver object.
• type: The type of receiver objects.
• cluster_id: The ID of the associated cluster.
• action: The name of the associated action.
or desc.
• global_project: A boolean value indicating whether receivers

• from all projects will be returned.

Returns A generator of receiver instances.
Action Operations

**kwargs)
get_action(action)
Get a single action.
Parameters action The value can be the name or ID of an action or a Action
instance.
Returns an action object.
Return type Action
Raises ResourceNotFound when no action matching the criteria could be
found.
actions(**query)
Retrieve a generator of actions.
the actions to be returned. Available parameters include:
• name: name of action for query.
• target: ID of the target object for which the actions should be returned.
• action: built-in action types for query.
or desc.
request.
Returns A generator of action instances.

Event Operations

**kwargs)
get_event(event)
Get a single event.
Parameters event The value can be the name or ID of an event or a Event
instance.
Returns an event object.
Return type Event
Raises ResourceNotFound when no event matching the criteria could be
found.
events(**query)
Retrieve a generator of events.
the events to be returned. Available parameters include:
• obj_name: name string of the object associated with an event.
• obj_type: type string of the object related to an event. The value can be
cluster, node, policy etc.
• obj_id: ID of the object associated with an event.
• cluster_id: ID of the cluster associated with the event, if any.
• action: name of the action associated with an event.
or desc.
request.
• global_project: A boolean specifying whether events from all projects
should be returned. This option is subject to access control checking.
Returns A generator of event instances.

Helper Operations

**kwargs)
wait_for_status(res, status, failures=None, interval=2, wait=120)

Wait for a resource to be in a particular status.
Parameters
• res The resource to wait on to reach the specified status. The resource
must have a status attribute.
• status Desired status.
• failures (list) Statuses that would be interpreted as failures.
• interval Number of seconds to wait before to consecutive checks. De-
fault to 2.
• wait Maximum number of seconds to wait before the change. Default to
120.
Returns The resource is returned on success.
Raises ResourceTimeout if transition to the desired status failed to occur in
specified seconds.
Raises ResourceFailure if the resource has transited to one of the failure
statuses.
Raises AttributeError if the resource does not have a status attribute.
wait_for_delete(res, interval=2, wait=120)
Wait for a resource to be deleted.
Parameters
• res The resource to wait on to be deleted.
fault to 2.
120.
Raises ResourceTimeout if transition to delete failed to occur in the specified
seconds.

Service Operations

**kwargs)
services(**query)
Get a generator of services.
Returns A generator of objects that are of type Service
Compute API
For details on how to use compute, see Using OpenStack Compute
The Compute Class
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.
Server Operations
class openstack.compute.v2._proxy.Proxy(session, statsd_client=None,

**kwargs)
create_server(**attrs)
Create a new server from attributes
Server, comprised of the properties on the Server class.
Returns The results of server creation
Return type Server
delete_server(server, ignore_missing=True, force=False)
Delete a server
Parameters
• server The value can be either the ID of a server or a Server instance.


will be raised when the server does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent server
• force (bool) When set to True, the server deletion will be forced im-
mediately.
Returns None
find_server(name_or_id, ignore_missing=True)
Find a single server
Parameters
• name_or_id The name or ID of a server.
Returns One Server or None
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
servers(details=True, all_projects=False, **query)
Retrieve a generator of servers
Parameters
• details (bool) When set to False instances with only basic data will
be returned. The default, True, will cause instances with full data to be
returned.
• query (kwargs) Optional query parameters to be sent to limit the
servers being returned. Available parameters can be seen under https:
//docs.openstack.org/api-ref/compute/#list-servers
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_image(server, name, metadata=None, wait=False, timeout=120)
Create an image from a server
Parameters
• server Either the ID of a server or a Server instance.

• name (str) The name of the image to be created.

• metadata (dict) A dictionary of metadata to be set on the image.
Returns Image object.
backup_server(server, name, backup_type, rotation)
Backup a server
Parameters
• name The name of the backup image.
• backup_type The type of the backup, for example, daily.
• rotation The rotation of the back up image, the oldest image will be
removed when image count exceed the rotation count.
Returns None
wait_for_server(server, status=’ACTIVE’, failures=None, interval=2, wait=120)
Wait for a server to be in a particular status.
Parameters
• server (Server:) The Server to wait on to reach the specified status.
• interval (int) Number of seconds to wait before to consecutive checks.
Default to 2.
• wait (int) Maximum number of seconds to wait before the change. De-
fault to 120.
specified seconds.
statuses.
get_server_metadata(server)
Return a dictionary of metadata for a server
Parameters server Either the ID of a server or a Server or ServerDetail
instance.
Returns A Server with only the servers metadata. All keys and values are Uni-
code text.
Return type Server
set_server_metadata(server, **metadata)
Update metadata for a server
Parameters


• metadata (kwargs) Key/value pairs to be updated in the servers meta-
data. No other metadata is modified by this call. All keys and values are
stored as Unicode.
Returns A Server with only the servers metadata. All keys and values are Uni-
code text.
Return type Server
delete_server_metadata(server, keys)
Delete metadata for a server
Note: This method will do a HTTP DELETE request for every key in keys.
Parameters
• keys The keys to delete
Return type None
Network Actions

**kwargs)
fetch_server_security_groups(server)
Fetch security groups with details for a server.
Returns updated Server instance
add_security_group_to_server(server, security_group)
Add a security group to a server
Parameters
• security_group Either the ID, Name of a security group or a
SecurityGroup instance.
Returns None
remove_security_group_from_server(server, security_group)
Remove a security group from a server
Parameters

• security_group Either the ID of a security group or a

Returns None
add_fixed_ip_to_server(server, network_id)
Adds a fixed IP address to a server instance.
Parameters
• network_id The ID of the network from which a fixed IP address is
about to be allocated.
Returns None
remove_fixed_ip_from_server(server, address)
Removes a fixed IP address from a server instance.
Parameters
• address The fixed IP address to be disassociated from the server.
Returns None
add_floating_ip_to_server(server, address, fixed_address=None)
Adds a floating IP address to a server instance.
Parameters
• address The floating IP address to be added to the server.
• fixed_address The fixed IP address to be associated with the floating
IP address. Used when the server is connected to multiple networks.
Returns None
remove_floating_ip_from_server(server, address)
Removes a floating IP address from a server instance.
Parameters
• address The floating IP address to be disassociated from the server.
Returns None

Starting, Stopping, etc.

**kwargs)
reboot_server(server, reboot_type)
Reboot a server
Parameters
• reboot_type (str) The type of reboot to perform. HARD and SOFT
are the current options.
Returns None
pause_server(server)
Pauses a server and changes its status to PAUSED.
Returns None
unpause_server(server)
Unpauses a paused server and changes its status to ACTIVE.
Returns None
suspend_server(server)
Suspends a server and changes its status to SUSPENDED.
Returns None
resume_server(server)
Resumes a suspended server and changes its status to ACTIVE.
Returns None
lock_server(server)
Locks a server.
Returns None
unlock_server(server)
Unlocks a locked server.

Returns None
rescue_server(server, admin_pass=None, image_ref=None)
Puts a server in rescue mode and changes it status to RESCUE.
Parameters
• admin_pass The password for the rescued server. If you omit this pa-
rameter, the operation generates a new password.
• image_ref The image reference to use to rescue your server. This can
be the image ID or its full URL. If you omit this parameter, the base image
reference will be used.
Returns None
unrescue_server(server)
Unrescues a server and changes its status to ACTIVE.
Returns None
evacuate_server(server, host=None, admin_pass=None, force=None)
Evacuates a server from a failed host to a new host.
Parameters
• host An optional parameter specifying the name or ID of the host to which
the server is evacuated.
• admin_pass An optional parameter specifying the administrative pass-
word to access the evacuated or rebuilt server.
• force Force an evacuation by not verifying the provided destination host
by the scheduler. (New in API version 2.29).
Returns None
start_server(server)
Starts a stopped server and changes its state to ACTIVE.
Returns None
stop_server(server)
Stops a running server and changes its state to SHUTOFF.
Returns None
shelve_server(server)
Shelves a server.
All associated data and resources are kept but anything still in memory is not retained. Policy
defaults enable only users with administrative role or the owner of the server to perform this
operation. Cloud provides could change this permission though.


Returns None
unshelve_server(server)
Unselves or restores a shelved server.
Policy defaults enable only users with administrative role or the owner of the server to per-
form this operation. Cloud provides could change this permission though.
Returns None
get_server_console_output(server, length=None)
Return the console output for a server.
Parameters
• length Optional number of line to fetch from the end of console log. All
lines will be returned if this is not specified.
Returns The console output as a dict. Control characters will be escaped to create
a valid JSON string.
migrate_server(server)
Migrate a server from one host to another
Returns None
live_migrate_server(server, host=None, force=False, block_migration=None)
Live migrate a server from one host to target host
Parameters
• host (str) The host to which to migrate the server. If the Nova service
is too old, the host parameter implies force=True which causes the Nova
scheduler to be bypassed. On such clouds, a ValueError will be thrown
if host is given without force.
• force (bool) Force a live-migration by not verifying the provided desti-
nation host by the scheduler. This is unsafe and not recommended.
• block_migration Perform a block live migration to the destination
host by the scheduler. Can be auto, True or False. Some clouds are too old
to support auto, in which case a ValueError will be thrown. If omitted, the
value will be auto on clouds that support it, and False on clouds that do not.
Returns None

Modifying a Server

**kwargs)
change_server_password(server, new_password)
Change the administrator password
Parameters
• new_password (str) The new password to be set.
Returns None
get_server_password(server)
Get the administrator password
Returns encrypted password.
reset_server_state(server, state)
Reset the state of server
Parameters
• server The server can be either the ID of a server or a Server.
• state The state of the server to be set, active or error are valid.
Returns None
rebuild_server(server, name, admin_password, **attrs)
Rebuild a server
Parameters
• name (str) The name of the server
• admin_password (str) The administrator password
• preserve_ephemeral (bool) Indicates whether the server is rebuilt
with the preservation of the ephemeral partition. Default: False
• image (str) The id of an image to rebuild with. Default: None
• access_ipv4 (str) The IPv4 address to rebuild with. Default: None
• access_ipv6 (str) The IPv6 address to rebuild with. Default: None
• metadata (dict) A dictionary of metadata to rebuild with. Default:
None

• personality A list of dictionaries, each including a path and contents

key, to be injected into the rebuilt server at launch. Default: None
Returns The rebuilt Server instance.
resize_server(server, flavor)
Resize a server
Parameters
• flavor Either the ID of a flavor or a Flavor instance.
Returns None
confirm_server_resize(server)
Confirm a server resize
Returns None
revert_server_resize(server)
Revert a server resize
Returns None
Image Operations

**kwargs)
delete_image(image, ignore_missing=True)
Delete an image
Parameters
• image The value can be either the ID of an image or a Image instance.
will be raised when the image does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent image.
Returns None
find_image(name_or_id, ignore_missing=True)
Find a single image
Parameters
• name_or_id The name or ID of a image.


Returns One Image or None
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
images(details=True, **query)
Return a generator of images
Parameters
• details (bool) When True, returns Image objects with all available
properties, otherwise only basic properties are returned. Default: “True“
• query (kwargs) Optional query parameters to be sent to limit the re-
sources being returned.
Returns A generator of image objects
get_image_metadata(image)
Return a dictionary of metadata for an image
Parameters image Either the ID of an image or a Image instance.
Returns A Image with only the images metadata. All keys and values are Uni-
code text.
Return type Image
set_image_metadata(image, **metadata)
Update metadata for an image
Parameters
• image Either the ID of an image or a Image instance.
• metadata (kwargs) Key/value pairs to be updated in the images meta-
data. No other metadata is modified by this call. All keys and values are
stored as Unicode.
Returns A Image with only the images metadata. All keys and values are Uni-
code text.
Return type Image
delete_image_metadata(image, keys)
Delete metadata for an image
Note: This method will do a HTTP DELETE request for every key in keys.
Parameters
• image Either the ID of an image or a Image instance.
• keys The keys to delete.

Return type None
Flavor Operations

**kwargs)
find_flavor(name_or_id, ignore_missing=True, get_extra_specs=False)

Find a single flavor
Parameters
• name_or_id The name or ID of a flavor.
• get_extra_specs (bool) When set to True and extra_specs not
present in the response will invoke additional API call to fetch extra_specs.
Returns One Flavor or None
create_flavor(**attrs)
Create a new flavor from attributes
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
• flavor The value can be either the ID of a flavor or a Flavor instance.
will be raised when the flavor does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent flavor.
Returns None
get_flavor(flavor, get_extra_specs=False)
Get a single flavor
Parameters
• flavor The value can be the ID of a flavor or a Flavor instance.
• get_extra_specs (bool) When set to True and extra_specs not
present in the response will invoke additional API call to fetch extra_specs.

Returns One Flavor

flavors(details=True, **query)
Return a generator of flavors
Parameters
• details (bool) When True, returns Flavor objects, with additional
attributes filled.
• query (kwargs) Optional query parameters to be sent to limit the flavors
being returned.
Returns A generator of flavor objects
flavor_add_tenant_access(flavor, tenant)
Adds tenant/project access to flavor.
Parameters
• tenant (str) The UUID of the tenant.
Returns One Flavor
flavor_remove_tenant_access(flavor, tenant)
Removes tenant/project access to flavor.
Parameters
• tenant (str) The UUID of the tenant.
Returns One Flavor
get_flavor_access(flavor)
Lists tenants who have access to private flavor
Parameters flavor Either the ID of a flavor or a Flavor instance.
Returns List of dicts with flavor_id and tenant_id attributes.
fetch_flavor_extra_specs(flavor)
Lists Extra Specs of a flavor
Parameters flavor Either the ID of a flavor or a Flavor instance.
Returns One Flavor
create_flavor_extra_specs(flavor, extra_specs)
Lists Extra Specs of a flavor
Parameters
• extra_specs (dict) dict of extra specs
Returns One Flavor

get_flavor_extra_specs_property(flavor, prop)
Get specific Extra Spec property of a flavor
Parameters
• prop (str) Property name.
Returns String value of the requested property.
update_flavor_extra_specs_property(flavor, prop, val)
Update specific Extra Spec property of a flavor
Parameters
• val (str) Property value.
Returns String value of the requested property.
delete_flavor_extra_specs_property(flavor, prop)
Delete specific Extra Spec property of a flavor
Parameters
Returns None
Service Operations

**kwargs)
force_service_down(service, host, binary)

Force a service down
Parameters
• service Either the ID of a service or a Service instance.
• host (str) The host where service runs.
• binary (str) The name of service.
Returns None
disable_service(service, host, binary, disabled_reason=None)
Disable a service
Parameters


• disabled_reason (str) The reason of force down a service.
Returns None
enable_service(service, host, binary)
Enable a service
Parameters
Returns None
services()
Return a generator of service
Returns A generator of service
Return type class: ~openstack.compute.v2.service.Service
Volume Attachment Operations

**kwargs)
create_volume_attachment(server, **attrs)
Create a new volume attachment from attributes
Parameters
• server The server can be either the ID of a server or a Server instance.
• attrs (dict) Keyword arguments which will be used to create a
VolumeAttachment, comprised of the properties on the VolumeAttach-
ment class.
Returns The results of volume attachment creation
Return type VolumeAttachment
update_volume_attachment(volume_attachment, server, **attrs)
update a volume attachment
Parameters

• volume_attachment The value can be either the ID of a volume at-

tachment or a VolumeAttachment instance.
• server This parameter need to be specified when VolumeAttachment ID
is given as value. It can be either the ID of a server or a Server instance
that the attachment belongs to.
will be raised when the volume attachment does not exist. When set to
True, no exception will be set when attempting to delete a nonexistent vol-
ume attachment.
Returns None
delete_volume_attachment(volume_attachment, server, ignore_missing=True)
Delete a volume attachment
Parameters
• volume_attachment The value can be either the ID of a volume at-
tachment or a VolumeAttachment instance.
ume attachment.
Returns None
get_volume_attachment(volume_attachment, server, ignore_missing=True)
Get a single volume attachment
Parameters
• volume_attachment The value can be the ID of a volume attachment
or a VolumeAttachment instance.
ume attachment.
Returns One VolumeAttachment
volume_attachments(server)
Return a generator of volume attachments
Parameters server The server can be either the ID of a server or a Server.
Returns A generator of VolumeAttachment objects

Return type VolumeAttachment
Keypair Operations

**kwargs)
create_keypair(**attrs)
Create a new keypair from attributes
Keypair, comprised of the properties on the Keypair class.
Returns The results of keypair creation
Return type Keypair
delete_keypair(keypair, ignore_missing=True, user_id=None)
Delete a keypair
Parameters
• keypair The value can be either the ID of a keypair or a Keypair in-
stance.
will be raised when the keypair does not exist. When set to True, no ex-
ception will be set when attempting to delete a nonexistent keypair.
• user_id (str) Optional user_id owning the keypair
Returns None
get_keypair(keypair, user_id=None)
Get a single keypair
Parameters
• keypair The value can be the ID of a keypair or a Keypair instance.
Returns One Keypair
find_keypair(name_or_id, ignore_missing=True, user_id=None)
Find a single keypair
Parameters
• name_or_id The name or ID of a keypair.


Returns One Keypair or None
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
Server IPs

**kwargs)
server_ips(server, network_label=None)
Return a generator of server IPs
Parameters
• server The server can be either the ID of a server or a Server.
• network_label The name of a particular network to list IP addresses
from.
Returns A generator of ServerIP objects
Return type ServerIP
Server Group Operations

**kwargs)
create_server_group(**attrs)
Create a new server group from attributes


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
• server_group The value can be either the ID of a server group or a
ServerGroup instance.
will be raised when the server group does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent server group.
Returns None
find_server_group(name_or_id, ignore_missing=True)
Find a single server group
Parameters
• name_or_id The name or ID of a server group.
Returns One ServerGroup object or None
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.
server_groups(**query)
Return a generator of server groups
Returns A generator of ServerGroup objects
Return type ServerGroup

Server Interface Operations

**kwargs)
create_server_interface(server, **attrs)
Create a new server interface from attributes
Parameters
• server The server can be either the ID of a server or a Server instance
that the interface belongs to.
ServerInterface, comprised of the properties on the ServerInterface
class.
Returns The results of server interface creation
Return type ServerInterface
delete_server_interface(server_interface, server=None, ignore_missing=True)
Delete a server interface
Parameters
• server_interface The value can be either the ID of a server interface
or a ServerInterface instance.
• server This parameter need to be specified when ServerInterface ID is
given as value. It can be either the ID of a server or a Server instance that
the interface belongs to.
will be raised when the server interface does not exist. When set to True,
no exception will be set when attempting to delete a nonexistent server in-
terface.
Returns None
get_server_interface(server_interface, server=None)
Get a single server interface
Parameters
• server_interface The value can be the ID of a server interface or a
ServerInterface instance.
• server This parameter need to be specified when ServerInterface ID is
given as value. It can be either the ID of a server or a Server instance that
the interface belongs to.
Returns One ServerInterface

server_interfaces(server)
Return a generator of server interfaces
Parameters server The server can be either the ID of a server or a Server.
Returns A generator of ServerInterface objects
Return type ServerInterface
Availability Zone Operations

**kwargs)
availability_zones(details=False)
Return a generator of availability zones
Parameters details (bool) Return extra details about the availability zones.
This defaults to False as it generally requires extra permission.
Returns A generator of availability zone
Return type AvailabilityZone
Limits Operations

**kwargs)
get_limits()
Retrieve limits that are applied to the projects account
Returns A Limits object, including both AbsoluteLimits and RateLimits
Return type Limits

Hypervisor Operations

**kwargs)
hypervisors(details=False, **query)
Return a generator of hypervisor
Parameters
• details (bool) When set to the default, False, Hypervisor in-
stances will be returned with only basic information populated.
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.
Extension Operations

**kwargs)
find_extension(name_or_id, ignore_missing=True)
Find a single extension
Parameters
• name_or_id The name or ID of an extension.


Returns One Extension or None
extensions()
Retrieve a generator of extensions
Returns A generator of extension instances.
Return type Extension
Database API
For details on how to use database, see Using OpenStack Database
The Database Class
The database high-level interface is available through the database member of a Connection ob-
ject. The database member will only be added if the service is detected.
Database Operations
class openstack.database.v1._proxy.Proxy(session, statsd_client=None,

**kwargs)
create_database(instance, **attrs)
Create a new database from attributes
Parameters
• instance This can be either the ID of an instance or a Instance
Database, comprised of the properties on the Database class.
Return type Database
delete_database(database, instance=None, ignore_missing=True)
Delete a database
Parameters
• database The value can be either the ID of a database or a Database
instance.

• instance This parameter needs to be specified when an ID is given as

database. It can be either the ID of an instance or a Instance
will be raised when the database does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent database.
Returns None
find_database(name_or_id, instance, ignore_missing=True)
Find a single database
Parameters
• name_or_id The name or ID of a database.
Returns One Database or None
databases(instance, **query)
Return a generator of databases
Parameters
• instance This can be either the ID of an instance or a Instance in-
stance that the interface belongs to.
Returns A generator of database objects
Return type Database
get_database(database, instance=None)
Get a single database
Parameters
• database The value can be the ID of a database or a Database instance.
Returns One Database

Flavor Operations

**kwargs)
find_flavor(name_or_id, ignore_missing=True)
Parameters
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
flavors(**query)
Return a generator of flavors
Return type Flavor
Instance Operations

**kwargs)
create_instance(**attrs)
Create a new instance from attributes
Instance, comprised of the properties on the Instance class.


Return type Instance
delete_instance(instance, ignore_missing=True)
Delete an instance
Parameters
• instance The value can be either the ID of an instance or a Instance
instance.
will be raised when the instance does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent instance.
Returns None
find_instance(name_or_id, ignore_missing=True)
Find a single instance
Parameters
• name_or_id The name or ID of a instance.
Returns One Instance or None
get_instance(instance)
Get a single instance
Parameters instance The value can be the ID of an instance or a Instance
instance.
Returns One Instance
instances(**query)
Return a generator of instances
Returns A generator of instance objects
update_instance(instance, **attrs)
Update a instance
Parameters instance Either the id of a instance or a Instance instance.
Attrs kwargs The attributes to update on the instance represented by value.
Returns The updated instance

User Operations

**kwargs)
create_user(instance, **attrs)
Create a new user from attributes
Parameters
• attrs (dict) Keyword arguments which will be used to create a User,
comprised of the properties on the User class.
Return type User
delete_user(user, instance=None, ignore_missing=True)
Delete a user
Parameters
• user The value can be either the ID of a user or a User instance.
user. It can be either the ID of an instance or a Instance
will be raised when the user does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent user.
Returns None
find_user(name_or_id, instance, ignore_missing=True)
Find a single user
Parameters
• name_or_id The name or ID of a user.
Returns One User or None
users(instance, **query)
Return a generator of users
Parameters


Returns A generator of user objects
Return type User
get_user(user, instance=None)
Get a single user
Parameters
• user The value can be the ID of a user or a User instance.
Returns One User
DNS API
For details on how to use dns, see Using OpenStack DNS
The DNS Class
The dns high-level interface is available through the dns member of a Connection object. The dns
member will only be added if the service is detected.
DNS Zone Operations
class openstack.dns.v2._proxy.Proxy(session, statsd_client=None,

fluxdb_client=None, *args, **kwargs)
zones(**query)
Retrieve a generator of zones
Parameters query (dict) Optional query parameters to be sent to limit the
• name: Zone Name field.
• type: Zone Type field.
• email: Zone email field.
• status: Status of the zone.
• ttl: TTL field filter.abs
• description: Zone description field filter.

Returns A generator of zone Zone instances.

create_zone(**attrs)
Create a new zone from attributes
Zone, comprised of the properties on the Zone class.
Returns The results of zone creation.
Return type Zone
get_zone(zone)
Get a zone
Parameters zone The value can be the ID of a zone or a Zone instance.
Returns Zone instance.
Return type Zone
delete_zone(zone, ignore_missing=True)
Delete a zone
Parameters
• zone The value can be the ID of a zone or a Zone instance.
Returns Zone been deleted
Return type Zone
find_zone(name_or_id, ignore_missing=True, **attrs)
Find a single zone
Parameters
• name_or_id The name or ID of a zone
Returns Zone
abandon_zone(zone, **attrs)
Abandon Zone
Parameters zone The value can be the ID of a zone to be abandoned or a
ZoneExport instance.
Returns None
xfr_zone(zone, **attrs)
Trigger update of secondary Zone
Parameters zone The value can be the ID of a zone to be abandoned or a
Returns None

Recordset Operations

recordsets(zone=None, **query)
Retrieve a generator of recordsets
Parameters
• zone The optional value can be the ID of a zone or a Zone instance. If it
is not given all recordsets for all zones of the tenant would be retrieved
being returned.
– name: Recordset Name field.
– type: Type field.
– status: Status of the recordset.
– ttl: TTL field filter.
– description: Recordset description field filter.
Returns A generator of zone (Recordset) instances
create_recordset(zone, **attrs)
Create a new recordset in the zone
Parameters
Recordset, comprised of the properties on the Recordset class.
Returns The results of zone creation
Return type Recordset
update_recordset(recordset, **attrs)
Update Recordset attributes
Recordset, comprised of the properties on the Recordset class.
Returns The results of zone creation
get_recordset(recordset, zone)
Get a recordset
Parameters

• recordset The value can be the ID of a recordset or a Recordset

instance.
Returns Recordset instance
delete_recordset(recordset, zone=None, ignore_missing=True)
Delete a zone
Parameters
• recordset The value can be the ID of a recordset or a Recordset
instance.
Returns Recordset instance been deleted
Zone Import Operations

zone_imports(**query)
Retrieve a generator of zone imports
• zone_id: Zone I field.
• message: Message field.
• status: Status of the zone import record.
Returns A generator of zone ZoneImport instances.
create_zone_import(**attrs)
Create a new zone import from attributes
ZoneImport, comprised of the properties on the ZoneImport class.
Return type ZoneImport
get_zone_import(zone_import)
Get a zone import record

Parameters zone The value can be the ID of a zone import or a ZoneImport

instance.
Returns ZoneImport instance.
Return type ZoneImport
delete_zone_import(zone_import, ignore_missing=True)
Delete a zone import
Parameters
• zone_import The value can be the ID of a zone import or a
ZoneImport instance.
Returns None
Zone Export Operations

zone_exports(**query)
Retrieve a generator of zone exports
• zone_id: Zone I field.
• message: Message field.
• status: Status of the zone import record.
Returns A generator of zone ZoneExport instances.
create_zone_export(zone, **attrs)
Create a new zone export from attributes
Parameters
• zone The value can be the ID of a zone to be exported or a ZoneExport
instance.
ZoneExport, comprised of the properties on the ZoneExport class.
Return type ZoneExport

get_zone_export(zone_export)
Get a zone export record
Parameters zone The value can be the ID of a zone import or a ZoneExport
instance.
Returns ZoneExport instance.
get_zone_export_text(zone_export)
Get a zone export record as text
Parameters zone The value can be the ID of a zone import or a ZoneExport
instance.
Returns ZoneExport instance.
delete_zone_export(zone_export, ignore_missing=True)
Delete a zone export
Parameters
• zone_export The value can be the ID of a zone import or a
Returns None
FloatingIP Operations

floating_ips(**query)
Retrieve a generator of recordsets
• name: Recordset Name field.
• type: Type field.
• status: Status of the recordset.
• ttl: TTL field filter.
• description: Recordset description field filter.
Returns A generator of floatingips (FloatingIP) instances

get_floating_ip(floating_ip)
Get a Floating IP
Parameters floating_ip The value can be the ID of a floating ip or a
FloatingIP instance. The ID is in format region_name:floatingip_id
Returns FloatingIP instance.
Return type FloatingIP
update_floating_ip(floating_ip, **attrs)
Update floating ip attributes
Parameters
• floating_ip The id or an instance of FloatingIP.
• attrs (dict) attributes for update on FloatingIP.
Zone Transfer Operations

zone_transfer_requests(**query)
Retrieve a generator of zone transfer requests
Returns A generator of transfer requests (ZoneTransferRequest) instances
get_zone_transfer_request(request)
Get a ZoneTransfer Request info
Parameters request The value can be the ID of a transfer request or a
ZoneTransferRequest instance.
Returns Zone transfer request instance.
Return type ZoneTransferRequest
create_zone_transfer_request(zone, **attrs)
Create a new ZoneTransfer Request from attributes
Parameters
• zone The value can be the ID of a zone to be transferred or a


ZoneTransferRequest, comprised of the properties on the ZoneTrans-
ferRequest class.
Returns The results of zone transfer request creation.
update_zone_transfer_request(request, **attrs)
Update ZoneTransfer Request attributes
Parameters
• floating_ip The id or an instance of ZoneTransferRequest.
• attrs (dict) attributes for update on ZoneTransferRequest.
delete_zone_transfer_request(request, ignore_missing=True)
Delete a ZoneTransfer Request
Parameters
• request The value can be the ID of a zone transfer request or a
ZoneTransferRequest instance.
Returns None
zone_transfer_accepts(**query)
Retrieve a generator of zone transfer accepts
Returns A generator of transfer accepts (ZoneTransferAccept) instances
get_zone_transfer_accept(accept)
Get a ZoneTransfer Accept info
Parameters request The value can be the ID of a transfer accept or a
ZoneTransferAccept instance.
Returns Zone transfer request instance.
Return type ZoneTransferAccept
create_zone_transfer_accept(**attrs)
Create a new ZoneTransfer Accept from attributes
ZoneTransferAccept, comprised of the properties on the ZoneTransfer-
Accept class.
Returns The results of zone transfer request creation.
Return type ZoneTransferAccept

Identity API v2
For details on how to use identity, see Using OpenStack Identity
The Identity v2 Class
The identity high-level interface is available through the identity member of a Connection object.
The identity member will only be added if the service is detected.
class openstack.identity.v2._proxy.Proxy(session, statsd_client=None,

**kwargs)
extensions()
Retrieve a generator of extensions
Returns A generator of extension instances.
get_extension(extension)
Get a single extension
Parameters extension The value can be the ID of an extension or a
Extension instance.
Returns One Extension
Raises ResourceNotFound when no extension can be found.
User Operations

**kwargs)
create_user(**attrs)
User, comprised of the properties on the User class.
Returns The results of user creation

Return type User

delete_user(user, ignore_missing=True)
Delete a user
Parameters
Returns None
find_user(name_or_id, ignore_missing=True)
Find a single user
Parameters
get_user(user)
Get a single user
Parameters user The value can be the ID of a user or a User instance.
Returns One User
users(**query)
Retrieve a generator of users
Returns A generator of user instances.
Return type User
update_user(user, **attrs)
Update a user
Parameters user Either the ID of a user or a User instance.
Attrs kwargs The attributes to update on the user represented by value.
Returns The updated user
Return type User

Role Operations

**kwargs)
create_role(**attrs)
Create a new role from attributes
Role, comprised of the properties on the Role class.
Returns The results of role creation
Return type Role
delete_role(role, ignore_missing=True)
Delete a role
Parameters
• role The value can be either the ID of a role or a Role instance.
will be raised when the role does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent role.
Returns None
find_role(name_or_id, ignore_missing=True)
Find a single role
Parameters
• name_or_id The name or ID of a role.
Returns One Role or None
get_role(role)
Get a single role
Parameters role The value can be the ID of a role or a Role instance.
Returns One Role
roles(**query)
Retrieve a generator of roles

Returns A generator of role instances.

Return type Role
update_role(role, **attrs)
Update a role
Parameters role Either the ID of a role or a Role instance.
Attrs kwargs The attributes to update on the role represented by value.
Returns The updated role
Return type Role
Tenant Operations

**kwargs)
create_tenant(**attrs)
Create a new tenant from attributes
Tenant, comprised of the properties on the Tenant class.
Returns The results of tenant creation
Return type Tenant
delete_tenant(tenant, ignore_missing=True)
Delete a tenant
Parameters
• tenant The value can be either the ID of a tenant or a Tenant instance.
will be raised when the tenant does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent tenant.
Returns None
find_tenant(name_or_id, ignore_missing=True)
Find a single tenant
Parameters
• name_or_id The name or ID of a tenant.
Returns One Tenant or None

get_tenant(tenant)
Get a single tenant
Parameters tenant The value can be the ID of a tenant or a Tenant instance.
Returns One Tenant
tenants(**query)
Retrieve a generator of tenants
Returns A generator of tenant instances.
Return type Tenant
update_tenant(tenant, **attrs)
Update a tenant
Parameters tenant Either the ID of a tenant or a Tenant instance.
Attrs kwargs The attributes to update on the tenant represented by value.
Returns The updated tenant
Return type Tenant
Identity API v3
For details on how to use identity, see Using OpenStack Identity
The Identity v3 Class
The identity high-level interface is available through the identity member of a Connection object.
The identity member will only be added if the service is detected.
Credential Operations

**kwargs)
create_credential(**attrs)
Create a new credential from attributes
Credential, comprised of the properties on the Credential class.
Returns The results of credential creation

Return type Credential

delete_credential(credential, ignore_missing=True)
Delete a credential
Parameters
• credential The value can be either the ID of a credential or a
Credential instance.
will be raised when the credential does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent credential.
Returns None
find_credential(name_or_id, ignore_missing=True)
Find a single credential
Parameters
• name_or_id The name or ID of a credential.
Returns One Credential or None
get_credential(credential)
Get a single credential
Parameters credential The value can be the ID of a credential or a
Credential instance.
Returns One Credential
credentials(**query)
Retrieve a generator of credentials
Returns A generator of credentials instances.
update_credential(credential, **attrs)
Update a credential
Parameters credential Either the ID of a credential or a Credential in-
stance.
Attrs kwargs The attributes to update on the credential represented by value.
Returns The updated credential

Domain Operations

**kwargs)
create_domain(**attrs)
Create a new domain from attributes
Domain, comprised of the properties on the Domain class.
Returns The results of domain creation
Return type Domain
delete_domain(domain, ignore_missing=True)
Delete a domain
Parameters
• domain The value can be either the ID of a domain or a Domain instance.
will be raised when the domain does not exist. When set to True, no ex-
ception will be set when attempting to delete a nonexistent domain.
Returns None
find_domain(name_or_id, ignore_missing=True)
Find a single domain
Parameters
• name_or_id The name or ID of a domain.
Returns One Domain or None
get_domain(domain)
Get a single domain
Parameters domain The value can be the ID of a domain or a Domain instance.
Returns One Domain
domains(**query)
Retrieve a generator of domains

Returns A generator of domain instances.

Return type Domain
update_domain(domain, **attrs)
Update a domain
Parameters domain Either the ID of a domain or a Domain instance.
Attrs kwargs The attributes to update on the domain represented by value.
Returns The updated domain
Return type Domain
Endpoint Operations

**kwargs)
create_endpoint(**attrs)
Create a new endpoint from attributes
Endpoint, comprised of the properties on the Endpoint class.
Returns The results of endpoint creation
Return type Endpoint
delete_endpoint(endpoint, ignore_missing=True)
Delete an endpoint
Parameters
• endpoint The value can be either the ID of an endpoint or a Endpoint
instance.
will be raised when the endpoint does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent endpoint.
Returns None
find_endpoint(name_or_id, ignore_missing=True)
Find a single endpoint
Parameters
• name_or_id The name or ID of a endpoint.

Returns One Endpoint or None

get_endpoint(endpoint)
Get a single endpoint
Parameters endpoint The value can be the ID of an endpoint or a Endpoint
instance.
Returns One Endpoint
endpoints(**query)
Retrieve a generator of endpoints
Returns A generator of endpoint instances.
update_endpoint(endpoint, **attrs)
Update a endpoint
Parameters endpoint Either the ID of a endpoint or a Endpoint instance.
Attrs kwargs The attributes to update on the endpoint represented by value.
Returns The updated endpoint
Group Operations

**kwargs)
create_group(**attrs)
Create a new group from attributes
Group, comprised of the properties on the Group class.
Returns The results of group creation
Return type Group
delete_group(group, ignore_missing=True)
Delete a group
Parameters
• group The value can be either the ID of a group or a Group instance.


will be raised when the group does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent group.
Returns None
find_group(name_or_id, ignore_missing=True)
Find a single group
Parameters
• name_or_id The name or ID of a group.
Returns One Group or None
get_group(group)
Get a single group
Parameters group The value can be the ID of a group or a Group instance.
Returns One Group
groups(**query)
Retrieve a generator of groups
Returns A generator of group instances.
Return type Group
update_group(group, **attrs)
Update a group
Parameters group Either the ID of a group or a Group instance.
Attrs kwargs The attributes to update on the group represented by value.
Returns The updated group
Return type Group
Policy Operations

**kwargs)

create_policy(**attrs)
Create a new policy from attributes
Policy, comprised of the properties on the Policy class.
Returns The results of policy creation
Return type Policy
delete_policy(policy, ignore_missing=True)
Delete a policy
Parameters
• policy The value can be either the ID of a policy or a Policy instance.
will be raised when the policy does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent policy.
Returns None
find_policy(name_or_id, ignore_missing=True)
Find a single policy
Parameters
• name_or_id The name or ID of a policy.
Returns One Policy or None
get_policy(policy)
Get a single policy
Parameters policy The value can be the ID of a policy or a Policy instance.
Returns One Policy
policies(**query)
Retrieve a generator of policies
Returns A generator of policy instances.
Return type Policy
update_policy(policy, **attrs)
Update a policy
Parameters policy Either the ID of a policy or a Policy instance.
Attrs kwargs The attributes to update on the policy represented by value.
Returns The updated policy

Return type Policy
Project Operations

**kwargs)
create_project(**attrs)
Create a new project from attributes
Project, comprised of the properties on the Project class.
Returns The results of project creation
Return type Project
delete_project(project, ignore_missing=True)
Delete a project
Parameters
• project The value can be either the ID of a project or a Project in-
stance.
will be raised when the project does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent project.
Returns None
find_project(name_or_id, ignore_missing=True, **attrs)
Find a single project
Parameters
• name_or_id The name or ID of a project.
Returns One Project or None
get_project(project)
Get a single project
Parameters project The value can be the ID of a project or a Project in-
stance.
Returns One Project

projects(**query)
Retrieve a generator of projects
Returns A generator of project instances.
Return type Project
update_project(project, **attrs)
Update a project
Parameters project Either the ID of a project or a Project instance.
Attrs kwargs The attributes to update on the project represented by value.
Returns The updated project
Return type Project
Region Operations

**kwargs)
create_region(**attrs)
Create a new region from attributes
Region, comprised of the properties on the Region class.
Returns The results of region creation.
Return type Region
delete_region(region, ignore_missing=True)
Delete a region
Parameters
• region The value can be either the ID of a region or a Region instance.
will be raised when the region does not exist. When set to True, no excep-
tion will be thrown when attempting to delete a nonexistent region.
Returns None
find_region(name_or_id, ignore_missing=True)
Find a single region
Parameters
• name_or_id The name or ID of a region.


will be raised when the region does not exist. When set to True, None will
be returned when attempting to find a nonexistent region.
Returns One Region or None
get_region(region)
Get a single region
Parameters region The value can be the ID of a region or a Region instance.
Returns One Region
Raises ResourceNotFound when no matching region can be found.
regions(**query)
Retrieve a generator of regions
regions being returned.
Returns A generator of region instances.
Return type Region
update_region(region, **attrs)
Update a region
Parameters region Either the ID of a region or a Region instance.
Attrs kwargs The attributes to update on the region represented by value.
Returns The updated region.
Return type Region
Role Operations

**kwargs)
create_role(**attrs)
Create a new role from attributes
Role, comprised of the properties on the Role class.
Returns The results of role creation.
Return type Role
delete_role(role, ignore_missing=True)
Delete a role
Parameters

• role The value can be either the ID of a role or a Role instance.

will be raised when the role does not exist. When set to True, no exception
will be thrown when attempting to delete a nonexistent role.
Returns None
find_role(name_or_id, ignore_missing=True)
Find a single role
Parameters
• name_or_id The name or ID of a role.
will be raised when the role does not exist. When set to True, None will be
returned when attempting to find a nonexistent role.
Returns One Role or None
get_role(role)
Get a single role
Parameters role The value can be the ID of a role or a Role instance.
Returns One Role
Raises ResourceNotFound when no matching role can be found.
roles(**query)
Retrieve a generator of roles
resources being returned. The options are: domain_id, name.
Return type Role
update_role(role, **attrs)
Update a role
Parameters
• role Either the ID of a role or a Role instance.
• kwargs (dict) The attributes to update on the role represented by
value. Only name can be updated
Returns The updated role.
Return type Role

Role Assignment Operations

**kwargs)
role_assignments_filter(domain=None, project=None, group=None,

user=None)
Retrieve a generator of roles assigned to user/group
Parameters
• domain Either the ID of a domain or a Domain instance.
• project Either the ID of a project or a Project instance.
• group Either the ID of a group or a Group instance.
• user Either the ID of a user or a User instance.
Return type Role
role_assignments(**query)
Retrieve a generator of role assignments
Parameters query (kwargs) Optional query parameters to be sent to
limit the resources being returned. The options are: group_id, role_id,
scope_domain_id, scope_project_id, user_id, include_names, include_subtree.
Returns RoleAssignment
assign_project_role_to_user(project, user, role)
Assign role to user on a project
Parameters
Returns None
unassign_project_role_from_user(project, user, role)
Unassign role from user on a project
Parameters
Returns None

validate_user_has_role(project, user, role)

Validates that a user has a role on a project
Parameters
Returns True if user has role in project
assign_project_role_to_group(project, group, role)
Assign role to group on a project
Parameters
Returns None
unassign_project_role_from_group(project, group, role)
Unassign role from group on a project
Parameters
Returns None
validate_group_has_role(project, group, role)
Validates that a group has a role on a project
Parameters
Returns True if group has role in project
Service Operations

**kwargs)

create_service(**attrs)
Create a new service from attributes
Service, comprised of the properties on the Service class.
Returns The results of service creation
Return type Service
delete_service(service, ignore_missing=True)
Delete a service
Parameters
• service The value can be either the ID of a service or a Service in-
stance.
will be raised when the service does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent service.
Returns None
find_service(name_or_id, ignore_missing=True)
Find a single service
Parameters
• name_or_id The name or ID of a service.
Returns One Service or None
get_service(service)
Get a single service
Parameters service The value can be the ID of a service or a Service in-
stance.
Returns One Service
services(**query)
Retrieve a generator of services
Returns A generator of service instances.
Return type Service
update_service(service, **attrs)
Update a service
Parameters service Either the ID of a service or a Service instance.
Attrs kwargs The attributes to update on the service represented by value.

Returns The updated service

Return type Service
Trust Operations

**kwargs)
create_trust(**attrs)
Create a new trust from attributes
Trust, comprised of the properties on the Trust class.
Returns The results of trust creation
Return type Trust
delete_trust(trust, ignore_missing=True)
Delete a trust
Parameters
• trust The value can be either the ID of a trust or a Trust instance.
will be raised when the credential does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent credential.
Returns None
find_trust(name_or_id, ignore_missing=True)
Find a single trust
Parameters
• name_or_id The name or ID of a trust.
Returns One Trust or None
get_trust(trust)
Get a single trust
Parameters trust The value can be the ID of a trust or a Trust instance.
Returns One Trust

trusts(**query)
Retrieve a generator of trusts
Returns A generator of trust instances.
Return type Trust
User Operations

**kwargs)
user_projects(user, **query)
Retrieve a generator of projects to which the user has authorization to access.
Parameters
• user Either the user id or an instance of User
Returns A generator of project instances.
Return type UserProject
create_user(**attrs)
User, comprised of the properties on the User class.
Returns The results of user creation
Return type User
delete_user(user, ignore_missing=True)
Delete a user
Parameters
Returns None
find_user(name_or_id, ignore_missing=True, **attrs)
Find a single user

Parameters
get_user(user)
Get a single user
Parameters user The value can be the ID of a user or a User instance.
Returns One User
users(**query)
Retrieve a generator of users
Returns A generator of user instances.
Return type User
update_user(user, **attrs)
Update a user
Parameters user Either the ID of a user or a User instance.
Attrs kwargs The attributes to update on the user represented by value.
Returns The updated user
Return type User
Image API v1
For details on how to use image, see Using OpenStack Image
The Image v1 Class
The image high-level interface is available through the image member of a Connection object. The
image member will only be added if the service is detected.
class openstack.image.v1._proxy.Proxy(session, statsd_client=None,
upload_image(**attrs)
Upload a new image from attributes


Image, comprised of the properties on the Image class.
Returns The results of image creation
Return type Image
Delete an image
Parameters
Returns None
Find a single image
Parameters
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
images(**query)
Return type Image
update_image(image, **attrs)
Update a image
Parameters image Either the ID of a image or a Image instance.
Attrs kwargs The attributes to update on the image represented by value.
Returns The updated image
Return type Image

Image API v2
For details on how to use image, see Using OpenStack Image
The Image v2 Class
The image high-level interface is available through the image member of a Connection object. The
image member will only be added if the service is detected.
Image Operations

import_image(image, method=’glance-direct’, uri=None, store=None, stores=None,

all_stores=None, all_stores_must_succeed=None)
Import data to an existing image
Interoperable image import process are introduced in the Image API v2.6. It mainly allow
image importing from an external url and let Image Service download it by itself without
sending binary data at image creation.
Parameters
• image The value can be the ID of a image or a Image instance.
• method Method to use for importing the image. A valid value is glance-
direct or web-download.
• uri Required only if using the web-download import method. This url is
where the data is made available to the Image service.
• store Used when enabled_backends is activated in glance. The value can
be the id of a store or a Store instance.
• stores List of stores to be used when enabled_backends is activated in
glance. List values can be the id of a store or a Store instance.
• all_stores Upload to all available stores. Mutually exclusive with
store and stores.
• all_stores_must_succeed When set to True, if an error occurs dur-
ing the upload in at least one store, the worfklow fails, the data is deleted
from stores where copying is done (not staging), and the state of the image
is unchanged. When set to False, the workflow will fail (data deleted from
stores, ) only if the import fails on all stores specified by the user. In case of
a partial success, the locations added to the image will be the stores where
the data has been correctly uploaded. Default is True.
Returns None

stage_image(image, filename=None, data=None)

Stage binary image data
Parameters
• image The value can be the ID of a image or a Image instance.
• filename Optional name of the file to read data from.
• data Optional data to be uploaded as an image.
Return type Image
upload_image(container_format=None, disk_format=None, data=None, **attrs)
Create and upload a new image from attributes
Parameters
• container_format Format of the container. A valid value is ami, ari,
aki, bare, ovf, ova, or docker.
• disk_format The format of the disk. A valid value is ami, ari, aki, vhd,
vmdk, raw, qcow2, vdi, or iso.
• data The data to be uploaded as an image.
• attrs (dict) Keyword arguments which will be used to create a Image,
comprised of the properties on the Image class.
Return type Image
download_image(image, stream=False, output=None, chunk_size=1024)
Download an image
This will download an image to memory when stream=False, or allow streaming down-
loads using an iterator when stream=True. For examples of working with streamed re-
sponses, see Downloading an Image with stream=True.
Parameters
• stream (bool) When True, return a requests.Response in-
stance allowing you to iterate over the response data stream instead of
storing its entire contents in memory. See requests.Response.
iter_content() for more details. NOTE: If you do not consume the
entirety of the response you must explicitly call requests.Response.
close() or otherwise risk inefficiencies with the requests librarys han-
dling of connections.
When False, return the entire contents of the response.
• output Either a file object or a path to store data into.
• chunk_size (int) size in bytes to read from the wire and buffer at one
time. Defaults to 1024

Returns When output is not given - the bytes comprising the given Image when
stream is False, otherwise a requests.Response instance. When output
is given - a Image instance.
Delete an image
Parameters
Returns None
Find a single image
Parameters
get_image(image)
Get a single image
Parameters image The value can be the ID of a image or a Image instance.
Returns One Image
images(**query)
Return type Image
update_image(image, **attrs)
Update a image
Attrs kwargs The attributes to update on the image represented by value.
Returns The updated image
Return type Image
deactivate_image(image)
Deactivate an image

Returns None
reactivate_image(image)
Deactivate an image
Returns None
add_tag(image, tag)
Add a tag to an image
Parameters
• image The value can be the ID of a image or a Image instance that the
member will be created for.
• tag (str) The tag to be added
Returns None
remove_tag(image, tag)
Remove a tag to an image
Parameters
• tag (str) The tag to be removed
Returns None
create_image(name, filename=None, container=None, md5=None,
sha256=None, disk_format=None, container_format=None,
disable_vendor_agent=True, allow_duplicates=False,
meta=None, wait=False, timeout=3600, data=None, val-
idate_checksum=False, use_import=False, stores=None,
all_stores=None, all_stores_must_succeed=None, **kwargs)
Upload an image.
Parameters
• name (str) Name of the image to create. If it is a pathname of an image,
the name will be constructed from the extensionless basename of the path.
• filename (str) The path to the file to upload, if needed. (optional,
defaults to None)
• data Image data (string or file-like object). It is mutually exclusive with
filename
• container (str) Name of the container in swift where images should
be uploaded for import if the cloud requires such a thing. (optional, defaults
to images)
• md5 (str) md5 sum of the image file. If not given, an md5 will be calcu-
lated.
• sha256 (str) sha256 sum of the image file. If not given, an md5 will be
calculated.

• disk_format (str) The disk format the image is in. (optional, defaults
to the os-client-config config value for this cloud)
• container_format (str) The container format the image is in. (op-
tional, defaults to the os-client-config config value for this cloud)
• disable_vendor_agent (bool) Whether or not to append metadata
flags to the image to inform the cloud in question to not expect a vendor
agent to be runing. (optional, defaults to True)
• allow_duplicates If true, skips checks that enforce unique image
name. (optional, defaults to False)
• meta A dict of key/value pairs to use for metadata that bypasses automatic
type conversion.
• wait (bool) If true, waits for image to be created. Defaults to true -
however, be aware that one of the upload methods is always synchronous.
• validate_checksum (bool) If true and cloud returns checksum, com-
pares return value with the one calculated or passed into this call. If value
does not match - raises exception. Default is false
• use_import (bool) Use the interoperable image import mechanism to
import the image. This defaults to false because it is harder on the target
cloud so should only be used when needed, such as when the user needs the
cloud to transform image format. If the cloud has disabled direct uploads,
this will default to true.
• stores List of stores to be used when enabled_backends is activated in
glance. List values can be the id of a store or a Store instance. Implies
use_import equals True.
• all_stores Upload to all available stores. Mutually exclusive with
store and stores. Implies use_import equals True.
• all_stores_must_succeed When set to True, if an error occurs dur-
ing the upload in at least one store, the worfklow fails, the data is deleted
from stores where copying is done (not staging), and the state of the image
is unchanged. When set to False, the workflow will fail (data deleted from
stores, ) only if the import fails on all stores specified by the user. In case of a
partial success, the locations added to the image will be the stores where the
data has been correctly uploaded. Default is True. Implies use_import
equals True.
Additional kwargs will be passed to the image creation as additional metadata for the im-
age and will have all values converted to string except for min_disk, min_ram, size and
virtual_size which will be converted to int.
If you are sure you have all of your data types correct or have an advanced need to be explicit,
use meta. If you are just a normal consumer, using kwargs is likely the right choice.
If a value is in meta and kwargs, meta wins.
Raises SDKException if there are problems uploading

Member Operations

add_member(image, **attrs)
Create a new member from attributes
Parameters
Member, comprised of the properties on the Member class.
Returns The results of member creation
Return type Member
remove_member(member, image, ignore_missing=True)
Delete a member
Parameters
• member The value can be either the ID of a member or a Member instance.
will be raised when the member does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent member.
Returns None
find_member(name_or_id, image, ignore_missing=True)
Find a single member
Parameters
• name_or_id The name or ID of a member.
• image This is the image that the member belongs to, the value can be the
ID of a image or a Image instance.
Returns One Member or None
get_member(member, image)
Get a single member on an image
Parameters
• member The value can be the ID of a member or a Member instance.

• image This is the image that the member belongs to. The value can be the
Returns One Member
members(image)
Return a generator of members
Parameters image This is the image that the member belongs to, the value can
be the ID of a image or a Image instance.
Returns A generator of member objects
Return type Member
update_member(member, image, **attrs)
Update the member of an image
Parameters
• member Either the ID of a member or a Member instance.
• image This is the image that the member belongs to. The value can be the
Attrs kwargs The attributes to update on the member represented by value.
Returns The updated member
Return type Member
Task Operations

tasks(**query)
Return a generator of tasks
Returns A generator of task objects
Return type Task
get_task(task)
Get task details
Parameters task The value can be the ID of a task or a Task instance.
Returns One Task

create_task(**attrs)
Create a new task from attributes
Task, comprised of the properties on the Task class.
Returns The results of task creation
Return type Task
wait_for_task(task, status=’success’, failures=None, interval=2, wait=120)
Wait for a task to be in a particular status.
Parameters
• task The resource to wait on to reach the specified status. The resource
must have a status attribute.
fault to 2.
120.
specified seconds.
statuses.
Schema Operations

get_images_schema()
Get images schema
Returns One Schema
get_image_schema()
Get single image schema
Returns One Schema

get_members_schema()
Get image members schema
Returns One Schema
get_member_schema()
Get image member schema
Returns One Schema
get_tasks_schema()
Get image tasks schema
Returns One Schema
get_task_schema()
Get image task schema
Returns One Schema
Service Info Discovery Operations

stores(**query)
Return a generator of supported image stores
Returns A generator of store objects
Return type Store
get_import_info()
Get a info about image constraints
Returns One Import

KeyManager API
For details on how to use key_management, see Using OpenStack Key Manager
The KeyManager Class
The key_management high-level interface is available through the key_manager member of a

Connection object. The key_manager member will only be added if the service is detected.
Secret Operations
class openstack.key_manager.v1._proxy.Proxy(session, statsd_client=None,

**kwargs)
create_secret(**attrs)
Create a new secret from attributes
Secret, comprised of the properties on the Order class.
Returns The results of secret creation
Return type Secret
delete_secret(secret, ignore_missing=True)
Delete a secret
Parameters
• secret The value can be either the ID of a secret or a Secret instance.
will be raised when the secret does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent secret.
Returns None
find_secret(name_or_id, ignore_missing=True)
Find a single secret
Parameters
• name_or_id The name or ID of a secret.
Returns One Secret or None

get_secret(secret)
Get a single secret
Parameters secret The value can be the ID of a secret or a Secret instance.
Returns One Secret
secrets(**query)
Return a generator of secrets
Returns A generator of secret objects
Return type Secret
update_secret(secret, **attrs)
Update a secret
Parameters secret Either the id of a secret or a Secret instance.
Attrs kwargs The attributes to update on the secret represented by value.
Returns The updated secret
Return type Secret
Container Operations

**kwargs)
create_container(**attrs)
Create a new container from attributes
Container, comprised of the properties on the Container class.
Returns The results of container creation
Return type Container
delete_container(container, ignore_missing=True)
Delete a container
Parameters
• container The value can be either the ID of a container or a
Container instance.


will be raised when the container does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent container.
Returns None
find_container(name_or_id, ignore_missing=True)
Find a single container
Parameters
• name_or_id The name or ID of a container.
Returns One Container or None
get_container(container)
Get a single container
Parameters container The value can be the ID of a container or a
Container instance.
Returns One Container
containers(**query)
Return a generator of containers
Returns A generator of container objects
update_container(container, **attrs)
Update a container
Parameters container Either the id of a container or a Container instance.
Attrs kwargs The attributes to update on the container represented by value.
Returns The updated container
Order Operations

**kwargs)

create_order(**attrs)
Create a new order from attributes
Order, comprised of the properties on the Order class.
Returns The results of order creation
Return type Order
delete_order(order, ignore_missing=True)
Delete an order
Parameters
• order The value can be either the ID of a order or a Order instance.
will be raised when the order does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent order.
Returns None
find_order(name_or_id, ignore_missing=True)
Find a single order
Parameters
• name_or_id The name or ID of a order.
Returns One Order or None
get_order(order)
Get a single order
Parameters order The value can be the ID of an order or a Order instance.
Returns One Order
orders(**query)
Return a generator of orders
Returns A generator of order objects
Return type Order
update_order(order, **attrs)
Update a order
Parameters order Either the id of a order or a Order instance.
Attrs kwargs The attributes to update on the order represented by value.
Returns The updated order

Return type Order
Load Balancer v2 API
The LoadBalancer Class
The load_balancer high-level interface is available through the load_balancer member of a

Connection object. The load_balancer member will only be added if the service is detected.
Load Balancer Operations
class openstack.load_balancer.v2._proxy.Proxy(session,
statsd_client=None,
**kwargs)
create_load_balancer(**attrs)
Create a new load balancer from attributes
LoadBalancer, comprised of the properties on the LoadBalancer class.
Returns The results of load balancer creation
Return type LoadBalancer
get_load_balancer(*attrs)
Get a load balancer
Parameters load_balancer The value can be the name of a load balancer or
LoadBalancer instance.
Returns One LoadBalancer
get_load_balancer_statistics(name_or_id)
Get the load balancer statistics
Parameters name_or_id The name or ID of a load balancer
Returns One LoadBalancerStats
load_balancers(**query)
Retrieve a generator of load balancers
Returns A generator of load balancer instances
delete_load_balancer(load_balancer, ignore_missing=True, cascade=False)
Delete a load balancer
Parameters

• load_balancer The load_balancer can be either the name or a

LoadBalancer instance
will be raised when the load balancer does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent load balancer.
• cascade (bool) If true will delete all child objects of the load balancer.
Returns None
find_load_balancer(name_or_id, ignore_missing=True)
Find a single load balancer
Parameters
• name_or_id The name or ID of a load balancer
Returns None
update_load_balancer(load_balancer, **attrs)
Update a load balancer
Parameters
• load_balancer The load_balancer can be either the name or a
LoadBalancer instance
• attrs (dict) The attributes to update on the load balancer represented
by load_balancer.
Returns The updated load_balancer
failover_load_balancer(name_or_id, **attrs)
Failover a load balancer
Parameters name_or_id The name or ID of a load balancer
Returns None
Listener Operations
statsd_client=None,
**kwargs)
create_listener(**attrs)
Create a new listener from attributes


Listener, comprised of the properties on the Listener class.
Returns The results of listener creation
Return type Listener
delete_listener(listener, ignore_missing=True)
Delete a listener
Parameters
• listener The value can be either the ID of a listner or a Listener
instance.
will be raised when the listner does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent listener.
Returns None
find_listener(name_or_id, ignore_missing=True)
Find a single listener
Parameters
• name_or_id The name or ID of a listener.
Returns One Listener or None
get_listener(listener)
Get a single listener
Parameters listener The value can be the ID of a listener or a Listener
instance.
Returns One Listener
get_listener_statistics(listener)
Get the listener statistics
instance.
Returns One ListenerStats
listeners(**query)
Return a generator of listeners
resources being returned. Valid parameters are:
Returns A generator of listener objects

update_listener(listener, **attrs)
Update a listener
Parameters
• listener Either the id of a listener or a Listener instance.
• attrs (dict) The attributes to update on the listener represented by
listener.
Returns The updated listener
Pool Operations
statsd_client=None,
**kwargs)
create_pool(**attrs)
Create a new pool from attributes
Pool, comprised of the properties on the Pool class.
Returns The results of Pool creation
Return type Pool
get_pool(*attrs)
Get a pool
Parameters pool Value is Pool instance.
Returns One Pool
pools(**query)
Retrieve a generator of pools
Returns A generator of Pool instances
delete_pool(pool, ignore_missing=True)
Delete a pool
Parameters
• pool The pool is a Pool instance
will be raised when the pool does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent pool.
Returns None

find_pool(name_or_id, ignore_missing=True)
Find a single pool
Parameters
• name_or_id The name or ID of a pool
Returns None
update_pool(pool, **attrs)
Update a pool
Parameters
• pool Either the id of a pool or a Pool instance.
• attrs (dict) The attributes to update on the pool represented by pool.
Returns The updated pool
Return type Pool
Member Operations
statsd_client=None,
**kwargs)
create_member(pool, **attrs)
Create a new member from attributes
Parameters
• pool The pool can be either the ID of a pool or a Pool instance that the
member will be created in.
Member, comprised of the properties on the Member class.
Returns The results of member creation
Return type Member
delete_member(member, pool, ignore_missing=True)
Delete a member
Parameters
• member The member can be either the ID of a member or a Member
instance.

member belongs to.
will be raised when the member does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent member.
Returns None
find_member(name_or_id, pool, ignore_missing=True)
Find a single member
Parameters
• name_or_id (str) The name or ID of a member.
member belongs to.
Returns One Member or None
get_member(member, pool)
Get a single member
Parameters
• member The member can be the ID of a member or a Member instance.
member belongs to.
Returns One Member
members(pool, **query)
Return a generator of members
Parameters
member belongs to.
being returned. Valid parameters are:
Returns A generator of member objects
Return type Member
update_member(member, pool, **attrs)
Update a member
Parameters
• member Either the ID of a member or a Member instance.
member belongs to.

• attrs (dict) The attributes to update on the member represented by

member.
Returns The updated member
Return type Member
Health Monitor Operations
statsd_client=None,
**kwargs)
find_health_monitor(name_or_id, ignore_missing=True)
Find a single health monitor
Parameters
• name_or_id The name or ID of a health monitor
will be raised when the health monitor does not exist. When set to True, no
exception will be set when attempting to find a nonexistent health monitor.
Returns The openstack.load_balancer.v2.healthmonitor.
HealthMonitor object matching the given name or id or None if nothing
matches.
Raises openstack.exceptions.DuplicateResource if more than one
resource is found for this request.
Raises openstack.exceptions.ResourceNotFound if nothing is found
and ignore_missing is False.
create_health_monitor(**attrs)
Create a new health monitor from attributes
HealthMonitor, comprised of the properties on the HealthMonitor class.
Returns The results of HealthMonitor creation
Return type HealthMonitor
get_health_monitor(healthmonitor)
Get a health monitor
Parameters healthmonitor The value can be the ID of a health monitor or
HealthMonitor instance.
Returns One health monitor

health_monitors(**query)
Retrieve a generator of health monitors
resources being returned. Valid parameters are: name, created_at, updated_at,
delay, expected_codes, http_method, max_retries, max_retries_down, pool_id,
provisioning_status, operating_status, timeout, project_id, type, url_path,
is_admin_state_up.
Returns A generator of health monitor instances
delete_health_monitor(healthmonitor, ignore_missing=True)
Delete a health monitor
Parameters
• healthmonitor The healthmonitor can be either the ID of the health
monitor or a HealthMonitor instance
will be raised when the healthmonitor does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent healthmonitor.
Returns None
update_health_monitor(healthmonitor, **attrs)
Update a health monitor
Parameters
• healthmonitor The healthmonitor can be either the ID of the health
monitor or a HealthMonitor instance
• attrs (dict) The attributes to update on the health monitor represented
by healthmonitor.
Returns The updated health monitor
L7 Policy Operations
statsd_client=None,
**kwargs)
create_l7_policy(**attrs)
Create a new l7policy from attributes
L7Policy, comprised of the properties on the L7Policy class.
Returns The results of l7policy creation

Return type L7Policy

delete_l7_policy(l7_policy, ignore_missing=True)
Delete a l7policy
Parameters
• l7_policy The value can be either the ID of a l7policy or a L7Policy
instance.
will be raised when the l7policy does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent l7policy.
Returns None
find_l7_policy(name_or_id, ignore_missing=True)
Find a single l7policy
Parameters
• name_or_id The name or ID of a l7policy.
Returns One L7Policy or None
get_l7_policy(l7_policy)
Get a single l7policy
Parameters l7_policy The value can be the ID of a l7policy or a L7Policy
instance.
Returns One L7Policy
l7_policies(**query)
Return a generator of l7policies
resources being returned. Valid parameters are:
Returns A generator of l7policy objects
update_l7_policy(l7_policy, **attrs)
Update a l7policy
Parameters
• l7_policy Either the id of a l7policy or a L7Policy instance.
• attrs (dict) The attributes to update on the l7policy represented by
l7policy.
Returns The updated l7policy

L7 Rule Operations
statsd_client=None,
**kwargs)
create_l7_rule(l7_policy, **attrs)
Create a new l7rule from attributes
Parameters
• l7_policy The l7_policy can be either the ID of a l7policy or
L7Policy instance that the l7rule will be created in.
L7Rule, comprised of the properties on the L7Rule class.
Returns The results of l7rule creation
Return type L7Rule
delete_l7_rule(l7rule, l7_policy, ignore_missing=True)
Delete a l7rule
Parameters
• l7rule The l7rule can be either the ID of a l7rule or a L7Rule instance.
L7Policy instance that the l7rule belongs to.
will be raised when the l7rule does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent l7rule.
Returns None
find_l7_rule(name_or_id, l7_policy, ignore_missing=True)
Find a single l7rule
Parameters
• name_or_id (str) The name or ID of a l7rule.
Returns One L7Rule or None
get_l7_rule(l7rule, l7_policy)
Get a single l7rule

Parameters
• l7rule The l7rule can be the ID of a l7rule or a L7Rule instance.
Returns One L7Rule
l7_rules(l7_policy, **query)
Return a generator of l7rules
Parameters
• l7_policy The l7_policy can be either the ID of a l7_policy or
being returned. Valid parameters are:
Returns A generator of l7rule objects
Return type L7Rule
update_l7_rule(l7rule, l7_policy, **attrs)
Update a l7rule
Parameters
• l7rule Either the ID of a l7rule or a L7Rule instance.
• attrs (dict) The attributes to update on the l7rule represented by
l7rule.
Returns The updated l7rule
Return type L7Rule
Provider Operations
statsd_client=None,
**kwargs)
providers(**query)
Retrieve a generator of providers
Returns A generator of providers instances

provider_flavor_capabilities(provider, **query)
Retrieve a generator of provider flavor capabilities
Returns A generator of provider flavor capabilities instances
Flavor Profile Operations
statsd_client=None,
**kwargs)
create_flavor_profile(**attrs)
Create a new flavor profile from attributes
FlavorProfile, comprised of the properties on the FlavorProfile class.
Returns The results of profile creation creation
Return type FlavorProfile
get_flavor_profile(*attrs)
Get a flavor profile
Parameters flavor_profile The value can be the name of a flavor profile
or FlavorProfile instance.
Returns One FlavorProfile
flavor_profiles(**query)
Retrieve a generator of flavor profiles
Returns A generator of flavor profiles instances
delete_flavor_profile(flavor_profile, ignore_missing=True)
Delete a flavor profile
Parameters
• flavor_profile The flavor_profile can be either the name or a
FlavorProfile instance
will be raised when the flavor profile does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent flavor profile.
Returns None
find_flavor_profile(name_or_id, ignore_missing=True)
Find a single flavor profile
Parameters
• name_or_id The name or ID of a flavor profile


will be raised when the flavor profile does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent flavor profile.
Returns None
update_flavor_profile(flavor_profile, **attrs)
Update a flavor profile
Parameters
• flavor_profile The flavor_profile can be either the name or a
FlavorProfile instance
• attrs (dict) The attributes to update on the flavor profile represented by
flavor_profile.
Returns The updated flavor profile
Return type FlavorProfile
Flavor Operations
statsd_client=None,
**kwargs)
Create a new flavor from attributes
Flavor, comprised of the properties on the Flavorclass.
Returns The results of flavor creation creation
Return type Flavor
get_flavor(*attrs)
Get a flavor
Parameters flavor The value can be the name of a flavor or Flavor instance.
Returns One Flavor
flavors(**query)
Retrieve a generator of flavors
Returns A generator of flavor instances
Delete a flavor
Parameters
• flavor The flavorcan be either the name or a Flavor instance


Returns None
find_flavor(name_or_id, ignore_missing=True)
Parameters
• name_or_id The name or ID of a flavor
Returns None
update_flavor(flavor, **attrs)
Update a flavor
Parameters
• flavor The flavor can be either the name or a Flavor instance
• attrs (dict) The attributes to update on the flavor represented by
flavor.
Returns The updated flavor
Return type Flavor
Quota Operations
statsd_client=None,
**kwargs)
quotas(**query)
Return a generator of quotas
resources being returned. Currently no query parameter is supported.
Returns A generator of quota objects
Return type Quota
get_quota(quota)
Get a quota
Parameters quota The value can be the ID of a quota or a Quota instance. The
ID of a quota is the same as the project ID for the quota.

Returns One Quota

update_quota(quota, **attrs)
Update a quota
Parameters
• quota Either the ID of a quota or a Quota instance. The ID of a quota is
the same as the project ID for the quota.
• attrs (dict) The attributes to update on the quota represented by
quota.
Returns The updated quota
Return type Quota
get_quota_default()
Get a default quota
Returns One QuotaDefault
delete_quota(quota, ignore_missing=True)
Delete a quota (i.e. reset to the default quota)
Parameters
• quota The value can be either the ID of a quota or a Quota instance. The
will be raised when quota does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent quota.
Returns None
Amphora Operations
statsd_client=None,
**kwargs)
amphorae(**query)
Retrieve a generator of amphorae
Returns A generator of amphora instances
get_amphora(*attrs)
Get a amphora
Parameters amphora The value can be the ID of an amphora or Amphora
instance.

Returns One Amphora

find_amphora(amphora_id, ignore_missing=True)
Find a single amphora
Parameters
• amphora_id The ID of a amphora
will be raised when the amphora does not exist. When set to True, no
exception will be set when attempting to find a nonexistent amphora.
Returns None
configure_amphora(amphora_id, **attrs)
Update the configuration of an amphora agent
Parameters amphora_id The ID of an amphora
Returns None
failover_amphora(amphora_id, **attrs)
Failover an amphora
Parameters amphora_id The ID of an amphora
Returns None
Availability Zone Profile Operations
statsd_client=None,
**kwargs)
create_availability_zone_profile(**attrs)
Create a new availability zone profile from attributes
AvailabilityZoneProfile, comprised of the properties on the Avail-
abilityZoneProfile class.
Returns The results of profile creation creation
Return type AvailabilityZoneProfile
get_availability_zone_profile(*attrs)
Get an availability zone profile
Parameters availability_zone_profile The value can be the name of
an availability_zone profile or AvailabilityZoneProfile instance.
Returns One AvailabilityZoneProfile

availability_zone_profiles(**query)
Retrieve a generator of availability zone profiles
Returns A generator of availability zone profiles instances
delete_availability_zone_profile(availability_zone_profile, ig-
nore_missing=True)
Delete an availability zone profile
Parameters
• availability_zone_profile The availability_zone_profile can be
either the name or a AvailabilityZoneProfile instance
will be raised when the availability zone profile does not exist. When set
to True, no exception will be set when attempting to delete a nonexistent
availability zone profile.
Returns None
find_availability_zone_profile(name_or_id, ignore_missing=True)
Find a single availability zone profile
Parameters
• name_or_id The name or ID of a availability zone profile
will be raised when the availability zone profile does not exist. When set
to True, no exception will be set when attempting to delete a nonexistent
availability zone profile.
Returns None
update_availability_zone_profile(availability_zone_profile, **attrs)
Update an availability zone profile
Parameters
• availability_zone_profile The availability_zone_profile can be
either the name or a AvailabilityZoneProfile instance
• attrs (dict) The attributes to update on the availability_zone profile
represented by availability_zone_profile.
Returns The updated availability zone profile
Return type AvailabilityZoneProfile

statsd_client=None,
**kwargs)
create_availability_zone(**attrs)
Create a new availability zone from attributes
Parameters attrs (dict) Keyword arguments which will be used to create
a AvailabilityZone, comprised of the properties on the Availability-
Zoneclass.
Returns The results of availability_zone creation creation
get_availability_zone(*attrs)
Get an availability zone
Parameters availability_zone The value can be the name of a availabil-
ity_zone or AvailabilityZone instance.
Returns One AvailabilityZone
availability_zones(**query)
Retrieve a generator of availability zones
Returns A generator of availability zone instances
delete_availability_zone(availability_zone, ignore_missing=True)
Delete an availability_zone
Parameters
• availability_zone The availability_zone can be either the name or a
AvailabilityZone instance
will be raised when the availability zone does not exist. When set to True,
no exception will be set when attempting to delete a nonexistent availability
zone.
Returns None
find_availability_zone(name_or_id, ignore_missing=True)
Find a single availability zone
Parameters
• name_or_id The name or ID of a availability zone
will be raised when the availability zone does not exist. When set to True,

no exception will be set when attempting to delete a nonexistent availability

zone.
Returns None
update_availability_zone(availability_zone, **attrs)
Update an availability zone
Parameters
• availability_zone The availability_zone can be either the name or a
AvailabilityZone instance
• attrs (dict) The attributes to update on the availability_zone repre-
sented by availability_zone.
Returns The updated availability_zone
Message API v2
For details on how to use message, see Using OpenStack Message
The Message v2 Class
The message high-level interface is available through the message member of a Connection object.
The message member will only be added if the service is detected.
Message Operations
class openstack.message.v2._proxy.Proxy(session, statsd_client=None,

**kwargs)
post_message(queue_name, messages)
Post messages to given queue
Parameters
• queue_name The name of target queue to post message to.
• messages (list) List of messages body and TTL to post.
Returns A string includes location of messages successfully posted.
messages(queue_name, **query)
Retrieve a generator of messages
Parameters
• queue_name The name of target queue to query messages from.

• query (kwargs) Optional query parameters to be sent to restrict the mes-

sages to be returned. Available parameters include:
– limit: Requests at most the specified number of items be returned
from the query.
– marker: Specifies the ID of the last-seen subscription. Use the limit
parameter to make an initial limited request and use the ID of the
last-seen subscription from the response as the marker parameter value
in a subsequent limited request.
– echo: Indicate if the messages can be echoed back to the client that
posted them.
– include_claimed: Indicate if the messages list should include the
claimed messages.
Returns A generator of message instances.
get_message(queue_name, message)
Get a message
Parameters
• queue_name The name of target queue to get message from.
• message The value can be the name of a message or a Message instance.
Returns One Message
Raises ResourceNotFound when no message matching the criteria could be
found.
delete_message(queue_name, value, claim=None, ignore_missing=True)
Delete a message
Parameters
• queue_name The name of target queue to delete message from.
• value The value can be either the name of a message or a Message
instance.
• claim The value can be the ID or a Claim instance of the claim seizing
the message. If None, the message has not been claimed.
will be raised when the message does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent message.
Returns None

Queue Operations

**kwargs)
create_queue(**attrs)
Create a new queue from attributes
Queue, comprised of the properties on the Queue class.
Returns The results of queue creation
Return type Queue
get_queue(queue)
Get a queue
Parameters queue The value can be the name of a queue or a Queue instance.
Returns One Queue
Raises ResourceNotFound when no queue matching the name could be
found.
queues(**query)
Retrieve a generator of queues
the queues to be returned. Available parameters include:
the query.
• marker: Specifies the ID of the last-seen queue. Use the limit
last-seen queue from the response as the marker parameter value in a
Returns A generator of queue instances.
delete_queue(value, ignore_missing=True)
Delete a queue
Parameters
• value The value can be either the name of a queue or a Queue instance.
will be raised when the queue does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent queue.
Returns None

Claim Operations

**kwargs)
create_claim(queue_name, **attrs)
Create a new claim from attributes
Parameters
• queue_name The name of target queue to claim message from.
• attrs (dict) Keyword arguments which will be used to create a Claim,
comprised of the properties on the Claim class.
Returns The results of claim creation
Return type Claim
get_claim(queue_name, claim)
Get a claim
Parameters
• claim The value can be either the ID of a claim or a Claim instance.
Returns One Claim
Raises ResourceNotFound when no claim matching the criteria could be
found.
update_claim(queue_name, claim, **attrs)
Update an existing claim from attributes
Parameters
• attrs (dict) Keyword arguments which will be used to update a Claim,
comprised of the properties on the Claim class.
Returns The results of claim update
Return type Claim
delete_claim(queue_name, claim, ignore_missing=True)
Delete a claim
Parameters
• queue_name The name of target queue to claim messages from.


will be raised when the claim does not exist. When set to True, no excep-
tion will be thrown when attempting to delete a nonexistent claim.
Returns None
Subscription Operations

**kwargs)
create_subscription(queue_name, **attrs)
Create a new subscription from attributes
Parameters
• queue_name The name of target queue to subscribe on.
Subscription, comprised of the properties on the Subscription class.
Returns The results of subscription creation
Return type Subscription
subscriptions(queue_name, **query)
Retrieve a generator of subscriptions
Parameters
• queue_name The name of target queue to subscribe on.
• query (kwargs) Optional query parameters to be sent to restrict the sub-
scriptions to be returned. Available parameters include:
– limit: Requests at most the specified number of items be returned
from the query.
– marker: Specifies the ID of the last-seen subscription. Use the limit
last-seen subscription from the response as the marker parameter value
in a subsequent limited request.
Returns A generator of subscription instances.
get_subscription(queue_name, subscription)
Get a subscription
Parameters
• queue_name The name of target queue of subscription.
• message The value can be the ID of a subscription or a Subscription
instance.

Returns One Subscription

Raises ResourceNotFound when no subscription matching the criteria could
be found.
delete_subscription(queue_name, value, ignore_missing=True)
Delete a subscription
Parameters
• queue_name The name of target queue to delete subscription from.
• value The value can be either the name of a subscription or a
Subscription instance.
will be raised when the subscription does not exist. When set to True, no
exception will be thrown when attempting to delete a nonexistent subscrip-
tion.
Returns None
Network API
For details on how to use network, see Using OpenStack Network
The Network Class
The network high-level interface is available through the network member of a Connection object.
The network member will only be added if the service is detected.
Network Operations
class openstack.network.v2._proxy.Proxy(session, statsd_client=None,

**kwargs)
dhcp_agent_hosting_networks(agent, **query)
A generator of networks hosted by a DHCP agent.
Parameters
• agent Either the agent id of an instance of Agent
• query kwargs query: Optional query parameters to be sent to limit the
Returns A generator of networks
add_dhcp_agent_to_network(agent, network)
Add a DHCP Agent to a network

Parameters
• network Network instance
Returns
remove_dhcp_agent_from_network(agent, network)
Remove a DHCP Agent from a network
Parameters
• network Network instance
Returns
create_network(**attrs)
Create a new network from attributes
Network, comprised of the properties on the Network class.
Returns The results of network creation
Return type Network
delete_network(network, ignore_missing=True, if_revision=None)
Delete a network
Parameters
• network The value can be either the ID of a network or a Network
instance.
will be raised when the network does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent network.
• if_revision (int) Revision to put in If-Match header of update request
to perform compare-and-swap update.
Returns None
find_network(name_or_id, ignore_missing=True, **args)
Find a single network
Parameters
• name_or_id The name or ID of a network.
• args (dict) Any additional parameters to be passed into underlying
methods. such as query filters.
Returns One Network or None
get_network(network)
Get a single network

Parameters network The value can be the ID of a network or a Network

instance.
Returns One Network
networks(**query)
Return a generator of networks
resources being returned. Available parameters include:
• description: The network description.
• ipv4_address_scope_id: The ID of the IPv4 address scope for
the network.
• ipv6_address_scope_id: The ID of the IPv6 address scope for
the network.
• is_admin_state_up: Network administrative state
• is_port_security_enabled: The port security status.
• is_router_external: Network is external or not.
• is_shared: Whether the network is shared across projects.
• name: The name of the network.
• status: Network status
• project_id: Owner tenant ID
• provider_network_type: Network physical mechanism
• provider_physical_network: Physical network
• provider_segmentation_id: VLAN ID for VLAN networks or Tunnel
ID for GENEVE/GRE/VXLAN networks
Returns A generator of network objects
Return type Network
update_network(network, if_revision=None, **attrs)
Update a network
Parameters
• network Either the id of a network or an instance of type Network.
• attrs (dict) The attributes to update on the network represented by
network.
Returns The updated network
Return type Network
find_network_ip_availability(name_or_id, ignore_missing=True, **args)
Find IP availability of a network

Parameters
• name_or_id The name or ID of a network.
Returns One NetworkIPAvailability or None
get_network_ip_availability(network)
Get IP availability of a network
Parameters network The value can be the ID of a network or a Network
instance.
Returns One NetworkIPAvailability
network_ip_availabilities(**query)
Return a generator of network ip availabilities
• ip_version: IP version of the network
• network_id: ID of network to use when listening network IP
availability.
• network_name: The name of the network for the particular network
IP availability.
Returns A generator of network ip availability objects
Return type NetworkIPAvailability
Port Operations

**kwargs)
create_port(**attrs)
Create a new port from attributes
Port, comprised of the properties on the Port class.
Returns The results of port creation

Return type Port

create_ports(data)
Create ports from the list of attributes
Parameters data (list) List of dicts of attributes which will be used to create
a Port, comprised of the properties on the Port class.
Returns A generator of port objects
Return type Port
delete_port(port, ignore_missing=True, if_revision=None)
Delete a port
Parameters
• port The value can be either the ID of a port or a Port instance.
will be raised when the port does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent port.
Returns None
find_port(name_or_id, ignore_missing=True, **args)
Find a single port
Parameters
• name_or_id The name or ID of a port.
Returns One Port or None
get_port(port)
Get a single port
Parameters port The value can be the ID of a port or a Port instance.
Returns One Port
ports(**query)
Return a generator of ports
• description: The port description.
• device_id: Port device ID.
• device_owner: Port device owner (e.g. network:dhcp).

• ip_address: IP addresses of an allowed address pair.

• is_admin_state_up: The administrative state of the port.
• is_port_security_enabled: The port security status.
• mac_address: Port MAC address.
• name: The port name.
• network_id: ID of network that owns the ports.
• project_id: The ID of the project who owns the network.
• status: The port status. Value is ACTIVE or DOWN.
• subnet_id: The ID of the subnet.
Returns A generator of port objects
Return type Port
update_port(port, if_revision=None, **attrs)
Update a port
Parameters
• port Either the id of a port or a Port instance.
• attrs (dict) The attributes to update on the port represented by port.
Returns The updated port
Return type Port
Router Operations

**kwargs)
create_router(**attrs)
Create a new router from attributes
Router, comprised of the properties on the Router class.
Returns The results of router creation
Return type Router
delete_router(router, ignore_missing=True, if_revision=None)
Delete a router
Parameters

• router The value can be either the ID of a router or a Router instance.

will be raised when the router does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent router.
Returns None
find_router(name_or_id, ignore_missing=True, **args)
Find a single router
Parameters
• name_or_id The name or ID of a router.
Returns One Router or None
get_router(router)
Get a single router
Parameters router The value can be the ID of a router or a Router instance.
Returns One Router
routers(**query)
Return a generator of routers
Parameters query (dict)
Optional query parameters to be sent to limit the resources being returned.
Valid parameters are:
• description: The description of a router.

• flavor_id: The ID of the flavor.
• is_admin_state_up: Router administrative state is up or not
• is_distributed: The distributed state of a router
• is_ha: The highly-available state of a router
• name: Router name
• project_id: The ID of the project this router is associated with.
• status: The status of the router.
Returns A generator of router objects

Return type Router

update_router(router, if_revision=None, **attrs)

Update a router
Parameters
• router Either the id of a router or a Router instance.
• attrs (dict) The attributes to update on the router represented by
router.
Returns The updated router
Return type Router
add_interface_to_router(router, subnet_id=None, port_id=None)
Add Interface to a router
Parameters
• router Either the router ID or an instance of Router
• subnet_id ID of the subnet
• port_id ID of the port
Returns Router with updated interface
Return type
class ~openstack.network.v2.router.Router
remove_interface_from_router(router, subnet_id=None, port_id=None)
Remove Interface from a router
Parameters
• subnet ID of the subnet
• port ID of the port
Return type
add_extra_routes_to_router(router, body)
Add extra routes to a router
Parameters
• body The request body as documented in the api-ref.
Returns Router with updated extra routes
Return type

remove_extra_routes_from_router(router, body)
Remove extra routes from a router
Parameters
• body The request body as documented in the api-ref.
Returns Router with updated extra routes
Return type
add_gateway_to_router(router, **body)
Add Gateway to a router
Parameters
• body Body with the gateway information
Return type
remove_gateway_from_router(router, **body)
Remove Gateway from a router
Parameters
• body Body with the gateway information
Return type
Floating IP Operations

**kwargs)
create_ip(**attrs)
Create a new floating ip from attributes
FloatingIP, comprised of the properties on the FloatingIP class.
Returns The results of floating ip creation


delete_ip(floating_ip, ignore_missing=True, if_revision=None)
Delete a floating ip
Parameters
• floating_ip The value can be either the ID of a floating ip or a
FloatingIP instance.
will be raised when the floating ip does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent ip.
Returns None
find_available_ip()
Find an available IP
Returns One FloatingIP or None
find_ip(name_or_id, ignore_missing=True, **args)
Find a single IP
Parameters
• name_or_id The name or ID of an IP.
Returns One FloatingIP or None
get_ip(floating_ip)
Get a single floating ip
Parameters floating_ip The value can be the ID of a floating ip or a
FloatingIP instance.
Returns One FloatingIP
ips(**query)
Return a generator of ips
• description: The description of a floating IP.

• fixed_ip_address: The fixed IP address associated with a floating
IP address.

• floating_ip_address: The IP address of a floating IP.

• floating_network_id: The ID of the network associated with a
floating IP.
• port_id: The ID of the port to which a floating IP is associated.
• project_id: The ID of the project a floating IP is associated with.
• router_id: The ID of an associated router.
• status: The status of a floating IP, which can be ACTIVE or DOWN.
Returns A generator of floating IP objects

update_ip(floating_ip, if_revision=None, **attrs)
Update a ip
Parameters
• floating_ip Either the id of a ip or a FloatingIP instance.
• attrs (dict) The attributes to update on the ip represented by value.
Returns The updated ip
Pool Operations

**kwargs)
create_pool(**attrs)
Create a new pool from attributes
Pool, comprised of the properties on the Pool class.
Returns The results of pool creation
Return type Pool
delete_pool(pool, ignore_missing=True)
Delete a pool
Parameters
• pool The value can be either the ID of a pool or a Pool instance.


Returns None
find_pool(name_or_id, ignore_missing=True, **args)
Find a single pool
Parameters
• name_or_id The name or ID of a pool.
Returns One Pool or None
get_pool(pool)
Get a single pool
Parameters pool The value can be the ID of a pool or a Pool instance.
Returns One Pool
pools(**query)
Return a generator of pools
• description: The description for the pool.

• is_admin_state_up: The administrative state of the pool.
• lb_algorithm: The load-balancer algorithm used, which is one of
round-robin, least-connections and so on.
• name: The name of the node pool.
• project_id: The ID of the project the pool is associated with.
• protocol: The protocol used by the pool, which is one of TCP, HTTP
or HTTPS.
• provider: The name of the provider of the load balancer service.
• subnet_id: The subnet on which the members of the pool are
located.
• virtual_ip_id: The ID of the virtual IP used.
Returns A generator of pool objects

Return type Pool

update_pool(pool, **attrs)
Update a pool
Parameters
• pool Either the id of a pool or a Pool instance.
• attrs (dict) The attributes to update on the pool represented by pool.
Returns The updated pool
Return type Pool
create_pool_member(pool, **attrs)
Create a new pool member from attributes
Parameters
member will be created in.
PoolMember, comprised of the properties on the PoolMember class.
Returns The results of pool member creation
Return type PoolMember
delete_pool_member(pool_member, pool, ignore_missing=True)
Delete a pool member
Parameters
• pool_member The member can be either the ID of a pool member or a
PoolMember instance.
member belongs to.
will be raised when the pool member does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent pool member.
Returns None
find_pool_member(name_or_id, pool, ignore_missing=True, **args)
Find a single pool member
Parameters
• name_or_id (str) The name or ID of a pool member.
member belongs to.
Returns One PoolMember or None

get_pool_member(pool_member, pool)
Get a single pool member
Parameters
• pool_member The member can be the ID of a pool member or a
PoolMember instance.
member belongs to.
Returns One PoolMember
pool_members(pool, **query)
Return a generator of pool members
Parameters
member belongs to.
• query (dict)
Optional query parameters to be sent to limit the resources being re-
turned. Valid parameters are:
– address: The IP address of the pool member.

– is_admin_state_up: The administrative state of the pool
member.
– name: Name of the pool member.
– project_id: The ID of the project this pool member is associated
with.
– protocol_port: The port on which the application is hosted.
– subnet_id: Subnet ID in which to access this pool member.
– weight: A positive integer value that indicates the relative portion
of traffic that this member should receive from the pool.
Returns A generator of pool member objects

update_pool_member(pool_member, pool, **attrs)
Update a pool member
Parameters
• pool_member Either the ID of a pool member or a PoolMember in-
stance.
member belongs to.
• attrs (dict) The attributes to update on the pool member represented
by pool_member.

Returns The updated pool member

Auto Allocated Topology Operations

**kwargs)
get_auto_allocated_topology(project=None)
Get the auto-allocated topology of a given tenant
Parameters project The value is the ID or name of a project
Returns The auto-allocated topology
Return type AutoAllocatedTopology
delete_auto_allocated_topology(project=None, ignore_missing=False)
Delete auto-allocated topology
Parameters
• project The value is the ID or name of a project
• ignore_missing When set to False ResourceNotFound will be
raised when the topology does not exist. When set to True, no exception
will be raised when attempting to delete nonexistant topology
Returns None
validate_auto_allocated_topology(project=None)
Validate the resources for auto allocation
Parameters project The value is the ID or name of a project
Returns Whether all resources are correctly configured or not
Return type ValidateTopology
Security Group Operations

**kwargs)

create_security_group(**attrs)
Create a new security group from attributes
SecurityGroup, comprised of the properties on the SecurityGroup class.
Returns The results of security group creation
Return type SecurityGroup
delete_security_group(security_group, ignore_missing=True, if_revision=None)
Delete a security group
Parameters
• security_group The value can be either the ID of a security group or
a SecurityGroup instance.
will be raised when the security group does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent security group.
Returns None
find_security_group(name_or_id, ignore_missing=True, **args)
Find a single security group
Parameters
• name_or_id The name or ID of a security group.
Returns One SecurityGroup or None
get_security_group(security_group)
Get a single security group
Parameters security_group The value can be the ID of a security group or
a SecurityGroup instance.
Returns One SecurityGroup
security_groups(**query)
Return a generator of security groups
• description: Security group description

• ìd: The id of a security group, or list of security group ids

• name: The name of a security group
• project_id: The ID of the project this security group is associated
with.
Returns A generator of security group objects

update_security_group(security_group, if_revision=None, **attrs)
Update a security group
Parameters
• security_group Either the id of a security group or a
• attrs (dict) The attributes to update on the security group represented
by security_group.
Returns The updated security group
create_security_group_rule(**attrs)
Create a new security group rule from attributes
a SecurityGroupRule, comprised of the properties on the Security-
GroupRule class.
Returns The results of security group rule creation
Return type SecurityGroupRule
create_security_group_rules(data)
Create new security group rules from the list of attributes
Parameters data (list) List of dicts of attributes which will be used to cre-
ate a SecurityGroupRule, comprised of the properties on the Security-
GroupRule class.
Returns A generator of security group rule objects
delete_security_group_rule(security_group_rule, ignore_missing=True,
if_revision=None)
Delete a security group rule
Parameters
• security_group_rule The value can be either the ID of a security
group rule or a SecurityGroupRule instance.
will be raised when the security group rule does not exist. When set to

True, no exception will be set when attempting to delete a nonexistent se-

curity group rule.
Returns None
find_security_group_rule(name_or_id, ignore_missing=True, **args)
Find a single security group rule
Parameters
• name_or_id (str) The ID of a security group rule.
Returns One SecurityGroupRule or None
get_security_group_rule(security_group_rule)
Get a single security group rule
Parameters security_group_rule The value can be the ID of a security
group rule or a SecurityGroupRule instance.
Returns SecurityGroupRule
security_group_rules(**query)
Return a generator of security group rules
• description: The security group rule description
• direction: Security group rule direction
• ether_type: Must be IPv4 or IPv6, and addresses represented in
CIDR must match the ingress or egress rule.
• project_id: The ID of the project this security group rule is associ-
ated with.
• protocol: Security group rule protocol
• remote_group_id: ID of a remote security group
• security_group_id: ID of security group that owns the rules
Returns A generator of security group rule objects


**kwargs)
availability_zones(**query)
Return a generator of availability zones
optional query parameters to be set to limit the returned resources. Valid
parameters include:
• name: The name of an availability zone.

• resource: The type of resource for the availability zone.
Returns A generator of availability zone objects

Address Scope Operations

**kwargs)
create_address_scope(**attrs)
Create a new address scope from attributes
AddressScope, comprised of the properties on the AddressScope class.
Returns The results of address scope creation
Return type AddressScope
delete_address_scope(address_scope, ignore_missing=True)
Delete an address scope
Parameters
• address_scope The value can be either the ID of an address scope or a
AddressScope instance.


will be raised when the address scope does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent address scope.
Returns None
find_address_scope(name_or_id, ignore_missing=True, **args)
Find a single address scope
Parameters
• name_or_id The name or ID of an address scope.
Returns One AddressScope or None
get_address_scope(address_scope)
Get a single address scope
Parameters address_scope The value can be the ID of an address scope or a
AddressScope instance.
Returns One AddressScope
address_scopes(**query)
Return a generator of address scopes
• name: Address scope name

• ip_version: Address scope IP address version
• tenant_id: Owner tenant ID
• shared: Address scope is shared (boolean)
Returns A generator of address scope objects

update_address_scope(address_scope, **attrs)
Update an address scope
Parameters
• address_scope Either the ID of an address scope or a AddressScope
instance.
• attrs (dict) The attributes to update on the address scope represented
by value.
Returns The updated address scope

Quota Operations

**kwargs)
delete_quota(quota, ignore_missing=True)
Delete a quota (i.e. reset to the default quota)
Parameters
• quota The value can be either the ID of a quota or a Quota instance. The
will be raised when quota does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent quota.
Returns None
get_quota(quota, details=False)
Get a quota
Parameters
• quota The value can be the ID of a quota or a Quota instance. The ID of
a quota is the same as the project ID for the quota.
• details If set to True, details about quota usage will be returned.
Returns One Quota
get_quota_default(quota)
Get a default quota
Parameters quota The value can be the ID of a default quota or a
QuotaDefault instance. The ID of a default quota is the same as the project
ID for the default quota.
Returns One QuotaDefault
quotas(**query)
Return a generator of quotas
resources being returned. Currently no query parameter is supported.
Returns A generator of quota objects
Return type Quota

update_quota(quota, **attrs)
Update a quota
Parameters
• quota Either the ID of a quota or a Quota instance. The ID of a quota is
the same as the project ID for the quota.
• attrs (dict) The attributes to update on the quota represented by
quota.
Returns The updated quota
Return type Quota
QoS Operations

**kwargs)
create_qos_bandwidth_limit_rule(qos_policy, **attrs)
Create a new bandwidth limit rule
Parameters
QoSBandwidthLimitRule, comprised of the properties on the QoS-
BandwidthLimitRule class.
• qos_policy The value can be the ID of the QoS policy that the rule
belongs or a QoSPolicy instance.
Returns The results of resource creation
Return type QoSBandwidthLimitRule
delete_qos_bandwidth_limit_rule(qos_rule, qos_policy, ig-
nore_missing=True)
Delete a bandwidth limit rule
Parameters
• qos_rule The value can be either the ID of a bandwidth limit rule or a
QoSBandwidthLimitRule instance.
will be raised when the resource does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent bandwidth
limit rule.
Returns None

find_qos_bandwidth_limit_rule(qos_rule_id, qos_policy, ig-

nore_missing=True, **args)
Find a bandwidth limit rule
Parameters
• qos_rule_id The ID of a bandwidth limit rule.
Returns One QoSBandwidthLimitRule or None
get_qos_bandwidth_limit_rule(qos_rule, qos_policy)
Get a single bandwidth limit rule
Parameters
• qos_rule The value can be the ID of a minimum bandwidth rule or a
Returns One QoSBandwidthLimitRule
qos_bandwidth_limit_rules(qos_policy, **query)
Return a generator of bandwidth limit rules
Parameters
Returns A generator of bandwidth limit rule objects
update_qos_bandwidth_limit_rule(qos_rule, qos_policy, **attrs)
Update a bandwidth limit rule
Parameters
• qos_rule Either the id of a bandwidth limit rule or a
Attrs kwargs The attributes to update on the bandwidth limit rule represented by
value.

Returns The updated minimum bandwidth rule

create_qos_dscp_marking_rule(qos_policy, **attrs)
Create a new QoS DSCP marking rule
Parameters
QoSDSCPMarkingRule, comprised of the properties on the QosDscp-
MarkingRule class.
Returns The results of router creation
Return type QoSDSCPMarkingRule
delete_qos_dscp_marking_rule(qos_rule, qos_policy, ignore_missing=True)
Delete a QoS DSCP marking rule
Parameters
• qos_rule The value can be either the ID of a minimum bandwidth rule
or a QoSDSCPMarkingRule instance.
will be raised when the resource does not exist. When set to True, no ex-
ception will be set when attempting to delete a nonexistent minimum band-
width rule.
Returns None
find_qos_dscp_marking_rule(qos_rule_id, qos_policy, ignore_missing=True,
**args)
Find a QoS DSCP marking rule
Parameters
• qos_rule_id The ID of a QoS DSCP marking rule.
Returns One QoSDSCPMarkingRule or None
get_qos_dscp_marking_rule(qos_rule, qos_policy)
Get a single QoS DSCP marking rule
Parameters


QoSDSCPMarkingRule instance.
Returns One QoSDSCPMarkingRule
qos_dscp_marking_rules(qos_policy, **query)
Return a generator of QoS DSCP marking rules
Parameters
Returns A generator of QoS DSCP marking rule objects
update_qos_dscp_marking_rule(qos_rule, qos_policy, **attrs)
Update a QoS DSCP marking rule
Parameters
• qos_rule Either the id of a minimum bandwidth rule or a
QoSDSCPMarkingRule instance.
Attrs kwargs The attributes to update on the QoS DSCP marking rule represented
by value.
Returns The updated QoS DSCP marking rule
create_qos_minimum_bandwidth_rule(qos_policy, **attrs)
Create a new minimum bandwidth rule
Parameters
QoSMinimumBandwidthRule, comprised of the properties on the QoS-
MinimumBandwidthRule class.
Returns The results of resource creation
Return type QoSMinimumBandwidthRule
delete_qos_minimum_bandwidth_rule(qos_rule, qos_policy, ig-
nore_missing=True)
Delete a minimum bandwidth rule

Parameters
• qos_rule The value can be either the ID of a minimum bandwidth rule
or a QoSMinimumBandwidthRule instance.
will be raised when the resource does not exist. When set to True, no ex-
ception will be set when attempting to delete a nonexistent minimum band-
width rule.
Returns None
find_qos_minimum_bandwidth_rule(qos_rule_id, qos_policy, ig-
nore_missing=True, **args)
Find a minimum bandwidth rule
Parameters
• qos_rule_id The ID of a minimum bandwidth rule.
Returns One QoSMinimumBandwidthRule or None
get_qos_minimum_bandwidth_rule(qos_rule, qos_policy)
Get a single minimum bandwidth rule
Parameters
QoSMinimumBandwidthRule instance.
Returns One QoSMinimumBandwidthRule
qos_minimum_bandwidth_rules(qos_policy, **query)
Return a generator of minimum bandwidth rules
Parameters
Returns A generator of minimum bandwidth rule objects


update_qos_minimum_bandwidth_rule(qos_rule, qos_policy, **attrs)
Update a minimum bandwidth rule
Parameters
• qos_rule Either the id of a minimum bandwidth rule or a
QoSMinimumBandwidthRule instance.
Attrs kwargs The attributes to update on the minimum bandwidth rule repre-
sented by value.
Returns The updated minimum bandwidth rule
create_qos_policy(**attrs)
Create a new QoS policy from attributes
QoSPolicy, comprised of the properties on the QoSPolicy class.
Returns The results of QoS policy creation
Return type QoSPolicy
delete_qos_policy(qos_policy, ignore_missing=True)
Delete a QoS policy
Parameters
• qos_policy The value can be either the ID of a QoS policy or a
QoSPolicy instance.
will be raised when the QoS policy does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent QoS policy.
Returns None
find_qos_policy(name_or_id, ignore_missing=True, **args)
Find a single QoS policy
Parameters
• name_or_id The name or ID of a QoS policy.
Returns One QoSPolicy or None
get_qos_policy(qos_policy)
Get a single QoS policy

Parameters qos_policy The value can be the ID of a QoS policy or a

QoSPolicy instance.
Returns One QoSPolicy
qos_policies(**query)
Return a generator of QoS policies
• description: The description of a QoS policy.

• is_shared: Whether the policy is shared among projects.
• name: The name of a QoS policy.
• project_id: The ID of the project who owns the network.
Returns A generator of QoS policy objects

update_qos_policy(qos_policy, **attrs)
Update a QoS policy
Parameters qos_policy Either the id of a QoS policy or a QoSPolicy in-
stance.
Attrs kwargs The attributes to update on the QoS policy represented by value.
Returns The updated QoS policy
find_qos_rule_type(rule_type_name, ignore_missing=True)
Find a single QoS rule type details
Parameters
• rule_type_name The name of a QoS rule type.
Returns One QoSRuleType or None
get_qos_rule_type(qos_rule_type)
Get details about single QoS rule type
Parameters qos_rule_type The value can be the name of a QoS policy rule
type or a QoSRuleType instance.
Returns One QoSRuleType

qos_rule_types(**query)
Return a generator of QoS rule types
Optional query parameters to be sent to limit the resources returned.
Valid parameters include:
• type: The type of the QoS rule type.
Returns A generator of QoS rule type objects

Return type QoSRuleType
Agent Operations

**kwargs)
agents(**query)
Return a generator of network agents
Optional query parameters to be sent to limit the resources being re-
turned.
• agent_type: Agent type.

• availability_zone: The availability zone for an agent.
• binary: The name of the agents application binary.
• description: The description of the agent.
• host: The host (host name or host address) the agent is running on.
• topic: The message queue topic used.
• is_admin_state_up: The administrative state of the agent.
• is_alive: Whether the agent is alive.
Returns A generator of agents

Return type Agent
delete_agent(agent, ignore_missing=True)
Delete a network agent
Parameters
• agent The value can be the ID of a agent or a Agent instance.


will be raised when the agent does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent agent.
Returns None
get_agent(agent)
Get a single network agent
Parameters agent The value can be the ID of a agent or a Agent instance.
Returns One Agent
Return type Agent
update_agent(agent, **attrs)
Update a network agent
Parameters
• agent The value can be the ID of a agent or a Agent instance.
• attrs (dict) The attributes to update on the agent represented by
value.
Returns One Agent
Return type Agent
network_hosting_dhcp_agents(network, **query)
A generator of DHCP agents hosted on a network.
Parameters
• network The instance of Network
returned.
Returns A generator of hosted DHCP agents
routers_hosting_l3_agents(router, **query)
Return a generator of L3 agent hosting a router
Parameters
• router Either the router id or an instance of Router
sources returned
Returns A generator of Router L3 Agents
Return type RouterL3Agents
agent_hosted_routers(agent, **query)
Return a generator of routers hosted by a L3 agent
Parameters


sources returned
Returns A generator of routers
Return type L3AgentRouters
add_router_to_agent(agent, router)
Add router to L3 agent
Parameters
• agent Either the id of an agent Agent instance
• router A router instance
Returns Agent with attached router
Return type Agent
remove_router_from_agent(agent, router)
Remove router from L3 agent
Parameters
• agent Either the id of an agent or an Agent instance
• router A router instance
Returns Agent with removed router
Return type Agent
RBAC Operations

**kwargs)
create_rbac_policy(**attrs)
Create a new RBAC policy from attributes
RBACPolicy, comprised of the properties on the RBACPolicy class.
Returns The results of RBAC policy creation
Return type RBACPolicy
delete_rbac_policy(rbac_policy, ignore_missing=True)
Delete a RBAC policy
Parameters
• rbac_policy The value can be either the ID of a RBAC policy or a
RBACPolicy instance.


will be raised when the RBAC policy does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent RBAC policy.
Returns None
find_rbac_policy(rbac_policy, ignore_missing=True, **args)
Find a single RBAC policy
Parameters
• rbac_policy The ID of a RBAC policy.
Returns One RBACPolicy or None
get_rbac_policy(rbac_policy)
Get a single RBAC policy
Parameters rbac_policy The value can be the ID of a RBAC policy or a
RBACPolicy instance.
Returns One RBACPolicy
rbac_policies(**query)
Return a generator of RBAC policies
Available parameters include:
• action: RBAC policy action

• object_type: Type of the object that the RBAC policy affects
• target_project_id: ID of the tenant that the RBAC policy affects
Returns A generator of rbac objects

update_rbac_policy(rbac_policy, **attrs)
Update a RBAC policy
Parameters
• rbac_policy Either the id of a RBAC policy or a RBACPolicy in-
stance.
• attrs (dict) The attributes to update on the RBAC policy represented
by rbac_policy.

Returns The updated RBAC policy

Listener Operations

**kwargs)
create_listener(**attrs)
Create a new listener from attributes
Listener, comprised of the properties on the Listener class.
Returns The results of listener creation
delete_listener(listener, ignore_missing=True)
Delete a listener
Parameters
• listener The value can be either the ID of a listner or a Listener
instance.
will be raised when the listner does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent listener.
Returns None
find_listener(name_or_id, ignore_missing=True, **args)
Find a single listener
Parameters
• name_or_id The name or ID of a listener.
Returns One Listener or None
get_listener(listener)
Get a single listener
instance.

Returns One Listener

listeners(**query)
Return a generator of listeners
• connection_limit: The maximum number of connections

permitted for the load-balancer.
• default_pool_id: The ID of the default pool.
• default_tls_container_ref: A reference to a container of TLS
secret.
• description: The description of a listener.
• is_admin_state_up: The administrative state of the listener.
• name: The name of a listener.
• project_id: The ID of the project associated with a listener.
• protocol: The protocol of the listener.
• protocol_port: Port the listener will listen to.
Returns A generator of listener objects

update_listener(listener, **attrs)
Update a listener
Parameters
• listener Either the id of a listener or a Listener instance.
• attrs (dict) The attributes to update on the listener represented by
listener.
Returns The updated listener
Subnet Operations

**kwargs)

create_subnet(**attrs)
Create a new subnet from attributes
Subnet, comprised of the properties on the Subnet class.
Returns The results of subnet creation
Return type Subnet
delete_subnet(subnet, ignore_missing=True, if_revision=None)
Delete a subnet
Parameters
• subnet The value can be either the ID of a subnet or a Subnet instance.
will be raised when the subnet does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent subnet.
Returns None
find_subnet(name_or_id, ignore_missing=True, **args)
Find a single subnet
Parameters
• name_or_id The name or ID of a subnet.
Returns One Subnet or None
get_subnet(subnet)
Get a single subnet
Parameters subnet The value can be the ID of a subnet or a Subnet instance.
Returns One Subnet
subnets(**query)
Return a generator of subnets
• cidr: Subnet CIDR
• description: The subnet description
• gateway_ip: Subnet gateway IP address
• ip_version: Subnet IP address version

• ipv6_address_mode: The IPv6 address mode

• ipv6_ra_mode: The IPv6 router advertisement mode
• is_dhcp_enabled: Subnet has DHCP enabled (boolean)
• name: Subnet name
• network_id: ID of network that owns the subnets
• subnet_pool_id: The subnet pool ID from which to obtain a
CIDR.
Returns A generator of subnet objects
Return type Subnet
update_subnet(subnet, if_revision=None, **attrs)
Update a subnet
Parameters
• subnet Either the id of a subnet or a Subnet instance.
• attrs (dict) The attributes to update on the subnet represented by
subnet.
Returns The updated subnet
Return type Subnet
create_subnet_pool(**attrs)
Create a new subnet pool from attributes
SubnetPool, comprised of the properties on the SubnetPool class.
Returns The results of subnet pool creation
Return type SubnetPool
delete_subnet_pool(subnet_pool, ignore_missing=True)
Delete a subnet pool
Parameters
• subnet_pool The value can be either the ID of a subnet pool or a
SubnetPool instance.
will be raised when the subnet pool does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent subnet pool.
Returns None
find_subnet_pool(name_or_id, ignore_missing=True, **args)
Find a single subnet pool
Parameters

• name_or_id The name or ID of a subnet pool.

Returns One SubnetPool or None
get_subnet_pool(subnet_pool)
Get a single subnet pool
Parameters subnet_pool The value can be the ID of a subnet pool or a
SubnetPool instance.
Returns One SubnetPool
subnet_pools(**query)
Return a generator of subnet pools
• address_scope_id: Subnet pool address scope ID
• description: The subnet pool description
• ip_version: The IP address family
• is_default: Subnet pool is the default (boolean)
• is_shared: Subnet pool is shared (boolean)
• name: Subnet pool name
Returns A generator of subnet pool objects
update_subnet_pool(subnet_pool, **attrs)
Update a subnet pool
Parameters
• subnet_pool Either the ID of a subnet pool or a SubnetPool instance.
• attrs (dict) The attributes to update on the subnet pool represented by
subnet_pool.
Returns The updated subnet pool

Load Balancer Operations

**kwargs)
create_load_balancer(**attrs)
Create a new load balancer from attributes
LoadBalancer, comprised of the properties on the LoadBalancer class.
Returns The results of load balancer creation
delete_load_balancer(load_balancer, ignore_missing=True)
Delete a load balancer
Parameters
• load_balancer The value can be the ID of a load balancer or a
Returns None
find_load_balancer(name_or_id, ignore_missing=True, **args)
Find a single load balancer
Parameters
• name_or_id The name or ID of a load balancer.
Returns One LoadBalancer or None
get_load_balancer(load_balancer)
Get a single load balancer
Parameters load_balancer The value can be the ID of a load balancer or a
Returns One LoadBalancer

load_balancers(**query)
Return a generator of load balancers
Returns A generator of load balancer objects
update_load_balancer(load_balancer, **attrs)
Update a load balancer
Parameters
• load_balancer Either the id of a load balancer or a LoadBalancer
instance.
• attrs (dict) The attributes to update on the load balancer represented
by load_balancer.
Returns The updated load balancer
Health Monitor Operations

**kwargs)
create_health_monitor(**attrs)
Create a new health monitor from attributes
HealthMonitor, comprised of the properties on the HealthMonitor class.
Returns The results of health monitor creation
delete_health_monitor(health_monitor, ignore_missing=True)
Delete a health monitor
Parameters
• health_monitor The value can be either the ID of a health monitor or
a HealthMonitor instance.
will be raised when the health monitor does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent health monitor.
Returns None

find_health_monitor(name_or_id, ignore_missing=True, **args)

Find a single health monitor
Parameters
• name_or_id The name or ID of a health monitor.
Returns One HealthMonitor or None
get_health_monitor(health_monitor)
Get a single health monitor
Parameters health_monitor The value can be the ID of a health monitor or
a HealthMonitor instance.
Returns One HealthMonitor
health_monitors(**query)
Return a generator of health monitors
• delay: the time in milliseconds between sending probes.

• expected_codes: The expected HTTP codes for a pssing HTTP(S)
monitor.
• http_method: The HTTP method a monitor uses for requests.
• is_admin_state_up: The administrative state of a health monitor.
• max_retries: The maximum consecutive health probe attempts.
• project_id: The ID of the project this health monitor is associated
with.
• timeout: The maximum number of milliseconds for a monitor to
wait for a connection to be established before it times out.
• type: The type of probe sent by the load balancer for health check,
which can be PING, TCP, HTTP or HTTPS.
• url_path: The path portion of a URI that will be probed.
Returns A generator of health monitor objects

update_health_monitor(health_monitor, **attrs)
Update a health monitor

Parameters
• health_monitor Either the id of a health monitor or a
HealthMonitor instance.
• attrs (dict) The attributes to update on the health monitor represented
by value.
Returns The updated health monitor
Metering Label Operations

**kwargs)
create_metering_label(**attrs)
Create a new metering label from attributes
MeteringLabel, comprised of the properties on the MeteringLabel class.
Returns The results of metering label creation
Return type MeteringLabel
delete_metering_label(metering_label, ignore_missing=True)
Delete a metering label
Parameters
• metering_label The value can be either the ID of a metering label or
a MeteringLabel instance.
will be raised when the metering label does not exist. When set to True,
no exception will be set when attempting to delete a nonexistent metering
label.
Returns None
find_metering_label(name_or_id, ignore_missing=True, **args)
Find a single metering label
Parameters
• name_or_id The name or ID of a metering label.


Returns One MeteringLabel or None
get_metering_label(metering_label)
Get a single metering label
Parameters metering_label The value can be the ID of a metering label or
a MeteringLabel instance.
Returns One MeteringLabel
metering_labels(**query)
Return a generator of metering labels
• description: Description of a metering label.

• name: Name of a metering label.
• is_shared: Boolean indicating whether a metering label is shared.
• project_id: The ID of the project a metering label is associated
with.
Returns A generator of metering label objects

update_metering_label(metering_label, **attrs)
Update a metering label
Parameters
• metering_label Either the id of a metering label or a
MeteringLabel instance.
• attrs (dict) The attributes to update on the metering label represented
by metering_label.
Returns The updated metering label
create_metering_label_rule(**attrs)
Create a new metering label rule from attributes
MeteringLabelRule, comprised of the properties on the MeteringLabel-
Rule class.
Returns The results of metering label rule creation
Return type MeteringLabelRule

delete_metering_label_rule(metering_label_rule, ignore_missing=True)
Delete a metering label rule
Parameters
• metering_label_rule The value can be either the ID of a metering
label rule or a MeteringLabelRule instance.
will be raised when the metering label rule does not exist. When set to
True, no exception will be set when attempting to delete a nonexistent me-
tering label rule.
Returns None
find_metering_label_rule(name_or_id, ignore_missing=True, **args)
Find a single metering label rule
Parameters
• name_or_id The name or ID of a metering label rule.
Returns One MeteringLabelRule or None
get_metering_label_rule(metering_label_rule)
Get a single metering label rule
Parameters metering_label_rule The value can be the ID of a metering
label rule or a MeteringLabelRule instance.
Returns One MeteringLabelRule
metering_label_rules(**query)
Return a generator of metering label rules
• direction: The direction in which metering label rule is applied.

• metering_label_id: The ID of a metering label this rule is
associated with.
• project_id: The ID of the project the metering label rule is
associated with.
• remote_ip_prefix: The remote IP prefix to be associated with this
metering label rule.
Returns A generator of metering label rule objects


update_metering_label_rule(metering_label_rule, **attrs)
Update a metering label rule
Parameters
• metering_label_rule Either the id of a metering label rule or a
MeteringLabelRule instance.
• attrs (dict) The attributes to update on the metering label rule repre-
sented by metering_label_rule.
Returns The updated metering label rule
Segment Operations

**kwargs)
create_segment(**attrs)
Create a new segment from attributes
Segment, comprised of the properties on the Segment class.
Returns The results of segment creation
Return type Segment
delete_segment(segment, ignore_missing=True)
Delete a segment
Parameters
• segment The value can be either the ID of a segment or a Segment
instance.
will be raised when the segment does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent segment.
Returns None
find_segment(name_or_id, ignore_missing=True, **args)
Find a single segment
Parameters
• name_or_id The name or ID of a segment.


Returns One Segment or None
get_segment(segment)
Get a single segment
Parameters segment The value can be the ID of a segment or a Segment
instance.
Returns One Segment
segments(**query)
Return a generator of segments
• description: The segment description
• name: Name of the segments
• network_id: ID of the network that owns the segments
• network_type: Network type for the segments
• physical_network: Physical network name for the segments
• segmentation_id: Segmentation ID for the segments
Returns A generator of segment objects
Return type Segment
update_segment(segment, **attrs)
Update a segment
Parameters segment Either the id of a segment or a Segment instance.
Attrs kwargs The attributes to update on the segment represented by value.
Returns The update segment
Return type Segment

Flavor Operations

**kwargs)
Create a new network service flavor from attributes
Flavor, comprised of the properties on the Flavor class.
Returns The results of flavor creation
Return type Flavor
Delete a network service flavor
Parameters
• flavor The value can be either the ID of a flavor or a Flavor instance.
Returns None
find_flavor(name_or_id, ignore_missing=True, **args)
Find a single network service flavor
Parameters
get_flavor(flavor)
Get a single network service flavor
Parameters flavor The value can be the ID of a flavor or a Flavor instance.
Returns One Flavor
update_flavor(flavor, **attrs)
Update a network service 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
flavors(**query)
Return a generator of network service flavors
Valid parameters include:
• description: The description of a flavor.

• is_enabled: Whether a flavor is enabled.
• name: The name of a flavor.
• service_type: The service type to which a falvor applies.

Return type Flavor
Service Profile Operations

**kwargs)
associate_flavor_with_service_profile(flavor, service_profile)
Associate network flavor with service profile.
Parameters
• flavor Either the id of a flavor or a Flavor instance.
• service_profile The value can be either the ID of a service profile or
a ServiceProfile instance.
Returns
disassociate_flavor_from_service_profile(flavor, service_profile)
Disassociate network flavor from service profile.
Parameters
• flavor Either the id of a flavor or a Flavor instance.

Returns
create_service_profile(**attrs)
Create a new network service flavor profile from attributes
ServiceProfile, comprised of the properties on the ServiceProfile class.
Returns The results of service profile creation
Return type ServiceProfile
delete_service_profile(service_profile, ignore_missing=True)
Delete a network service flavor profile
Parameters
will be raised when the service profile does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent service profile.
Returns None
find_service_profile(name_or_id, ignore_missing=True, **args)
Find a single network service flavor profile
Parameters
• name_or_id The name or ID of a service profile.
Returns One ServiceProfile or None
get_service_profile(service_profile)
Get a single network service flavor profile
Parameters service_profile The value can be the ID of a service_profile
or a ServiceProfile instance.
Returns One ServiceProfile
service_profiles(**query)
Return a generator of network service flavor profiles
Optional query parameters to be sent to limit the resources returned.
Available parameters inclue:
• description: The description of the service flavor profile

• driver: Provider driver for the service flavor profile

• is_enabled: Whether the profile is enabled

• project_id: The owner project ID
Returns A generator of service profile objects

update_service_profile(service_profile, **attrs)
Update a network flavor service profile
Parameters service_profile Either the id of a service profile or a
ServiceProfile instance.
Attrs kwargs The attributes to update on the service profile represented by
value.
Returns The updated service profile
Tag Operations

**kwargs)
set_tags(resource, tags)
Replace tags of a specified resource with specified tags
Parameters
• resource Resource instance.
• tags ("list") New tags to be set.
Returns The updated resource
Return type Resource
VPN Operations

**kwargs)
create_vpn_service(**attrs)
Create a new vpn service from attributes


VPNService, comprised of the properties on the VPNService class.
Returns The results of vpn service creation
Return type VPNService
delete_vpn_service(vpn_service, ignore_missing=True)
Delete a vpn service
Parameters
• vpn_service The value can be either the ID of a vpn service or a
VPNService instance.
will be raised when the vpn service does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent vpn service.
Returns None
find_vpn_service(name_or_id, ignore_missing=True, **args)
Find a single vpn service
Parameters
• name_or_id The name or ID of a vpn service.
Returns One VPNService or None
get_vpn_service(vpn_service)
Get a single vpn service
Parameters vpn_service The value can be the ID of a vpn service or a
VPNService instance.
Returns One VPNService
vpn_services(**query)
Return a generator of vpn services
Returns A generator of vpn service objects
update_vpn_service(vpn_service, **attrs)
Update a vpn service
Parameters
• vpn_service Either the id of a vpn service or a VPNService instance.

• attrs (dict) The attributes to update on the VPN service represented by

vpn_service.
Returns The updated vpnservice

**kwargs)
find_extension(name_or_id, ignore_missing=True, **args)

Find a single extension
Parameters
• name_or_id The name or ID of a extension.
extensions(**query)
Return a generator of extensions
resources being returned. Currently no parameter is supported.
Returns A generator of extension objects
Service Provider Operations

**kwargs)
service_providers(**query)
Return a generator of service providers


Returns A generator of service provider objects
Return type ServiceProvider
Object Store API
For details on how to use this API, see Using OpenStack Object Store
The Object Store Class
The Object Store high-level interface is exposed as the object_store object on Connection ob-
jects.
Account Operations
class openstack.object_store.v1._proxy.Proxy(session, statsd_client=None,

**kwargs)
get_account_metadata()
Get metadata for this account.
Return type Account
set_account_metadata(**metadata)
Set metadata for this account.
Parameters metadata (kwargs) Key/value pairs to be set as metadata on the
container. Custom metadata can be set. Custom metadata are keys and values
defined by the user.
delete_account_metadata(keys)
Delete metadata for this account.
Parameters keys The keys of metadata to be deleted.

Container Operations

**kwargs)
containers(**query)
Obtain Container objects for this account.
Return type A generator of Container objects.
create_container(name, **attrs)
Create a new container from attributes
Parameters
• container Name of the container to create.
Container, comprised of the properties on the Container class.
Returns The results of container creation
delete_container(container, ignore_missing=True)
Delete a container
Parameters
• container The value can be either the name of a container or a
Container instance.
will be raised when the container does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent server.
Returns None
get_container_metadata(container)
Get metadata for a container
Parameters container The value can be the name of a container or a
Container instance.
Returns One Container
set_container_metadata(container, refresh=True, **metadata)
Set metadata for a container.
Parameters

• container The value can be the name of a container or a Container

instance.
• refresh Flag to trigger refresh of container object re-fetch.
• metadata (kwargs) Key/value pairs to be set as metadata on the con-
tainer. Both custom and system metadata can be set. Custom metadata are
keys and values defined by the user. System metadata are keys defined by
the Object Store and values defined by the user. The system metadata keys
are:
– content_type
– is_content_type_detected
– versions_location
– read_ACL
– write_ACL
– sync_to
– sync_key
delete_container_metadata(container, keys)
Delete metadata for a container.
Parameters
• container The value can be the ID of a container or a Container
instance.
• keys The keys of metadata to be deleted.
Object Operations

**kwargs)
objects(container, **query)
Return a generator that yields the Containers objects.
Parameters
• container (Container) A container object or the name of a container
that you want to retrieve objects from.
Return type A generator of Object objects.
get_object(obj, container=None)
Get the data associated with an object

Parameters
• obj The value can be the name of an object or a Object instance.
instance.
Returns The contents of the object. Use the get_object_metadata()
method if you want an object resource.
download_object(obj, container=None, **attrs)
Download the data contained inside an object.
Parameters
instance.
upload_object(container, name, filename=None, md5=None, sha256=None,
segment_size=None, use_slo=True, metadata=None, gener-
ate_checksums=None, data=None, **headers)
Create a file object.
Automatically uses large-object segments if needed.
Parameters
• container The name of the container to store the file in. This container
will be created if it does not exist already.
• filename The path to the local file whose contents will be uploaded.
Mutually exclusive with data.
• data The content to upload to the object. Mutually exclusive with file-
name.
• md5 A hexadecimal md5 of the file. (Optional), if it is known and can be
passed here, it will save repeating the expensive md5 process. It is assumed
to be accurate.
• sha256 A hexadecimal sha256 of the file. (Optional) See md5.
• segment_size Break the uploaded object into segments of this many
bytes. (Optional) SDK will attempt to discover the maximum value for this
from the server if it is not specified, or will use a reasonable default.
Headers.
• use_slo If the object is large enough to need to be a Large Object, use a
static rather than dynamic object. Static Objects will delete segment objects
when the manifest object is deleted. (optional, defaults to True)

• generate_checksums Whether to generate checksums on the client

side that get added to headers for later prevention of double uploads of iden-
tical data. (optional, defaults to True)
object
copy_object()
Copy an object.
delete_object(obj, ignore_missing=True, container=None)
Delete an object
Parameters
• obj The value can be either the name of an object or a Container in-
stance.
instance.
will be raised when the object does not exist. When set to True, no excep-
tion will be set when attempting to delete a nonexistent server.
Returns None
get_object_metadata(obj, container=None)
Get metadata for an object.
Parameters
instance.
Returns One Object
set_object_metadata(obj, container=None, **metadata)
Set metadata for an object.
Note: This method will do an extra HEAD call.
Parameters
instance.
• metadata (kwargs) Key/value pairs to be set as metadata on the con-
tainer. Both custom and system metadata can be set. Custom metadata are
keys and values defined by the user. System metadata are keys defined by
the Object Store and values defined by the user. The system metadata keys
are:
– content_type

– content_encoding
– content_disposition
– delete_after
– delete_at
– is_content_type_detected
delete_object_metadata(obj, container=None, keys=None)
Delete metadata for an object.
Parameters
instance.
• keys The keys of metadata to be deleted.
Orchestration API
For details on how to use orchestration, see Using OpenStack Orchestration
The Orchestration Class
The orchestration high-level interface is available through the orchestration member of a

Connection object. The orchestration member will only be added if the service is detected.
Stack Operations
class openstack.orchestration.v1._proxy.Proxy(session,
statsd_client=None,
**kwargs)
create_stack(preview=False, **attrs)
Create a new stack from attributes
Parameters
• preview (bool) When True, a preview endpoint will be used to verify
the template Default: “False“
• attrs (dict) Keyword arguments which will be used to create a Stack,
comprised of the properties on the Stack class.
Returns The results of stack creation
Return type Stack

find_stack(name_or_id, ignore_missing=True, resolve_outputs=True)

Find a single stack
Parameters
• name_or_id The name or ID of a stack.
Returns One Stack or None
stacks(**query)
Return a generator of stacks
Returns A generator of stack objects
Return type Stack
get_stack(stack, resolve_outputs=True)
Get a single stack
Parameters
• stack The value can be the ID of a stack or a Stack instance.
• resolve_outputs Whether stack should contain outputs resolved.
Returns One Stack
update_stack(stack, preview=False, **attrs)
Update a stack
Parameters
• stack The value can be the ID of a stack or a Stack instance.
• attrs (kwargs) The attributes to update on the stack represented by
value.
Returns The updated stack
Return type Stack
delete_stack(stack, ignore_missing=True)
Delete a stack
Parameters
• stack The value can be either the ID of a stack or a Stack instance.
will be raised when the stack does not exist. When set to True, no exception
will be set when attempting to delete a nonexistent stack.
Returns None

check_stack(stack)
Check a stacks status
Since this is an asynchronous action, the only way to check the result is to track the stacks
status.
Parameters stack The value can be either the ID of a stack or an instance of
Stack.
Returns None
get_stack_template(stack)
Get template used by a stack
Parameters stack The value can be the ID of a stack or an instance of Stack
Returns One object of StackTemplate
get_stack_environment(stack)
Get environment used by a stack
Returns One object of StackEnvironment
get_stack_files(stack)
Get files used by a stack
Returns A dictionary containing the names and contents of all files used by the
stack.
Raises ResourceNotFound when the stack cannot be found.
resources(stack, **query)
Return a generator of resources
Parameters
• stack This can be a stack object, or the name of a stack for which the
resources are to be listed.
Returns A generator of resource objects if the stack exists and there are resources
in it. If the stack cannot be found, an exception is thrown.
Return type A generator of Resource
Raises ResourceNotFound when the stack cannot be found.
validate_template(template, environment=None, template_url=None, ig-
nore_errors=None)
Validates a template.
Parameters
• template The stack template on which the validation is performed.

• environment A JSON environment for the stack, if provided.

• template_url A URI to the location containing the stack template for
validation. This parameter is only required if the template parameter is
None. This parameter is ignored if template is specified.
• ignore_errors A string containing comma separated error codes to
ignore. Currently the only valid error code is 99001.
Returns The result of template validation.
Raises InvalidRequest if neither template not template_url is provided.
Raises HttpException if the template fails the validation.
Software Configuration Operations
statsd_client=None,
**kwargs)
create_software_config(**attrs)
Create a new software config from attributes
SoftwareConfig, comprised of the properties on the SoftwareConfig class.
Returns The results of software config creation
Return type SoftwareConfig
software_configs(**query)
Returns a generator of software configs
software configs returned.
Returns A generator of software config objects.
Return type SoftwareConfig
get_software_config(software_config)
Get details about a specific software config.
Parameters software_config The value can be the ID of a software config
or a instace of SoftwareConfig,
Returns An object of type SoftwareConfig
delete_software_config(software_config, ignore_missing=True)
Delete a software config
Parameters

• software_config The value can be either the ID of a software config

or an instance of SoftwareConfig
will be raised when the software config does not exist. When set to True,
no exception will be set when attempting to delete a nonexistent software
config.
Returns None
Software Deployment Operations
statsd_client=None,
**kwargs)
create_software_deployment(**attrs)
Create a new software deployment from attributes
a SoftwareDeployment, comprised of the properties on the SoftwareDe-
ployment class.
Returns The results of software deployment creation
Return type SoftwareDeployment
software_deployments(**query)
Returns a generator of software deployments
software deployments returned.
Returns A generator of software deployment objects.
get_software_deployment(software_deployment)
Get details about a specific software deployment resource
Parameters software_deployment The value can be the ID of a software
deployment or an instace of SoftwareDeployment,
Returns An object of type SoftwareDeployment
delete_software_deployment(software_deployment, ignore_missing=True)
Delete a software deployment
Parameters
• software_deployment The value can be either the ID of a software
deployment or an instance of SoftwareDeployment


will be raised when the software deployment does not exist. When set to
True, no exception will be set when attempting to delete a nonexistent soft-
ware deployment.
Returns None
update_software_deployment(software_deployment, **attrs)
Update a software deployment
Parameters
• server Either the ID of a software deployment or an instance of
SoftwareDeployment
• attrs (dict) The attributes to update on the software deployment repre-
sented by software_deployment.
Returns The updated software deployment
Workflow API
The Workflow Class
The workflow high-level interface is available through the workflow member of a Connection
object. The workflow member will only be added if the service is detected.
Workflow Operations
class openstack.workflow.v2._proxy.Proxy(session, statsd_client=None,

**kwargs)
create_workflow(**attrs)
Create a new workflow from attributes
Workflow, comprised of the properties on the Workflow class.
Returns The results of workflow creation
Return type Workflow
get_workflow(*attrs)
Get a workflow
Parameters workflow The value can be the name of a workflow or Workflow
instance.
Returns One Workflow

Raises ResourceNotFound when no workflow matching the name could be

found.
workflows(**query)
Retrieve a generator of workflows
the workflows to be returned. Available parameters include:
the query.
• marker: Specifies the ID of the last-seen workflow. Use the limit pa-
rameter to make an initial limited request and use the ID of the
last-seen workflow from the response as the marker parameter value in a
Returns A generator of workflow instances.
delete_workflow(value, ignore_missing=True)
Delete a workflow
Parameters
• value The value can be either the name of a workflow or a Workflow
instance.
will be raised when the workflow does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent workflow.
Returns None
find_workflow(name_or_id, ignore_missing=True)
Find a single workflow
Parameters
• name_or_id The name or ID of an workflow.
Execution Operations
class openstack.workflow.v2._proxy.Proxy(session, statsd_client=None,

**kwargs)
create_execution(**attrs)
Create a new execution from attributes

Parameters
• workflow_name The name of target workflow to execute.
Execution, comprised of the properties on the Execution class.
Returns The results of execution creation
Return type Execution
get_execution(*attrs)
Get a execution
Parameters
• workflow_name The name of target workflow to execute.
• execution The value can be either the ID of a execution or a
Execution instance.
Returns One Execution
Raises ResourceNotFound when no execution matching the criteria could be
found.
executions(**query)
Retrieve a generator of executions
the executions to be returned. Available parameters include:
the query.
• marker: Specifies the ID of the last-seen execution. Use the limit pa-
rameter to make an initial limited request and use the ID of the
last-seen execution from the response as the marker parameter value in a
Returns A generator of execution instances.
delete_execution(value, ignore_missing=True)
Delete an execution
Parameters
• value The value can be either the name of a execution or a Execution
instance.
will be raised when the execution does not exist. When set to True, no
exception will be set when attempting to delete a nonexistent execution.
Returns None
find_execution(name_or_id, ignore_missing=True)
Find a single execution
Parameters
• name_or_id The name or ID of an execution.


Returns One Execution or None
Resource Interface
The Resource layer is a lower-level interface to communicate with OpenStack services. While the classes
exposed by the Connection build a convenience layer on top of this, Resources can be used directly.
However, the most common usage of this layer is in receiving an object from a class in the Connection
layer, modifying it, and sending it back into the Connection layer, such as to update a resource on the
server.
The following services have exposed Resource classes.
Accelerator v2 Resources
openstack.accelerator.v2.device
The Device Class
The Device class inherits from Resource.

class openstack.accelerator.v2.device.Device(_synchronized=False, con-
nection=None, **attrs)
The base resource
Parameters
• _synchronized (bool) This is not intended to be used directly. See
new() and existing().
• 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.
created_at
The timestamp when this device was created.
hostname
The hostname of the device.
id
The ID of the device.
model
The model of the device.
std_board_info
The std board information of the device.
type
The type of the device.

updated_at
The timestamp when this device was updated.
uuid
The UUID of the device.
vendor
The vendor ID of the device.
vendor_board_info
The vendor board information of the device.
openstack.accelerator.v2.deployable
The Deployable Class
The Deployable class inherits from Resource.

class openstack.accelerator.v2.deployable.Deployable(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
created_at
The timestamp when this deployable was created.
device_id
The device_id of the deployable.
id
The UUID of the deployable.
name
The name of the deployable.
num_accelerators
The num_accelerator of the deployable.
parent_id
The parent_id of the deployable.
root_id
The root_id of the deployable.
updated_at
The timestamp when this deployable was updated.

openstack.accelerator.v2.device_profile
The DeviceProfile Class
The DeviceProfile class inherits from Resource.

class openstack.accelerator.v2.device_profile.DeviceProfile(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
created_at
The timestamp when this device_profile was created.
groups
The groups of the device profile
name
The name of the device profile
updated_at
The timestamp when this device_profile was updated.
uuid
The uuid of the device profile
create(session, base_path=None)
Create a remote resource based on this instance.
Parameters
• session (Adapter) The session to use for making this request.
• prepend_key A boolean indicating whether the resource_key should be
prepended in a resource creation request. Default to True.
• base_path (str) Base part of the URI for creating resources, if different
from base_path.
• params (dict) Additional params to pass.
Returns This Resource instance.
Raises MethodNotSupported if Resource.allow_create is not set to
True.

openstack.accelerator.v2.accelerator_request
The AcceleratorRequest Class
The AcceleratorRequest class inherits from Resource.

class openstack.accelerator.v2.accelerator_request.AcceleratorRequest(_synchronized=
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
allow_patch = True
Allow patch operation for binding.
attach_handle_info
The device address associated with this ARQ (if any)
attach_handle_type
The type of attach handle (e.g. PCI, mdev)
device_profile_name
The name of the device profile
device_profile_group_id
The id of the device profile group
device_rp_uuid
The UUID of the bound device RP (if any)
hostname
The host name to which ARQ is bound. (if any)
instance_uuid
The UUID of the instance associated with this ARQ (if any)
state
The state of the ARQ
uuid
The UUID of the ARQ
patch(session, patch=None, prepend_key=True, has_body=True,
retry_on_conflict=None, base_path=None)
Patch the remote resource.

Allows modifying the resource by providing a list of JSON patches to apply to it. The
patches can use both the original (server-side) and SDK field names.
Parameters
• patch Additional JSON patch as a list or one patch item. If provided, it is
applied on top of any changes to the current resource.
prepended in a resource update request. Default to True.
• retry_on_conflict (bool) Whether to enable retries on HTTP
CONFLICT (409). Value of None leaves the Adapter defaults.
• base_path (str) Base part of the URI for modifying resources, if dif-
ferent from base_path.
Raises MethodNotSupported if Resource.allow_patch is not set to
True.
Parameters
from base_path.
True.
Baremetal Resources
openstack.baremetal.v1.driver
The Driver Class
The Driver class inherits from Resource.

class openstack.baremetal.v1.driver.Driver(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters


hosts
A list of active hosts that support this driver.
links
A list of relative links, including the self and bookmark links.
name
The name of the driver
properties
A list of links to driver properties.
default_bios_interface
Default BIOS interface implementation. Introduced in API microversion 1.40.
default_boot_interface
Default boot interface implementation. Introduced in API microversion 1.30.
default_console_interface
Default console interface implementation. Introduced in API microversion 1.30.
default_deploy_interface
Default deploy interface implementation. Introduced in API microversion 1.30.
default_inspect_interface
Default inspect interface implementation. Introduced in API microversion 1.30.
default_management_interface
Default management interface implementation. Introduced in API microversion 1.30.
default_network_interface
Default network interface implementation. Introduced in API microversion 1.30.
default_power_interface
Default port interface implementation. Introduced in API microversion 1.30.
default_raid_interface
Default RAID interface implementation. Introduced in API microversion 1.30.
default_rescue_interface
Default rescue interface implementation. Introduced in API microversion 1.38.
default_storage_interface
Default storage interface implementation. Introduced in API microversion 1.33.
default_vendor_interface
Default vendor interface implementation. Introduced in API microversion 1.30.
enabled_bios_interfaces
Enabled BIOS interface implementations. Introduced in API microversion 1.40.
enabled_boot_interfaces
Enabled boot interface implementations. Introduced in API microversion 1.30.

enabled_console_interfaces
Enabled console interface implementations. Introduced in API microversion 1.30.
enabled_deploy_interfaces
Enabled deploy interface implementations. Introduced in API microversion 1.30.
enabled_inspect_interfaces
Enabled inspect interface implementations. Introduced in API microversion 1.30.
enabled_management_interfaces
Enabled management interface implementations. Introduced in API microversion 1.30.
enabled_network_interfaces
Enabled network interface implementations. Introduced in API microversion 1.30.
enabled_power_interfaces
Enabled port interface implementations. Introduced in API microversion 1.30.
enabled_raid_interfaces
Enabled RAID interface implementations. Introduced in API microversion 1.30.
enabled_rescue_interfaces
Enabled rescue interface implementations. Introduced in API microversion 1.38.
enabled_storage_interfaces
Enabled storage interface implementations. Introduced in API microversion 1.33.
enabled_vendor_interfaces
Enabled vendor interface implementations. Introduced in API microversion 1.30.
openstack.baremetal.v1.chassis
The Chassis Class
The Chassis class inherits from Resource.

class openstack.baremetal.v1.chassis.Chassis(_synchronized=False, con-
The base resource
Parameters
created_at
Timestamp at which the chassis was created.
description
A descriptive text about the service
extra
A set of one or more arbitrary metadata key and value pairs.

id
The UUID for the chassis
links
nodes
Links to the collection of nodes contained in the chassis
updated_at
Timestamp at which the chassis was last updated.
openstack.baremetal.v1.Node
The Node Class
The Node class inherits from Resource.

class openstack.baremetal.v1.node.Node(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
allocation_id
The UUID of the allocation associated with this node. Added in API microversion 1.52.
owner
A string or UUID of the tenant who owns the baremetal node. Added in API microversion
1.50.
chassis_id
The UUID of the chassis associated wit this node. Can be empty or None.
clean_step
The current clean step.
conductor_group
Conductor group this node is managed by. Added in API microversion 1.46.
created_at
Timestamp at which the node was last updated.
deploy_step
The current deploy step. Added in API microversion 1.44.
driver
The name of the driver.

driver_info
All the metadata required by the driver to manage this node. List of fields varies between
drivers, and can be retrieved from the openstack.baremetal.v1.driver.Driver
resource.
driver_internal_info
Internal metadata set and stored by nodes driver. This is read-only.
extra
fault
Fault type that caused the node to enter maintenance mode. Introduced in API microversion
1.42.
id
The UUID of the node resource.
instance_info
Information used to customize the deployed image, e.g. size of root partition, config drive
in the form of base64 encoded string and other metadata.
instance_id
UUID of the nova instance associated with this node.
is_automated_clean_enabled
Override enabling of automated cleaning. Added in API microversion 1.47.
is_console_enabled
Whether console access is enabled on this node.
is_maintenance
Whether node is currently in maintenance mode. Nodes put into maintenance mode are
removed from the available resource pool.
is_retired
Whether the node is marked for retirement. Added in API microversion 1.61.
last_error
Any error from the most recent transaction that started but failed to finish.
links
A list of relative links, including self and bookmark links.
maintenance_reason
user settable description of the reason why the node was placed into maintenance mode.
name
Human readable identifier for the node. May be undefined. Certain words are reserved.
Added in API microversion 1.5
ports
Links to the collection of ports on this node.
port_groups
Links to the collection of portgroups on this node. Available since API microversion 1.24.
power_state
The current power state. Usually power on or power off, but may be None if service is unable
to determine the power state.

properties
Physical characteristics of the node. Content populated by the service during inspection.
provision_state
The current provisioning state of the node.
retired_reason
The reason why the node is marked for retirement. Added in API microversion 1.61.
raid_config
The current RAID configuration of the node.
reservation
The name of an service conductor host which is holding a lock on this node, if a lock is held.
resource_class
A string to be used by external schedulers to identify this node as a unit of a specific type of
resource. Added in API microversion 1.21.
states
Links to the collection of states.
target_provision_state
The requested state if a provisioning action has been requested. For example, AVAILABLE,
DEPLOYING, DEPLOYWAIT, DEPLOYING, ACTIVE etc.
target_power_state
The requested state during a state transition.
target_raid_config
The requested RAID configuration of the node which will be applied when the node next
transitions through the CLEANING state.
traits
Traits of the node. Introduced in API microversion 1.37.
updated_at
Timestamp at which the node was last updated.
bios_interface
BIOS interface to use when setting BIOS properties of the node. Introduced in API mi-
croversion 1.40.
boot_interface
Boot interface to use when configuring boot of the node. Introduced in API microversion
1.31.
console_interface
Console interface to use when working with serial console. Introduced in API microversion
1.31.
deploy_interface
Deploy interface to use when deploying the node. Introduced in API microversion 1.31.
inspect_interface
Inspect interface to use when inspecting the node. Introduced in API microversion 1.31.
management_interface
Management interface to use for management actions on the node. Introduced in API mi-
croversion 1.31.

network_interface
Network interface provider to use when plumbing the network connections for this node.
Introduced in API microversion 1.20.
power_interface
Power interface to use for power actions on the node. Introduced in API microversion 1.31.
raid_interface
RAID interface to use for configuring RAID on the node. Introduced in API microversion
1.31.
rescue_interface
Rescue interface to use for rescuing of the node. Introduced in API microversion 1.38.
storage_interface
Storage interface to use when attaching remote storage. Introduced in API microversion
1.33.
vendor_interface
Vendor interface to use for vendor-specific actions on the node. Introduced in API microver-
sion 1.31.
create(session, *args, **kwargs)
The overridden version is capable of handling the populated provision_state field of
one of three values: enroll, manageable or available. The default is currently
available, since its the only state supported by all API versions.
Note that Bare Metal API 1.4 is required for manageable and 1.11 is required for
enroll.
Parameters session (Adapter) The session to use for making this request.
Raises ValueError if the Nodes provision_state is not one of None,
enroll, manageable or available.
Raises NotSupported if the provision_state cannot be reached with any
API version supported by the server.
commit(session, *args, **kwargs)
Commit the state of the instance to the remote resource.
set_provision_state(session, target, config_drive=None, clean_steps=None, res-
cue_password=None, wait=False, timeout=None)
Run an action modifying this nodes provision state.
edges the request.
Parameters

• target Provisioning action, e.g. active, provide. See the Bare Metal
service documentation for available actions.
• config_drive Config drive to pass to the node, only valid for active`
and ``rebuild targets. You can use functions from openstack.
baremetal.configdrive to build it.
• clean_steps Clean steps to execute, only valid for clean target.
• rescue_password Password for the rescue operation, only valid for
rescue target.
• wait Whether to wait for the target state to be reached.
• timeout Timeout (in seconds) to wait for the target state to be reached. If
None, wait without timeout.
Raises ValueError if config_drive, clean_steps or
rescue_password are provided with an invalid target.
Raises ResourceFailure if the node reaches an error state while waiting for
the state.
Raises ResourceTimeout if timeout is reached while waiting for the state.
wait_for_power_state(session, expected_state, timeout=None)
Wait for the node to reach the expected power state.
Parameters
• expected_state The expected power state to reach.
wait_for_provision_state(session, expected_state, timeout=None,
abort_on_failed_state=True)
Wait for the node to reach the expected state.
Parameters
• expected_state The expected provisioning state to reach.
• abort_on_failed_state If True (the default), abort waiting if the
node reaches a failure state which does not match the expected one. Note
that the failure state for enroll -> manageable transition is enroll
again.


Raises ResourceFailure if the node reaches an error state and
abort_on_failed_state is True.
wait_for_reservation(session, timeout=None)
Wait for a lock on the node to be released.
Bare metal nodes in ironic have a reservation lock that is used to represent that a conductor
has locked the node while performing some sort of action, such as changing configuration
as a result of a machine state change.
This lock can occur during power syncronization, and prevents updates to objects attached
to the node, such as ports.
Note that nothing prevents a conductor from acquiring the lock again after this call returns,
so it should be treated as best effort.
Returns immediately if there is no reservation on the node.
Parameters
• timeout How much (in seconds) to wait for the lock to be released. The
value of None (the default) means no timeout.
set_power_state(session, target, wait=False, timeout=None)
Run an action modifying this nodes power state.
edges the request.
Parameters
• target Target power state, as a PowerAction or a string.
• wait Whether to wait for the expected power state to be reached.
• timeout Timeout (in seconds) to wait for the target state to be reached. If
None, wait without timeout.
attach_vif(session, vif_id, retry_on_conflict=True)
Attach a VIF to the node.
most common case it is a Network service port (NOT a Bare Metal port) ID. A VIF can only
be attached to one node at a time.
Parameters

• retry_on_conflict Whether to retry HTTP CONFLICT errors. This

can happen when either the VIF is already used on a node or the node is
locked. Since the latter happens more often, the default value is True.
Returns None
detach_vif(session, vif_id, ignore_missing=True)
Detach a VIF from the node.
Parameters
will be raised when the VIF does not exist. Otherwise, False is returned.
Returns True if the VIF was detached, otherwise False.
list_vifs(session)
List IDs of VIFs attached to the node.
Returns List of VIF IDs as strings.
validate(session, required=(’boot’, ’deploy’, ’power’))
Validate required information on a node.
Parameters
• required List of interfaces that are required to pass validation. The de-
fault value is the list of minimum required interfaces for provisioning.
Returns dict mapping interface names to ValidationResult objects.
Raises ValidationException if validation fails for a required interface.
set_maintenance(session, reason=None)
Enable maintenance mode on the node.
Parameters
• reason Optional reason for maintenance.

unset_maintenance(session)
Disable maintenance mode on the node.
set_boot_device(session, boot_device, persistent=False)
Set node boot device
Parameters
• session The session to use for making this request.
• boot_device Boot device to assign to the node.
• persistent If the boot device change is maintained after node reboot
add_trait(session, trait)
Add a trait to a node.
Parameters
• trait The trait to add to the node.
remove_trait(session, trait, ignore_missing=True)
Remove a trait from a node.
Parameters
• trait The trait to remove from the node.
will be raised when the trait does not exist. Otherwise, False is returned.
set_traits(session, traits)
Set traits for a node.
Removes any existing traits and adds the traits passed in to this method.
Parameters
• traits list of traits to add to the node.
retry_on_conflict=None, base_path=None, reset_interfaces=None)

Parameters
True.
The PowerAction Class
The PowerAction enumeration represents known power actions.

class openstack.baremetal.v1.node.PowerAction(value)
Mapping from an action to a target power state.
POWER_ON = 'power on'
Power on the node.
POWER_OFF = 'power off'
Power off the node (using hard power off).
REBOOT = 'rebooting'
Reboot the node (using hard power off).
SOFT_POWER_OFF = 'soft power off'
Power off the node using soft power off.
SOFT_REBOOT = 'soft rebooting'
Reboot the node using soft power off.
The ValidationResult Class
The ValidationResult class represents the result of a validation.

class openstack.baremetal.v1.node.ValidationResult(result, reason)
Result of a single interface validation.
Variables
• result Result of a validation, True for success, False for failure, None
for unsupported interface.
• reason If result is False or None, explanation of the result.

The WaitResult Class
The WaitResult class represents the result of waiting for several nodes.
class openstack.baremetal.v1.node.WaitResult(success, failure, timeout)
A named tuple representing a result of waiting for several nodes.
Each component is a list of Node objects:
Variables
• success a list of Node objects that reached the state.
• timeout a list of Node objects that reached timeout.
• failure a list of Node objects that hit a failure.
Create new instance of WaitResult(success, failure, timeout)
openstack.baremetal.v1.port
The Port Class
The Port class inherits from Resource.

class openstack.baremetal.v1.port.Port(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
address
The physical hardware address of the network port, typically the hardware MAC address.
created_at
Timestamp at which the port was created.
extra
id
The UUID of the port
internal_info
Internal metadata set and stored by the port. This field is read-only. Added in API microver-
sion 1.18.
is_pxe_enabled
Whether PXE is enabled on the port. Added in API microversion 1.19.

links
local_link_connection
The port bindig profile. If specified, must contain switch_id and port_id fields.
switch_info field is an optional string field to be used to store vendor specific infor-
mation. Added in API microversion 1.19.
node_id
The UUID of node this port belongs to
physical_network
The name of physical network this port is attached to. Added in API microversion 1.34.
port_group_id
The UUID of PortGroup this port belongs to. Added in API microversion 1.24.
updated_at
Timestamp at which the port was last updated.
openstack.baremetal.v1.port_group
The PortGroup Class
The PortGroup class inherits from Resource.

class openstack.baremetal.v1.port_group.PortGroup(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
address
The physical hardware address of the portgroup, typically the hardware MAC address.
Added in API microversion 1.23.
created_at
Timestamp at which the portgroup was created.
extra
name
The name of the portgroup
id
The UUID for the portgroup

internal_info
Internal metadaa set and stored by the portgroup.
is_standalone_ports_supported
Whether ports that are members of this portgroup can be used as standalone ports. Added in
API microversion 1.23.
links
mode
Port bonding mode. Added in API microversion 1.26.
node_id
UUID of the node this portgroup belongs to.
ports
A list of links to the collection of ports belonging to this portgroup. Added in API microver-
sion 1.24.
properties
Port group properties. Added in API microversion 1.26.
updated_at
Timestamp at which the portgroup was last updated.
openstack.baremetal.v1.Allocation
The Allocation Class
The Allocation class inherits from Resource.

class openstack.baremetal.v1.allocation.Allocation(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
candidate_nodes
The candidate nodes for this allocation.
created_at
Timestamp at which the allocation was created.
extra
id
The UUID for the allocation.

last_error
The last error for the allocation.
links
name
The name of the allocation.
node
The node UUID or name to create the allocation against, bypassing the normal allocation
process.
node_id
UUID of the node this allocation belongs to.
resource_class
The requested resource class.
state
The state of the allocation.
traits
The requested traits.
updated_at
Timestamp at which the allocation was last updated.
wait(session, timeout=None, ignore_error=False)
Wait for the allocation to become active.
Parameters
• timeout How much (in seconds) to wait for the allocation. The value of
None (the default) means no client-side timeout.
• ignore_error If True, this call will raise an exception if the allocation
reaches the error state. Otherwise the error state is considered successful
and the call returns.
Returns This Allocation instance.
Raises ResourceFailure if allocation fails and ignore_error is False.
openstack.baremetal.v1.volume_connector
The VolumeConnector Class
The VolumeConnector class inherits from Resource.

class openstack.baremetal.v1.volume_connector.VolumeConnector(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
created_at
extra
links
node_id
The UUID of node this port belongs to
type
The types of Volume connector
updated_at
id
The UUID of the port
openstack.baremetal.v1.volume_target
The VolumeTarget Class
The VolumeTarget class inherits from Resource.

class openstack.baremetal.v1.volume_target.VolumeTarget(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters


created_at
extra
links
A list of relative links. Includes the self and bookmark links.
node_id
The UUID of the Node this resource belongs to.
properties
A set of physical information of the volume.
updated_at
id
The UUID of the resource.
volume_id
The identifier of the volume.
volume_type
The type of Volume target.
Baremetal Introspection Resources
openstack.baremetal_introspection.v1.Introspection
The Introspection Class
The Introspection class inherits from Resource.

class openstack.baremetal_introspection.v1.introspection.Introspection(_synchronized
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters

finished_at
Timestamp at which the introspection was finished.
error
The last error message (if any).
id
The UUID of the introspection (matches the node UUID).
is_finished
Whether introspection is finished.
links
started_at
Timestamp at which the introspection was started.
state
The current introspection state.
abort(session)
Abort introspection.
get_data(session, processed=True)
Get introspection data.
Note that the introspection data format is not stable and can vary from environment to envi-
ronment.
Parameters
• processed (bool) Whether to fetch the final processed data (the default)
or the raw unprocessed data as received from the ramdisk.
Returns introspection data from the most recent successful run.
Return type dict
wait(session, timeout=None, ignore_error=False)
Wait for the node to reach the expected state.
Parameters
• timeout How much (in seconds) to wait for the introspection. The value
of None (the default) means no client-side timeout.
• ignore_error If True, this call will raise an exception if the intro-
spection reaches the error state. Otherwise the error state is considered
successful and the call returns.
Returns This Introspection instance.
Raises ResourceFailure if introspection fails and ignore_error is
False.

Block Storage Resources
openstack.block_storage.v2.backup
The Backup Class
The Backup class inherits from Resource.

class openstack.block_storage.v2.backup.Backup(_synchronized=False,
connection=None, **at-
trs)
Volume Backup
The base resource
Parameters
availability_zone
Properties backup availability zone
container
The container backup in
created_at
The date and time when the resource was created.
data_timestamp
data timestamp The time when the data on the volume was first saved. If it is a backup from
volume, it will be the same as created_at for a backup. If it is a backup from a snapshot, it
will be the same as created_at for the snapshot.
description
backup description
fail_reason
Backup fail reason
force
Force backup
has_dependent_backups
has_dependent_backups If this value is true, there are other backups depending on this
backup.
is_incremental
Indicates whether the backup mode is incremental. If this value is true, the backup mode is
incremental. If this value is false, the backup mode is full.
links
A list of links associated with this volume. Type: list

name
backup name
object_count
backup object count
size
The size of the volume, in gibibytes (GiB).
snapshot_id
The UUID of the source volume snapshot.
status
backup status values: creating, available, deleting, error, restoring, error_restoring
updated_at
The date and time when the resource was updated.
volume_id
The UUID of the volume.
create(session, prepend_key=True, base_path=None, **params)
Parameters
from base_path.
True.
restore(session, volume_id=None, name=None)
Restore current backup to volume
Parameters
• session openstack session
• volume_id The ID of the volume to restore the backup to.
• name The name for new volume creation to restore.
Returns Updated backup instance

openstack.block_storage.v2.snapshot
The Snapshot Class
The Snapshot class inherits from Resource.

class openstack.block_storage.v2.snapshot.Snapshot(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
id
A ID representing this snapshot.
name
Name of the snapshot. Default is None.
status
The current status of this snapshot. Potential values are creating, available, deleting, error,
and error_deleting.
description
Description of snapshot. Default is None.
created_at
The timestamp of this snapshot creation.
metadata
Metadata associated with this snapshot.
volume_id
The ID of the volume this snapshot was taken of.
size
The size of the volume, in GBs.
is_forced
Indicate whether to create snapshot, even if the volume is attached. Default is False. Type:
bool

The SnapshotDetail Class
The SnapshotDetail class inherits from Snapshot.

class openstack.block_storage.v2.snapshot.SnapshotDetail(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
progress
The percentage of completeness the snapshot is currently at.
project_id
The project ID this snapshot is associated with.
openstack.block_storage.v2.type
The Type Class
The Type class inherits from Resource.

class openstack.block_storage.v2.type.Type(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
id
A ID representing this type.
name
Name of the type.
extra_specs
A dict of extra specifications. capabilities is a usual key.
is_public
a private volume-type. Type: bool

openstack.block_storage.v2.volume
The Volume Class
The Volume class inherits from Resource.

class openstack.block_storage.v2.volume.Volume(_synchronized=False,
trs)
The base resource
Parameters
id
A ID representing this volume.
name
The name of this volume.
links
A list of links associated with this volume. Type: list
availability_zone
The availability zone.
source_volume_id
To create a volume from an existing volume, specify the ID of the existing volume. If
specified, the volume is created with same size of the source volume.
description
The volume description.
snapshot_id
To create a volume from an existing snapshot, specify the ID of the existing volume snap-
shot. If specified, the volume is created in same availability zone and with same size of the
snapshot.
size
The size of the volume, in GBs. Type: int
image_id
The ID of the image from which you want to create the volume. Required to create a bootable
volume.
volume_type
The name of the associated volume type.
is_bootable
Enables or disables the bootable attribute. You can boot an instance from a bootable volume.
Type: bool

metadata
One or more metadata key and value pairs to associate with the volume.
volume_image_metadata
One or more metadata key and value pairs about image
status
One of the following values: creating, available, attaching, in-use deleting, error, er-
ror_deleting, backing-up, restoring-backup, error_restoring. For details on these statuses,
see the Block Storage API documentation.
attachments
TODO(briancurtin): This is currently undocumented in the API.
created_at
The timestamp of this volume creation.
host
The volumes current back-end.
project_id
The project ID associated with current back-end.
user_id
The user ID associated with the volume
migration_status
The status of this volumes migration (None means that a migration is not currently in
progress).
migration_id
The volume ID that this volumes name on the back-end is based on.
replication_status
Status of replication on this volume.
extended_replication_status
Extended replication status on this volume.
consistency_group_id
ID of the consistency group.
replication_driver_data
Data set by the replication driver
is_encrypted
True if this volume is encrypted, False if not. Type: bool
extend(session, size)
Extend a volume size.

Cluster Resources
openstack.clustering.v1.build_info
The BuildInfo Class
The BuildInfo class inherits from Resource.

class openstack.clustering.v1.build_info.BuildInfo(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
api
String representation of the API build version
engine
String representation of the engine build version
openstack.clustering.v1.profile_type
The ProfileType Class
The ProfileType class inherits from Resource.

class openstack.clustering.v1.profile_type.ProfileType(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
name
Name of the profile type.
schema
The schema of the profile type.

support_status
The support status of the profile type
openstack.clustering.v1.profile
The Profile Class
The Profile class inherits from Resource.

class openstack.clustering.v1.profile.Profile(_synchronized=False, con-
The base resource
Parameters
name
The name of the profile
type
The type of the profile.
project_id
The ID of the project this profile belongs to.
domain_id
The domain ID of the profile.
user_id
The ID of the user who created this profile.
spec
The spec of the profile.
metadata
A collection of key-value pairs that are attached to the profile.
created_at
Timestamp of when the profile was created.
updated_at
Timestamp of when the profile was last updated.

openstack.clustering.v1.policy_type
The PolicyType Class
The PolicyType class inherits from Resource.

class openstack.clustering.v1.policy_type.PolicyType(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
name
Name of policy type.
schema
The schema of the policy type.
support_status
The support status of the policy type
openstack.clustering.v1.policy
The Policy Class
The Policy class inherits from Resource.

class openstack.clustering.v1.policy.Policy(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
name
The name of the policy.
type
The type name of the policy.

project_id
The ID of the project this policy belongs to.
user_id
The ID of the user who created this policy.
created_at
The timestamp when the policy is created.
updated_at
The timestamp when the policy was last updated.
spec
The specification of the policy.
data
A dictionary containing runtime data of the policy.
openstack.clustering.v1.Cluster
The Cluster Class
The Cluster class inherits from Resource.

class openstack.clustering.v1.cluster.Cluster(_synchronized=False, con-
The base resource
Parameters
name
The name of the cluster.
profile_id
The ID of the profile used by this cluster.
user_id
The ID of the user who created this cluster, thus the owner of it.
project_id
The ID of the project this cluster belongs to.
domain_id
The domain ID of the cluster owner.
init_at
Timestamp of when the cluster was initialized. Type: datetime object parsed from ISO 8601
formatted string

created_at
Timestamp of when the cluster was created. Type: datetime object parsed from ISO 8601
formatted string
updated_at
Timestamp of when the cluster was last updated. Type: datetime object parsed from ISO
8601 formatted string
min_size
Lower bound (inclusive) for the size of the cluster.
max_size
Upper bound (inclusive) for the size of the cluster. A value of -1 indicates that there is no
upper limit of cluster size.
desired_capacity
Desired capacity for the cluster. A cluster would be created at the scale specified by this
value.
timeout
Default timeout (in seconds) for cluster operations.
status
A string representation of the cluster status.
status_reason
A string describing the reason why the cluster in current status.
config
A dictionary configuration for cluster.
metadata
A collection of key-value pairs that are attached to the cluster.
data
A dictionary with some runtime data associated with the cluster.
node_ids
A list IDs of nodes that are members of the cluster.
profile_name
Name of the profile used by the cluster.
is_profile_only
Specify whether the cluster update should only pertain to the profile.
dependents
A dictionary with dependency information of the cluster
op(session, operation, **params)
Perform an operation on the cluster.
Parameters
• session A session object used for sending request.
• operation A string representing the operation to be performed.
• params (dict) An optional dict providing the parameters for the opera-
tion.


force_delete(session)
Force delete a cluster.
openstack.clustering.v1.Node
The Node Class
The Node class inherits from Resource.

class openstack.clustering.v1.node.Node(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
name
The name of the node.
physical_id
The ID of the physical object that backs the node.
cluster_id
The ID of the cluster in which this node is a member. A node is an orphan node if this field
is empty.
profile_id
The ID of the profile used by this node.
domain_id
The domain ID of the node.
user_id
The ID of the user who created this node.
project_id
The ID of the project this node belongs to.
profile_name
The name of the profile used by this node.
index
An integer that is unique inside the owning cluster. A value of -1 means this node is an
orphan node.
role
A string indicating the role the node plays in a cluster.

init_at
The timestamp of the node objects initialization. Type: datetime object parsed from ISO
8601 formatted string
created_at
The timestamp of the nodes creation, i.e. the physical object represented by this node is also
created. Type: datetime object parsed from ISO 8601 formatted string
updated_at
The timestamp the node was last updated. Type: datetime object parsed from ISO 8601
formatted string
status
A string indicating the nodes status.
status_reason
A string describing why the node entered its current status.
metadata
A map containing key-value pairs attached to the node.
data
A map containing some runtime data for this node.
details
A map containing the details of the physical object this node represents
dependents
A map containing the dependency of nodes
tainted
Whether the node is tainted. Type: bool
check(session, **params)
An action procedure for the node to check its health status.
Parameters session A session object used for sending request.
recover(session, **params)
An action procedure for the node to recover.
Parameters session A session object used for sending request.
op(session, operation, **params)
Perform an operation on the specified node.
Parameters
• operation A string representing the operation to be performed.
• params (dict) An optional dict providing the parameters for the opera-
tion.

adopt(session, preview=False, **params)

Adopt a node for management.
Parameters
• preview A boolean indicating whether the adoption is a preview. A pre-
view does not create the node object.
• params (dict) A dict providing the details of a node to be adopted.
Force delete a node.
openstack.clustering.v1.cluster_policy
The ClusterPolicy Class
The ClusterPolicy class inherits from Resource.

class openstack.clustering.v1.cluster_policy.ClusterPolicy(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
policy_id
ID of the policy object.
policy_name
Name of the policy object.
cluster_id
ID of the cluster object.
cluster_name
Name of the cluster object.
policy_type
Type string of the policy.
is_enabled
Whether the policy is enabled on the cluster. Type: bool
data
Data associated with the cluster-policy binding.

openstack.clustering.v1.receiver
The Receiver Class
The Receiver class inherits from Resource.

class openstack.clustering.v1.receiver.Receiver(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
name
The name of the receiver.
type
The type of the receiver.
user_id
The ID of the user who created the receiver, thus the owner of it.
project_id
The ID of the project this receiver belongs to.
domain_id
The domain ID of the receiver.
cluster_id
The ID of the targeted cluster.
action
The name of the targeted action.
created_at
Timestamp of when the receiver was created.
updated_at
Timestamp of when the receiver was last updated.
actor
The credential of the impersonated user.
params
A dictionary containing key-value pairs that are provided to the targeted action.
channel
The information about the channel through which you can trigger the receiver hence the
associated action.

openstack.clustering.v1.action
The Action Class
The Action class inherits from Resource.

class openstack.clustering.v1.action.Action(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
name
Name of the action.
target_id
ID of the target object, which can be a cluster or a node.
action
Built-in type name of action.
cause
A string representation of the reason why the action was created.
owner_id
The owning engine that is currently running the action.
user_id
The ID of the user who created this action.
project_id
The ID of the project this profile belongs to.
domain_id
The domain ID of the action.
interval
Interval in seconds between two consecutive executions.
start_at
The time the action was started.
end_at
The time the action completed execution.
timeout
The timeout in seconds.
status
Current status of the action.

inputs
A dictionary containing the inputs to the action.
outputs
A dictionary containing the outputs to the action.
depends_on
A list of actions that must finish before this action starts execution.
depended_by
A list of actions that can start only after this action has finished.
created_at
Timestamp when the action is created.
updated_at
Timestamp when the action was last updated.
cluster_id
The ID of cluster which this action runs on.
openstack.clustering.v1.event
The Event Class
The Event class inherits from Resource.

class openstack.clustering.v1.event.Event(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
generated_at
Timestamp string (in ISO8601 format) when the event was generated.
obj_id
The UUID of the object related to this event.
obj_name
The name of the object related to this event.
obj_type
The type name of the object related to this event.
cluster_id
The UUID of the cluster related to this event, if any.
level
The event level (priority).

user_id
The ID of the user.
project_id
The ID of the project (tenant).
action
The string representation of the action associated with the event.
status
The status of the associated object.
status_reason
A string description of the reason that brought the object into its current status.
meta_data
The metadata of an event object.
Compute Resources
openstack.compute.v2.extension
The Extension Class
The Extension class inherits from Resource.

class openstack.compute.v2.extension.Extension(_synchronized=False,
trs)
The base resource
Parameters
alias
A short name by which this extension is also known.
description
Text describing this extensions purpose.
links
Links pertaining to this extension. This is a list of dictionaries, each including keys href
and rel.
name
The name of the extension.
namespace
A URL pointing to the namespace for this extension.

updated_at
Timestamp when this extension was last updated.
openstack.compute.v2.flavor
The Flavor Class
The Flavor class inherits from Resource.

class openstack.compute.v2.flavor.Flavor(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
links
Links pertaining to this flavor. This is a list of dictionaries, each including keys href and
rel.
name
The name of this flavor.
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 flavors extra-specs key-and-value pairs.
classmethod list(session, paginated=True, base_path=’/flavors/detail’, al-
low_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
• paginated (bool) True if a GET to this resource returns a paginated
series of responses, or False if a GET returns only one page of data. When
paginated is False only one page of data will be returned regardless of
the APIs 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 un-
known query parameters. This allows getting list of filters and passing ev-
erything 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 pa-
rameters to be sent in the params argument to get(). They are additionally
checked against the base_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 if Resource.allow_list is not set to
True.
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
openstack.compute.v2.image
The Image Class
The Image class inherits from Resource.

class openstack.compute.v2.image.Image(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
links
Links pertaining to this image. This is a list of dictionaries, each including keys href and
rel, and optionally type.
name
The name of this image.
created_at
Timestamp when the image was created.
metadata
Metadata pertaining to this image. Type: dict
min_disk
The mimimum disk size. Type: int

min_ram
The minimum RAM size. Type: int
progress
If this image is still building, its progress is represented here. Once an image is created,
progres will be 100. Type: int
status
The status of this image.
updated_at
Timestamp when the image was updated.
size
Size of the image in bytes. Type: int
The ImageDetail Class
The ImageDetail class inherits from Image.

openstack.compute.v2.image.ImageDetail
alias of openstack.compute.v2.image.Image
openstack.compute.v2.keypair
The Keypair Class
The Keypair class inherits from Resource.

class openstack.compute.v2.keypair.Keypair(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
created_at
The date and time when the resource was created.
is_deleted
A boolean indicates whether this keypair is deleted or not.
fingerprint
The short fingerprint associated with the public_key for this keypair.
id
The id identifying the keypair

name
A name identifying the keypair
private_key
The private key for the keypair
public_key
The SSH public key that is paired with the server.
type
The type of the keypair.
user_id
The user_id for a keypair.
classmethod existing(connection=None, **kwargs)
Create an instance of an existing remote resource.
When creating the instance set the _synchronized parameter of Resource to True to
indicate that it represents the state of an existing server-side resource. As such, all attributes
passed in **kwargs are considered clean, such that an immediate update() call would
not generate a body of attributes to be modified on the server.
Parameters kwargs (dict) Each of the named arguments will be set as at-
tributes on the resulting Resource object.
openstack.compute.v2.limits
The Limits Class
The Limits class inherits from Resource.

class openstack.compute.v2.limits.Limits(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
fetch(session, requires_id=False, error_message=None, base_path=None)
Get the Limits resource.
Returns A Limits instance
Return type Limits

The AbsoluteLimits Class
The AbsoluteLimits class inherits from Resource.

class openstack.compute.v2.limits.AbsoluteLimits(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
image_meta
The number of key-value pairs that can be set as image metadata.
personality
The maximum number of personality contents that can be supplied.
personality_size
The maximum size, in bytes, of a personality.
security_group_rules
The maximum amount of security group rules allowed.
security_groups
The maximum amount of security groups allowed.
security_groups_used
The amount of security groups currently in use.
server_meta
The number of key-value pairs that can be set as server metadata.
total_cores
The maximum amount of cores.
total_cores_used
The amount of cores currently in use.
floating_ips
The maximum amount of floating IPs.
floating_ips_used
The amount of floating IPs currently in use.
instances
The maximum amount of instances.
instances_used
The amount of instances currently in use.
keypairs
The maximum amount of keypairs.

total_ram
The maximum RAM size in megabytes.
total_ram_used
The RAM size in megabytes currently in use.
server_groups
The maximum amount of server groups.
server_groups_used
The amount of server groups currently in use.
server_group_members
The maximum number of members in a server group.
The RateLimit Class
The RateLimit class inherits from Resource.

class openstack.compute.v2.limits.RateLimit(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
limits
A list of the specific limits that apply to the regex and uri.
regex
A regex representing which routes this rate limit applies to.
uri
A URI representing which routes this rate limit applies to.
openstack.compute.v2.server
The Server Class
The Server class inherits from Resource.

class openstack.compute.v2.server.Server(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters


links
A list of dictionaries holding links relevant to this server.
addresses
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
admin_password
When a server is first created, it provides the administrator password.
attached_volumes
A list of an attached volumes. Each item in the list contains at least an id key to identify the
specific volumes.
availability_zone
The name of the availability zone this server is a part of.
block_device_mapping
Enables fine grained control of the block device mapping for an instance. This is typically
used for booting servers from volumes.
config_drive
Indicates whether or not a config drive was used for this server.
compute_host
The name of the compute host on which this instance is running. Appears in the response
for administrative users only.
created_at
Timestamp of when the server was created.
description
The description of the server. Before microversion 2.19 this was set to the server name.
disk_config
The disk configuration. Either AUTO or MANUAL.
flavor_id
The flavor reference, as a ID or full URL, for the flavor to use for this server.
has_config_drive
Indicates whether a configuration drive enables metadata injection. Not all cloud providers
enable this feature.
host_id
An ID representing the host of this server.
host_status
The host status.
hostname
The hostname set on the instance when it is booted. By default, it appears in the response

for administrative users only.

hypervisor_hostname
The hypervisor host name. Appears in the response for administrative users only.
image_id
The image reference, as a ID or full URL, for the image to use for this server.
image
The image property as returned from server.
instance_name
The instance name. The Compute API generates the instance name from the instance name
template. Appears in the response for administrative users only.
kernel_id
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.
key_name
The name of an associated keypair
launch_index
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.
launched_at
The timestamp when the server was launched.
metadata
Metadata stored for this server. Type: dict
networks
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.
personality
The file path and contents, text only, to inject into the server at launch. The maximum size
of the file path data is 255 bytes. The maximum limit is The number of allowed bytes in the
decoded, rather than encoded, data.
power_state
The power state of this server.
progress
While the server is building, this value represents the percentage of completion. Once it is
completed, it will be 100. Type: int
project_id
The ID of the project this server is associated with.
ramdisk_id
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.
reservation_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.
root_device_name
The root device name for the instance By default, it appears in the response for administrative
users only.
scheduler_hints
The dictionary of data to send to the scheduler.
security_groups
A list of applicable security groups. Each group contains keys for description, name, id, and
rules.
server_groups
The UUIDs of the server groups to which the server belongs. Currently this can contain at
most one entry.
status
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.
task_state
The task state of this server.
terminated_at
The timestamp when the server was terminated (if it has been).
trusted_image_certificates
A list of trusted certificate IDs, that were used during image signature verification to verify
the signing certificate.
updated_at
Timestamp of when this server was last updated.
user_data
Configuration information or scripts to use upon launch. Must be Base64 encoded.
user_id
The ID of the owners of this server.
vm_state
The VM state of this server.
change_password(session, new_password)
Change the administrator password to the given password.
get_password(session)
Get the encrypted administrator password.
reboot(session, reboot_type)
Reboot server where reboot_type might be SOFT or HARD.
Force delete a server.

rebuild(session, name=None, admin_password=None, preserve_ephemeral=False, im-

age=None, access_ipv4=None, access_ipv6=None, metadata=None, personal-
ity=None)
Rebuild the server with the given arguments.
resize(session, flavor)
Resize server to flavor reference.
confirm_resize(session)
Confirm the resize of the server.
revert_resize(session)
Revert the resize of the server.
create_image(session, name, metadata=None)
Create image from server.
fetch_security_groups(session)
Fetch security groups of a server.
Returns Updated Server instance.
openstack.compute.v2.server_interface
The ServerInterface Class
The ServerInterface class inherits from Resource.

class openstack.compute.v2.server_interface.ServerInterface(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
fixed_ips
Fixed IP addresses with subnet IDs.
mac_addr
The MAC address.
net_id
The network ID.
port_id
The ID of the port for which you want to create an interface.

port_state
The port state.
server_id
The ID for the server.
openstack.compute.v2.server_ip
The ServerIP Class
The ServerIP class inherits from Resource.

class openstack.compute.v2.server_ip.ServerIP(_synchronized=False, con-
The base resource
Parameters
address
The IP address. The format of the address depends on version
network_label
The network label, such as public or private.
server_id
The ID for the server.
classmethod list(session, paginated=False, server_id=None, network_label=None,
base_path=None, **params)
filtering.
Parameters
from base_path.


True.
Database Resources
openstack.database.v1.database
The Database Class
The Database class inherits from Resource.

class openstack.database.v1.database.Database(_synchronized=False, con-
The base resource
Parameters
character_set
Set of symbols and encodings. The default character set is utf8.
collate
Set of rules for comparing characters in a character set. The default value for collate is
utf8_general_ci.
instance_id
The ID of the instance
name
The name of the database

openstack.database.v1.flavor
The Flavor Class

class openstack.database.v1.flavor.Flavor(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
links
Links associated with the flavor
name
The name of the flavor
ram
The size in MB of RAM the flavor has
openstack.database.v1.instance
The Instance Class
The Instance class inherits from Resource.

class openstack.database.v1.instance.Instance(_synchronized=False, con-
The base resource
Parameters
flavor
The flavor of the instance
links
Links associated with the instance
name
The name of the instance

status
The status of the instance
volume
The size of the volume
datastore
A dictionary of datastore details, often including type and version keys
id
The ID of this instance
region
The region this instance resides in
hostname
The name of the host
created_at
The timestamp when this instance was created
updated_at
The timestamp when this instance was updated
enable_root_user(session)
Enable login for the root user.
This operation enables login from any host for the root user and provides the user with a
generated root password.
Returns A dictionary with keys name and password specifying the login cre-
dentials.
is_root_enabled(session)
Determine if root is enabled on an instance.
Determine if root is enabled on this particular instance.
Returns True if root user is enabled for a specified database instance or False
otherwise.
restart(session)
Restart the database instance
Returns None
resize(session, flavor_reference)
Resize the database instance
Returns None
resize_volume(session, volume_size)
Resize the volume attached to the instance
Returns None

openstack.database.v1.user
The User Class
The User class inherits from Resource.

class openstack.database.v1.user.User(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
databases
Databases the user has access to
name
The name of the user
password
The password of the user
DNS Resources
openstack.dns.v2.zone
The Zone Class
The DNS class inherits from Resource.

class openstack.dns.v2.zone.Zone(_synchronized=False, connection=None, **at-
trs)
DNS ZONE Resource
The base resource
Parameters
action
Properties current action in progress on the resource

attributes
Attributes Key:Value pairs of information about this zone, and the pool the user would like
to place the zone in. This information can be used by the scheduler to place zones on the
correct pool.
created_at
Timestamp when the zone was created
description
Zone description Type: str
email
The administrator email of this zone Type: str
links
Links contains a self pertaining to this zone or a next pertaining to next page
masters
The master list for slaver server to fetch DNS
name
Zone name
pool_id
The pool which manages the zone, assigned by system
project_id
The project id which the zone belongs to
serial
Serial number in the SOA record set in the zone, which identifies the change on the primary
DNS server Type: int
status
Zone status Valid values include PENDING_CREATE, ACTIVE, PENDING_DELETE, ER-
ROR
ttl
SOA TTL time, unit is seconds, default 300, TTL range 300-2147483647 Type: int
type
Zone type, Valid values include PRIMARY, SECONDARY Type: str
updated_at
Timestamp when the zone was last updated
openstack.dns.v2.zone_transfer
The ZoneTransferRequest Class

class openstack.dns.v2.zone_transfer.ZoneTransferRequest(_synchronized=False,
connec-
tion=None,
**attrs)
DNS Zone Transfer Request Resource

The base resource

Parameters
description
Description
target_project_id
A project ID that the request will be limited to. No other project will be allowed to accept
this request.
zone_name
Name for the zone that is being exported
The ZoneTransferAccept Class

class openstack.dns.v2.zone_transfer.ZoneTransferAccept(_synchronized=False,
connec-
tion=None,
**attrs)
DNS Zone Transfer Accept Resource
The base resource
Parameters
zone_transfer_request_id
Name for the zone that is being exported

openstack.dns.v2.zone_export
The ZoneExport Class

class openstack.dns.v2.zone_export.ZoneExport(_synchronized=False, con-
DNS Zone Exports Resource
The base resource
Parameters
created_at
Properties Timestamp when the zone was created
links
message
Message
metadata
Returns the total_count of resources matching this filter
project_id
status
Current status of the zone export
updated_at
version
Version of the resource
zone_id
ID for the zone that was created by this export
create(session, prepend_key=True, base_path=None)
Parameters

from base_path.
True.
openstack.dns.v2.zone_import
The ZoneImport Class

class openstack.dns.v2.zone_import.ZoneImport(_synchronized=False, con-
DNS Zone Import Resource
The base resource
Parameters
created_at
Properties Timestamp when the zone was created
links
message
Message
metadata
Returns the total_count of resources matching this filter
project_id
status
Current status of the zone import
updated_at
version
Version of the resource
zone_id
ID for the zone that was created by this import

Parameters
from base_path.
True.
openstack.dns.v2.floating_ip
The FloatingIP Class

class openstack.dns.v2.floating_ip.FloatingIP(_synchronized=False, con-
DNS Floating IP Resource
The base resource
Parameters
action
address
The floatingip address for this PTR record
description
Description for this PTR record
ptrdname
Domain name for this PTR record
status
status of the resource
ttl
Time to live for this PTR record

openstack.dns.v2.recordset
The Recordset Class

class openstack.dns.v2.recordset.Recordset(_synchronized=False, connec-
tion=None, **attrs)
DNS Recordset Resource
The base resource
Parameters
action
created_at
Timestamp when the zone was created
description
Recordset description
links
name
DNS Name of the recordset
project_id
ID of the project which the recordset belongs to
records
DNS record value list
status
Recordset status Valid values include: PENDING_CREATE, AC-
TIVE,‘PENDING_DELETE‘, ERROR
ttl
Time to live, default 300, available value 300-2147483647 (seconds)
type
DNS type of the recordset Valid values include A, AAAA, MX, CNAME, TXT, NS, SSHFP,
SPF, SRV, PTR
updated_at
zone_id
The id of the Zone which this recordset belongs to

zone_name
The name of the Zone which this recordset belongs to
Identity v2 Resources
openstack.identity.v2.extension
The Extension Class

class openstack.identity.v2.extension.Extension(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
alias
A unique identifier, which will be used for accessing the extension through a dedicated url
/extensions/*alias*. The extension alias uniquely identifies an extension and is
prefixed by a vendor identifier. Type: string
description
A description of the extension. Type: string
links
Links to the documentation in various format. Type: string
name
The name of the extension. Type: string
namespace
The second unique identifier of the extension after the alias. It is usually a URL which will
be used. Example: http://docs.openstack.org/identity/api/ext/s3tokens/v1.0 Type: string
updated_at
The last time the extension has been modified (update date).
classmethod list(session, paginated=False, base_path=None, **params)
filtering.
Parameters


from base_path.
True.
openstack.identity.v2.role
The Role Class
The Role class inherits from Resource.

class openstack.identity.v2.role.Role(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
The description of the role. Type: string
is_enabled
Setting this attribute to False prevents this role from being available in the role list. Type:
bool
name
Unique role name. Type: string

openstack.identity.v2.tenant
The Tenant Class
The Tenant class inherits from Resource.

class openstack.identity.v2.tenant.Tenant(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
The description of the tenant. Type: string
is_enabled
Setting this attribute to False prevents users from authorizing against this tenant. Addi-
tionally, all pre-existing tokens authorized for the tenant are immediately invalidated. Re-
enabling a tenant does not re-enable pre-existing tokens. Type: bool
name
Unique tenant name. Type: string
openstack.identity.v2.user
The User Class

class openstack.identity.v2.user.User(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
email
The email of this user. Type: string

is_enabled
Setting this value to False prevents the user from authenticating or receiving authoriza-
tion. Additionally, all pre-existing tokens held by the user are immediately invalidated.
Re-enabling a user does not re-enable pre-existing tokens. Type: bool
name
The name of this user. Type: string
Identity v3 Resources
openstack.identity.v3.credential
The Credential Class
The Credential class inherits from Resource.

class openstack.identity.v3.credential.Credential(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
blob
Arbitrary blob of the credential data, to be parsed according to the type. Type: string
project_id
References a project ID which limits the scope the credential applies to. This attribute is
mandatory if the credential type is ec2. Type: string
type
Representing the credential type, such as ec2 or cert. A specific implementation may
determine the list of supported types. Type: string
user_id
References the user ID which owns the credential. Type: string

openstack.identity.v3.domain
The Domain Class
The Domain class inherits from Resource.

class openstack.identity.v3.domain.Domain(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
The description of this domain. Type: string
is_enabled
Setting this attribute to False prevents users from authorizing against this domain or any
projects owned by this domain, and prevents users owned by this domain from authenticating
or receiving any other authorization. Additionally, all pre-existing tokens applicable to the
above entities are immediately invalidated. Re-enabling a domain does not re-enable pre-
existing tokens. Type: bool
name
The globally unique name of this domain. Type: string
links
The links related to the domain resource.
assign_role_to_user(session, user, role)
Assign role to user on domain
validate_user_has_role(session, user, role)
Validates that a user has a role on a domain
unassign_role_from_user(session, user, role)
Unassigns a role from a user on a domain
assign_role_to_group(session, group, role)
Assign role to group on domain
validate_group_has_role(session, group, role)
Validates that a group has a role on a domain
unassign_role_from_group(session, group, role)
Unassigns a role from a group on a domain

openstack.identity.v3.endpoint
The Endpoint Class
The Endpoint class inherits from Resource.

class openstack.identity.v3.endpoint.Endpoint(_synchronized=False, con-
The base resource
Parameters
interface
Describes the interface of the endpoint according to one of the following values:
• public: intended for consumption by end users, generally on a publicly available
network interface
• internal: not intended for consumption by end users, generally on an unmetered
internal network interface
• admin: intended only for consumption by those needing administrative access to
the service, generally on a secure network interface
Type: string
is_enabled
Setting this value to False prevents the endpoint from appearing in the service catalog.
Type: bool
links
The links for the region resource.
region_id
Represents the containing region ID of the service endpoint. New in v3.2 Type: string
service_id
References the service ID to which the endpoint belongs. Type: string
url
Fully qualified URL of the service endpoint. Type: string

openstack.identity.v3.group
The Group Class
The Group class inherits from Resource.

class openstack.identity.v3.group.Group(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
The description of this group. Type: string
domain_id
References the domain ID which owns the group; if a domain ID is not specified by the
client, the Identity service implementation will default it to the domain ID to which the
clients token is scoped. Type: string
name
Unique group name, within the owning domain. Type: string
openstack.identity.v3.policy
The Policy Class
The Policy class inherits from Resource.

class openstack.identity.v3.policy.Policy(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
blob
The policy rule set itself, as a serialized blob. Type: string
links
The links for the policy resource.

project_id
The ID for the project.
type
The MIME Media Type of the serialized policy blob. Type: string
user_id
The ID of the user who owns the policy
openstack.identity.v3.project
The Project Class
The Project class inherits from Resource.

class openstack.identity.v3.project.Project(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
The description of the project. Type: string
domain_id
References the domain ID which owns the project; if a domain ID is not specified by the
client, the Identity service implementation will default it to the domain ID to which the
clients token is scoped. Type: string
is_domain
Indicates whether the project also acts as a domain. If set to True, the project acts as both a
project and a domain. Default is False. New in version 3.6
is_enabled
Setting this attribute to False prevents users from authorizing against this project. Addi-
tionally, all pre-existing tokens authorized for the project are immediately invalidated. Re-
enabling a project does not re-enable pre-existing tokens. Type: bool
name
Unique project name, within the owning domain. Type: string
parent_id
The ID of the parent of the project. New in version 3.4
assign_role_to_user(session, user, role)
Assign role to user on project
validate_user_has_role(session, user, role)
Validates that a user has a role on a project

unassign_role_from_user(session, user, role)

Unassigns a role from a user on a project
assign_role_to_group(session, group, role)
Assign role to group on project
validate_group_has_role(session, group, role)
Validates that a group has a role on a project
unassign_role_from_group(session, group, role)
Unassigns a role from a group on a project
openstack.identity.v3.service
The Service Class
The Service class inherits from Resource.

class openstack.identity.v3.service.Service(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
User-facing description of the service. Type: string
is_enabled
Setting this value to False prevents the service and its endpoints from appearing in the
service catalog. Type: bool
links
The links for the service resource.
name
User-facing name of the service. Type: string
type
Describes the API implemented by the service. The following values are recognized within
the OpenStack ecosystem: compute, image, ec2, identity, volume, network. To
support non-core and future projects, the value should not be validated against this list. Type:
string

openstack.identity.v3.trust
The Trust Class
The Trust class inherits from Resource.

class openstack.identity.v3.trust.Trust(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
allow_redelegation
A boolean indicating whether the trust can be issued by the trustee as a regulart trust. Default
is False.
expires_at
Specifies the expiration time of the trust. A trust may be revoked ahead of expiration. If the
value represents a time in the past, the trust is deactivated.
is_impersonation
If impersonation is set to true, then the user attribute of tokens that are generated
based on the trust will represent that of the trustor rather than the trustee, thus allowing the
trustee to impersonate the trustor. If impersonation is set to False, then the tokens
user attribute will represent that of the trustee. Type: bool
links
Links for the trust resource.
project_id
ID of the project upon which the trustor is delegating authorization. Type: string
role_links
A role links object that includes next, previous, and self links for roles.
roles
Specifies the subset of the trustors roles on the project_id to be granted to the trustee
when the token in consumed. The trustor must already be granted these roles in the project
referenced by the project_id attribute. Type: list
redelegated_trust_id
Returned with redelegated trust provides information about the predecessor in the trust chain.
redelegation_count
Redelegation count
remaining_uses
How many times the trust can be used to obtain a token. The value is decreased each time
a token is issued through the trust. Once it reaches zero, no further tokens will be isued
through the trust.

trustee_user_id
Represents the user ID who is capable of consuming the trust. Type: string
trustor_user_id
Represents the user ID who created the trust, and whos authorization is being delegated.
Type: string
openstack.identity.v3.user
The User Class

class openstack.identity.v3.user.User(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
default_project_id
References the users default project ID against which to authorize, if the API user does not
explicitly specify one when creating a token. Setting this attribute does not grant any actual
authorization on the project, and is merely provided for the users convenience. Therefore,
the referenced project does not need to exist within the users domain.
New in version 3.1 If the user does not have authorization to their default project, the default
project will be ignored at token creation. Type: string
description
The description of this user. Type: string
domain_id
References the domain ID which owns the user; if a domain ID is not specified by the client,
the Identity service implementation will default it to the domain ID to which the clients token
is scoped. Type: string
email
The email of this user. Type: string
is_enabled
Setting this value to False prevents the user from authenticating or receiving authoriza-
tion. Additionally, all pre-existing tokens held by the user are immediately invalidated.
Re-enabling a user does not re-enable pre-existing tokens. Type: bool
links
The links for the user resource.
name
Unique user name, within the owning domain. Type: string

password
The default form of credential used during authentication. Type: string
password_expires_at
The date and time when the password expires. The time zone is UTC. A None value means
the password never expires. This is a response object attribute, not valid for requests. New
in version 3.7
Image v1 Resources
openstack.image.v1.image
The Image Class

class openstack.image.v1.image.Image(_synchronized=False, connection=None,
**attrs)
The base resource
Parameters
checksum
Hash of the image data used. The Image service uses this value for verification.
container_format
The container format refers to whether the VM image is in a file format that also contains
metadata about the actual VM. Container formats include OVF and Amazon AMI. In addi-
tion, a VM image might not have a container format - instead, the image is just a blob of
unstructured data.
copy_from
A URL to copy an image from
created_at
The timestamp when this image was created.
disk_format
Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk. The disk format of a VM
image is the format of the underlying disk image. Virtual appliance vendors have different
formats for laying out the information contained in a VM disk image.
is_protected
Defines whether the image can be deleted. Type: bool
is_public
True if this is a public image. Type: bool

location
A location for the image identified by a URI
min_disk
The minimum disk size in GB that is required to boot the image.
min_ram
The minimum amount of RAM in MB that is required to boot the image.
name
Name for the image. Note that the name of an image is not unique to a Glance node. The
API cannot expect users to know the names of images owned by others.
owner
The ID of the owner, or project, of the image.
owner_id
The ID of the owner, or project, of the image. (backwards compat)
properties
Properties, if any, that are associated with the image.
size
The size of the image data, in bytes.
status
The image status.
updated_at
The timestamp when this image was last updated.
classmethod find(session, name_or_id, ignore_missing=True, **params)
Find a resource by its name or id.
Parameters
• name_or_id This resources identifier, if needed by the request. The de-
fault is None.
• params (dict) Any additional parameters to be passed into underlying
methods, such as to existing() in order to pass on URI parameters.
Returns The Resource object matching the given name or id or None if nothing
matches.

Image v2 Resources
openstack.image.v2.image
The Image Class

class openstack.image.v2.image.Image(_synchronized=False, connection=None,
**attrs)
The base resource
Parameters
checksum
Hash of the image data used. The Image service uses this value for verification.
container_format
The container format refers to whether the VM image is in a file format that also contains
metadata about the actual VM. Container formats include OVF and Amazon AMI. In addi-
tion, a VM image might not have a container format - instead, the image is just a blob of
unstructured data.
created_at
The date and time when the image was created.
disk_format
Valid values are: aki, ari, ami, raw, iso, vhd, vdi, qcow2, or vmdk. The disk format of a VM
image is the format of the underlying disk image. Virtual appliance vendors have different
formats for laying out the information contained in a VM disk image.
is_hidden
This field controls whether an image is displayed in the default image-list response
is_protected
Defines whether the image can be deleted. Type: bool
hash_algo
The algorithm used to compute a secure hash of the image data for this image
hash_value
The hexdigest of the secure hash of the image data computed using the algorithm whose
name is the value of the os_hash_algo property.
min_disk
The minimum disk size in GB that is required to boot the image.
min_ram
The minimum amount of RAM in MB that is required to boot the image.

name
The name of the image.
owner
The ID of the owner, or project, of the image.
owner_id
The ID of the owner, or project, of the image. (backwards compat)
properties
Properties, if any, that are associated with the image.
size
The size of the image data, in bytes.
store
When present, Glance will attempt to store the disk image data in the backing store indicated
by the value of the header. When not present, Glance will store the disk image data in the
backing store that is marked default. Valid values are: file, s3, rbd, swift, cinder, gridfs,
sheepdog, or vsphere.
status
The image status.
updated_at
The date and time when the image was updated.
virtual_size
The virtual size of the image.
visibility
The image visibility.
file
The URL for the virtual machine image file.
locations
A list of URLs to access the image file in external store. This list appears if the
show_multiple_locations option is set to true in the Image services configuration file.
direct_url
The URL to access the image file kept in external store. It appears when you set the
show_image_direct_url option to true in the Image services configuration file.
url
The URL to access the image file kept in external store.
metadata
The location metadata.
architecture
The CPU architecture that must be supported by the hypervisor.
hypervisor_type
The hypervisor type. Note that qemu is used for both QEMU and KVM hypervisor types.
instance_type_rxtx_factor
Optional property allows created servers to have a different bandwidth cap than that defined
in the network they are attached to.

instance_uuid
create this image.
needs_config_drive
Specifies whether the image needs a config drive. mandatory or optional (default if property
is not used).
kernel_id
The ID of an image stored in the Image service that should be used as the kernel when
booting an AMI-style image.
os_distro
The common name of the operating system distribution in lowercase
os_version
The operating system version as specified by the distributor.
needs_secure_boot
Secure Boot is a security standard. When the instance starts, Secure Boot first examines
software such as firmware and OS by their signature and only allows them to run if the
signatures are valid.
os_shutdown_timeout
Time for graceful shutdown
ramdisk_id
The ID of image stored in the Image service that should be used as the ramdisk when booting
an AMI-style image.
vm_mode
The virtual machine mode. This represents the host/guest ABI (application binary interface)
used for the virtual machine.
hw_cpu_sockets
The preferred number of sockets to expose to the guest.
hw_cpu_cores
The preferred number of cores to expose to the guest.
hw_cpu_threads
The preferred number of threads to expose to the guest.
hw_disk_bus
Specifies the type of disk controller to attach disk devices to. One of scsi, virtio, uml, xen,
ide, or usb.
hw_cpu_policy
Used to pin the virtual CPUs (vCPUs) of instances to the hosts physical CPU cores (pCPUs).
hw_cpu_thread_policy
Defines how hardware CPU threads in a simultaneous multithreading-based (SMT) archi-
tecture be used.
hw_rng_model
Adds a random-number generator device to the images instances.
hw_machine_type
For libvirt: Enables booting an ARM system using the specified machine type. For Hyper-V:
Specifies whether the Hyper-V instance will be a generation 1 or generation 2 VM.

hw_scsi_model
Enables the use of VirtIO SCSI (virtio-scsi) to provide block device access for compute
instances; by default, instances use VirtIO Block (virtio-blk).
hw_serial_port_count
Specifies the count of serial ports that should be provided.
hw_video_model
The video image driver used.
hw_video_ram
Maximum RAM for the video image.
hw_watchdog_action
Enables a virtual hardware watchdog device that carries out the specified action if the server
hangs.
os_command_line
The kernel command line to be used by the libvirt driver, instead of the default.
hw_vif_model
Specifies the model of virtual network interface device to use.
is_hw_vif_multiqueue_enabled
If true, this enables the virtio-net multiqueue feature. In this case, the driver sets the number
of queues equal to the number of guest vCPUs. This makes the network performance scale
across a number of vCPUs.
is_hw_boot_menu_enabled
If true, enables the BIOS bootmenu.
vmware_adaptertype
The virtual SCSI or IDE controller used by the hypervisor.
vmware_ostype
A VMware GuestID which describes the operating system installed in the image.
has_auto_disk_config
If true, the root partition on the disk is automatically resized before the instance boots.
os_type
The operating system installed on the image.
os_admin_user
The operating system admin username.
hw_qemu_guest_agent
If true, QEMU guest agent will be exposed to the instance.
os_require_quiesce
If true, require quiesce on snapshot via QEMU guest agent.
schema
The URL for the schema describing a virtual machine image.
deactivate(session)
Deactivate an image
Note: Only administrative users can view image locations for deactivated images.

reactivate(session)
Reactivate an image
Note: The image must exist in order to be reactivated.
upload(session)
Upload data into an existing image
stage(session)
Stage binary image data into an existing image
import_image(session, method=’glance-direct’, uri=None, store=None, stores=None,
all_stores=None, all_stores_must_succeed=None)
Import Image via interoperable image import process
Parameters
fault is None.
matches.
openstack.image.v2.member
The Member Class
The Member class inherits from Resource.

class openstack.image.v2.member.Member(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters


member_id
The ID of the image member. An image member is a tenant with whom the image is shared.
created_at
The date and time when the member was created.
image_id
Image ID stored through the image API. Typically a UUID.
status
The status of the image.
schema
The URL for schema of the member.
updated_at
The date and time when the member was updated.
openstack.image.v2.task
The Task Class
The Task class inherits from Resource.

class openstack.image.v2.task.Task(_synchronized=False, connection=None,
**attrs)
The base resource
Parameters
created_at
The date and time when the task was created.
expires_at
The date and time when the task is subject to removal.
input
A JSON object specifying the input parameters to the task.
message
Human-readable text, possibly an empty string, usually displayed in an error situation to
provide more information about what has occurred.
owner_id
The ID of the owner, or project, of the task.

result
A JSON object specifying the outcome of the task.
schema
The URL for schema of the task.
status
The status of the task.
type
The type of task represented by this content.
updated_at
The date and time when the task was updated.
openstack.image.v2.service_info
The Store Class
The Store class inherits from Resource.

class openstack.image.v2.service_info.Store(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
Description of the store
is_default
default
The Import Info Class
The Import class inherits from Resource.

class openstack.image.v2.service_info.Import(_synchronized=False, con-
The base resource
Parameters


import_methods
import methods
KeyManager Resources
openstack.key_manager.v1.container
The Container Class
The Container class inherits from Resource.

class openstack.key_manager.v1.container.Container(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
container_ref
A URI for this container
container_id
The ID for this container
created_at
The timestamp when this container was created.
name
The name of this container
secret_refs
A list of references to secrets in this container
status
The status of this container
type
The type of this container
updated_at
The timestamp when this container was updated.
consumers
A party interested in this container.

openstack.key_manager.v1.order
The Order Class
The Order class inherits from Resource.

class openstack.key_manager.v1.order.Order(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
created_at
Timestamp in ISO8601 format of when the order was created
creator_id
Keystone Id of the user who created the order
meta
A dictionary containing key-value parameters which specify the details of an order request
order_ref
A URI for this order
order_id
The ID of this order
secret_ref
Secret href associated with the order
secret_id
Secret ID associated with the order
sub_status
Metadata associated with the order
sub_status_message
Metadata associated with the order
updated_at
Timestamp in ISO8601 format of the last time the order was updated.

openstack.key_manager.v1.secret
The Secret Class
The Secret class inherits from Resource.

class openstack.key_manager.v1.secret.Secret(_synchronized=False, con-
The base resource
Parameters
algorithm
Metadata provided by a user or system for informational purposes
bit_length
Metadata provided by a user or system for informational purposes. Value must be greater
than zero.
content_types
A list of content types
expires_at
Once this timestamp has past, the secret will no longer be available.
created_at
Timestamp of when the secret was created.
mode
The type/mode of the algorithm associated with the secret information.
name
The name of the secret set by the user
secret_ref
A URI to the sercret
secret_type
Used to indicate the type of secret being stored.
status
The status of this secret
updated_at
A timestamp when this secret was updated.
payload
The secrets data to be stored. payload_content_type must also be supplied if payload is
included. (optional)

payload_content_type
The media type for the content of the payload. (required if payload is included)
payload_content_encoding
The encoding used for the payload to be able to include it in the JSON request. Currently
only base64 is supported. (required if payload is encoded)
fetch(session, requires_id=True, base_path=None, error_message=None)
Get a remote resource based on this instance.
Parameters
• requires_id (boolean) A boolean indicating whether resource ID
should be part of the requested URI.
• base_path (str) Base part of the URI for fetching resources, if different
from base_path.
• error_message (str) An Error message to be returned if requested
object does not exist.
• params (dict) Additional parameters that can be consumed.
Raises MethodNotSupported if Resource.allow_fetch is not set to
True.
Raises ResourceNotFound if the resource was not found.
Load Balancer Resources
openstack.load_balancer.v2.load_balancer
The LoadBalancer class inherits from Resource.

class openstack.load_balancer.v2.load_balancer.LoadBalancer(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters

is_admin_state_up
The administrative state of the load balancer Type: bool
availability_zone
Name of the target Octavia availability zone
created_at
Timestamp when the load balancer was created
description
The load balancer description
flavor_id
The load balancer flavor ID
listeners
List of listeners associated with this load balancer
name
The load balancer name
operating_status
Operating status of the load balancer
pools
List of pools associated with this load balancer
project_id
The ID of the project this load balancer is associated with.
provider
Provider name for the load balancer.
provisioning_status
The provisioning status of this load balancer
updated_at
Timestamp when the load balancer was last updated
vip_address
VIP address of load balancer
vip_network_id
VIP netowrk ID
vip_port_id
VIP port ID
vip_subnet_id
VIP subnet ID
delete(session, error_message=None)
Delete the remote resource based on this instance.
Parameters
• kwargs (dict) Parameters that will be passed to _prepare_request()

Raises MethodNotSupported if Resource.allow_commit is not set to

True.
The LoadBalancerStats Class
The LoadBalancerStats class inherits from Resource.

class openstack.load_balancer.v2.load_balancer.LoadBalancerStats(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
lb_id
The ID of the load balancer.
active_connections
The currently active connections.
bytes_in
The total bytes received.
bytes_out
The total bytes sent.
request_errors
The total requests that were unable to be fulfilled.
total_connections
The total connections handled.
The LoadBalancerFailover Class
The LoadBalancerFailover class inherits from Resource.

class openstack.load_balancer.v2.load_balancer.LoadBalancerFailover(_synchronized=Fa
con-
nec-
tion=None,
**at-
trs)
The base resource

Parameters
lb_id
commit(session, base_path=None)
Parameters
True.
openstack.load_balancer.v2.listener
The Listener Class
The Listener class inherits from Resource.

class openstack.load_balancer.v2.listener.Listener(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
allowed_cidrs
List of IPv4 or IPv6 CIDRs.

alpn_protocols
List of ALPN protocols.
connection_limit
The maximum number of connections permitted for this load balancer. Default is infinite.
created_at
Timestamp when the listener was created.
default_pool
Default pool to which the requests will be routed.
default_pool_id
ID of default pool. Must have compatible protocol with listener.
default_tls_container_ref
A reference to a container of TLS secrets.
description
Description for the listener.
insert_headers
Dictionary of additional headers insertion into HTTP header.
is_admin_state_up
The administrative state of the listener, which is up True or down False. Type: bool
l7_policies
List of l7policies associated with this listener.
load_balancer_id
The ID of the parent load balancer.
load_balancers
List of load balancers associated with this listener. Type: list of dicts which contain the load
balancer IDs
name
Name of the listener
operating_status
Operating status of the listener.
project_id
The ID of the project this listener is associated with.
protocol
The protocol of the listener, which is TCP, HTTP, HTTPS or TERMINATED_HTTPS.
protocol_port
Port the listener will listen to, e.g. 80.
provisioning_status
The provisioning status of this listener.
sni_container_refs
A list of references to TLS secrets. Type: list
updated_at
Timestamp when the listener was last updated.

timeout_client_data
Frontend client inactivity timeout in milliseconds.
timeout_member_connect
Backend member connection timeout in milliseconds.
timeout_member_data
Backend member inactivity timeout in milliseconds.
timeout_tcp_inspect
Time, in milliseconds, to wait for additional TCP packets for content inspection.
tls_ciphers
Stores a cipher string in OpenSSL format.
tls_versions
A lsit of TLS protocols to be used by the listener
The ListenerStats Class
The ListenerStats class inherits from Resource.

class openstack.load_balancer.v2.listener.ListenerStats(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
listener_id
The ID of the listener.
active_connections
The currently active connections.
bytes_in
The total bytes received.
bytes_out
The total bytes sent.
request_errors
The total requests that were unable to be fulfilled.
total_connections
The total connections handled.

openstack.load_balancer.v2.pool
The Pool Class
The Pool class inherits from Resource.

class openstack.load_balancer.v2.pool.Pool(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
created_at
Properties Timestamp when the pool was created
description
Description for the pool.
health_monitor_id
Health Monitor ID
is_admin_state_up
The administrative state of the pool Type: bool
lb_algorithm
The loadbalancing algorithm used in the pool
listener_id
ID of listener associated with this pool
listeners
List of listeners associated with this pool
loadbalancer_id
ID of load balancer associated with this pool
loadbalancers
List of loadbalancers associated with this pool
members
Members associated with this pool
name
The pool name
operating_status
Operating status of the pool
project_id
The ID of the project

protocol
The protocol of the pool
provisioning_status
Provisioning status of the pool
tls_ciphers
Stores a string of cipher strings in OpenSSL format.
session_persistence
A JSON object specifying the session persistence for the pool.
tls_versions
A list of TLS protocol versions to be used in by the pool
updated_at
Timestamp when the pool was updated
tls_enabled
Use TLS for connections to backend member servers Type: bool
openstack.load_balancer.v2.member
The Member Class
The Member class inherits from Resource.

class openstack.load_balancer.v2.member.Member(_synchronized=False,
trs)
The base resource
Parameters
address
The IP address of the member.
created_at
Timestamp when the member was created.
is_admin_state_up
The administrative state of the member, which is up True or down False. Type: bool
monitor_address
IP address used to monitor this member
monitor_port
Port used to monitor this member

name
Name of the member.
operating_status
Operating status of the member.
pool_id
The ID of the owning pool.
provisioning_status
The provisioning status of this member.
project_id
The ID of the project this member is associated with.
protocol_port
The port on which the application is hosted.
subnet_id
Subnet ID in which to access this member.
updated_at
Timestamp when the member was last updated.
weight
A positive integer value that indicates the relative portion of traffic that this member should
receive from the pool. For example, a member with a weight of 10 receives five times as
much traffic as a member with weight of 2.
backup
A bool value that indicates whether the member is a backup or not. Backup members only
receive traffic when all non-backup members are down.
openstack.load_balancer.v2.health_monitor
The HealthMonitor Class
The HealthMonitor class inherits from Resource.

class openstack.load_balancer.v2.health_monitor.HealthMonitor(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters

created_at
Properties Timestamp when the health monitor was created.
delay
The time, in seconds, between sending probes to members.
expected_codes
The expected http status codes to get from a successful health check
http_method
The HTTP method that the monitor uses for requests
is_admin_state_up
The administrative state of the health monitor Type: bool
max_retries
The number of successful checks before changing the operating status of the member to
ONLINE.
max_retries_down
The number of allowed check failures before changing the operating status of the member
to ERROR.
name
The health monitor name
operating_status
pools
List of associated pools. Type: list of dicts which contain the pool IDs
pool_id
The ID of the associated Pool
project_id
The ID of the project
provisioning_status
The provisioning status of this member.
timeout
The time, in seconds, after which a health check times out
type
The type of health monitor
updated_at
url_path
The HTTP path of the request to test the health of a member

openstack.load_balancer.v2.l7_policy
The L7Policy Class
The L7Policy class inherits from Resource.

class openstack.load_balancer.v2.l7_policy.L7Policy(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
action
Properties The action to be taken l7policy is matched
created_at
Timestamp when the L7 policy was created.
description
The l7policy description
is_admin_state_up
The administrative state of the l7policy Type: bool
listener_id
The ID of the listener associated with this l7policy
name
The l7policy name
operating_status
position
Sequence number of this l7policy
project_id
The ID of the project this l7policy is associated with.
provisioning_status
The provisioning status of this l7policy
redirect_pool_id
The ID of the pool to which the requests will be redirected
redirect_prefix
The URL prefix to which the requests should be redirected
redirect_url
The URL to which the requests should be redirected

rules
The list of L7Rules associated with the l7policy
updated_at
openstack.load_balancer.v2.l7_rule
The L7Rule Class
The L7Rule class inherits from Resource.

class openstack.load_balancer.v2.l7_rule.L7Rule(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
is_admin_state_up
Properties The administrative state of the l7policy Type: bool
compare_type
comparison type to be used with the value in this L7 rule.
created_at
Timestamp when the L7 rule was created.
key
The key to use for the comparison.
l7_policy_id
The ID of the associated l7 policy
operating_status
The operating status of this l7rule
project_id
The ID of the project this l7policy is associated with.
provisioning_status
The provisioning status of this l7policy
type
The type of L7 rule
updated_at
Timestamp when the L7 rule was updated.

rule_value
value to be compared with
openstack.load_balancer.v2.provider
The Provider Class
The Provider class inherits from Resource.

class openstack.load_balancer.v2.provider.Provider(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
name
The provider name.
description
The provider description.
The Provider Flavor Capabilities Class
The ProviderFlavorCapabilities class inherits from Resource.

class openstack.load_balancer.v2.provider.ProviderFlavorCapabilities(_synchronized=F
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
provider
The provider name to query.

name
The provider name.
description
The provider description.
openstack.load_balancer.v2.flavor_profile
The FlavorProfile Class
The FlavorProfile class inherits from Resource.

class openstack.load_balancer.v2.flavor_profile.FlavorProfile(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
id
The ID of the flavor profile.
name
The name of the flavor profile.
provider_name
The provider this flavor profile is for.
flavor_data
The JSON string containing the flavor metadata.
openstack.load_balancer.v2.flavor
The Flavor Class

class openstack.load_balancer.v2.flavor.Flavor(_synchronized=False,
trs)
The base resource
Parameters


id
The ID of the flavor.
name
The name of the flavor.
description
The flavor description.
flavor_profile_id
The associated flavor profile ID
is_enabled
Whether the flavor is enabled for use or not.
openstack.load_balancer.v2.quota
The Quota Class
The Quota class inherits from Resource.

class openstack.load_balancer.v2.quota.Quota(_synchronized=False, con-
The base resource
Parameters
load_balancers
The maximum amount of load balancers you can have. Type: int
listeners
The maximum amount of listeners you can create. Type: int
pools
The maximum amount of pools you can create. Type: int
health_monitors
The maximum amount of health monitors you can create. Type: int
members
The maximum amount of members you can create. Type: int

project_id
The ID of the project this quota is associated with.
openstack.load_balancer.v2.amphora
The Amphora Class
The Amphora class inherits from Resource.

class openstack.load_balancer.v2.amphora.Amphora(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
id
The ID of the amphora.
loadbalancer_id
compute_id
The ID of the amphora resource in the compute system.
lb_network_ip
The management IP of the amphora.
vrrp_ip
The address of the vrrp port on the amphora.
ha_ip
The IP address of the Virtual IP (VIP).
vrrp_port_id
The vrrp ports ID in the networking system.
ha_port_id
The ID of the Virtual IP (VIP) port.
cert_expiration
The date the certificate for the amphora expires.
cert_busy
Whether the certificate is in the process of being replaced.
role
The role configured for the amphora. One of STANDALONE, MASTER, BACKUP.

status
The status of the amphora. One of: BOOTING, ALLOCATED, READY, PEND-
ING_CREATE, PENDING_DELETE, DELETED, ERROR.
vrrp_interface
The bound interface name of the vrrp port on the amphora.
vrrp_id
The vrrp groups ID for the amphora.
vrrp_priority
The priority of the amphora in the vrrp group.
cached_zone
The availability zone of a compute instance, cached at create time.
created_at
The UTC date and timestamp when the resource was created.
updated_at
The UTC date and timestamp when the resource was last updated.
image_id
The ID of the glance image used for the amphora.
compute_flavor
The ID of the compute flavor used for the amphora.
The AmphoraConfig Class
The AmphoraConfig class inherits from Resource.

class openstack.load_balancer.v2.amphora.AmphoraConfig(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
amphora_id
Parameters


True.
The AmphoraFailover Class
The AmphoraFailover class inherits from Resource.

class openstack.load_balancer.v2.amphora.AmphoraFailover(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
amphora_id
Parameters


True.
openstack.load_balancer.v2.availability_zone_profile
The AvailabilityZoneProfile Class
The AvailabilityZoneProfile class inherits from Resource.

class openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfi
The base resource

Parameters
id
The ID of the availability zone profile.
name
The name of the availability zone profile.
provider_name
The provider this availability zone profile is for.
availability_zone_data
The JSON string containing the availability zone metadata.
openstack.load_balancer.v2.availability_zone
The AvailabilityZone Class
The AvailabilityZone class inherits from Resource.

class openstack.load_balancer.v2.availability_zone.AvailabilityZone(_synchronized=Fa
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters


name
The name of the availability zone.
description
The availability zone description.
availability_zone_profile_id
The associated availability zone profile ID
is_enabled
Whether the availability zone is enabled for use or not.
Network Resources
openstack.network.v2.address_group
The AddressGroup Class
The AddressGroup class inherits from Resource.

class openstack.network.v2.address_group.AddressGroup(_synchronized=False,
connec-
tion=None,
**attrs)
Address group extension.
The base resource
Parameters
id
The ID of the address group.
name
The address group name.
description
The address group name.
project_id
The ID of the project that owns the address group.

addresses
The IP addresses of the address group.
add_addresses(session, addresses)
Add addresses into the address group.
Parameters
• session (Adapter) The session to communicate through.
• addresses (list) The list of address strings.
Returns The response as a AddressGroup object with updated addresses
Raises SDKException on error.
remove_addresses(session, addresses)
Remove addresses from the address group.
Parameters
• addresses (list) The list of address strings.
Returns The response as a AddressGroup object with updated addresses
openstack.network.v2.address_scope
The AddressScope Class
The AddressScope class inherits from Resource.

class openstack.network.v2.address_scope.AddressScope(_synchronized=False,
connec-
tion=None,
**attrs)
Address scope extension.
The base resource
Parameters
name
The address scope name.
project_id
The ID of the project that owns the address scope.

ip_version
The IP address family of the address scope. Type: int
is_shared
Indicates whether this address scope is shared across all projects. Type: bool
openstack.network.v2.agent
The Agent Class
The Agent class inherits from Resource.

class openstack.network.v2.agent.Agent(_synchronized=False, connec-
tion=None, **attrs)
Neutron agent extension.
The base resource
Parameters
agent_type
The type of network agent.
availability_zone
Availability zone for the network agent.
binary
The name of the network agents application binary.
configuration
Network agent configuration data specific to the agent_type.
created_at
Timestamp when the network agent was created.
description
The network agent description.
last_heartbeat_at
Timestamp when the network agents heartbeat was last seen.
host
The host the agent is running on.
is_admin_state_up
The administrative state of the network agent, which is up True or down False. Type:
bool
is_alive
Whether or not the network agent is alive. Type: bool

resources_synced
Whether or not the agent is succesffully synced towards placement. Agents supporting the
guaranteed minimum bandwidth feature share their resource view with neutron-server and
neutron-server share this view with placement, resources_synced represents the success of
the latter. The value None means no resource view synchronization to Placement was at-
tempted. true / false values signify the success of the last synchronization attempt. Type:
bool
started_at
Timestamp when the network agent was last started.
topic
The messaging queue topic the network agent subscribes to.
ha_state
The HA state of the L3 agent. This is one of active, standby or fault for HA routers, or None
for other types of routers.
openstack.network.v2.auto_allocated_topology
The Auto Allocated Topology Class
The Auto Allocated Toplogy class inherits from Resource.

class openstack.network.v2.auto_allocated_topology.AutoAllocatedTopology(_synchroni
con-
nec-
tion=None
**at-
trs)
The base resource
Parameters
project_id
Project ID If project is not specified the topology will be created for project user is authenti-
cated against. Will return in error if resources have not been configured correctly To use this
feature auto-allocated-topology, subnet_allocation, external-net and router extensions must
be enabled and set up.

openstack.network.v2.availability_zone
The AvailabilityZone Class
The AvailabilityZone class inherits from Resource.

class openstack.network.v2.availability_zone.AvailabilityZone(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
name
Name of the availability zone.
resource
Type of resource for the availability zone, such as network.
state
State of the availability zone, either available or unavailable.
openstack.network.v2.extension
The Extension Class

class openstack.network.v2.extension.Extension(_synchronized=False,
trs)
The base resource
Parameters
alias
An alias the extension is known under.

description
Text describing what the extension does.
links
Links pertaining to this extension.
name
The name of this extension.
updated_at
Timestamp when the extension was last updated.
openstack.network.v2.flavor
The Flavor Class

class openstack.network.v2.flavor.Flavor(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
description
description for the flavor
is_enabled
Sets enabled flag
name
The name of the flavor
service_type
Service type to which the flavor applies
service_profile_ids
IDs of service profiles associated with this flavor

openstack.network.v2.floating_ip
The FloatingIP Class
The FloatingIP class inherits from Resource.

class openstack.network.v2.floating_ip.FloatingIP(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
created_at
Timestamp at which the floating IP was created.
description
The floating IP description.
dns_domain
The DNS domain.
dns_name
The DNS name.
fixed_ip_address
The fixed IP address associated with the floating IP. If you intend to associate the floating IP
with a fixed IP at creation time, then you must indicate the identifier of the internal port. If
an internal port has multiple associated IP addresses, the service chooses the first IP unless
you explicitly specify the parameter fixed_ip_address to select a specific IP.
floating_ip_address
The floating IP address.
name
Floating IP object doesnt have name attribute, set ip address to name so that user could find
floating IP by UUID or IP address using find_ip
floating_network_id
The ID of the network associated with the floating IP.
port_details
Read-only. The details of the port that this floating IP associates with. Present if
fip-port-details extension is loaded. Type: dict with keys: name, network_id,
mac_address, admin_state_up, status, device_id, device_owner
port_id
The port ID.

qos_policy_id
The ID of the QoS policy attached to the floating IP.
project_id
The ID of the project this floating IP is associated with.
router_id
The ID of an associated router.
status
The floating IP status. Value is ACTIVE or DOWN.
updated_at
Timestamp at which the floating IP was last updated.
subnet_id
The Subnet ID associated with the floating IP.
openstack.network.v2.health_monitor
The HealthMonitor Class
The HealthMonitor class inherits from Resource.

class openstack.network.v2.health_monitor.HealthMonitor(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
delay
The time, in seconds, between sending probes to members.
expected_codes
Expected HTTP codes for a passing HTTP(S) monitor.
http_method
The HTTP method that the monitor uses for requests.
is_admin_state_up
The administrative state of the health monitor, which is up True or down False. Type:
bool
max_retries
Maximum consecutive health probe tries.
name
Name of the health monitor.

pool_ids
List of pools associated with this health monitor Type: list of dicts which contain the pool
IDs
pool_id
The ID of the pool associated with this health monitor
project_id
The ID of the project this health monitor is associated with.
timeout
The maximum number of seconds for a monitor to wait for a connection to be established
before it times out. This value must be less than the delay value.
type
The type of probe sent by the load balancer to verify the member state, which is PING, TCP,
HTTP, or HTTPS.
url_path
Path portion of URI that will be probed if type is HTTP(S).
openstack.network.v2.listener
The Listener Class
The Listener class inherits from Resource.

class openstack.network.v2.listener.Listener(_synchronized=False, con-
The base resource
Parameters
connection_limit
The maximum number of connections permitted for this load balancer. Default is infinite.
default_pool_id
ID of default pool. Must have compatible protocol with listener.
default_tls_container_ref
A reference to a container of TLS secrets.
description
Description for the listener.
is_admin_state_up
The administrative state of the listener, which is up True or down False. Type: bool

load_balancer_ids
List of load balancers associated with this listener. Type: list of dicts which contain the load
balancer IDs
load_balancer_id
The ID of the load balancer associated with this listener.
name
Name of the listener
project_id
The ID of the project this listener is associated with.
protocol
The protocol of the listener, which is TCP, HTTP, HTTPS or TERMINATED_HTTPS.
protocol_port
Port the listener will listen to, e.g. 80.
sni_container_refs
A list of references to TLS secrets. Type: list
openstack.network.v2.load_balancer
The LoadBalancer class inherits from Resource.

class openstack.network.v2.load_balancer.LoadBalancer(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
description
Description for the load balancer.
is_admin_state_up
The administrative state of the load balancer, which is up True or down False. Type: bool
listener_ids
List of listeners associated with this load balancer. Type: list of dicts which contain the
listener IDs
name
Name of the load balancer

operating_status
Status of load_balancer operating, e.g. ONLINE, OFFLINE.
pool_ids
List of pools associated with this load balancer. Type: list of dicts which contain the pool
IDs
project_id
The ID of the project this load balancer is associated with.
provider
The name of the provider.
provisioning_status
Status of load balancer provisioning, e.g. ACTIVE, INACTIVE.
vip_address
The IP address of the VIP.
vip_port_id
The ID of the port for the VIP.
vip_subnet_id
The ID of the subnet on which to allocate the VIP address.
openstack.network.v2.metering_label
The MeteringLabel Class
The MeteringLabel class inherits from Resource.

class openstack.network.v2.metering_label.MeteringLabel(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
description
Description of the metering label.
name
Name of the metering label.
project_id
The ID of the project this metering label is associated with.
is_shared
Indicates whether this label is shared across all tenants. Type: bool

openstack.network.v2.metering_label_rule
The MeteringLabelRule Class
The MeteringLabelRule class inherits from Resource.

class openstack.network.v2.metering_label_rule.MeteringLabelRule(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
direction
ingress or egress: The direction in which metering label rule is applied. Default:
"ingress"
is_excluded
Specify whether the remote_ip_prefix will be excluded or not from traffic counters of
the metering label, ie: to not count the traffic of a specific IP address of a range. Default:
False, Type: bool
metering_label_id
The metering label ID to associate with this metering label rule.
project_id
The ID of the project this metering label rule is associated with.
remote_ip_prefix
The remote IP prefix to be associated with this metering label rule.
source_ip_prefix
The source IP prefix to be associated with this metering label rule.
destination_ip_prefix
The destination IP prefix to be associated with this metering label rule

openstack.network.v2.network
The Network Class
The Network class inherits from Resource.

class openstack.network.v2.network.Network(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
availability_zone_hints
Availability zone hints to use when scheduling the network. Type: list of availability zone
names
availability_zones
Availability zones for the network. Type: list of availability zone names
created_at
Timestamp when the network was created.
description
The network description.
dns_domain
The DNS domain associated.
ipv4_address_scope_id
The ID of the IPv4 address scope for the network.
ipv6_address_scope_id
The ID of the IPv6 address scope for the network.
is_admin_state_up
The administrative state of the network, which is up True or down False. Type: bool
is_default
Whether or not this is the default external network. Type: bool
is_port_security_enabled
The port security status, which is enabled True or disabled False. Type: bool Default:
False Available for multiple provider extensions.
is_router_external
Whether or not the router is external. Type: bool Default: False
is_shared
Indicates whether this network is shared across all tenants. By default, only administrative
users can change this value. Type: bool

mtu
Read-only. The maximum transmission unit (MTU) of the network resource.
name
The network name.
project_id
The ID of the project this network is associated with.
provider_network_type
The type of physical network that maps to this network resource. For example, flat, vlan,
vxlan, or gre. Available for multiple provider extensions.
provider_physical_network
The physical network where this network object is implemented. Available for multiple
provider extensions.
provider_segmentation_id
An isolated segment ID on the physical network. The provider network type defines the
segmentation model. Available for multiple provider extensions.
qos_policy_id
The ID of the QoS policy attached to the port.
segments
A list of provider segment objects. Available for multiple provider extensions.
status
The network status.
subnet_ids
The associated subnet IDs. Type: list of strs of the subnet IDs
updated_at
Timestamp when the network was last updated.
is_vlan_transparent
Indicates the VLAN transparency mode of the network
openstack.network.v2.network_ip_availability
The NetworkIPAvailability Class
The NetworkIPAvailability class inherits from Resource.

class openstack.network.v2.network_ip_availability.NetworkIPAvailability(_synchroni
con-
nec-
tion=None
**at-
trs)
The base resource
Parameters


network_id
Network ID to use when listing network IP availability.
network_name
Network Name for the particular network IP availability.
subnet_ip_availability
The Subnet IP Availability of all subnets of a network. Type: list
project_id
The ID of the project this network IP availability is associated with.
total_ips
The total ips of a network. Type: int
used_ips
The used or consumed ip of a network Type: int
openstack.network.v2.network_segment_range
The NetworkSegmentRange Class
The NetworkSegmentRange class inherits from Resource.

class openstack.network.v2.network_segment_range.NetworkSegmentRange(_synchronized=F
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
name
The network segment range name.
default
The network segment range is loaded from the host configuration file. Type: bool
shared
The network segment range is shared with other projects. Type: bool

project_id
The ID of the project associated with this network segment range.
network_type
The type of network associated with this network segment range, such as geneve, gre,
vlan or vxlan.
physical_network
The name of the physical network associated with this network segment range.
minimum
The minimum segmentation ID for this network segment range. The network type defines
the segmentation model, VLAN ID for vlan network type and tunnel ID for geneve, gre
and vxlan network types. Type: int
maximum
The maximum segmentation ID for this network segment range. The network type defines
the segmentation model, VLAN ID for vlan network type and tunnel ID for geneve, gre
and vxlan network types. Type: int
used
Mapping of which segmentation ID in the range is used by which tenant. Type: dict
available
List of available segmentation IDs in this network segment range. Type: list
openstack.network.v2.pool
The Pool Class
The Pool class inherits from Resource.

class openstack.network.v2.pool.Pool(_synchronized=False, connection=None,
**attrs)
The base resource
Parameters
description
Description for the pool.
health_monitor_id
The ID of the associated health monitors.
health_monitor_ids
The ID of the associated health monitors (LBaaS v1).
health_monitor_status
The statuses of the associated health monitors.

is_admin_state_up
The administrative state of the pool, which is up True or down False. Type: bool
lb_algorithm
The load-balancer algorithm, which is round-robin, least-connections, and so on. This value,
which must be supported, is dependent on the load-balancer provider. Round-robin must be
supported.
listener_ids
List of associated listeners. Type: list of dicts which contain the listener IDs
listener_id
ID of listener associated with this pool
load_balancer_ids
List of associated load balancers. Type: list of dicts which contain the load balancer IDs
load_balancer_id
ID of load balancer associated with this pool
member_ids
List of members that belong to the pool. Type: list of dicts which contain the member IDs
name
Pool name. Does not have to be unique.
project_id
The ID of the project this pool is associated with.
protocol
The protocol of the pool, which is TCP, HTTP, or HTTPS.
provider
The provider name of the load balancer service.
status
Human readable description of the status.
status_description
The status of the network.
subnet_id
The subnet on which the members of the pool will be located.
session_persistence
Session persistence algorithm that should be used (if any). Type: dict with keys “type“ and
“cookie_name“
virtual_ip_id
The ID of the virtual IP (VIP) address.

openstack.network.v2.pool_member
The PoolMember Class
The PoolMember class inherits from Resource.

class openstack.network.v2.pool_member.PoolMember(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
pool_id
The ID of the owning pool
address
The IP address of the pool member.
is_admin_state_up
The administrative state of the pool member, which is up True or down False. Type: bool
name
Name of the pool member.
project_id
The ID of the project this pool member is associated with.
protocol_port
The port on which the application is hosted.
subnet_id
Subnet ID in which to access this pool member.
weight
A positive integer value that indicates the relative portion of traffic that this member should
receive from the pool. For example, a member with a weight of 10 receives five times as
much traffic as a member with weight of 2.

openstack.network.v2.port
The Port Class
The Port class inherits from Resource.

class openstack.network.v2.port.Port(_synchronized=False, connection=None,
**attrs)
The base resource
Parameters
allowed_address_pairs
Allowed address pairs.
binding_host_id
The ID of the host where the port is allocated. In some cases, different implementations can
run on different hosts.
binding_profile
A dictionary the enables the application running on the specified host to pass and receive vif
port-specific information to the plug-in. Type: dict
binding_vif_details
Read-only. A dictionary that enables the application to pass information about functions that
the Networking API provides. To enable or disable port filtering features such as security
group and anti-MAC/IP spoofing, specify port_filter: True or port_filter:
False. Type: dict
binding_vif_type
Read-only. The vif type for the specified port.
binding_vnic_type
The vnic type that is bound to the neutron port.
In POST and PUT operations, specify a value of normal (virtual nic), direct (pci
passthrough), or macvtap (virtual interface with a tap-like software interface). These val-
ues support SR-IOV PCI passthrough networking. The ML2 plug-in supports the vnic_type.
In GET operations, the binding:vnic_type extended attribute is visible to only port owners
and administrative users.
created_at
Timestamp when the port was created.
data_plane_status
Underlying data plane status of this port.
description
The port description.

device_id
Device ID of this port.
device_owner
Device owner of this port (e.g. network:dhcp).
dns_assignment
DNS assignment for the port.
dns_domain
DNS domain assigned to the port.
dns_name
DNS name for the port.
extra_dhcp_opts
Extra DHCP options.
fixed_ips
IP addresses for the port. Includes the IP address and subnet ID.
is_admin_state_up
The administrative state of the port, which is up True or down False. Type: bool
is_port_security_enabled
The port security status, which is enabled True or disabled False. Type: bool Default:
False
mac_address
The MAC address of an allowed address pair.
name
The port name.
network_id
The ID of the attached network.
numa_affinity_policy
The NUMA affinity policy defined for this port.
project_id
The ID of the project who owns the network. Only administrative users can specify a project
ID other than their own.
propagate_uplink_status
Whether to propagate uplink status of the port. Type: bool
qos_policy_id
The ID of the QoS policy attached to the port.
security_group_ids
The IDs of any attached security groups. Type: list of strs of the security group IDs
status
The port status. Value is ACTIVE or DOWN.
trunk_details
Read-only. The trunk referring to this parent port and its subports. Present for trunk
parent ports if trunk-details extension is loaded. Type: dict with keys: trunk_id,

sub_ports. sub_ports is a list of dicts with keys: port_id, segmentation_type, segmenta-

tion_id, mac_address
updated_at
Timestamp when the port was last updated.
openstack.network.v2.qos_bandwidth_limit_rule
The QoSBandwidthLimitRule Class
The QoSBandwidthLimitRule class inherits from Resource.

class openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule(_synchro
con-
nec-
tion=Non
**at-
trs)
The base resource
Parameters
qos_policy_id
The ID of the QoS policy who owns rule.
max_kbps
Maximum bandwidth in kbps.
max_burst_kbps
Maximum burst bandwidth in kbps.
direction
Traffic direction from the tenant point of view (egress, ingress).
openstack.network.v2.qos_dscp_marking_rule
The QoSDSCPMarkingRule Class
The QoSDSCPMarkingRule class inherits from Resource.

class openstack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule(_synchronized=Fa
con-
nec-
tion=None,
**at-
trs)

The base resource

Parameters
qos_policy_id
dscp_mark
DSCP mark field.
openstack.network.v2.qos_minimum_bandwidth_rule
The QoSMinimumBandwidthRule Class
The QoSMinimumBandwidthRule class inherits from Resource.

class openstack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule(_sy
con
nec
tion
**a
trs)
The base resource
Parameters
qos_policy_id
min_kbps
Minimum bandwidth in kbps.
direction
Traffic direction from the tenant point of view. Valid values: egress

openstack.network.v2.qos_policy
The QoSPolicy Class
The QoSPolicy class inherits from Resource.

class openstack.network.v2.qos_policy.QoSPolicy(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
name
QoS policy name.
project_id
The ID of the project who owns the network. Only administrative users can specify a project
ID other than their own.
description
The QoS policy description.
is_default
Indicates whether this QoS policy is the default policy for this project. Type: bool
is_shared
Indicates whether this QoS policy is shared across all projects. Type: bool
rules
List of QoS rules applied to this QoS policy.
set_tags(session, tags)
Sets/Replaces all tags on the resource.
Parameters
• tags (list) List with tags to be set on the resource

openstack.network.v2.qos_rule_type
The QoSRuleType Class
The QoSRuleType class inherits from Resource.

class openstack.network.v2.qos_rule_type.QoSRuleType(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
type
QoS rule type name.
drivers
List of QoS backend drivers supporting this QoS rule type
openstack.network.v2.quota
The Quota Class
The Quota class inherits from Resource.

class openstack.network.v2.quota.Quota(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
floating_ips
The maximum amount of floating IPs you can have. Type: int
health_monitors
The maximum amount of health monitors you can create. Type: int
listeners
The maximum amount of listeners you can create. Type: int

load_balancers
The maximum amount of load balancers you can create. Type: int
l7_policies
The maximum amount of L7 policies you can create. Type: int
networks
The maximum amount of networks you can create. Type: int
pools
The maximum amount of pools you can create. Type: int
ports
The maximum amount of ports you can create. Type: int
project_id
The ID of the project these quota values are for.
rbac_policies
The maximum amount of RBAC policies you can create. Type: int
routers
The maximum amount of routers you can create. Type: int
subnets
The maximum amount of subnets you can create. Type: int
subnet_pools
The maximum amount of subnet pools you can create. Type: int
The maximum amount of security group rules you can create. Type: int
security_groups
The maximum amount of security groups you can create. Type: int
openstack.network.v2.rbac_policy
The RBACPolicy Class
The RBACPolicy class inherits from Resource.

class openstack.network.v2.rbac_policy.RBACPolicy(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters

object_id
ID of the object that this RBAC policy affects.
target_project_id
The ID of the project this RBAC will be enforced.
project_id
The owner project ID.
object_type
Type of the object that this RBAC policy affects.
action
Action for the RBAC policy.
openstack.network.v2.router
The Router Class
The Router class inherits from Resource.

class openstack.network.v2.router.Router(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters
availability_zone_hints
Availability zone hints to use when scheduling the router. Type: list of availability zone
names
availability_zones
Availability zones for the router. Type: list of availability zone names
created_at
Timestamp when the router was created.
description
The router description.
external_gateway_info
The network_id, for the external gateway. Type: dict
flavor_id
The ID of the flavor.
is_admin_state_up
The administrative state of the router, which is up True or down False. Type: bool

is_distributed
The distributed state of the router, which is distributed True or not False. Type: bool
is_ha
The highly-available state of the router, which is highly available True or not False. Type:
bool
name
The router name.
project_id
The ID of the project this router is associated with.
revision_number
Revision number of the router. Type: int
routes
The extra routes configuration for the router.
status
The router status.
updated_at
Timestamp when the router was created.
add_interface(session, **body)
Add an internal interface to a logical router.
Parameters
• body (dict) The body requested to be updated on the router
Returns The body of the response as a dictionary.
remove_interface(session, **body)
Remove an internal interface from a logical router.
Parameters
add_extra_routes(session, body)
Add extra routes to a logical router.
Parameters
• body (dict) The request body as documented in the api-ref.
Returns The response as a Router object with the added extra routes.

remove_extra_routes(session, body)
Remove extra routes from a logical router.
Parameters
• body (dict) The request body as documented in the api-ref.
Returns The response as a Router object with the extra routes left.
add_gateway(session, **body)
Add an external gateway to a logical router.
Parameters
remove_gateway(session, **body)
Remove an external gateway from a logical router.
Parameters
openstack.network.v2.security_group
The SecurityGroup Class
The SecurityGroup class inherits from Resource.

class openstack.network.v2.security_group.SecurityGroup(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
created_at
Timestamp when the security group was created.

description
The security group description.
name
The security group name.
stateful
Whether the security group is stateful or not.
project_id
The ID of the project this security group is associated with.
A list of SecurityGroupRule objects. Type: list
tenant_id
The ID of the project this security group is associated with.
updated_at
Timestamp when the security group was last updated.
openstack.network.v2.security_group_rule
The SecurityGroupRule Class
The SecurityGroupRule class inherits from Resource.

class openstack.network.v2.security_group_rule.SecurityGroupRule(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
created_at
Timestamp when the security group rule was created.
description
The security group rule description.
direction
ingress or egress: The direction in which the security group rule is applied. For a
compute instance, an ingress security group rule is applied to incoming ingress traffic for
that instance. An egress rule is applied to traffic leaving the instance.

ether_type
Must be IPv4 or IPv6, and addresses represented in CIDR must match the ingress or egress
rules.
port_range_max
The maximum port number in the range that is matched by the security group rule. The
port_range_min attribute constrains the port_range_max attribute. If the protocol is ICMP,
this value must be an ICMP type.
port_range_min
The minimum port number in the range that is matched by the security group rule. If the pro-
tocol is TCP or UDP, this value must be less than or equal to the value of the port_range_max
attribute. If the protocol is ICMP, this value must be an ICMP type.
project_id
The ID of the project this security group rule is associated with.
protocol
The protocol that is matched by the security group rule. Valid values are null, tcp, udp,
and icmp.
remote_group_id
The remote security group ID to be associated with this security group rule. You can specify
either remote_group_id or remote_ip_prefix in the request body.
remote_ip_prefix
The remote IP prefix to be associated with this security group rule. You can specify ei-
ther remote_group_id or remote_ip_prefix in the request body. This attribute
matches the specified IP prefix as the source IP address of the IP packet.
security_group_id
The security group ID to associate with this security group rule.
tenant_id
The ID of the project this security group rule is associated with.
updated_at
Timestamp when the security group rule was last updated.
openstack.network.v2.segment
The Segment Class
The Segment class inherits from Resource.

class openstack.network.v2.segment.Segment(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters


description
The segment description.
name
The segment name.
network_id
The ID of the network associated with this segment.
network_type
The type of network associated with this segment, such as flat, geneve, gre, local,
vlan or vxlan.
physical_network
The name of the physical network associated with this segment.
segmentation_id
The segmentation ID for this segment. The network type defines the segmentation model,
VLAN ID for vlan network type and tunnel ID for geneve, gre and vxlan network
types. Type: int
openstack.network.v2.service_profile
The ServiceProfile Class
The ServiceProfile class inherits from Resource.

class openstack.network.v2.service_profile.ServiceProfile(_synchronized=False,
connec-
tion=None,
**attrs)
The base resource
Parameters
description
Description of the service flavor profile.
driver
Provider driver for the service flavor profile
is_enabled
Sets enabled flag
meta_info
Metainformation of the service flavor profile

project_id
The owner project ID
openstack.network.v2.service_provider
The Service Provider Class
The Service Provider class inherits from Resource.

class openstack.network.v2.service_provider.ServiceProvider(_synchronized=False,
con-
nec-
tion=None,
**at-
trs)
The base resource
Parameters
service_type
Service type (FIREWALL, FLAVORS, METERING, QOS, etc..)
name
Name of the service type
is_default
The default value of service type
openstack.network.v2.subnet
The Subnet Class
The Subnet class inherits from Resource.

class openstack.network.v2.subnet.Subnet(_synchronized=False, connec-
tion=None, **attrs)
The base resource
Parameters

allocation_pools
List of allocation pools each of which has a start and an end address for this subnet
cidr
The CIDR.
created_at
Timestamp when the subnet was created.
description
The subnet description.
dns_nameservers
A list of DNS nameservers.
dns_publish_fixed_ip
Whether to publish DNS records for fixed IPs
gateway_ip
The gateway IP address.
host_routes
A list of host routes.
ip_version
The IP version, which is 4 or 6. Type: int
ipv6_address_mode
The IPv6 address modes which are dhcpv6-stateful, dhcpv6-stateless or slaac.
ipv6_ra_mode
The IPv6 router advertisements modes which can be slaac, dhcpv6-stateful, dhcpv6-
stateless.
is_dhcp_enabled
Set to True if DHCP is enabled and False if DHCP is disabled. Type: bool
name
The subnet name.
network_id
The ID of the attached network.
prefix_length
The prefix length to use for subnet allocation from a subnet pool
project_id
The ID of the project this subnet is associated with.
segment_id
The ID of the segment this subnet is associated with.
service_types
Service types for this subnet
subnet_pool_id
The subnet pool ID from which to obtain a CIDR.
updated_at
Timestamp when the subnet was last updated.

use_default_subnet_pool
Whether to use the default subnet pool to obtain a CIDR.
openstack.network.v2.subnet_pool
The SubnetPool Class
The SubnetPool class inherits from Resource.

class openstack.network.v2.subnet_pool.SubnetPool(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
address_scope_id
The ID of the address scope associated with the subnet pool.
created_at
Timestamp when the subnet pool was created.
default_prefix_length
The length of the prefix to allocate when the cidr or prefixlen attributes are omitted when
creating a subnet. Type: int
default_quota
A per-project quota on the prefix space that can be allocated from the subnet pool for project
subnets. For IPv4 subnet pools, default_quota is measured in units of /32. For IPv6 subnet
pools, default_quota is measured units of /64. All projects that use the subnet pool have the
same prefix quota applied. Type: int
description
The subnet pool description.
ip_version
Read-only. The IP address family of the list of prefixes. Type: int
is_default
Whether or not this is the default subnet pool. Type: bool
is_shared
Indicates whether this subnet pool is shared across all projects. Type: bool
maximum_prefix_length
The maximum prefix length that can be allocated from the subnet pool. Type: int
minimum_prefix_length
The minimum prefix length that can be allocated from the subnet pool. Type: int

name
The subnet pool name.
project_id
The ID of the project that owns the subnet pool.
prefixes
A list of subnet prefixes that are assigned to the subnet pool. The adjacent prefixes are
merged and treated as a single prefix. Type: list
revision_number
Revision number of the subnet pool. Type: int
updated_at
Timestamp when the subnet pool was last updated.
Orchestration Resources
openstack.orchestration.v1.stack
The Stack Class
The Stack class inherits from Resource.

class openstack.orchestration.v1.stack.Stack(_synchronized=False, con-
The base resource
Parameters
capabilities
Placeholder for AWS compatible template listing capabilities required by the stack.
created_at
Timestamp of the stack creation.
description
A text description of the stack.
deleted
A list of resource objects that will be deleted if a stack update is performed.
deleted_at
Timestamp of the stack deletion.
environment
A JSON environment for the stack.

environment_files
An ordered list of names for environment files found in the files dict.
files
Additional files referenced in the template or the environment
files_container
Name of the container in swift that has child templates and environment files.
is_rollback_disabled
Whether the stack will support a rollback operation on stack create/update failures. Type:
bool
links
A list of dictionaries containing links relevant to the stack.
name
Name of the stack.
notification_topics
Placeholder for future extensions where stack related events can be published.
outputs
A list containing output keys and values from the stack, if any.
owner_id
The ID of the owner stack if any.
parameters
A dictionary containing the parameter names and values for the stack.
parent_id
The ID of the parent stack if any
replaced
A list of resource objects that will be replaced if a stack update is performed.
status
A string representation of the stack status, e.g. CREATE_COMPLETE.
status_reason
A text explaining how the stack transits to its current status.
tags
A list of strings used as tags on the stack
template
A dict containing the template use for stack creation.
template_description
Stack template description text. Currently contains the same text as that of the
description property.
template_url
A string containing the URL where a stack template can be found.
timeout_mins
Stack operation timeout in minutes.
unchanged
A list of resource objects that will remain unchanged if a stack update is performed.

updated
A list of resource objects that will have their properties updated in place if a stack update is
performed.
updated_at
Timestamp of last update on the stack.
user_project_id
The ID of the user project created for this stack.
Parameters
from base_path.
True.
Parameters
True.
update([E ], **F) → None. Update D from dict/iterable E and F.
If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] If E is present
and lacks a .keys() method, then does: for k, v in E: D[k] = v In either case, this is followed
by: for k in F: D[k] = F[k]
fetch(session, requires_id=True, base_path=None, error_message=None, re-
solve_outputs=True)

Parameters
from base_path.
True.
Parameters
fault is None.
matches.
openstack.orchestration.v1.resource
The Resource Class
The Resource class inherits from Resource.

class openstack.orchestration.v1.resource.Resource(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters


links
A list of dictionaries containing links relevant to the resource.
logical_resource_id
ID of the logical resource, usually the literal name of the resource as it appears in the stack
template.
name
Name of the resource.
physical_resource_id
ID of the physical resource (if any) that backs up the resource. For example, it contains a
nova server ID if the resource is a nova server.
required_by
A list of resource names that depend on this resource. This property facilitates the deduction
of resource dependencies. Type: list
resource_type
A string representation of the resource type.
status
A string representing the status the resource is currently in.
status_reason
A string that explains why the resource is in its current status.
updated_at
Timestamp of the last update made to the resource.
Object Store Resources
openstack.object_store.v1.account
The Account Class
The Account class inherits from Resource.

class openstack.object_store.v1.account.Account(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters


account_bytes_used
The total number of bytes that are stored in Object Storage for the account.
account_container_count
The number of containers.
account_object_count
The number of objects in the account.
meta_temp_url_key
The secret key value for temporary URLs. If not set, this header is not returned by this
operation.
meta_temp_url_key_2
A second secret key value for temporary URLs. If not set, this header is not returned by this
operation.
timestamp
The timestamp of the transaction.
set_temp_url_key(proxy, key, secondary=False)
Set the temporary url key for the account.
Parameters
• proxy (Proxy) The proxy to use for making this request.
• key Text of the key to use.
• secondary (bool) Whether this should set the secondary key. (defaults
to False)
openstack.object_store.v1.container
The Container Class
The Container class inherits from Resource.

class openstack.object_store.v1.container.Container(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters

name
The name of the container.
count
The number of objects in the container.
bytes
The total number of bytes that are stored in Object Storage for the container.
object_count
The number of objects.
bytes_used
The count of bytes used in total.
timestamp
is_newest
If set to True, Object Storage queries all replicas to return the most recent one. If you omit
this header, Object Storage responds faster after it finds one valid replica. Because setting
this header to True is more expensive for the back end, use it only when it is absolutely
needed. Type: bool
read_ACL
The ACL that grants read access. If not set, this header is not returned by this operation.
write_ACL
The ACL that grants write access. If not set, this header is not returned by this operation.
sync_to
The destination for container synchronization. If not set, this header is not returned by this
operation.
sync_key
The secret key for container synchronization. If not set, this header is not returned by this
operation.
versions_location
Enables versioning on this container. The value is the name of another container. You
must UTF-8-encode and then URL-encode the name before you include it in the header. To
disable versioning, set the header to an empty string.
content_type
The MIME type of the list of names.
is_content_type_detected
If set to true, Object Storage guesses the content type based on the file extension and ignores
the value sent in the Content-Type header, if present. Type: bool
if_none_match
In combination with Expect: 100-Continue, specify an If-None-Match: * header to query
whether the server already has a copy of the object before any data is sent.
meta_temp_url_key
The secret key value for temporary URLs. If not set, this header is not returned by this
operation.

meta_temp_url_key_2
A second secret key value for temporary URLs. If not set, this header is not returned by this
operation.
classmethod new(**kwargs)
Create a new instance of this resource.
When creating the instance set the _synchronized parameter of Resource to False
to indicate that the resource does not yet exist on the server side. This marks all attributes
passed in **kwargs as dirty on the resource, and thusly tracked as necessary in subsequent
calls such as update().
Parameters
True.
set_temp_url_key(proxy, key, secondary=False)
Set the temporary url key for a container.
Parameters
• proxy (Proxy) The proxy to use for making this request.
instance.
• key Text of the key to use.
• secondary (bool) Whether this should set the second key. (defaults to
False)
openstack.object_store.v1.obj
The Object Class
The Object class inherits from Resource.

class openstack.object_store.v1.obj.Object(data=None, **attrs)
The base resource
Parameters


container
The unique name for the container.
name
The unique name for the object.
is_newest
If set to True, Object Storage queries all replicas to return the most recent one. If you omit
this header, Object Storage responds faster after it finds one valid replica. Because setting
this header to True is more expensive for the back end, use it only when it is absolutely
needed. Type: bool
range
TODO(briancurtin) theres a lot of content here
if_match
See http://www.ietf.org/rfc/rfc2616.txt.
if_none_match
In combination with Expect: 100-Continue, specify an If-None-Match: * header to query
whether the server already has a copy of the object before any data is sent.
if_modified_since
if_unmodified_since
signature
Used with temporary URLs to sign the request. For more information about temporary
URLs, see OpenStack Object Storage API v1 Reference.
expires_at
Used with temporary URLs to specify the expiry time of the signature. For more information
about temporary URLs, see OpenStack Object Storage API v1 Reference.
multipart_manifest
If you include the multipart-manifest=get query parameter and the object is a large object, the
object contents are not returned. Instead, the manifest is returned in the X-Object-Manifest
response header for dynamic large objects or in the response body for static large objects.
content_length
HEAD operations do not return content. However, in this operation the value in the Content-
Length header is not the size of the response body. Instead it contains the size of the object,
in bytes.
content_type
The MIME type of the object.
accept_ranges
The type of ranges that the object accepts.
etag
For objects smaller than 5 GB, this value is the MD5 checksum of the object content. The

value is not quoted. For manifest objects, this value is the MD5 checksum of the concate-
nated string of MD5 checksums and ETags for each of the segments in the manifest, and
not the MD5 checksum of the content that was downloaded. Also the value is enclosed in
double-quote characters. You are strongly recommended to compute the MD5 checksum of
the response body as it is received and compare this value with the one in the ETag header.
If they differ, the content was corrupted, so retry the operation.
is_static_large_object
Set to True if this object is a static large object manifest object. Type: bool
content_encoding
If set, the value of the Content-Encoding metadata. If not set, this header is not returned by
this operation.
content_disposition
If set, specifies the override behavior for the browser. For example, this header might specify
that the browser use a download program to save this file rather than show the file, which is
the default. If not set, this header is not returned by this operation.
delete_after
Specifies the number of seconds after which the object is removed. Internally, the Object
Storage system stores this value in the X-Delete-At metadata item.
delete_at
If set, the time when the object will be deleted by the system in the format of a UNIX Epoch
timestamp. If not set, this header is not returned by this operation.
object_manifest
If set, to this is a dynamic large object manifest object. The value is the container and object
name prefix of the segment objects in the form container/prefix.
timestamp
last_modified_at
The date and time that the object was created or the last time that the metadata was changed.
transfer_encoding
Set to chunked to enable chunked transfer encoding. If used, do not set the Content-Length
header to a non-zero value.
is_content_type_detected
If set to true, Object Storage guesses the content type based on the file extension and ignores
the value sent in the Content-Type header, if present. Type: bool
copy_from
If set, this is the name of an object used to create the new object by copying the X-Copy-
From object. The value is in form {container}/{object}. You must UTF-8-encode and then
URL-encode the names of the container and object before you include them in the header.
Using PUT with X-Copy-From has the same effect as using the COPY operation to copy an
object.
Parameters


from base_path.
True.
Object Store Resources
openstack.workflow.v2.execution
The Execution Class
The Execution class inherits from Resource.

class openstack.workflow.v2.execution.Execution(_synchronized=False,
connection=None,
**attrs)
The base resource
Parameters
workflow_name
The name of the workflow
workflow_id
The ID of the workflow
description
A description of the workflow execution
task_execution_id
A reference to the parent task execution
status
Status can be one of: IDLE, RUNNING, SUCCESS, ERROR, or PAUSED
status_info
An optional information string about the status
params
An optional JSON structure containing workflow type specific parameters

output
The output of the workflow
created_at
The time at which the Execution was created
updated_at
The time at which the Execution was updated
Parameters
from base_path.
True.
openstack.workflow.v2.workflow
The Workflow Class
The Workflow class inherits from Resource.

class openstack.workflow.v2.workflow.Workflow(_synchronized=False, con-
The base resource
Parameters
name
The name of this Workflow
input
The inputs for this Workflow
definition
A Workflow definition using the Mistral v2 DSL

scope
Can be either private or public
project_id
The ID of the associated project
created_at
The time at which the workflow was created
updated_at
The time at which the workflow was created
Parameters
from base_path.
True.
Low-Level Classes
The following classes are not commonly used by application developers, but are used to construct appli-
cations to talk to OpenStack APIs. Typically these parts are managed through the Connection Interface,
but their use can be customized.
Note: This class is in the process of being applied as the new base class for resources around the
OpenStack SDK. Once that has been completed, this module will be drop the 2 suffix and be the
only resource module.
Resource
The Resource class is a base class that represent a remote resource. The attributes that comprise a
request or response for this resource are specified as class members on the Resource subclass where their
values are of a component type, including Body, Header, and URI.
For update management, Resource employs a series of _ComponentManager instances to look
after the attributes of that particular component type. This is particularly useful for Body and Header
types, so that only the values necessary are sent in requests to the server.
When making requests, each of the managers are looked at to gather the necessary URI, body, and
header data to build a request to be sent via keystoneauths sessions. Responses from keystoneauth are
then converted into this Resource class appropriate components and types and then returned to the caller.

Components
class openstack.resource.Body(name, type=None, default=None, alias=None,

aka=None, alternate_id=False, list_type=None, co-
erce_to_default=False, deprecated=False, depreca-
tion_reason=None, **kwargs)
Body attributes
A typed descriptor for a component that makes up a Resource
Parameters
• name The name this component exists as on the server
• type The type this component is expected to be by the server. By default this
is None, meaning any value you specify will work. If you specify type=dict
and then set a component to a string, __set__ will fail, for example.
• default Typically None, but any other default can be set.
• alias If set, alternative attribute on object to return.
• aka If set, additional name attribute would be available under.
• alternate_id When True, this property is known internally as a value
that can be sent with requests that require an ID but when id is not a name
the Resource has. This is a relatively uncommon case, and this setting should
only be used once per Resource.
• list_type If type is list, list_type designates what the type of the elements
of the list should be.
• coerce_to_default If the Component is None or not present, force the
given default to be used. If a default is not given but a type is given, construct
an empty version of the type in question.
• deprecated Indicates if the option is deprecated. If it is, we display a
warning message to the user.
• deprecation_reason Custom deprecation message.
class openstack.resource.Header(name, type=None, default=None, alias=None,
aka=None, alternate_id=False, list_type=None,
coerce_to_default=False, deprecated=False,
deprecation_reason=None, **kwargs)
Header attributes
Parameters


class openstack.resource.URI(name, type=None, default=None, alias=None,
aka=None, alternate_id=False, list_type=None,
coerce_to_default=False, deprecated=False, depre-
cation_reason=None, **kwargs)
URI attributes
Parameters

The Resource class
class openstack.resource.Resource(_synchronized=False, connection=None,

**attrs)
The base resource
Parameters
resource_key = None
Singular form of key for resource.
resources_key = None
Plural form of key for resource.
pagination_key = None
Key used for pagination links
id
The ID of this resource.
name
The name of this resource.
location
The OpenStack location of this resource.
base_path = ''
The base part of the URI for this resource.
service = None
The service associated with this resource to find the service URL.
allow_create = False
Allow create operation for this resource.
allow_fetch = False
Allow get operation for this resource.
allow_commit = False
Allow update operation for this resource.
allow_delete = False
Allow delete operation for this resource.
allow_list = False
Allow list operation for this resource.
allow_head = False
Allow head operation for this resource.
allow_patch = False
Allow patch operation for this resource.

allow_empty_commit = False
Commits happen without header or body being dirty.
commit_method = 'PUT'
Method for committing a resource (PUT, PATCH, POST)
create_method = 'POST'
Method for creating a resource (POST, PUT)
commit_jsonpatch = False
Whether commit uses JSON patch format.
requires_id = True
Do calls for this resource require an id
create_requires_id = None
Whether create requires an ID (determined from method if None).
create_exclude_id_from_body = False
Whether create should exclude ID in the body of the request.
has_body = True
Do responses for this resource have bodies
create_returns_body = None
Does create returns a body (if False requires ID), defaults to has_body
microversion = None
API microversion (string or None) this Resource was loaded with
keys() → a set-like object providing a view on Ds keys
items() → a set-like object providing a view on Ds items
classmethod new(**kwargs)
Create a new instance of this resource.
When creating the instance set the _synchronized parameter of Resource to False
to indicate that the resource does not yet exist on the server side. This marks all attributes
passed in **kwargs as dirty on the resource, and thusly tracked as necessary in subsequent
calls such as update().
classmethod existing(connection=None, **kwargs)
Create an instance of an existing remote resource.
When creating the instance set the _synchronized parameter of Resource to True to
indicate that it represents the state of an existing server-side resource. As such, all attributes
passed in **kwargs are considered clean, such that an immediate update() call would
not generate a body of attributes to be modified on the server.
to_dict(body=True, headers=True, computed=True, ignore_none=False, origi-
nal_names=False, _to_munch=False)
Return a dictionary of this resources contents
Parameters

• body (bool) Include the Body attributes in the returned dictionary.

• headers (bool) Include the Header attributes in the returned dictio-
nary.
• computed (bool) Include the Computed attributes in the returned dic-
tionary.
• ignore_none (bool) When True, exclude key/value pairs where the
value is None. This will exclude attributes that the server hasnt returned.
• original_names (bool) When True, use attribute names as they were
received from the server.
• _to_munch (bool) For internal use only. Converts to munch.Munch in-
stead of dict.
Returns A dictionary of key/value pairs where keys are named as they exist as
attributes of this class.
toDict(body=True, headers=True, computed=True, ignore_none=False, origi-
Parameters
nary.
tionary.
stead of dict.
copy(body=True, headers=True, computed=True, ignore_none=False, origi-
Parameters
nary.
tionary.


stead of dict.
create(session, prepend_key=True, base_path=None, **params)
Parameters
from base_path.
True.
classmethod bulk_create(session, data, prepend_key=True, base_path=None,
**params)
Create multiple remote resources based on this class and data.
Parameters
• data list of dicts, which represent resources to create.
from base_path.
True.
fetch(session, requires_id=True, base_path=None, error_message=None, **params)
Parameters

from base_path.
True.
head(session, base_path=None)
Get headers from a remote resource based on this instance.
Parameters
from base_path.
Raises MethodNotSupported if Resource.allow_head is not set to
True.
property requires_commit
Whether the next commit() call will do anything.
commit(session, prepend_key=True, has_body=True, retry_on_conflict=None,
base_path=None, **kwargs)
Parameters
True.
retry_on_conflict=None, base_path=None)

Parameters
True.
delete(session, error_message=None, **kwargs)
Delete the remote resource based on this instance.
Parameters
True.
classmethod list(session, paginated=True, base_path=None, al-
low_unknown_params=False, **params)
filtering.
Parameters
from base_path.


True.
Parameters
fault is None.
matches.
ServiceDescription
ServiceDescription object
class openstack.service_description.ServiceDescription(service_type,
sup-
ported_versions=None,
aliases=None)
Class describing how to interact with a REST service.
Each service in an OpenStack cloud needs to be found by looking for it in the catalog. Once the
endpoint is found, REST calls can be made, but a Proxy class and some Resource objects are
needed to provide an object interface.

Instances of ServiceDescription can be passed to openstack.connection.Connection.add_service,

or a list can be passed to the openstack.connection.Connection constructor in the
extra_services argument.
All three parameters can be provided at instantation time, or a service-specific subclass can be
used that sets the attributes directly.
Parameters
• service_type (string) service_type to look for in the keystone catalog
• aliases (list) Optional list of aliases, if there is more than one name that
might be used to register the service in the catalog.
service_type = None
main service_type to use to find this service in the catalog
supported_versions = None
Dictionary of supported versions and proxy classes for that version
aliases = []
list of aliases this service might be registered as
Utilities
2.2 Presentations
2.2.1 Multi-Cloud Demo
This document contains a presentation in presentty format. If you want to walk through it like a presen-
tation, install presentty and run:
presentty doc/source/user/multi-cloud-demo.rst
The content is hopefully helpful even if its not being narrated, so its being included in the shade docs.
Using Multiple OpenStack Clouds Easily with Shade
Who am I?
Monty Taylor
• OpenStack Infra Core
• irc: mordred
• twitter: @e_monty
2.2. Presentations 535

What are we going to talk about?
shade
• a task and end-user oriented Python library
• abstracts deployment differences
• designed for multi-cloud
• simple to use
• massive scale
– optional advanced features to handle 20k servers a day
• Initial logic/design extracted from nodepool
• Librified to re-use in Ansible
shade is Free Software
• https://opendev.org/openstack/shade
• [email protected]
• #openstack-shade on freenode
This talk is Free Software, too
• Written for presentty (https://pypi.org/project/presentty)

• doc/source/multi-cloud-demo.rst
• examples in doc/source/examples
• Paths subject to change- this is the first presentation in tree!
Complete Example
from openstack import cloud as openstack
# Initialize and turn on debug logging

openstack.enable_logging(debug=True)
for cloud_name, region_name in [

('my-vexxhost', 'ca-ymq-1'),
('my-citycloud', 'Buf1'),
('my-internap', 'ams01')]:
# Initialize cloud
cloud = openstack.connect(cloud=cloud_name, region_name=region_name)
# Upload an image to the cloud

image = cloud.create_image(
'devuan-jessie', filename='devuan-jessie.qcow2', wait=True)
# Find a flavor with at least 512M of RAM



flavor = cloud.get_flavor_by_ram(512)
# Boot a server, wait for it to boot, and then do whatever is needed

# to get a public ip for it.
cloud.create_server(
'my-server', image=image, flavor=flavor, wait=True, auto_ip=True)
Lets Take a Few Steps Back
Multi-cloud is easy, but you need to know a few things.

• Terminology
• Config
• Shade API
Cloud Terminology
Lets define a few terms, so that we can use them with ease:
• cloud - logically related collection of services
• region - completely independent subset of a given cloud
• patron - human who has an account
• user - account on a cloud
• project - logical collection of cloud resources
• domain - collection of users and projects
Cloud Terminology Relationships
• A cloud has one or more regions

• A patron has one or more users
• A patron has one or more projects
• A cloud has one or more domains
• In a cloud with one domain it is named default
• Each patron may have their own domain
• Each user is in one domain
• Each project is in one domain
• A user has one or more roles on one or more projects

HTTP Sessions
• HTTP interactions are authenticated via keystone

• Authenticating returns a token
• An authenticated HTTP Session is shared across a region
Cloud Regions
A cloud region is the basic unit of REST interaction.

• A cloud has a service catalog
• The service catalog is returned in the token
• The service catalog lists endpoint for each service in each region
• A region is completely autonomous
Users, Projects and Domains
In clouds with multiple domains, project and user names are only unique within a region.
• Names require domain information for uniqueness. IDs do not.
• Providing domain information when not needed is fine.
• project_name requires project_domain_name or project_domain_id
• project_id does not
• username requires user_domain_name or user_domain_id
• user_id does not
Confused Yet?
Dont worry - you dont have to deal with most of that.
Auth per cloud, select per region
In general, the thing you need to know is:

• Configure authentication per cloud
• Select config to use by cloud and region

clouds.yaml
Information about the clouds you want to connect to is stored in a file called clouds.yaml.
clouds.yaml can be in your homedir: ~/.config/openstack/clouds.yaml or system-wide:
/etc/openstack/clouds.yaml.
Information in your homedir, if it exists, takes precedence.
Full docs on clouds.yaml are at https://docs.openstack.org/os-client-config/latest/
What about Mac and Windows?
USER_CONFIG_DIR is different on Linux, OSX and Windows.

• Linux: ~/.config/openstack
• OSX: ~/Library/Application Support/openstack
• Windows: C:\Users\USERNAME\AppData\Local\OpenStack\openstack
SITE_CONFIG_DIR is different on Linux, OSX and Windows.
• Linux: /etc/openstack
• OSX: /Library/Application Support/openstack
• Windows: C:\ProgramData\OpenStack\openstack
Config Terminology
For multi-cloud, think of two types:

• profile - Facts about the cloud that are true for everyone
• cloud - Information specific to a given user
Apologies for the use of cloud twice.
Environment Variables and Simple Usage
• Environment variables starting with OS_ go into a cloud called envvars

• If you only have one cloud, you dont have to specify it
• OS_CLOUD and OS_REGION_NAME are default values for cloud and region_name

TOO MUCH TALKING - NOT ENOUGH CODE
basic clouds.yaml for the example code
Simple example of a clouds.yaml

• Config for a named cloud my-citycloud
• Reference a well-known named profile: citycloud
• os-client-config has a built-in list of profiles at https://docs.openstack.org/openstacksdk/latest/
user/config/vendor-support.html
• Vendor profiles contain various advanced config
• cloud name can match profile name (using different names for clarity)
clouds:
my-citycloud:
profile: citycloud
auth:
username: mordred
project_id: 65222a4d09ea4c68934fa1028c77f394
user_domain_id: d0919bd5e8d74e49adf0e145807ffc38
project_domain_id: d0919bd5e8d74e49adf0e145807ffc38
Wheres the password?
secure.yaml
• Optional additional file just like clouds.yaml

• Values overlaid on clouds.yaml
• Useful if you want to protect secrets more stringently
Example secure.yaml
• No, my password isnt XXXXXXXX

• cloud name should match clouds.yaml
• Optional - I actually keep mine in my clouds.yaml
clouds:
my-citycloud:
auth:
password: XXXXXXXX

more clouds.yaml
More information can be provided.

• Use v3 of the identity API - even if others are present
• Use https://image-ca-ymq-1.vexxhost.net/v2 for image API instead of whats in the catalog
my-vexxhost:
identity_api_version: 3
image_endpoint_override: https://image-ca-ymq-1.vexxhost.net/v2
profile: vexxhost
auth:
user_domain_id: default
project_domain_id: default
project_name: d8af8a8f-a573-48e6-898a-af333b970a2d
username: 0b8c435b-cc4d-4e05-8a47-a2ada0539af1
Much more complex clouds.yaml example
• Not using a profile - all settings included

• In the ams01 region there are two networks with undiscoverable qualities
• Each one are labeled here so choices can be made
• Any of the settings can be specific to a region if needed
• region settings override cloud settings
• cloud does not support floating-ips
my-internap:
auth:
auth_url: https://identity.api.cloud.iweb.com
identity_api_version: 3
floating_ip_source: None
regions:
- name: ams01
values:
networks:
default_interface: true

Complete Example Again


# Initialize cloud



Step By Step
Import the library
Logging
• openstacksdk uses standard python logging

• openstack.enable_logging does easy defaults
• Squelches some meaningless warnings
– debug
* Logs shade loggers at debug level

– http_debug Implies debug, turns on HTTP tracing


Example with Debug Logging
• doc/source/examples/debug-logging.py

cloud = openstack.connect(
cloud='my-vexxhost', region_name='ca-ymq-1')
cloud.get_image('Ubuntu 16.04.1 LTS [2017-03-03]')
Example with HTTP Debug Logging
• doc/source/examples/http-debug-logging.py

openstack.enable_logging(http_debug=True)
cloud='my-vexxhost', region_name='ca-ymq-1')
cloud.get_image('Ubuntu 16.04.1 LTS [2017-03-03]')
Cloud Regions
• cloud constructor needs cloud and region_name

• openstack.connect is a helper factory function

# Initialize cloud
Upload an Image
• Picks the correct upload mechanism

• SUGGESTION Always upload your own base images


Always Upload an Image
Ok. You dont have to. But, for multi-cloud

• Images with same content are named different on different clouds
• Images with same name on different clouds can have different content
• Upload your own to all clouds, both problems go away
• Download from OS vendor or build with diskimage-builder
Find a flavor
• Flavors are all named differently on clouds

• Flavors can be found via RAM
• get_flavor_by_ram finds the smallest matching flavor

Create a server
• my-vexxhost
– Boot server
– Wait for status==ACTIVE
• my-internap
– Boot server on network inap-17037-WAN1654
• my-citycloud
– Boot server
– Find the port for the fixed_ip for server
– Create floating-ip on that port
– Wait for floating-ip to attach


Wow. We didnt even deploy Wordpress!
Image and Flavor by Name or ID
• Pass string to image/flavor

• Image/Flavor will be found by name or ID
• Common pattern
• doc/source/examples/create-server-name-or-id.py

for cloud_name, region_name, image, flavor in [

('my-vexxhost', 'ca-ymq-1',
'Ubuntu 16.04.1 LTS [2017-03-03]', 'v1-standard-4'),
('my-citycloud', 'Buf1',
'Ubuntu 16.04 Xenial Xerus', '4C-4GB-100GB'),
('my-internap', 'ams01',
'Ubuntu 16.04 LTS (Xenial Xerus)', 'A1.4')]:
# Initialize cloud

server = cloud.create_server(
print(server.name)
print(server['name'])
cloud.pprint(server)
# Delete it - this is a demo
cloud.delete_server(server, wait=True, delete_ips=True)
cloud.pprint method was just added this morning
Delete Servers
• delete_ips Delete any floating_ips the server may have
cloud.delete_server('my-server', wait=True, delete_ips=True)

Image and Flavor by Dict
• Pass dict to image/flavor

• If you know if the value is Name or ID
• Common pattern
• doc/source/examples/create-server-dict.py

for cloud_name, region_name, image, flavor_id in [

('my-vexxhost', 'ca-ymq-1', 'Ubuntu 16.04.1 LTS [2017-03-03]',
'5cf64088-893b-46b5-9bb1-ee020277635d'),
('my-citycloud', 'Buf1', 'Ubuntu 16.04 Xenial Xerus',
'0dab10b5-42a2-438e-be7b-505741a7ffcc'),
('my-internap', 'ams01', 'Ubuntu 16.04 LTS (Xenial Xerus)',
'A1.4')]:
# Initialize cloud

'my-server', image=image, flavor=dict(id=flavor_id),
wait=True, auto_ip=True)
Munch Objects
• Behave like a dict and an object

• doc/source/examples/munch-dict-object.py

cloud = openstack.connect(cloud='zetta', region_name='no-osl1')

image = cloud.get_image('Ubuntu 14.04 (AMD64) [Local Storage]')
print(image.name)
print(image['name'])

API Organized by Logical Resource
• list_servers
• search_servers
• get_server
• create_server
• delete_server
• update_server
For other things, its still {verb}_{noun}
• attach_volume
• wait_for_server
• add_auto_ip
Cleanup Script
• Sometimes my examples had bugs

• doc/source/examples/cleanup-servers.py


# Initialize cloud
for server in cloud.search_servers('my-server'):
Normalization
• https://docs.openstack.org/shade/latest/user/model.html#image
• doc/source/examples/normalization.py

cloud = openstack.connect(cloud='fuga', region_name='cystack')

image = cloud.get_image(
'Ubuntu 16.04 LTS - Xenial Xerus - 64-bit - Fuga Cloud Based Image')
cloud.pprint(image)

Strict Normalized Results
• Return only the declared model

• doc/source/examples/strict-mode.py

cloud='fuga', region_name='cystack', strict=True)
image = cloud.get_image(
'Ubuntu 16.04 LTS - Xenial Xerus - 64-bit - Fuga Cloud Based Image')
cloud.pprint(image)
How Did I Find the Image Name for the Last Example?
• I often make stupid little utility scripts

• doc/source/examples/find-an-image.py

cloud = openstack.connect(cloud='fuga', region_name='cystack')

cloud.pprint([
image for image in cloud.list_images()
if 'ubuntu' in image.name.lower()])
Added / Modified Information
• Servers need more extra help

• Fetch addresses dict from neutron
• Figure out which IPs are good
• detailed - defaults to True, add everything
• bare - no extra calls - dont even fix broken things
• bare is still normalized
• doc/source/examples/server-information.py

cloud = openstack.connect(cloud='my-citycloud', region_name='Buf1')

try:
'my-server', image='Ubuntu 16.04 Xenial Xerus',
flavor=dict(id='0dab10b5-42a2-438e-be7b-505741a7ffcc'),
wait=True, auto_ip=True)
print("\n\nFull Server\n\n")


cloud.pprint(server)
print("\n\nTurn Detailed Off\n\n")

cloud.pprint(cloud.get_server('my-server', detailed=False))
print("\n\nBare Server\n\n")
cloud.pprint(cloud.get_server('my-server', bare=True))
finally:
Exceptions
• All shade exceptions are subclasses of OpenStackCloudException

• Direct REST calls throw OpenStackCloudHTTPError
• OpenStackCloudHTTPError subclasses OpenStackCloudException and re-
quests.exceptions.HTTPError
• OpenStackCloudURINotFound for 404
• OpenStackCloudBadRequest for 400
User Agent Info
• Set app_name and app_version for User Agents

• (sssh region_name is optional if the cloud has one region)
• doc/source/examples/user-agent.py

openstack.enable_logging(http_debug=True)
cloud='datacentred', app_name='AmazingApp', app_version='1.0')
cloud.list_networks()
Uploading Large Objects
• swift has a maximum object size

• Large Objects are uploaded specially
• shade figures this out and does it
• multi-threaded
• doc/source/examples/upload-object.py


cloud = openstack.connect(cloud='ovh', region_name='SBG1')

cloud.create_object(
container='my-container', name='my-object',
filename='/home/mordred/briarcliff.sh3d')
cloud.delete_object('my-container', 'my-object')
cloud.delete_container('my-container')
Uploading Large Objects
• Default max_file_size is 5G
• This is a conference demo
• Lets force a segment_size
• One MILLION bytes
• doc/source/examples/upload-object.py

cloud = openstack.connect(cloud='ovh', region_name='SBG1')

cloud.create_object(
container='my-container', name='my-object',
filename='/home/mordred/briarcliff.sh3d',
segment_size=1000000)
cloud.delete_object('my-container', 'my-object')
cloud.delete_container('my-container')
Service Conditionals

cloud = openstack.connect(cloud='kiss', region_name='region1')

print(cloud.has_service('network'))
print(cloud.has_service('container-orchestration'))
Service Conditional Overrides
• Sometimes clouds are weird and figuring that out wont work

cloud = openstack.connect(cloud='rax', region_name='DFW')

print(cloud.has_service('network'))

clouds:
rax:
profile: rackspace
auth:
username: mordred
project_id: 245018
# This is already in profile: rackspace
has_network: false
Coming Soon
• Completion of RESTification
• Full version discovery support
• Multi-cloud facade layer
• Microversion support (talk tomorrow)
• Completion of caching tier (talk tomorrow)
• All of you helping hacking on shade!!! (were friendly)


CHAPTER
THREE
FOR CONTRIBUTORS
3.1 Contributing to the OpenStack SDK
This section of documentation pertains to those who wish to contribute to the development of this SDK.
If youre looking for documentation on how to use the SDK to build applications, please see the user
section.
3.1.1 About the Project
The OpenStack SDK is a OpenStack project aimed at providing a complete software development kit
for the programs which make up the OpenStack community. It is a Python library with corresponding
documentation, examples, and tools released under the Apache 2 license.
A Brief History
openstacksdk started its life as three different libraries: shade, os-client-config and python-openstacksdk.
shade started its life as some code inside of OpenStack Infras nodepool project, and as some code
inside of the Ansible OpenStack Modules. Ansible had a bunch of different OpenStack related modules,
and there was a ton of duplicated code. Eventually, between refactoring that duplication into an internal
library, and adding the logic and features that the OpenStack Infra team had developed to run client
applications at scale, it turned out that wed written nine-tenths of what wed need to have a standalone
library.
Because of its background from nodepool, shade contained abstractions to work around deployment
differences and is resource oriented rather than service oriented. This allows a user to think about
Security Groups without having to know whether Security Groups are provided by Nova or Neutron
on a given cloud. On the other hand, as an interface that provides an abstraction, it deviates from the
published OpenStack REST API and adds its own opinions, which may not get in the way of more
advanced users with specific needs.
os-client-config was a library for collecting client configuration for using an OpenStack cloud
in a consistent and comprehensive manner, which introduced the clouds.yaml file for expressing
named cloud configurations.
python-openstacksdk was a library that exposed the OpenStack APIs to developers in a consistent
and predictable manner.
After a while it became clear that there was value in both the high-level layer that contains additional
business logic and the lower-level SDK that exposes services and their resources faithfully and consis-
tently as Python objects.
553
Even with both of those layers, it is still beneficial at times to be able to make direct REST calls and to
do so with the same properly configured Session from python-requests.
This led to the merge of the three projects.
The original contents of the shade library have been moved into openstack.cloud and os-client-
config has been moved in to openstack.config.
3.1.2 Contribution Mechanics
Contributing to openstacksdk
If youre interested in contributing to the openstacksdk project, the following will help get you started.
Contributor License Agreement
In order to contribute to the openstacksdk project, you need to have signed OpenStacks contributors
agreement.
Please read DeveloperWorkflow before sending your first patch for review. Pull requests submitted
through GitHub will be ignored.
See also:
• https://wiki.openstack.org/wiki/How_To_Contribute
• https://wiki.openstack.org/wiki/CLA
Project Hosting Details
Project Documentation https://docs.openstack.org/openstacksdk/latest/

Bug tracker https://storyboard.openstack.org/#!/project/openstack/openstacksdk
Mailing list (prefix subjects with [sdk] for faster responses) http://lists.openstack.org/cgi-bin/
mailman/listinfo/openstack-discuss
Code Hosting https://opendev.org/openstack/openstacksdk
Code Review https://review.opendev.org/#/q/status:open+project:openstack/openstacksdk,n,z
3.1.3 Contacting the Developers
IRC
The developers of this project are available in the #openstack-sdks channel on Freenode. This channel
includes conversation on SDKs and tools within the general OpenStack community, including Open-
StackClient as well as occasional talk about SDKs created for languages outside of Python.
554 Chapter 3. For Contributors

Email
The openstack-discuss mailing list fields questions of all types on OpenStack. Using the [sdk] filter
to begin your email subject will ensure that the message gets to SDK developers.
3.1.4 Coding Standards
We are a bit stricter than usual in the coding standards department. Its a good idea to read through the
coding section.
OpenStack SDK Developer Coding Standards
In the beginning, there were no guidelines. And it was good. But that didnt last long. As more and more
people added more and more code, we realized that we needed a set of coding standards to make sure
that the openstacksdk API at least attempted to display some form of consistency.
Thus, these coding standards/guidelines were developed. Note that not all of openstacksdk adheres to
these standards just yet. Some older code has not been updated because we need to maintain backward
compatibility. Some of it just hasnt been changed yet. But be clear, all new code must adhere to these
guidelines.
Below are the patterns that we expect openstacksdk developers to follow.
Release Notes
openstacksdk uses reno for managing its release notes. A new release note should be added to your
contribution anytime you add new API calls, fix significant bugs, add new functionality or parameters to
existing API calls, or make any other significant changes to the code base that we should draw attention
to for the user base.
It is not necessary to add release notes for minor fixes, such as correction of documentation typos, minor
code cleanup or reorganization, or any other change that a user would not notice through normal usage.
Exceptions
Exceptions should NEVER be wrapped and re-raised inside of a new exception. This removes important
debug information from the user. All of the exceptions should be raised correctly the first time.
openstack.cloud API Methods
The openstack.cloud layer has some specific rules:

• When an API call acts on a resource that has both a unique ID and a name, that API call should
accept either identifier with a name_or_id parameter.
• All resources should adhere to the get/list/search interface that control retrieval of those resources.
E.g., get_image(), list_images(), search_images().
• Resources should have create_RESOURCE(), delete_RESOURCE(), update_RESOURCE() API
methods (as it makes sense).
3.1. Contributing to the OpenStack SDK 555

• For those methods that should behave differently for omitted or None-valued parameters, use the
_utils.valid_kwargs decorator. Notably: all Neutron update_* functions.
• Deleting a resource should return True if the delete succeeded, or False if the resource was not
found.
Returned Resources
Complex objects returned to the caller must be a munch.Munch type. The open-
stack.proxy._ShadeAdapter class makes resources into munch.Munch.
All objects should be normalized. It is shades purpose in life to make OpenStack consistent for end
users, and this means not trusting the clouds to return consistent objects. There should be a normalize
function in openstack/cloud/_normalize.py that is applied to objects before returning them to the user.
See Data Model for further details on object model requirements.
Fields should not be in the normalization contract if we cannot commit to providing them to all users.
Fields should be renamed in normalization to be consistent with the rest of openstack.cloud. For in-
stance, nothing in openstack.cloud exposes the legacy OpenStack concept of tenant to a user, but instead
uses project even if the cloud in question uses tenant.
Nova vs. Neutron
• Recognize that not all cloud providers support Neutron, so never assume it will be present. If a
task can be handled by either Neutron or Nova, code it to be handled by either.
• For methods that accept either a Nova pool or Neutron network, the parameter should just refer to
the network, but documentation of it should explain about the pool. See: create_floating_ip() and
available_floating_ip() methods.
Tests
• New API methods must have unit tests!

• New unit tests should only mock at the REST layer using requests_mock. Any mocking of open-
stacksdk itself should be considered legacy and to be avoided. Exceptions to this rule can be made
when attempting to test the internals of a logical shim where the inputs and output of the method
arent actually impacted by remote content.
• Functional tests should be added, when possible.
• In functional tests, always use unique names (for resources that have this attribute) and use it for
clean up (see next point).
• In functional tests, always define cleanup functions to delete data added by your test, should
something go wrong. Data removal should be wrapped in a try except block and try to delete as
many entries added by the test as possible.

3.1.5 Development Environment
The first step towards contributing code and documentation is to setup your development environment.
We use a pretty standard setup, but it is fully documented in our setup section.
Creating a Development Environment
Required Tools
Python
As the OpenStack SDK is developed in Python, you will need at least one version of Python installed.
It is strongly preferred that you have at least one of version 2 and one of version 3 so that your tests
are run against both. Our continuous integration system runs against several versions, so ultimately we
will have the proper test coverage, but having multiple versions locally results in less time spent in code
review when changes unexpectedly break other versions.
Python can be downloaded from https://www.python.org/downloads.
virtualenv
In order to isolate our development environment from the system-based Python installation, we use
virtualenv. This allows us to install all of our necessary dependencies without interfering with anything
else, and preventing others from interfering with us. Virtualenv must be installed on your system in
order to use it, and it can be had from PyPI, via pip, as follows. Note that you may need to run this as an
administrator in some situations.:
$ apt-get install python-virtualenv # Debian based platforms

$ yum install python-virtualenv # Red Hat based platforms
$ pip install virtualenv # Mac OS X and other platforms
You can create a virtualenv in any location. A common usage is to store all of your virtualenvs in the
same place, such as under your home directory. To create a virtualenv for the default Python, run the
following:
$ virtualenv $HOME/envs/sdk
To create an environment for a different version, run the following:
$ virtualenv -p python3.8 $HOME/envs/sdk3
When you want to enable your environment so that you can develop inside of it, you activate it. To
activate an environment, run the /bin/activate script inside of it, like the following:
$ source $HOME/envs/sdk3/bin/activate
(sdk3)$
Once you are activated, you will see the environment name in front of your command prompt. In order
to exit that environment, run the deactivate command.

tox
We use tox as our test runner, which allows us to run the same test commands against multiple versions
of Python. Inside any of the virtualenvs you use for working on the SDK, run the following to install
tox into it.:
(sdk3)$ pip install tox
Git
The source of the OpenStack SDK is stored in Git. In order to work with our source repository, you
must have Git installed on your system. If your system has a package manager, it can likely be had from
there. If not, you can find downloads or the source at http://git-scm.com.
Getting the Source Code
Note: Before checking out the code, please read the OpenStack Developers Guide for details on how
to use the continuous integration and code review systems that we use.
The canonical Git repository is hosted on opendev.org at http://opendev.org/openstack/openstacksdk/:
(sdk3)$ git clone https://opendev.org/openstack/openstacksdk

(sdk3)$ cd openstacksdk
Installing Dependencies
In order to work with the SDK locally, such as in the interactive interpreter or to run example scripts,
you need to install the projects dependencies.:
(sdk3)$ pip install -r requirements.txt
After the downloads and installs are complete, youll have a fully functional environment to use the SDK
in.
Building the Documentation
Our documentation is written in reStructured Text and is built using Sphinx. A docs command is
available in our tox.ini, allowing you to build the documentation like youd run tests. The docs
command is not evaluated by default.:
(sdk3)$ tox -e docs
That command will cause the documentation, which lives in the docs folder, to be built. HTML output
is the most commonly referenced, which is located in docs/build/html.

3.1.6 Testing
The project contains three test packages, one for unit tests, one for functional tests and one for ex-
amples tests. The openstack.tests.unit package tests the SDKs features in isolation. The
openstack.tests.functional and openstack.tests.examples packages test the SDKs
features and examples against an OpenStack cloud.
Testing
The tests are run with tox and configured in tox.ini. The test results are tracked by testr and config-
ured in .testr.conf.
Unit Tests
Run
In order to run the entire unit test suite, simply run the tox command inside of your source checkout.
This will attempt to run every test command listed inside of tox.ini, which includes Python 3.8, and
a PEP 8 check. You should run the full test suite on all versions before submitting changes for review in
order to avoid unexpected failures in the continuous integration system.:
(sdk3)$ tox
...
py38: commands succeeded
pep8: commands succeeded
congratulations :)
During development, it may be more convenient to run a subset of the tests to keep test time to a
minimum. You can choose to run the tests only on one version. A step further is to run only the tests
you are working on.:
(sdk3)$ tox -e py38 # Run run the tests on Python 3.8

(sdk3)$ tox -e py38 TestContainer # Run only the TestContainer tests on 3.
,→8
Functional Tests
The functional tests assume that you have a public or private OpenStack cloud that you can run the tests
against. The tests must be able to be run against public clouds but first and foremost they must be run
against OpenStack. In practice, this means that the tests should initially be run against a stable branch
of DevStack.

os-client-config
To connect the functional tests to an OpenStack cloud we use os-client-config. To setup os-client-config
create a clouds.yaml file in the root of your source checkout.
This is an example of a minimal configuration for a clouds.yaml that connects the functional tests
to a DevStack instance. Note that one cloud under clouds must be named test_cloud.
clouds:
test_cloud:
auth:
auth_url: http://xxx.xxx.xxx.xxx:5000/v2.0/
username: demo
password: secrete
project_name: demo
rackspace:
cloud: rackspace
auth:
username: joe
password: joes-password
project_name: 123123
region_name: IAD
example:
image_name: fedora-20.x86_64
flavor_name: m1.small
network_name: private
Replace xxx.xxx.xxx.xxx with the IP address or FQDN of your DevStack instance.

You can also create a ~/.config/openstack/clouds.yaml file for your DevStack cloud en-
vironment using the following commands. Replace DEVSTACK_SOURCE with your DevStack source
checkout.:
(sdk3)$ source DEVSTACK_SOURCE/accrc/admin/admin

(sdk3)$ ./create_yaml.sh
Run
Functional tests are run against both Python 2 and 3. In order to run the entire functional test suite, run
the tox -e functional and tox -e functional3 command inside of your source checkout.
This will attempt to run every test command under /openstack/tests/functional/ in the
source tree. You should run the full functional test suite before submitting changes for review in order
to avoid unexpected failures in the continuous integration system.:
(sdk3)$ tox -e functional

...
functional: commands succeeded
congratulations :)
(sdk3)$ tox -e functional3
...
functional3: commands succeeded
congratulations :)

Examples Tests
Similar to the functional tests, the examples tests assume that you have a public or private OpenStack
cloud that you can run the tests against. In practice, this means that the tests should initially be run
against a stable branch of DevStack. And like the functional tests, the examples tests connect to an
OpenStack cloud using os-client-config. See the functional tests instructions for information on setting
up DevStack and os-client-config.
Run
In order to run the entire examples test suite, simply run the tox -e examples command inside
of your source checkout. This will attempt to run every test command under /openstack/tests/
examples/ in the source tree.:
(sdk3)$ tox -e examples

...
examples: commands succeeded
congratulations :)
3.1.7 Project Layout
The project contains a top-level openstack package, which houses several modules that form the
foundation upon which each services API is built on. Under the openstack package are packages for
each of those services, such as openstack.compute.
How the SDK is organized
The following diagram shows how the project is laid out.
openstack/
connection.py
resource.py
compute/
compute_service.py
v2/
server.py
_proxy.py
tests/
compute/
v2/
test_server.py

Resource
The openstack.resource.Resource base class is the building block of any service implemen-
tation. Resource objects correspond to the resources each services REST API works with, so the
openstack.compute.v2.server.Server subclass maps to the compute services https://
openstack:1234/v2/servers resource.
The base Resource contains methods to support the typical CRUD operations supported by REST
APIs, and handles the construction of URLs and calling the appropriate HTTP verb on the given
Adapter.
Values sent to or returned from the service are implemented as attributes on the Resource subclass
with type openstack.resource.prop. The prop is created with the exact name of what the API
expects, and can optionally include a type to be validated against on requests. You should choose an
attribute name that follows PEP-8, regardless of what the server-side expects, as this prop becomes a
mapping between the two.:
is_public = resource.prop('os-flavor-access:is_public', type=bool)
There are six additional attributes which the Resource class checks before making requests
to the REST API. allow_create, allow_retreive, allow_commit, allow_delete,
allow_head, and allow_list are set to True or False, and are checked before making the
corresponding method call.
The base_path attribute should be set to the URL which corresponds to this resource. Many
base_paths are simple, such as "/servers". For base_paths which are composed of
non-static information, Pythons string replacement is used, e.g., base_path = "/servers/
%(server_id)s/ips".
resource_key and resources_key are attributes to set when a Resource returns more than one
item in a response, or otherwise requires a key to obtain the response value. For example, the Server
class sets resource_key = "server" as an individual Server is stored in a dictionary keyed
with the singular noun, and resource_keys = "servers" as multiple Servers are stored in a
dictionary keyed with the plural noun in the response.
Proxy
Each service implements a Proxy class based on Proxy, within the openstack/
<program_name>/vX/_proxy.py module. For example, the v2 compute services Proxy
exists in openstack/compute/v2/_proxy.py.
The Proxy class is based on Adapter.
class openstack.proxy.Proxy(session, statsd_client=None,
statsd_prefix=None, prometheus_counter=None,
prometheus_histogram=None, influxdb_config=None,
influxdb_client=None, *args, **kwargs)
Bases: keystoneauth1.adapter.Adapter
Represents a service.
retriable_status_codes = None
HTTP status codes that should be retried by default.

The number of retries is defined by the configuration in parameters called

<service-type>_status_code_retries.
Each services Proxy provides a higher-level interface for users to work with via a Connection
instance.
Rather than requiring users to maintain their own Adapter and work with lower-level Resource
objects, the Proxy interface offers a place to make things easier for the caller.
Each Proxy class implements methods which act on the underlying Resource classes which represent
the service. For example:
def list_flavors(self, **params):

return flavor.Flavor.list(self.session, **params)
This method is operating on the openstack.compute.v2.flavor.Flavor.list method. For

the time being, it simply passes on the Adapter maintained by the Proxy, and returns what the
underlying Resource.list method does.
The implementations and method signatures of Proxy methods are currently under construction, as we
figure out the best way to implement them in a way which will apply nicely across all of the services.
Connection
The openstack.connection.Connection class builds atop a openstack.config.

cloud_region.CloudRegion object, and provides a higher level interface constructed of Proxy
objects from each of the services.
The Connection class primary purpose is to act as a high-level interface to this SDK, managing
the lower level connecton bits and exposing the Resource objects through their corresponding Proxy
object.
If youve built proper Resource objects and implemented methods on the corresponding Proxy object,
the high-level interface to your service should now be exposed.
3.1.8 Adding Features
Does this SDK not do what you need it to do? Is it missing a service? Are you a developer on another
project who wants to add their service? Youre in the right place. Below are examples of how to add new
features to the OpenStack SDK.
Creating a New Resource
This guide will walk you through how to add resources for a service.

Naming Conventions
Above all, names across this project conform to Pythons naming standards, as laid out in PEP 8.
The relevant details we need to know are as follows:
• Module names are lower case, and separated by underscores if more than one word. For example,
openstack.object_store
• Class names are capitalized, with no spacing, and each subsequent word is capitalized in a name.
For example, ServerMetadata.
• Attributes on classes, including methods, are lower case and separated by underscores. For exam-
ple, allow_list or get_data.
Services
Services in the OpenStack SDK are named after their program name, not their code name. For example,
the project often known as Nova is always called compute within this SDK.
This guide walks through creating service for an OpenStack program called Fake. Following our guide-
lines, the code for its service would live under the openstack.fake namespace. What follows is the
creation of a Resource class for the Fake service.
Resources
Resources are named after the server-side resource, which is set in the base_path attribute of the
resource class. This guide creates a resource class for the /fake server resource, so the resource
module is called fake.py and the class is called Fake.
An Example
openstack/fake/fake_service.py
1 # Apache 2 header omitted for brevity

2
3 from openstack import service_description
4 from openstack.fake.v2 import _proxy as _proxy_v2
5
6
7 class FakeService(service_description.ServiceDescription):
8 """The fake service."""
9
10 supported_versions = {
11 '2': _proxy_v2.Proxy,
12 }
openstack/fake/v2/fake.py
1 # Apache 2 header omitted for brevity

2
3 from openstack import resource


4
5
6 class Fake(resource.Resource):
7 resource_key = "resource"
8 resources_key = "resources"
9 base_path = "/fake"
10
11 allow_create = True
12 allow_fetch = True
13 allow_commit = True
14 allow_delete = True
15 allow_list = True
16 allow_head = True
17
18 #: The transaction date and time.
19 timestamp = resource.Header("x-timestamp")
20 #: The name of this resource.
21 name = resource.Body("name", alternate_id=True)
22 #: The value of the resource. Also available in headers.
23 value = resource.Body("value", alias="x-resource-value")
24 #: Is this resource cool? If so, set it to True.
25 #: This is a multi-line comment about cool stuff.
26 cool = resource.Body("cool", type=bool)
fake.Fake Attributes
Each services resources inherit from Resource, so they can override any of the base attributes to fit
the way their particular resource operates.
resource_key and resources_key
These attributes are set based on how your resource responds with data. The default values for each of
these are None, which works fine when your resource returns a JSON body that can be used directly
without a top-level key, such as {"name": "Ernie Banks", ...}".
However, our Fake resource returns JSON bodies that have the details of the resource one level deeper,
such as {"resources": {"name": "Ernie Banks", ...}, {...}}. It does a similar
thing with single resources, putting them inside a dictionary keyed on "resource".
By setting Fake.resource_key on line 8, we tell the Resource.create, Resource.get, and
Resource.update methods that were either sending or receiving a resource that is in a dictionary
with that key.
By setting Fake.resources_key on line 9, we tell the Resource.list method that were ex-
pecting to receive multiple resources inside a dictionary with that key.

base_path
The base_path is the URL were going to use to make requests for this resource. In this case, line 10
sets base_path = "/fake", which also corresponds to the name of our class, Fake.
Most resources follow this basic formula. Some cases are more complex, where the URL to make
requests to has to contain some extra data. The volume service has several resources which make ei-
ther basic requests or detailed requests, so they use base_path = "/volumes/%s(detailed)".
Before a request is made, if detailed = True, they convert it to a string so the URL becomes /
volumes/detailed. If its False, they only send /volumes/.
service
Line 11 is an instance of the service were implementing. Each resource ties itself to the service through
this setting, so that the proper URL can be constructed.
In fake_service.py, we specify the valid versions as well as what this service is called in the
service catalog. When a request is made for this resource, the Session now knows how to construct the
appropriate URL using this FakeService instance.
Supported Operations
The base Resource disallows all types of requests by default, requiring each resource to specify which
requests they support. On lines 14-19, our Fake resource specifies that itll work with all of the opera-
tions.
In order to have the following methods work, you must allow the corresponding value by setting it to
True:
create allow_create
delete allow_delete
head allow_head
list allow_list
fetch allow_fetch
commit allow_commit
An additional attribute to set is commit_method. It defaults to PUT, but some services use POST or
PATCH to commit changes back to the remote resource.
Properties
The way resource classes communicate values between the user and the server are prop objects. These
act similarly to Pythons built-in property objects, but they share only the name - theyre not the same.
Properties are set based on the contents of a response body or headers. Based on what your resource
returns, you should set props to map those values to ones on your Resource object.
Line 22 sets a prop for timestamp , which will cause the Fake.timestamp attribute to contain the
value returned in an X-Timestamp header, such as from a Fake.head request.

Line 24 sets a prop for name, which is a value returned in a body, such as from a Fake.get request.
Note from line 12 that name is specified its id attribute, so when this resource is populated from a
response, Fake.name and Fake.id are the same value.
Line 26 sets a prop which contains an alias. Fake.value will be set when a response body contains a
value, or when a header contains X-Resource-Value.
Line 28 specifies a type to be checked before sending the value in a request. In this case, we can only
set Fake.cool to either True or False, otherwise a TypeError will be raised if the value cant be
converted to the expected type.
Documentation
We use Sphinxs autodoc feature in order to build API documentation for each resource we expose.
The attributes we override from Resource dont need to be documented, but any prop attributes must
be. All you need to do is add a comment above the line to document, with a colon following the pound-
sign.
Lines 21, 23, 25, and 27-28 are comments which will then appear in the API documentation. As shown
in lines 27 & 28, these comments can span multiple lines.


CHAPTER
FOUR
OPENSTACKSDK
openstacksdk is a client library for building applications to work with OpenStack clouds. The project
aims to provide a consistent and complete set of interactions with OpenStacks many services, along with
complete documentation, examples, and tools.
It also contains an abstraction interface layer. Clouds can do many things, but there are probably only
about 10 of them that most people care about with any regularity. If you want to do complicated things,
the per-service oriented portions of the SDK are for you. However, if what you want is to be able to write
an application that talks to clouds no matter what crazy choices the deployer has made in an attempt to
be more hipster than their self-entitled narcissist peers, then the Cloud Abstraction layer is for you.
More information about its history can be found at https://docs.openstack.org/openstacksdk/latest/
contributor/history.html
569
570 Chapter 4. openstacksdk

CHAPTER
FIVE
OPENSTACK
List servers using objects configured with the clouds.yaml file:
import openstack

# Initialize cloud
conn = openstack.connect(cloud='mordred')
for server in conn.compute.servers():

print(server.to_dict())
571
572 Chapter 5. openstack

CHAPTER
SIX
CLOUD LAYER
openstacksdk contains a higher-level layer based on logical operations.
import openstack

for server in conn.list_servers():

print(server.to_dict())
The benefit is mostly seen in more complicated operations that take multiple steps and where the steps
vary across providers:
import openstack

# Initialize connection
# Cloud configs are read with openstack.config
conn = openstack.connect(cloud='mordred')

image = conn.create_image(
'ubuntu-trusty', filename='ubuntu-trusty.qcow2', wait=True)

flavor = conn.get_flavor_by_ram(512)

conn.create_server(
573
574 Chapter 6. Cloud Layer

CHAPTER
SEVEN
OPENSTACK.CONFIG
openstack.config will find cloud configuration for as few as 1 clouds and as many as you want to
put in a config file. It will read environment variables and config files, and it also contains some vendor
specific default values so that you dont have to know extra info to use OpenStack
• If you have a config file, you will get the clouds listed in it
• If you have environment variables, you will get a cloud named envvars
• If you have neither, you will get a cloud named defaults with base defaults
Sometimes an example is nice.
Create a clouds.yaml file:
clouds:
mordred:
region_name: Dallas
auth:
username: 'mordred'
password: XXXXXXX
project_name: 'shade'
auth_url: 'https://identity.example.com'
Please note: openstack.config will look for a file called clouds.yaml in the following loca-
tions:
• ~/.config/openstack
• /etc/openstack
More information at https://docs.openstack.org/openstacksdk/latest/user/config/configuration.html
575
576 Chapter 7. openstack.config

CHAPTER
EIGHT
LINKS
• Issue Tracker
• Code Review
• Documentation
• PyPI
• Mailing list
• Release Notes
8.1 General Information
General information about the SDK including a glossary and release history.
8.1.1 Glossary
CLI Command-Line Interface; a textual user interface.

compute OpenStack Compute (Nova).
container One of the object-store resources; a container holds objects being stored.
endpoint A base URL used in a REST request. An authentication endpoint is specifically the URL
given to a user to identify a cloud. A service endpoint is generally obtained from the service
catalog.
host A physical computer. Contrast with node and server.
identity OpenStack Identity (Keystone).
image OpenStack Image (Glance). Also the attribute name of the disk files stored for use by servers.
keypair The attribute name of the SSH public key used in the OpenStack Compute API for server
authentication.
node A logical system, may refer to a server (virtual machine) or a host.
Generally used to describe an OS instance where a specific process is running, e.g. a network
node is where the network processes run, and may be directly on a host or in a server. Contrast
with host and server.
object A generic term which normally refers to the a Python object. The OpenStack Object Store
service (Swift) also uses object as the name of the item being stored within a container.
577
object-store OpenStack Object Store (Swift).

project The name of the owner of resources in an OpenStack cloud. A project can map to a customer,
account or organization in different OpenStack deployments. Used instead of the deprecated
tenant.
region The attribute name of a partitioning of cloud resources.
resource A Python object representing an OpenStack resource inside the SDK code. Also used to
describe the items managed by OpenStack.
role A personality that a user assumes when performing a specific set of operations. A role includes a
set of rights and privileges that a user assuming that role inherits. The OpenStack Identity service
includes the set of roles that a user can assume in the token that is issued to that user.
The individual services determine how the roles are interpreted and access granted to operations
or resources. The OpenStack Identity service treats a role as an arbitrary name assigned by the
cloud administrator.
server A virtual machine or a bare-metal host managed by the OpenStack Compute service. Contrast
with host and node.
service In OpenStack this refers to a service/endpoint in the ServiceCatalog. It could also be a collection
of endpoints for different regions. A service has a type and a name.
service catalog The list of services configured at a given authentication endpoint available to the au-
thenticated user.
tenant Deprecated in favor of project.
token An arbitrary bit of text that is used to access resources. Some tokens are scoped to determine
what resources are accessible with it. A token may be revoked at any time and is valid for a finite
duration.
volume OpenStack Volume (Cinder). Also the attribute name of the virtual disks managed by the
OpenStack Volume service.
8.1.2 Release Notes
Release notes for openstacksdk can be found at https://releases.openstack.org/teams/openstacksdk.html
578 Chapter 8. Links

PYTHON MODULE INDEX
o 403
openstack.accelerator.v2._proxy, openstack.clustering.v1.cluster,
168 406
openstack.clustering.v1.cluster_policy,
openstack.accelerator.v2.accelerator_request,
377 410
openstack.accelerator.v2.deployable,openstack.clustering.v1.event, 413
375 openstack.clustering.v1.node, 408
openstack.accelerator.v2.device, openstack.clustering.v1.policy, 405
374 openstack.clustering.v1.policy_type,
openstack.accelerator.v2.device_profile, 405
376 openstack.clustering.v1.profile,
openstack.baremetal.v1._proxy, 171 404
openstack.baremetal.v1.allocation, openstack.clustering.v1.profile_type,
392 403
openstack.baremetal.v1.chassis, 380 openstack.clustering.v1.receiver,
openstack.baremetal.v1.driver, 378 411
openstack.baremetal.v1.node, 381 openstack.compute.v2._proxy, 217
openstack.baremetal.v1.port, 390 openstack.compute.v2.extension, 414
openstack.baremetal.v1.port_group, openstack.compute.v2.flavor, 415
391 openstack.compute.v2.image, 417
openstack.compute.v2.keypair, 418
openstack.baremetal.v1.volume_connector,
393 openstack.compute.v2.limits, 419
openstack.compute.v2.server, 421
openstack.baremetal.v1.volume_target,
394 openstack.compute.v2.server_interface,
425
openstack.baremetal_introspection.v1._proxy,
192 openstack.compute.v2.server_ip, 426
openstack.config, 19
openstack.baremetal_introspection.v1.introspection,
395 openstack.connection, 77
openstack.block_storage.v2._proxy, openstack.database.v1._proxy, 239
194 openstack.database.v1.database, 427
openstack.block_storage.v2.backup, openstack.database.v1.flavor, 428
397 openstack.database.v1.instance, 428
openstack.block_storage.v2.snapshot,openstack.database.v1.user, 430
399 openstack.dns.v2._proxy, 244
openstack.block_storage.v2.type, openstack.dns.v2.floating_ip, 435
400 openstack.dns.v2.recordset, 436
openstack.block_storage.v2.volume, openstack.dns.v2.zone, 430
401 openstack.dns.v2.zone_export, 433
openstack.clustering.v1._proxy, 199 openstack.dns.v2.zone_import, 434
openstack.clustering.v1.action, 412 openstack.dns.v2.zone_transfer, 431
openstack.clustering.v1.build_info, openstack.identity.v2._proxy, 252
579
openstack.identity.v2.extension, openstack.load_balancer.v2.load_balancer,
437 460
openstack.identity.v2.role, 438 openstack.load_balancer.v2.member,
openstack.identity.v2.tenant, 439 467
openstack.identity.v2.user, 439 openstack.load_balancer.v2.pool,
openstack.identity.v3._proxy, 256 466
openstack.identity.v3.credential, openstack.load_balancer.v2.provider,
440 472
openstack.identity.v3.domain, 441 openstack.load_balancer.v2.quota,
openstack.identity.v3.endpoint, 442 474
openstack.identity.v3.group, 443 openstack.message.v2._proxy, 305
openstack.identity.v3.policy, 443 openstack.network.v2._proxy, 310
openstack.identity.v3.project, 444 openstack.network.v2.address_group,
openstack.identity.v3.service, 445 479
openstack.identity.v3.trust, 446 openstack.network.v2.address_scope,
openstack.identity.v3.user, 447 480
openstack.image.v1._proxy, 272 openstack.network.v2.agent, 481
openstack.image.v1.image, 448 openstack.network.v2.auto_allocated_topology,
openstack.image.v2._proxy, 274 482
openstack.image.v2.image, 450 openstack.network.v2.availability_zone,
openstack.image.v2.member, 454 483
openstack.image.v2.service_info, openstack.network.v2.extension, 483
456 openstack.network.v2.flavor, 484
openstack.image.v2.task, 455 openstack.network.v2.floating_ip,
openstack.key_manager.v1._proxy, 485
283 openstack.network.v2.health_monitor,
openstack.key_manager.v1.container, 486
457 openstack.network.v2.listener, 487
openstack.key_manager.v1.order, 458 openstack.network.v2.load_balancer,
openstack.key_manager.v1.secret, 488
459 openstack.network.v2.metering_label,
openstack.load_balancer.v2._proxy, 489
287 openstack.network.v2.metering_label_rule,
openstack.load_balancer.v2.amphora, 490
475 openstack.network.v2.network, 491
openstack.load_balancer.v2.availability_zone,
openstack.network.v2.network_ip_availability,
478 492
openstack.load_balancer.v2.availability_zone_profile,
openstack.network.v2.network_segment_range,
478 493
openstack.load_balancer.v2.flavor, openstack.network.v2.pool, 494
473 openstack.network.v2.pool_member,
openstack.load_balancer.v2.flavor_profile,496
473 openstack.network.v2.port, 497
openstack.load_balancer.v2.health_monitor,
468 499
openstack.load_balancer.v2.l7_policy,
openstack.network.v2.qos_dscp_marking_rule,
470 499
openstack.load_balancer.v2.l7_rule, openstack.network.v2.qos_minimum_bandwidth_ru
471 500
openstack.load_balancer.v2.listener,openstack.network.v2.qos_policy,
463 501
580 Python Module Index

openstack.network.v2.qos_rule_type,
502
openstack.network.v2.quota, 502
openstack.network.v2.rbac_policy,
503
openstack.network.v2.router, 504
openstack.network.v2.security_group,
506
openstack.network.v2.security_group_rule,
507
openstack.network.v2.segment, 508
openstack.network.v2.service_profile,
509
openstack.network.v2.service_provider,
510
openstack.network.v2.subnet, 510
openstack.network.v2.subnet_pool,
512
openstack.object_store.v1._proxy,
361
openstack.object_store.v1.account,
517
openstack.object_store.v1.container,
518
openstack.object_store.v1.obj, 520
openstack.orchestration.v1._proxy,
366
openstack.orchestration.v1.resource,
516
openstack.orchestration.v1.stack,
513
openstack.resource, 525
openstack.service_description, 534
openstack.utils, 535
openstack.workflow.v2._proxy, 371
openstack.workflow.v2.execution,
523
openstack.workflow.v2.workflow, 524
Python Module Index 581

582 Python Module Index

INDEX
A active_connections (open-
abort() (openstack.load_balancer.v2.listener.ListenerStats
attribute), 465
stack.baremetal_introspection.v1.introspection.Introspection
method), 396 active_connections (open-
AbsoluteLimits (class in openstack.load_balancer.v2.load_balancer.LoadBalancerStats
stack.compute.v2.limits), 420 attribute), 462
AcceleratorRequest (class in open- actor (openstack.clustering.v1.receiver.Receiver
stack.accelerator.v2.accelerator_request), attribute), 411
377 add_addresses() (open-
accept_ranges (openstack.network.v2.address_group.AddressGroup
stack.object_store.v1.obj.Object at- method), 480
tribute), 521 add_auto_ip() (open-
Account (class in openstack.connection.Connection method),
stack.object_store.v1.account), 517 82
account_bytes_used (open- add_extra_routes() (open-
stack.object_store.v1.account.Account stack.network.v2.router.Router method),
attribute), 518 505
account_container_count (open- add_flavor_access() (open-
stack.object_store.v1.account.Account stack.connection.Connection method),
attribute), 518 83
account_object_count (open- add_gateway() (open-
stack.object_store.v1.account.Account stack.network.v2.router.Router method),
attribute), 518 506
Action (class in openstack.clustering.v1.action), add_host_to_aggregate() (open-
412 stack.connection.Connection method),
action (openstack.clustering.v1.action.Action 83
attribute), 412 add_interface() (open-
action (openstack.clustering.v1.event.Event at- stack.network.v2.router.Router method),
tribute), 414 505
action (openstack.clustering.v1.receiver.Receiver add_ip_list() (open-
attribute), 411 stack.connection.Connection method),
action (openstack.dns.v2.floating_ip.FloatingIP 83
attribute), 435 add_router_interface() (open-
action (openstack.dns.v2.recordset.Recordset stack.connection.Connection method),
attribute), 436 83
action (openstack.dns.v2.zone.Zone attribute), add_server_security_groups() (open-
430 stack.connection.Connection method), 84
add_service()
action (openstack.load_balancer.v2.l7_policy.L7Policy (open-
action (openstack.network.v2.rbac_policy.RBACPolicy 82
attribute), 504 add_tenant_access() (open-
583
stack.compute.v2.flavor.Flavor method), alias (openstack.compute.v2.extension.Extension

416 attribute), 414
add_trait() (open- alias (openstack.identity.v2.extension.Extension
stack.baremetal.v1.node.Node method), attribute), 437
388 alias (openstack.network.v2.extension.Extension
add_user_to_group() (open- attribute), 483
stack.connection.Connection method), aliases (open-
84 stack.service_description.ServiceDescription
add_volume_type_access() (open- attribute), 535
stack.connection.Connection method), Allocation (class in open-
84 stack.baremetal.v1.allocation), 392
address (openstack.baremetal.v1.port.Port at- allocation_id (open-
tribute), 390 stack.baremetal.v1.node.Node attribute),
address (open- 381
stack.baremetal.v1.port_group.PortGroup allocation_pools (open-
attribute), 391 stack.network.v2.subnet.Subnet at-
address (open- tribute), 510
stack.compute.v2.server_ip.ServerIP allow_commit (openstack.resource.Resource
attribute), 426 attribute), 528
address (open- allow_create (openstack.resource.Resource
stack.dns.v2.floating_ip.FloatingIP attribute), 528
attribute), 435 allow_delete (openstack.resource.Resource
address (open- attribute), 528
stack.load_balancer.v2.member.Member allow_empty_commit (open-
attribute), 467 stack.resource.Resource attribute),
address (open- 528
stack.network.v2.pool_member.PoolMemberallow_fetch (openstack.resource.Resource at-
attribute), 496 tribute), 528
address_scope_id (open- allow_head (openstack.resource.Resource at-
stack.network.v2.subnet_pool.SubnetPool tribute), 528
attribute), 512 allow_list (openstack.resource.Resource at-
addresses (openstack.compute.v2.server.Server tribute), 528
attribute), 422 allow_patch (open-
addresses (openstack.accelerator.v2.accelerator_request.AcceleratorRequ
stack.network.v2.address_group.AddressGroup attribute), 377
attribute), 479 allow_patch (openstack.resource.Resource at-
AddressGroup (class in open- tribute), 528
stack.network.v2.address_group), 479 allow_redelegation (open-
AddressScope (class in openstack.identity.v3.trust.Trust attribute),
stack.network.v2.address_scope), 480 446
admin_password (open- allowed_address_pairs (open-
stack.compute.v2.server.Server attribute), stack.network.v2.port.Port attribute),
422 497
adopt() (openstack.clustering.v1.node.Node allowed_cidrs (open-
method), 409 stack.load_balancer.v2.listener.Listener
Agent (class in openstack.network.v2.agent), 481 attribute), 463
agent_type (openstack.network.v2.agent.Agent alpn_protocols (open-
attribute), 481 stack.load_balancer.v2.listener.Listener
algorithm (open- attribute), 463
stack.key_manager.v1.secret.Secret Amphora (class in open-
attribute), 459 stack.load_balancer.v2.amphora),
584 Index
475 attributes (openstack.dns.v2.zone.Zone at-

amphora_id (open- tribute), 430
stack.load_balancer.v2.amphora.AmphoraConfigauth_config_hook() (open-
attribute), 476 stack.config.OpenStackConfig method),
amphora_id (open- 19
stack.load_balancer.v2.amphora.AmphoraFailover
authorize() (open-
AmphoraConfig (class in open- 82
stack.load_balancer.v2.amphora), AutoAllocatedTopology (class in open-
476 stack.network.v2.auto_allocated_topology),
AmphoraFailover (class in open- 482
stack.load_balancer.v2.amphora), availability_zone (open-
477 stack.block_storage.v2.backup.Backup
api (openstack.clustering.v1.build_info.BuildInfo attribute), 397
attribute), 403 availability_zone (open-
architecture (openstack.block_storage.v2.volume.Volume
stack.image.v2.image.Image attribute), attribute), 401
451 availability_zone (open-
assign_role_to_group() (openstack.compute.v2.server.Server attribute),
stack.identity.v3.domain.Domain 422
method), 441 availability_zone (open-
assign_role_to_group() (openstack.load_balancer.v2.load_balancer.LoadBalancer
stack.identity.v3.project.Project method), attribute), 461
445 availability_zone (open-
assign_role_to_user() (openstack.network.v2.agent.Agent attribute),
stack.identity.v3.domain.Domain 481
method), 441 availability_zone_data (open-
assign_role_to_user() (openstack.load_balancer.v2.availability_zone_profile.Availabil
444 availability_zone_hints (open-
attach_handle_info (openstack.network.v2.network.Network
attribute), 491
stack.accelerator.v2.accelerator_request.AcceleratorRequest
attribute), 377 availability_zone_hints (open-
attach_handle_type (openstack.network.v2.router.Router attribute),
504
attribute), 377 availability_zone_profile_id (open-
attach_port_to_machine() (openstack.load_balancer.v2.availability_zone.AvailabilityZone
stack.connection.Connection method), attribute), 479
84 availability_zones (open-
attach_vif() (openstack.network.v2.network.Network
stack.baremetal.v1.node.Node method), attribute), 491
386 availability_zones (open-
attach_volume() (openstack.network.v2.router.Router attribute),
stack.connection.Connection method), 504
84 AvailabilityZone (class in open-
attached_volumes (openstack.load_balancer.v2.availability_zone),
stack.compute.v2.server.Server attribute), 478
422 AvailabilityZone (class in open-
attachments (openstack.network.v2.availability_zone),
stack.block_storage.v2.volume.Volume 483
attribute), 402 AvailabilityZoneProfile (class in open-
Index 585
stack.load_balancer.v2.availability_zone_profile), stack.baremetal.v1.node.Node attribute),

478 383
available (open- BuildInfo (class in open-
stack.network.v2.network_segment_range.NetworkSegmentRange
stack.clustering.v1.build_info), 403
attribute), 494 bulk_create() (openstack.resource.Resource
available_floating_ip() (open- class method), 531
stack.connection.Connection method), bytes (openstack.object_store.v1.container.Container
85 attribute), 519
bytes_in (open-
B stack.load_balancer.v2.listener.ListenerStats
Backup (class in open- attribute), 465
stack.block_storage.v2.backup), 397 bytes_in (open-
backup (openstack.load_balancer.v2.member.Member stack.load_balancer.v2.load_balancer.LoadBalancerStats
base_path (openstack.resource.Resource bytes_out (open-
attribute), 528 stack.load_balancer.v2.listener.ListenerStats
binary (openstack.network.v2.agent.Agent at- attribute), 465
tribute), 481 bytes_out (open-
bind_accelerator_request() (openstack.load_balancer.v2.load_balancer.LoadBalancerStats
85 bytes_used (open-
binding_host_id (openstack.object_store.v1.container.Container
stack.network.v2.port.Port attribute), attribute), 519
497
binding_profile (open- C
stack.network.v2.port.Port attribute), cached_zone (open-
497 stack.load_balancer.v2.amphora.Amphora
binding_vif_details (open- attribute), 476
stack.network.v2.port.Port attribute), candidate_nodes (open-
497 stack.baremetal.v1.allocation.Allocation
binding_vif_type (open- attribute), 392
stack.network.v2.port.Port attribute), capabilities (open-
497 stack.orchestration.v1.stack.Stack at-
binding_vnic_type (open- tribute), 513
stack.network.v2.port.Port attribute), cause (openstack.clustering.v1.action.Action at-
497 tribute), 412
bios_interface (open- cert_busy (open-
stack.baremetal.v1.node.Node attribute), stack.load_balancer.v2.amphora.Amphora
383 attribute), 475
bit_length (open- cert_expiration (open-
stack.key_manager.v1.secret.Secret stack.load_balancer.v2.amphora.Amphora
blob (openstack.identity.v3.credential.Credential change_password() (open-
attribute), 440 stack.compute.v2.server.Server method),
blob (openstack.identity.v3.policy.Policy at- 424
tribute), 443 channel (open-
block_device_mapping (openstack.clustering.v1.receiver.Receiver
stack.compute.v2.server.Server attribute), attribute), 411
422 character_set (open-
Body (class in openstack.resource), 526 stack.database.v1.database.Database
boot_interface (open- attribute), 427
586 Index
Chassis (class in open- method), 476

stack.baremetal.v1.chassis), 380 commit() (open-
chassis_id (openstack.load_balancer.v2.amphora.AmphoraFailover
stack.baremetal.v1.node.Node attribute), method), 477
381 commit() (open-
check() (openstack.clustering.v1.node.Node stack.load_balancer.v2.load_balancer.LoadBalancerFailo
method), 409 method), 463
checksum (openstack.image.v1.image.Image at- commit() (open-
tribute), 448 stack.orchestration.v1.stack.Stack
checksum (openstack.image.v2.image.Image at- method), 515
tribute), 450 commit() (openstack.resource.Resource
cidr (openstack.network.v2.subnet.Subnet method), 532
attribute), 511 commit_jsonpatch (open-
clean_step (openstack.resource.Resource attribute),
stack.baremetal.v1.node.Node attribute), 529
381 commit_method (openstack.resource.Resource
CLI, 577 attribute), 529
close() (openstack.connection.Connection compare_type (open-
method), 82 stack.load_balancer.v2.l7_rule.L7Rule
CloudRegion (class in open- attribute), 471
stack.config.cloud_region), 21 compute, 577
Cluster (class in open- compute_flavor (open-
stack.clustering.v1.cluster), 406 stack.load_balancer.v2.amphora.Amphora
cluster_id (open- attribute), 476
stack.clustering.v1.action.Action at- compute_host (open-
tribute), 413 stack.compute.v2.server.Server attribute),
cluster_id (open- 422
stack.clustering.v1.cluster_policy.ClusterPolicy
compute_id (open-
attribute), 410 stack.load_balancer.v2.amphora.Amphora
cluster_id (open- attribute), 475
stack.clustering.v1.event.Event attribute), conductor_group (open-
413 stack.baremetal.v1.node.Node attribute),
cluster_id (open- 381
stack.clustering.v1.node.Node attribute), config (openstack.clustering.v1.cluster.Cluster
408 attribute), 407
cluster_id (open- config_drive (open-
stack.clustering.v1.receiver.Receiver stack.compute.v2.server.Server attribute),
attribute), 411 422
cluster_name (open- configuration (open-
stack.clustering.v1.cluster_policy.ClusterPolicy stack.network.v2.agent.Agent attribute),
attribute), 410 481
ClusterPolicy (class in open- confirm_resize() (open-
stack.clustering.v1.cluster_policy), stack.compute.v2.server.Server method),
410 425
collate (open- connect_as() (open-
stack.database.v1.database.Database stack.connection.Connection method),
attribute), 427 85
commit() (openstack.baremetal.v1.node.Node connect_as_project() (open-
method), 384 stack.connection.Connection method),
commit() (open- 85
stack.load_balancer.v2.amphora.AmphoraConfig Connection (class in openstack.connection), 81
Index 587
connection_limit (openstack.object_store.v1.obj.Object at-

stack.load_balancer.v2.listener.Listener tribute), 521
attribute), 464 content_types (open-
connection_limit (openstack.key_manager.v1.secret.Secret
stack.network.v2.listener.Listener at- attribute), 459
tribute), 487 copy() (openstack.resource.Resource method),
consistency_group_id (open- 530
stack.block_storage.v2.volume.Volume copy_from (openstack.image.v1.image.Image
console_interface (open- copy_from (open-
stack.baremetal.v1.node.Node attribute), stack.object_store.v1.obj.Object at-
383 tribute), 522
consumers (open- count (openstack.object_store.v1.container.Container
stack.key_manager.v1.container.Container attribute), 519
attribute), 457 create() (open-
container, 577 stack.accelerator.v2.accelerator_request.AcceleratorRequ
Container (class in open- method), 378
stack.key_manager.v1.container), 457 create() (open-
Container (class in openstack.accelerator.v2.device_profile.DeviceProfile
stack.object_store.v1.container), 518 method), 376
container (open- create() (openstack.baremetal.v1.node.Node
stack.block_storage.v2.backup.Backup method), 384
attribute), 397 create() (open-
container (openstack.block_storage.v2.backup.Backup
tribute), 521 create() (open-
container_format (openstack.dns.v2.zone_export.ZoneExport
stack.image.v1.image.Image attribute), method), 433
448 create() (open-
container_format (openstack.dns.v2.zone_import.ZoneImport
450 create() (open-
container_id (openstack.object_store.v1.container.Container
stack.key_manager.v1.container.Container method), 520
attribute), 457 create() (openstack.object_store.v1.obj.Object
container_ref (open- method), 522
stack.key_manager.v1.container.Container create() (open-
attribute), 457 stack.orchestration.v1.stack.Stack
content_disposition (open- method), 515
stack.object_store.v1.obj.Object at- create() (openstack.resource.Resource
tribute), 522 method), 531
content_encoding (open- create() (open-
stack.object_store.v1.obj.Object at- stack.workflow.v2.execution.Execution
content_length (open- create() (open-
stack.object_store.v1.obj.Object at- stack.workflow.v2.workflow.Workflow
content_type (open- create_accelerator_request() (open-
stack.object_store.v1.container.Container stack.connection.Connection method), 86
attribute), 519 create_aggregate() (open-
content_type (openstack.connection.Connection method),
588 Index
86 stack.compute.v2.server.Server method),
create_baymodel() (open- 425
stack.connection.Connection method), create_image() (open-
create_cluster_template() (open- 91
stack.connection.Connection method), create_image_snapshot() (open-
create_coe_cluster() (open- 92
stack.connection.Connection method), create_keypair() (open-
create_coe_cluster_template() (open- 93
stack.connection.Connection method), 87 create_method (openstack.resource.Resource
create_container() (open- attribute), 529
stack.connection.Connection method), create_network() (open-
create_device_profile() (open- 93
stack.connection.Connection method), create_object() (open-
create_directory_marker_object() 93
(openstack.connection.Connection create_port() (open-
create_domain() (open- 94
stack.connection.Connection method), create_project() (open-
create_endpoint() (open- 95
stack.connection.Connection method), create_qos_bandwidth_limit_rule()
88 (openstack.connection.Connection
create_exclude_id_from_body (open- method), 95
stack.resource.Resource attribute), 529 create_qos_dscp_marking_rule()
create_extra_specs() (open- (openstack.connection.Connection
stack.compute.v2.flavor.Flavor method), method), 96
416 create_qos_minimum_bandwidth_rule()
create_firewall_group() (open- (openstack.connection.Connection
stack.connection.Connection method), method), 96
89 create_qos_policy() (open-
create_firewall_policy() (openstack.connection.Connection method),
89 create_recordset() (open-
create_firewall_rule() (openstack.connection.Connection method),
89 create_requires_id (open-
create_flavor() (openstack.resource.Resource attribute),
90 create_returns_body (open-
create_floating_ip() (openstack.resource.Resource attribute),
91 create_role() (open-
create_group() (openstack.connection.Connection method),
91 create_router() (open-
create_image() (openstack.connection.Connection method),
Index 589
97 created_at (open-
create_security_group() (openstack.baremetal.v1.node.Node attribute),
98 created_at (openstack.baremetal.v1.port.Port
create_security_group_rule() (open- attribute), 390
stack.connection.Connection method), 98 created_at (open-
create_server() (openstack.baremetal.v1.port_group.PortGroup
create_server_group() (openstack.baremetal.v1.volume_connector.VolumeConnector
create_service() (openstack.baremetal.v1.volume_target.VolumeTarget
create_stack() (openstack.block_storage.v2.backup.Backup
create_subnet() (openstack.block_storage.v2.snapshot.Snapshot
create_user() (openstack.block_storage.v2.volume.Volume
create_volume() (openstack.clustering.v1.action.Action at-
stack.connection.Connection method), tribute), 413
create_volume_backup() (openstack.clustering.v1.cluster.Cluster at-
create_volume_snapshot() (openstack.clustering.v1.node.Node attribute),
create_zone() (openstack.clustering.v1.policy.Policy at-
created_at (openstack.clustering.v1.profile.Profile at-
stack.accelerator.v2.deployable.Deployable tribute), 404
attribute), 375 created_at (open-
created_at (openstack.clustering.v1.receiver.Receiver
stack.accelerator.v2.device.Device attribute), 411
created_at (openstack.compute.v2.image.Image attribute),
stack.accelerator.v2.device_profile.DeviceProfile 417
created_at (openstack.compute.v2.keypair.Keypair at-
stack.baremetal.v1.allocation.Allocation tribute), 418
created_at (openstack.compute.v2.server.Server attribute),
stack.baremetal.v1.chassis.Chassis 422
590 Index
stack.database.v1.instance.Instance attribute), 467

created_at (openstack.load_balancer.v2.pool.Pool at-
stack.dns.v2.recordset.Recordset attribute), 466
tribute), 436 created_at (openstack.network.v2.agent.Agent
created_at (openstack.dns.v2.zone.Zone at- attribute), 481
tribute), 431 created_at (open-
created_at (openstack.network.v2.floating_ip.FloatingIP
stack.dns.v2.zone_export.ZoneExport attribute), 485
created_at (openstack.network.v2.network.Network
stack.dns.v2.zone_import.ZoneImport attribute), 491
attribute), 434 created_at (openstack.network.v2.port.Port
created_at (openstack.image.v1.image.Image attribute), 497
created_at (openstack.image.v2.image.Image stack.network.v2.router.Router attribute),
attribute), 450 504
created_at (open- created_at (open-
stack.image.v2.member.Member at- stack.network.v2.security_group.SecurityGroup
tribute), 455 attribute), 506
created_at (openstack.image.v2.task.Task at- created_at (open-
tribute), 455 stack.network.v2.security_group_rule.SecurityGroupRule
created_at (open- attribute), 507
stack.key_manager.v1.container.Container created_at (open-
created_at (open- tribute), 511
stack.key_manager.v1.order.Order created_at (open-
attribute), 458 stack.network.v2.subnet_pool.SubnetPool
stack.key_manager.v1.secret.Secret created_at (open-
attribute), 459 stack.orchestration.v1.stack.Stack at-
created_at (open- tribute), 513
stack.load_balancer.v2.amphora.Amphora created_at (open-
attribute), 476 stack.workflow.v2.execution.Execution
stack.load_balancer.v2.health_monitor.HealthMonitor
created_at (open-
attribute), 468 stack.workflow.v2.workflow.Workflow
stack.load_balancer.v2.l7_policy.L7Policy creator_id (open-
attribute), 470 stack.key_manager.v1.order.Order
stack.load_balancer.v2.l7_rule.L7Rule Credential (class in open-
attribute), 471 stack.identity.v3.credential), 440
created_at (open- current_location() (open-
stack.load_balancer.v2.listener.Listener stack.connection.Connection property),
attribute), 464 105
created_at (open- current_project() (open-
stack.load_balancer.v2.load_balancer.LoadBalancerstack.connection.Connection property),
attribute), 461 105
created_at (open- current_project_id() (open-
stack.load_balancer.v2.member.Member stack.connection.Connection property),
Index 591
105 default_network_interface (open-

current_user_id() (openstack.baremetal.v1.driver.Driver at-
stack.connection.Connection property), tribute), 379
105 default_pool (open-
stack.load_balancer.v2.listener.Listener
D attribute), 464
data (openstack.clustering.v1.cluster.Cluster at- default_pool_id (open-
tribute), 407 stack.load_balancer.v2.listener.Listener
data (openstack.clustering.v1.cluster_policy.ClusterPolicy attribute), 464
attribute), 410 default_pool_id (open-
data (openstack.clustering.v1.node.Node at- stack.network.v2.listener.Listener at-
tribute), 409 tribute), 487
data (openstack.clustering.v1.policy.Policy at- default_power_interface (open-
tribute), 406 stack.baremetal.v1.driver.Driver at-
data_plane_status (open- tribute), 379
stack.network.v2.port.Port attribute), default_prefix_length (open-
497 stack.network.v2.subnet_pool.SubnetPool
data_timestamp (open- attribute), 512
stack.block_storage.v2.backup.Backup default_project_id (open-
attribute), 397 stack.identity.v3.user.User attribute),
Database (class in open- 447
stack.database.v1.database), 427 default_quota (open-
databases (openstack.database.v1.user.User stack.network.v2.subnet_pool.SubnetPool
datastore (open- default_raid_interface (open-
stack.database.v1.instance.Instance stack.baremetal.v1.driver.Driver at-
deactivate() (open- default_rescue_interface (open-
stack.image.v2.image.Image method), stack.baremetal.v1.driver.Driver at-
453 tribute), 379
default (open- default_storage_interface (open-
stack.baremetal.v1.driver.Driver at-
default_bios_interface (open- default_tls_container_ref (open-
stack.baremetal.v1.driver.Driver at- stack.load_balancer.v2.listener.Listener
default_boot_interface (open- default_tls_container_ref (open-
stack.baremetal.v1.driver.Driver at- stack.network.v2.listener.Listener at-
default_console_interface (open- default_vendor_interface (open-
stack.baremetal.v1.driver.Driver at- stack.baremetal.v1.driver.Driver at-
default_deploy_interface (open- definition (open-
stack.baremetal.v1.driver.Driver at- stack.workflow.v2.workflow.Workflow
default_inspect_interface (open- delay (openstack.load_balancer.v2.health_monitor.HealthMonito
stack.baremetal.v1.driver.Driver at- attribute), 469
tribute), 379 delay (openstack.network.v2.health_monitor.HealthMonitor
default_management_interface (open- attribute), 486
stack.baremetal.v1.driver.Driver at- delete() (open-
tribute), 379 stack.load_balancer.v2.load_balancer.LoadBalancer
592 Index
method), 461 delete_firewall_policy() (open-

delete() (openstack.resource.Resource stack.connection.Connection method),
method), 533 107
delete_accelerator_request() (open- delete_firewall_rule() (open-
stack.connection.Connection method), stack.connection.Connection method),
105 107
delete_after (open- delete_flavor() (open-
stack.object_store.v1.obj.Object at- stack.connection.Connection method),
tribute), 522 108
delete_aggregate() (open- delete_floating_ip() (open-
105 108
delete_at (open- delete_group() (open-
stack.object_store.v1.obj.Object at- stack.connection.Connection method),
tribute), 522 108
delete_autocreated_image_objects() delete_image() (open-
(openstack.connection.Connection stack.connection.Connection method),
method), 105 108
delete_baymodel() (open- delete_keypair() (open-
106 108
delete_cluster_template() (open- delete_network() (open-
106 109
delete_coe_cluster() (open- delete_network_quotas() (open-
106 109
delete_coe_cluster_template() (open- delete_object() (open-
106 109
delete_compute_quotas() (open- delete_port() (open-
106 109
delete_container() (open- delete_project() (open-
106 109
delete_device_profile() (open- delete_qos_bandwidth_limit_rule()
stack.connection.Connection method), (openstack.connection.Connection
106 method), 109
delete_domain() (open- delete_qos_dscp_marking_rule()
106 method), 110
delete_endpoint() (open- delete_qos_minimum_bandwidth_rule()
107 method), 110
delete_extra_specs_property() (open- delete_qos_policy() (open-
stack.compute.v2.flavor.Flavor method), stack.connection.Connection method),
417 110
delete_firewall_group() (open- delete_recordset() (open-
107 110
Index 593
delete_role() (openstack.orchestration.v1.stack.Stack at-

110 depended_by (open-
delete_router() (openstack.clustering.v1.action.Action at-
111 dependents (open-
delete_security_group() (openstack.clustering.v1.cluster.Cluster at-
111 dependents (open-
delete_security_group_rule() (openstack.clustering.v1.node.Node attribute),
111 depends_on (open-
delete_server() (openstack.clustering.v1.action.Action at-
111 deploy_interface (open-
delete_server_group() (openstack.baremetal.v1.node.Node attribute),
111 deploy_step (open-
delete_server_metadata() (openstack.baremetal.v1.node.Node attribute),
112 Deployable (class in open-
delete_service() (openstack.accelerator.v2.deployable), 375
stack.connection.Connection method), description (open-
112 stack.baremetal.v1.chassis.Chassis
delete_stack() (open- attribute), 380
112 stack.block_storage.v2.backup.Backup
delete_subnet() (open- attribute), 397
112 stack.block_storage.v2.snapshot.Snapshot
delete_unattached_floating_ips() attribute), 399
(openstack.connection.Connection description (open-
method), 112 stack.block_storage.v2.volume.Volume
delete_volume() (open- attribute), 401
113 stack.compute.v2.extension.Extension
delete_volume_backup() (open- attribute), 414
113 stack.compute.v2.flavor.Flavor attribute),
delete_volume_quotas() (open- 415
113 stack.compute.v2.server.Server attribute),
delete_volume_snapshot() (open- 422
113 stack.dns.v2.floating_ip.FloatingIP
delete_zone() (open- attribute), 435
114 stack.dns.v2.recordset.Recordset at-
deleted (openstack.orchestration.v1.stack.Stack tribute), 436
attribute), 513 description (openstack.dns.v2.zone.Zone at-
deleted_at (open- tribute), 431
594 Index
description (open- attribute), 473

stack.dns.v2.zone_transfer.ZoneTransferRequest
description (open-
attribute), 432 stack.network.v2.address_group.AddressGroup
stack.identity.v2.extension.Extension description (open-
attribute), 437 stack.network.v2.agent.Agent attribute),
description (openstack.identity.v2.role.Role 481
attribute), 438 description (open-
description (openstack.network.v2.extension.Extension
stack.identity.v2.tenant.Tenant attribute), attribute), 483
439 description (open-
description (openstack.network.v2.flavor.Flavor attribute),
stack.identity.v3.domain.Domain at- 484
tribute), 441 description (open-
description (openstack.network.v2.floating_ip.FloatingIP
stack.identity.v3.group.Group attribute), attribute), 485
443 description (open-
description (openstack.network.v2.listener.Listener at-
stack.identity.v3.project.Project attribute), 487
description (openstack.network.v2.load_balancer.LoadBalancer
stack.identity.v3.service.Service at- attribute), 488
description (openstack.identity.v3.user.User stack.network.v2.metering_label.MeteringLabel
description (open- description (open-
stack.image.v2.service_info.Store at- stack.network.v2.network.Network
description (open- description (openstack.network.v2.pool.Pool
stack.load_balancer.v2.availability_zone.AvailabilityZone
attribute), 494
attribute), 479 description (openstack.network.v2.port.Port
stack.load_balancer.v2.flavor.Flavor description (open-
attribute), 474 stack.network.v2.qos_policy.QoSPolicy
stack.load_balancer.v2.l7_policy.L7Policy description (open-
attribute), 470 stack.network.v2.router.Router attribute),
description (open- 504
stack.load_balancer.v2.listener.Listener description (open-
attribute), 464 stack.network.v2.security_group.SecurityGroup
stack.load_balancer.v2.load_balancer.LoadBalancer
description (open-
attribute), 461 stack.network.v2.security_group_rule.SecurityGroupRule
stack.load_balancer.v2.pool.Pool at- description (open-
tribute), 466 stack.network.v2.segment.Segment
stack.load_balancer.v2.provider.Provider description (open-
attribute), 472 stack.network.v2.service_profile.ServiceProfile
stack.load_balancer.v2.provider.ProviderFlavorCapabilities
description (open-
Index 595
stack.network.v2.subnet.Subnet at- stack.accelerator.v2.device_profile),

tribute), 511 376
description (open- direct_url (openstack.image.v2.image.Image
stack.network.v2.subnet_pool.SubnetPool attribute), 451
attribute), 512 direction (open-
description (openstack.network.v2.metering_label_rule.MeteringLabelRule
stack.orchestration.v1.stack.Stack at- attribute), 490
tribute), 513 direction (open-
description (openstack.network.v2.qos_bandwidth_limit_rule.QoSBandwidt
stack.workflow.v2.execution.Execution attribute), 499
attribute), 523 direction (open-
desired_capacity (openstack.network.v2.qos_minimum_bandwidth_rule.QoSMini
stack.clustering.v1.cluster.Cluster at- attribute), 500
tribute), 407 direction (open-
destination_ip_prefix (openstack.network.v2.security_group_rule.SecurityGroupRule
stack.network.v2.metering_label_rule.MeteringLabelRule
attribute), 507
attribute), 490 disk (openstack.compute.v2.flavor.Flavor at-
detach_ip_from_server() (open- tribute), 415
stack.connection.Connection method), disk_config (open-
detach_port_from_machine() (open- 422
stack.connection.Connection method), disk_format (open-
114 stack.image.v1.image.Image attribute),
detach_vif() (open- 448
stack.baremetal.v1.node.Node method), disk_format (open-
387 stack.image.v2.image.Image attribute),
detach_volume() (open- 450
stack.connection.Connection method), dns_assignment (open-
114 stack.network.v2.port.Port attribute),
details (openstack.clustering.v1.node.Node at- 498
tribute), 409 dns_domain (open-
Device (class in openstack.network.v2.floating_ip.FloatingIP
stack.accelerator.v2.device), 374 attribute), 485
device_id (open- dns_domain (open-
stack.accelerator.v2.deployable.Deployable stack.network.v2.network.Network
device_id (openstack.network.v2.port.Port at- dns_domain (openstack.network.v2.port.Port
device_owner (open- dns_name (open-
stack.network.v2.port.Port attribute), stack.network.v2.floating_ip.FloatingIP
498 attribute), 485
device_profile_group_id (open- dns_name (openstack.network.v2.port.Port at-
tribute), 498
attribute), 377 dns_nameservers (open-
device_profile_name (openstack.network.v2.subnet.Subnet at-
tribute), 511
attribute), 377 dns_publish_fixed_ip (open-
device_rp_uuid (openstack.network.v2.subnet.Subnet at-
tribute), 511
attribute), 377 Domain (class in openstack.identity.v3.domain),
DeviceProfile (class in open- 441
596 Index
domain_id (open- enable_root_user() (open-

stack.clustering.v1.action.Action at- stack.database.v1.instance.Instance
domain_id (open- enabled_bios_interfaces (open-
stack.clustering.v1.cluster.Cluster at- stack.baremetal.v1.driver.Driver at-
domain_id (openstack.clustering.v1.node.Node enabled_boot_interfaces (open-
attribute), 408 stack.baremetal.v1.driver.Driver at-
domain_id (open- tribute), 379
stack.clustering.v1.profile.Profile at- enabled_console_interfaces (open-
tribute), 404 stack.baremetal.v1.driver.Driver at-
domain_id (open- tribute), 379
stack.clustering.v1.receiver.Receiver enabled_deploy_interfaces (open-
attribute), 411 stack.baremetal.v1.driver.Driver at-
domain_id (openstack.identity.v3.group.Group tribute), 380
attribute), 443 enabled_inspect_interfaces (open-
domain_id (openstack.baremetal.v1.driver.Driver at-
tribute), 444 enabled_management_interfaces
domain_id (openstack.identity.v3.user.User at- (openstack.baremetal.v1.driver.Driver
download_image() (open- enabled_network_interfaces (open-
stack.connection.Connection method), stack.baremetal.v1.driver.Driver at-
114 tribute), 380
Driver (class in openstack.baremetal.v1.driver), enabled_power_interfaces (open-
378 stack.baremetal.v1.driver.Driver at-
driver (openstack.baremetal.v1.node.Node attribute), 380
tribute), 381 enabled_raid_interfaces (open-
driver (openstack.network.v2.service_profile.ServiceProfilestack.baremetal.v1.driver.Driver at-
driver_info (open- enabled_rescue_interfaces (open-
stack.baremetal.v1.node.Node attribute), stack.baremetal.v1.driver.Driver at-
381 tribute), 380
driver_internal_info (open- enabled_storage_interfaces (open-
stack.baremetal.v1.node.Node attribute), stack.baremetal.v1.driver.Driver at-
382 tribute), 380
drivers (open- enabled_vendor_interfaces (open-
stack.network.v2.qos_rule_type.QoSRuleType stack.baremetal.v1.driver.Driver at-
dscp_mark (open- end_at (openstack.clustering.v1.action.Action
stack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule
attribute), 412
attribute), 500 endpoint, 577
Endpoint (class in open-
E stack.identity.v3.endpoint), 442
email (openstack.dns.v2.zone.Zone attribute), endpoint_for() (open-
email (openstack.identity.v2.user.User attribute), 115
439 engine (openstack.clustering.v1.build_info.BuildInfo
email (openstack.identity.v3.user.User attribute), attribute), 403
447 environment (open-
enable_logging() (in module openstack), 27 stack.orchestration.v1.stack.Stack at-
Index 597
tribute), 513 stack.network.v2.router.Router attribute),

environment_files (open- 504
stack.orchestration.v1.stack.Stack at- extra (openstack.baremetal.v1.allocation.Allocation
ephemeral (openstack.compute.v2.flavor.Flavor extra (openstack.baremetal.v1.chassis.Chassis
error (openstack.baremetal_introspection.v1.introspection.Introspection
extra (openstack.baremetal.v1.node.Node at-
etag (openstack.object_store.v1.obj.Object at- extra (openstack.baremetal.v1.port.Port at-
ether_type (open- extra (openstack.baremetal.v1.port_group.PortGroup
stack.network.v2.security_group_rule.SecurityGroupRule
attribute), 391
attribute), 507 extra (openstack.baremetal.v1.volume_connector.VolumeConnect
Event (class in openstack.clustering.v1.event), attribute), 394
413 extra (openstack.baremetal.v1.volume_target.VolumeTarget
Execution (class in open- attribute), 395
stack.workflow.v2.execution), 523 extra_dhcp_opts (open-
existing() (openstack.network.v2.port.Port attribute),
stack.compute.v2.keypair.Keypair class 498
method), 419 extra_specs (open-
existing() (openstack.resource.Resource stack.block_storage.v2.type.Type at-
class method), 529 tribute), 400
expected_codes (open- extra_specs (open-
stack.load_balancer.v2.health_monitor.HealthMonitor stack.compute.v2.flavor.Flavor attribute),
attribute), 469 415
expected_codes (open-
F
stack.network.v2.health_monitor.HealthMonitor
attribute), 486 fail_reason (open-
expires_at (openstack.identity.v3.trust.Trust stack.block_storage.v2.backup.Backup
expires_at (openstack.image.v2.task.Task at- fault (openstack.baremetal.v1.node.Node at-
expires_at (open- fetch() (openstack.compute.v2.limits.Limits
stack.key_manager.v1.secret.Secret method), 419
attribute), 459 fetch() (open-
expires_at (openstack.key_manager.v1.secret.Secret
tribute), 521 fetch() (openstack.orchestration.v1.stack.Stack
extend() (open- method), 515
stack.block_storage.v2.volume.Volume fetch() (openstack.resource.Resource method),
method), 402 531
extended_replication_status (open- fetch_extra_specs() (open-
stack.block_storage.v2.volume.Volume stack.compute.v2.flavor.Flavor method),
attribute), 402 416
Extension (class in open- fetch_security_groups() (open-
stack.compute.v2.extension), 414 stack.compute.v2.server.Server method),
Extension (class in open- 425
stack.identity.v2.extension), 437 file (openstack.image.v2.image.Image at-
Extension (class in open- tribute), 451
stack.network.v2.extension), 483 files (openstack.orchestration.v1.stack.Stack
external_gateway_info (open- attribute), 514
598 Index
files_container (openstack.load_balancer.v2.flavor_profile),

stack.orchestration.v1.stack.Stack at- 473
tribute), 514 floating_ip_address (open-
find() (openstack.image.v1.image.Image class stack.network.v2.floating_ip.FloatingIP
method), 449 attribute), 485
find() (openstack.image.v2.image.Image class floating_ips (open-
method), 454 stack.compute.v2.limits.AbsoluteLimits
find() (openstack.orchestration.v1.stack.Stack attribute), 420
class method), 516 floating_ips (open-
find() (openstack.resource.Resource class stack.network.v2.quota.Quota attribute),
method), 534 502
fingerprint (open- floating_ips_used (open-
stack.compute.v2.keypair.Keypair at- stack.compute.v2.limits.AbsoluteLimits
finished_at (open- floating_network_id (open-
stack.network.v2.floating_ip.FloatingIP
fixed_ip_address (open- FloatingIP (class in open-
stack.network.v2.floating_ip.FloatingIP stack.dns.v2.floating_ip), 435
attribute), 485 FloatingIP (class in open-
fixed_ips (openstack.network.v2.floating_ip), 485
stack.compute.v2.server_interface.ServerInterface
force (openstack.block_storage.v2.backup.Backup
fixed_ips (openstack.network.v2.port.Port at- force_delete() (open-
tribute), 498 stack.clustering.v1.cluster.Cluster
Flavor (class in openstack.compute.v2.flavor), method), 408
415 force_delete() (open-
Flavor (class in openstack.database.v1.flavor), stack.clustering.v1.node.Node method),
428 410
Flavor (class in open- force_delete() (open-
stack.load_balancer.v2.flavor), 473 stack.compute.v2.server.Server method),
Flavor (class in openstack.network.v2.flavor), 424
484 from_config() (in module open-
flavor (openstack.database.v1.instance.Instance stack.connection), 80
attribute), 428 full_name() (open-
flavor_data (openstack.config.cloud_region.CloudRegion
stack.load_balancer.v2.flavor_profile.FlavorProfile property), 22
attribute), 473
flavor_id (openstack.compute.v2.server.Server G
attribute), 422 gateway_ip (open-
flavor_id (openstack.network.v2.subnet.Subnet at-
stack.load_balancer.v2.load_balancer.LoadBalancer tribute), 511
attribute), 461 generated_at (open-
flavor_id (openstack.network.v2.router.Router stack.clustering.v1.event.Event attribute),
attribute), 504 413
flavor_profile_id (open- get_access() (open-
stack.load_balancer.v2.flavor.Flavor stack.compute.v2.flavor.Flavor method),
attribute), 474 416
FlavorDetail (in module open- get_aggregate() (open-
stack.compute.v2.flavor), 417 stack.connection.Connection method),
FlavorProfile (class in open- 115
Index 599
get_auth() (open- get_endpoint() (open-

stack.config.cloud_region.CloudRegion stack.connection.Connection method),
method), 22 118
get_baymodel() (open- get_endpoint_from_catalog() (open-
stack.connection.Connection method), stack.config.cloud_region.CloudRegion
115 method), 22
get_cache_resource_expiration() get_external_ipv4_floating_networks()
(openstack.config.cloud_region.CloudRegion (openstack.connection.Connection
get_client_config() (open- get_external_ipv4_networks() (open-
stack.config.cloud_region.CloudRegion stack.config.cloud_region.CloudRegion
get_cluster_template() (open- get_external_ipv4_networks() (open-
116 118
get_coe_cluster() (open- get_external_ipv6_networks() (open-
116 method), 23
get_coe_cluster_certificate() (open- get_external_ipv6_networks() (open-
116 118
get_coe_cluster_template() (open- get_external_networks() (open-
117 method), 23
get_compute_limits() (open- get_external_networks() (open-
117 119
get_compute_quotas() (open- get_extra_config() (open-
stack.connection.Connection method), stack.config.OpenStackConfig method),
117 19
get_compute_usage() (open- get_extra_specs_property() (open-
stack.connection.Connection method), stack.compute.v2.flavor.Flavor method),
117 417
get_container() (open- get_firewall_group() (open-
117 119
get_container_access() (open- get_firewall_policy() (open-
118 119
get_data() (open- get_firewall_rule() (open-
stack.connection.Connection method),
method), 396 119
get_default_network() (open- get_flavor() (open-
method), 23 119
get_default_network() (open- get_flavor_by_id() (open-
118 120
get_domain() (open- get_flavor_by_ram() (open-
118 120
600 Index
get_floating_ip() (open- get_nat_source() (open-

120 122
get_floating_ip_by_id() (open- get_network() (open-
121 123
get_group() (open- get_network_by_id() (open-
121 123
get_image() (open- get_network_extensions() (open-
121 123
get_image_by_id() (open- get_network_quotas() (open-
121 123
get_internal_ipv4_networks() (open- get_nic_by_mac() (open-
method), 23 123
get_internal_ipv4_networks() (open- get_object() (open-
121 123
get_internal_ipv6_networks() (open- get_object_raw() (open-
method), 23 124
get_internal_ipv6_networks() (open- get_object_segment_size() (open-
121 124
get_internal_networks() (open- get_one() (openstack.config.OpenStackConfig
stack.config.cloud_region.CloudRegion method), 19
method), 23 get_one_cloud() (open-
get_internal_networks() (openstack.config.OpenStackConfig method),
122 get_one_cloud_osc() (open-
get_keypair() (openstack.config.OpenStackConfig method),
122 get_password() (open-
get_machine() (openstack.compute.v2.server.Server method),
122 get_port() (openstack.connection.Connection
get_machine_by_mac() (open- method), 124
stack.connection.Connection method), get_port_by_id() (open-
get_nat_destination() (open- 124
stack.config.cloud_region.CloudRegion get_project() (open-
get_nat_destination() (open- 124
stack.connection.Connection method), get_qos_bandwidth_limit_rule()
122 (openstack.connection.Connection
get_nat_source() (open- method), 125
stack.config.cloud_region.CloudRegion get_qos_dscp_marking_rule() (open-
Index 601
125 get_session_client() (open-

get_qos_minimum_bandwidth_rule() stack.config.cloud_region.CloudRegion
(openstack.connection.Connection method), 22
method), 125 get_session_endpoint() (open-
get_qos_policy() (openstack.config.cloud_region.CloudRegion
125 get_stack() (open-
get_qos_rule_type_details() (openstack.connection.Connection method),
126 get_subnet() (open-
get_recordset() (openstack.connection.Connection method),
126 get_subnet_by_id() (open-
get_requests_verify_args() (openstack.connection.Connection method),
stack.config.cloud_region.CloudRegion 129
method), 22 get_user() (openstack.connection.Connection
get_role() (openstack.connection.Connection method), 129
method), 126 get_user_by_id() (open-
get_router() (openstack.connection.Connection method),
126 get_volume() (open-
get_security_group() (openstack.connection.Connection method),
127 get_volume_attach_device() (open-
get_security_group_by_id() (openstack.connection.Connection method),
127 get_volume_backup() (open-
get_server() (openstack.connection.Connection method),
127 get_volume_by_id() (open-
get_server_by_id() (openstack.connection.Connection method),
128 get_volume_limits() (open-
get_server_console() (openstack.connection.Connection method),
128 get_volume_quotas() (open-
get_server_group() (openstack.connection.Connection method),
128 get_volume_snapshot() (open-
get_service() (openstack.connection.Connection method),
128 get_volume_snapshot_by_id() (open-
get_service_catalog() (openstack.connection.Connection method),
method), 22 get_volume_type() (open-
get_services() (openstack.connection.Connection method),
method), 22 get_volume_type_access() (open-
get_session() (openstack.connection.Connection method),
method), 22 get_zone() (openstack.connection.Connection
602 Index

global_request() (open- health_monitors (open-
stack.connection.Connection method), stack.network.v2.quota.Quota attribute),
132 502
grant_role() (open- HealthMonitor (class in open-
stack.connection.Connection method), stack.load_balancer.v2.health_monitor),
132 468
Group (class in openstack.identity.v3.group), 443 HealthMonitor (class in open-
groups (openstack.accelerator.v2.device_profile.DeviceProfile stack.network.v2.health_monitor),
attribute), 376 486
host, 577
H host (openstack.block_storage.v2.volume.Volume
ha_ip (openstack.load_balancer.v2.amphora.Amphora attribute), 402
attribute), 475 host (openstack.network.v2.agent.Agent at-
ha_port_id (open- tribute), 481
stack.load_balancer.v2.amphora.Amphora host_id (openstack.compute.v2.server.Server
ha_state (openstack.network.v2.agent.Agent host_routes (open-
has_auto_disk_config (open- tribute), 511
stack.image.v2.image.Image attribute), host_status (open-
has_body (openstack.resource.Resource at- 422
tribute), 529 hostname (open-
has_config_drive (openstack.accelerator.v2.accelerator_request.AcceleratorRequ
stack.compute.v2.server.Server attribute), attribute), 377
422 hostname (open-
has_dependent_backups (openstack.accelerator.v2.device.Device
stack.block_storage.v2.backup.Backup attribute), 374
attribute), 397 hostname (openstack.compute.v2.server.Server
hash_algo (openstack.image.v2.image.Image attribute), 422
attribute), 450 hostname (open-
hash_value (openstack.image.v2.image.Image stack.database.v1.instance.Instance
head() (openstack.resource.Resource method), hosts (openstack.baremetal.v1.driver.Driver at-
532 tribute), 379
Header (class in openstack.resource), 526 http_method (open-
health_monitor_id (openstack.load_balancer.v2.health_monitor.HealthMonitor
stack.load_balancer.v2.pool.Pool at- attribute), 469
tribute), 466 http_method (open-
health_monitor_id (openstack.network.v2.health_monitor.HealthMonitor
stack.network.v2.pool.Pool attribute), attribute), 486
494 hw_cpu_cores (open-
health_monitor_ids (openstack.image.v2.image.Image attribute),
stack.network.v2.pool.Pool attribute), 452
494 hw_cpu_policy (open-
health_monitor_status (openstack.image.v2.image.Image attribute),
stack.network.v2.pool.Pool attribute), 452
494 hw_cpu_sockets (open-
health_monitors (openstack.image.v2.image.Image attribute),
stack.load_balancer.v2.quota.Quota 452
Index 603
hw_cpu_thread_policy (open- tribute), 380

stack.image.v2.image.Image attribute), id (openstack.baremetal.v1.node.Node attribute),
452 382
hw_cpu_threads (open- id (openstack.baremetal.v1.port.Port attribute),
stack.image.v2.image.Image attribute), 390
452 id (openstack.baremetal.v1.port_group.PortGroup
hw_disk_bus (open- attribute), 391
stack.image.v2.image.Image attribute), id (openstack.baremetal.v1.volume_connector.VolumeConnector
452 attribute), 394
hw_machine_type (open- id (openstack.baremetal.v1.volume_target.VolumeTarget
stack.image.v2.image.Image attribute), attribute), 395
452 id (openstack.baremetal_introspection.v1.introspection.Introspecti
hw_qemu_guest_agent (open- attribute), 396
stack.image.v2.image.Image attribute), id (openstack.block_storage.v2.snapshot.Snapshot
453 attribute), 399
hw_rng_model (open- id (openstack.block_storage.v2.type.Type at-
stack.image.v2.image.Image attribute), tribute), 400
452 id (openstack.block_storage.v2.volume.Volume
hw_scsi_model (open- attribute), 401
stack.image.v2.image.Image attribute), id (openstack.compute.v2.keypair.Keypair at-
452 tribute), 418
hw_serial_port_count (open- id (openstack.database.v1.instance.Instance at-
453 id (openstack.load_balancer.v2.amphora.Amphora
hw_video_model (open- attribute), 475
stack.image.v2.image.Image attribute), id (openstack.load_balancer.v2.availability_zone_profile.Availabil
453 attribute), 478
hw_video_ram (open- id (openstack.load_balancer.v2.flavor.Flavor at-
453 id (openstack.load_balancer.v2.flavor_profile.FlavorProfile
hw_vif_model (open- attribute), 473
stack.image.v2.image.Image attribute), id (openstack.network.v2.address_group.AddressGroup
453 attribute), 479
hw_watchdog_action (open- id (openstack.resource.Resource attribute), 528
stack.image.v2.image.Image attribute), identity, 577
453 if_match (openstack.object_store.v1.obj.Object
hypervisor_hostname (open- attribute), 521
stack.compute.v2.server.Server attribute), if_modified_since (open-
423 stack.object_store.v1.obj.Object at-
hypervisor_type (open- tribute), 521
stack.image.v2.image.Image attribute), if_none_match (open-
451 stack.object_store.v1.container.Container
attribute), 519
I if_none_match (open-
id (openstack.accelerator.v2.deployable.Deployable stack.object_store.v1.obj.Object at-
id (openstack.accelerator.v2.device.Device if_unmodified_since (open-
attribute), 374 stack.object_store.v1.obj.Object at-
id (openstack.baremetal.v1.allocation.Allocation tribute), 521
attribute), 392 image, 577
id (openstack.baremetal.v1.chassis.Chassis at- Image (class in openstack.compute.v2.image),
604 Index
417 383
Image (class in openstack.image.v1.image), 448 inspect_machine() (open-
Image (class in openstack.image.v2.image), 450 stack.connection.Connection method),
image (openstack.compute.v2.server.Server at- 133
tribute), 423 Instance (class in open-
image_id (openstack.database.v1.instance), 428
stack.block_storage.v2.volume.Volume instance_id (open-
attribute), 401 stack.baremetal.v1.node.Node attribute),
image_id (openstack.compute.v2.server.Server 382
attribute), 423 instance_id (open-
image_id (openstack.image.v2.member.Member stack.database.v1.database.Database
image_id (open- instance_info (open-
stack.load_balancer.v2.amphora.Amphora stack.baremetal.v1.node.Node attribute),
attribute), 476 382
image_meta (open- instance_name (open-
stack.compute.v2.limits.AbsoluteLimits stack.compute.v2.server.Server attribute),
attribute), 420 423
ImageDetail (in module open- instance_type_rxtx_factor (open-
stack.compute.v2.image), 418 stack.image.v2.image.Image attribute),
Import (class in open- 451
stack.image.v2.service_info), 456 instance_uuid (open-
import_image() (openstack.accelerator.v2.accelerator_request.AcceleratorRequ
stack.image.v2.image.Image method), attribute), 377
454 instance_uuid (open-
import_methods (openstack.image.v2.image.Image attribute),
stack.image.v2.service_info.Import 451
attribute), 457 instances (open-
index (openstack.clustering.v1.node.Node stack.compute.v2.limits.AbsoluteLimits
init_at (openstack.clustering.v1.cluster.Cluster instances_used (open-
attribute), 406 stack.compute.v2.limits.AbsoluteLimits
init_at (openstack.clustering.v1.node.Node at- attribute), 420
tribute), 408 interface (open-
input (openstack.image.v2.task.Task attribute), stack.identity.v3.endpoint.Endpoint
455 attribute), 442
input (openstack.workflow.v2.workflow.Workflow internal_info (open-
attribute), 524 stack.baremetal.v1.port.Port attribute),
inputs (openstack.clustering.v1.action.Action 390
attribute), 412 internal_info (open-
insert_headers (openstack.baremetal.v1.port_group.PortGroup
stack.load_balancer.v2.listener.Listener attribute), 391
attribute), 464 interval (open-
insert_rule_into_policy() (openstack.clustering.v1.action.Action at-
133 Introspection (class in open-
insert_user_agent() (openstack.baremetal_introspection.v1.introspection),
method), 22 ip_version (open-
inspect_interface (openstack.network.v2.address_scope.AddressScope
stack.baremetal.v1.node.Node attribute), attribute), 480
Index 605
ip_version (open- is_admin_state_up (open-

stack.network.v2.subnet.Subnet at- stack.network.v2.network.Network
ip_version (open- is_admin_state_up (open-
stack.network.v2.subnet_pool.SubnetPool stack.network.v2.pool.Pool attribute),
attribute), 512 494
ipv4_address_scope_id (open- is_admin_state_up (open-
stack.network.v2.network.Network stack.network.v2.pool_member.PoolMember
ipv6_address_mode (open- is_admin_state_up (open-
stack.network.v2.subnet.Subnet at- stack.network.v2.port.Port attribute),
tribute), 511 498
ipv6_address_scope_id (open- is_admin_state_up (open-
stack.network.v2.network.Network stack.network.v2.router.Router attribute),
attribute), 491 504
ipv6_ra_mode (open- is_alive (openstack.network.v2.agent.Agent
stack.network.v2.subnet.Subnet at- attribute), 481
tribute), 511 is_automated_clean_enabled (open-
is_admin_state_up (openstack.baremetal.v1.node.Node attribute),
382
attribute), 469 is_bootable (open-
is_admin_state_up (openstack.block_storage.v2.volume.Volume
stack.load_balancer.v2.l7_policy.L7Policy attribute), 401
attribute), 470 is_console_enabled (open-
is_admin_state_up (openstack.baremetal.v1.node.Node attribute),
stack.load_balancer.v2.l7_rule.L7Rule 382
attribute), 471 is_content_type_detected (open-
is_admin_state_up (openstack.object_store.v1.container.Container
attribute), 464 is_content_type_detected (open-
is_admin_state_up (openstack.object_store.v1.obj.Object at-
stack.load_balancer.v2.load_balancer.LoadBalancertribute), 522
attribute), 460 is_default (open-
is_admin_state_up (openstack.image.v2.service_info.Store at-
stack.load_balancer.v2.member.Member tribute), 456
is_admin_state_up (openstack.network.v2.network.Network
tribute), 466 is_default (open-
is_admin_state_up (openstack.network.v2.qos_policy.QoSPolicy
stack.network.v2.agent.Agent attribute), attribute), 501
481 is_default (open-
is_admin_state_up (openstack.network.v2.service_provider.ServiceProvider
stack.network.v2.health_monitor.HealthMonitor attribute), 510
is_admin_state_up (openstack.network.v2.subnet_pool.SubnetPool
stack.network.v2.listener.Listener at- attribute), 512
tribute), 487 is_deleted (open-
is_admin_state_up (openstack.compute.v2.keypair.Keypair at-
stack.network.v2.load_balancer.LoadBalancer tribute), 418
attribute), 488 is_dhcp_enabled (open-
606 Index
stack.network.v2.subnet.Subnet at- stack.network.v2.metering_label_rule.MeteringLabelRule

is_disabled (open- is_finished (open-
stack.compute.v2.flavor.Flavor attribute), stack.baremetal_introspection.v1.introspection.Introspecti
415 attribute), 396
is_distributed (open- is_forced (open-
stack.network.v2.router.Router attribute), stack.block_storage.v2.snapshot.Snapshot
504 attribute), 399
is_domain (open- is_ha (openstack.network.v2.router.Router at-
tribute), 444 is_hidden (openstack.image.v2.image.Image
is_enabled (open- attribute), 450
is_hw_boot_menu_enabled (open-
attribute), 410 stack.image.v2.image.Image attribute),
is_enabled (openstack.identity.v2.role.Role at- 453
tribute), 438 is_hw_vif_multiqueue_enabled (open-
is_enabled (openstack.image.v2.image.Image attribute),
stack.identity.v2.tenant.Tenant attribute), 453
439 is_impersonation (open-
is_enabled (openstack.identity.v2.user.User stack.identity.v3.trust.Trust attribute),
attribute), 439 446
is_enabled (open- is_incremental (open-
stack.identity.v3.domain.Domain at- stack.block_storage.v2.backup.Backup
is_enabled (open- is_maintenance (open-
stack.identity.v3.endpoint.Endpoint stack.baremetal.v1.node.Node attribute),
attribute), 442 382
is_enabled (open- is_newest (open-
stack.identity.v3.project.Project at- stack.object_store.v1.container.Container
is_enabled (open- is_newest (open-
stack.identity.v3.service.Service at- stack.object_store.v1.obj.Object at-
is_enabled (openstack.identity.v3.user.User is_object_stale() (open-
is_enabled (open- 134
stack.load_balancer.v2.availability_zone.AvailabilityZone
is_port_security_enabled (open-
attribute), 479 stack.network.v2.network.Network
is_enabled (open- attribute), 491
stack.load_balancer.v2.flavor.Flavor is_port_security_enabled (open-
attribute), 474 stack.network.v2.port.Port attribute),
is_enabled (open- 498
stack.network.v2.flavor.Flavor attribute), is_profile_only (open-
484 stack.clustering.v1.cluster.Cluster at-
is_enabled (open- tribute), 407
stack.network.v2.service_profile.ServiceProfile
is_protected (open-
is_encrypted (open- 448
stack.block_storage.v2.volume.Volume is_protected (open-
is_excluded (open- 450
Index 607
is_public (open- K
stack.block_storage.v2.type.Type at- kernel_id (openstack.compute.v2.server.Server
is_public (openstack.compute.v2.flavor.Flavor kernel_id (openstack.image.v2.image.Image
is_public (openstack.image.v1.image.Image key (openstack.load_balancer.v2.l7_rule.L7Rule
is_pxe_enabled (open- key_name (openstack.compute.v2.server.Server
stack.baremetal.v1.port.Port attribute), attribute), 423
390 keypair, 577
is_retired (open- Keypair (class in open-
stack.baremetal.v1.node.Node attribute), stack.compute.v2.keypair), 418
382 keypairs (open-
is_rollback_disabled (openstack.compute.v2.limits.AbsoluteLimits
tribute), 514 keys() (openstack.resource.Resource method),
is_root_enabled() (open- 529
stack.database.v1.instance.Instance
method), 429 L
is_router_external (open- l7_policies (open-
stack.network.v2.network.Network stack.load_balancer.v2.listener.Listener
is_shared (open- l7_policies (open-
stack.network.v2.address_scope.AddressScope stack.network.v2.quota.Quota attribute),
attribute), 481 503
is_shared (open- l7_policy_id (open-
stack.network.v2.metering_label.MeteringLabel stack.load_balancer.v2.l7_rule.L7Rule
is_shared (open- L7Policy (class in open-
stack.network.v2.network.Network stack.load_balancer.v2.l7_policy),
attribute), 491 470
is_shared (open- L7Rule (class in open-
stack.network.v2.qos_policy.QoSPolicy stack.load_balancer.v2.l7_rule), 471
attribute), 501 last_error (open-
is_shared (openstack.baremetal.v1.allocation.Allocation
stack.network.v2.subnet_pool.SubnetPool attribute), 392
attribute), 512 last_error (open-
is_standalone_ports_supported (openstack.baremetal.v1.node.Node attribute),
stack.baremetal.v1.port_group.PortGroup 382
attribute), 392 last_heartbeat_at (open-
is_static_large_object (openstack.network.v2.agent.Agent attribute),
stack.object_store.v1.obj.Object at- 481
tribute), 522 last_modified_at (open-
is_user_in_group() (openstack.object_store.v1.obj.Object at-
134 launch_index (open-
is_vlan_transparent (openstack.compute.v2.server.Server attribute),
stack.network.v2.network.Network 423
attribute), 492 launched_at (open-
items() (openstack.resource.Resource method), stack.compute.v2.server.Server attribute),
529 423
608 Index
lb_algorithm (open- links (openstack.database.v1.flavor.Flavor at-

stack.load_balancer.v2.pool.Pool attribute), 428
tribute), 466 links (openstack.database.v1.instance.Instance
lb_algorithm (open- attribute), 428
stack.network.v2.pool.Pool attribute), links (openstack.dns.v2.recordset.Recordset at-
495 tribute), 436
lb_id (openstack.load_balancer.v2.load_balancer.LoadBalancerFailover
links (openstack.dns.v2.zone.Zone attribute),
attribute), 463 431
lb_id (openstack.load_balancer.v2.load_balancer.LoadBalancerStats
links (openstack.dns.v2.zone_export.ZoneExport
lb_network_ip (open- links (openstack.dns.v2.zone_import.ZoneImport
stack.load_balancer.v2.amphora.Amphora attribute), 434
attribute), 475 links (openstack.identity.v2.extension.Extension
level (openstack.clustering.v1.event.Event at- attribute), 437
tribute), 413 links (openstack.identity.v3.domain.Domain at-
license tribute), 441
agreement, 554 links (openstack.identity.v3.endpoint.Endpoint
Limits (class in openstack.compute.v2.limits), attribute), 442
419 links (openstack.identity.v3.policy.Policy at-
limits (openstack.compute.v2.limits.RateLimit tribute), 443
attribute), 421 links (openstack.identity.v3.service.Service at-
links (openstack.baremetal.v1.allocation.Allocation tribute), 445
attribute), 393 links (openstack.identity.v3.trust.Trust at-
links (openstack.baremetal.v1.chassis.Chassis tribute), 446
attribute), 381 links (openstack.identity.v3.user.User attribute),
links (openstack.baremetal.v1.driver.Driver at- 447
tribute), 379 links (openstack.network.v2.extension.Extension
links (openstack.baremetal.v1.node.Node at- attribute), 484
tribute), 382 links (openstack.orchestration.v1.resource.Resource
links (openstack.baremetal.v1.port.Port at- attribute), 517
tribute), 390 links (openstack.orchestration.v1.stack.Stack
links (openstack.baremetal.v1.port_group.PortGroup attribute), 514
attribute), 392 list() (openstack.compute.v2.flavor.Flavor
links (openstack.baremetal.v1.volume_connector.VolumeConnector
class method), 416
attribute), 394 list() (openstack.compute.v2.server_ip.ServerIP
links (openstack.baremetal.v1.volume_target.VolumeTarget class method), 426
attribute), 395 list() (openstack.identity.v2.extension.Extension
links (openstack.baremetal_introspection.v1.introspection.Introspection
class method), 437
attribute), 396 list() (openstack.resource.Resource class
links (openstack.block_storage.v2.backup.Backup method), 533
attribute), 397 list_accelerator_requests() (open-
links (openstack.block_storage.v2.volume.Volume stack.connection.Connection method),
attribute), 401 134
links (openstack.compute.v2.extension.Extension list_aggregates() (open-
links (openstack.compute.v2.flavor.Flavor at- 134
tribute), 415 list_containers() (open-
links (openstack.compute.v2.image.Image at- stack.connection.Connection method),
tribute), 417 134
links (openstack.compute.v2.server.Server at- list_deployables() (open-
tribute), 422 stack.connection.Connection method),
Index 609
135 136
list_device_profiles() (open- list_objects() (open-
135 136
list_devices() (open- list_ports() (open-
135 137
list_domains() (open- list_ports_attached_to_machine()
135 method), 137
list_endpoints() (open- list_qos_bandwidth_limit_rules()
135 method), 137
list_firewall_groups() (open- list_qos_dscp_marking_rules() (open-
135 137
list_firewall_policies() (open- list_qos_minimum_bandwidth_rules()
135 method), 137
list_firewall_rules() (open- list_qos_policies() (open-
135 138
list_flavor_access() (open- list_qos_rule_types() (open-
135 138
list_floating_ip_pools() (open- list_recordsets() (open-
136 138
list_floating_ips() (open- list_role_assignments() (open-
136 138
list_hypervisors() (open- list_roles() (open-
136 138
list_keypairs() (open- list_router_interfaces() (open-
136 139
list_machines() (open- list_routers() (open-
136 139
list_magnum_services() (open- list_security_groups() (open-
136 139
list_networks() (open- list_server_groups() (open-
136 139
list_nics() (open- list_server_security_groups() (open-
136 139
list_nics_for_machine() (open- list_servers() (open-
610 Index
139 ListenerStats (class in open-

list_services() (openstack.load_balancer.v2.listener), 465
stack.connection.Connection method), load_balancer_id (open-
139 stack.load_balancer.v2.listener.Listener
list_subnets() (open- attribute), 464
stack.connection.Connection method), load_balancer_id (open-
140 stack.network.v2.listener.Listener at-
list_vifs() (open- tribute), 488
stack.baremetal.v1.node.Node method), load_balancer_id (open-
387 stack.network.v2.pool.Pool attribute),
list_volume_backups() (open- 495
stack.connection.Connection method), load_balancer_ids (open-
140 stack.network.v2.listener.Listener at-
list_volume_snapshots() (open- tribute), 487
stack.connection.Connection method), load_balancer_ids (open-
140 stack.network.v2.pool.Pool attribute),
list_zones() (open- 495
stack.connection.Connection method), load_balancers (open-
140 stack.load_balancer.v2.listener.Listener
Listener (class in open- attribute), 464
stack.load_balancer.v2.listener), 463 load_balancers (open-
Listener (class in openstack.load_balancer.v2.quota.Quota
stack.network.v2.listener), 487 attribute), 474
listener_id (open- load_balancers (open-
stack.load_balancer.v2.l7_policy.L7Policy stack.network.v2.quota.Quota attribute),
attribute), 470 502
listener_id (open- LoadBalancer (class in open-
stack.load_balancer.v2.listener.ListenerStats stack.load_balancer.v2.load_balancer),
attribute), 465 460
listener_id (open- LoadBalancer (class in open-
stack.load_balancer.v2.pool.Pool at- stack.network.v2.load_balancer), 488
tribute), 466 loadbalancer_id (open-
listener_id (openstack.network.v2.pool.Pool stack.load_balancer.v2.amphora.Amphora
listener_ids (open- loadbalancer_id (open-
stack.network.v2.load_balancer.LoadBalancer stack.load_balancer.v2.pool.Pool at-
listener_ids (open- LoadBalancerFailover (class in open-
stack.network.v2.pool.Pool attribute), stack.load_balancer.v2.load_balancer),
495 462
listeners (open- loadbalancers (open-
stack.load_balancer.v2.load_balancer.LoadBalancerstack.load_balancer.v2.pool.Pool at-
listeners (open- LoadBalancerStats (class in open-
stack.load_balancer.v2.pool.Pool at- stack.load_balancer.v2.load_balancer),
tribute), 466 462
listeners (open- local_link_connection (open-
stack.load_balancer.v2.quota.Quota stack.baremetal.v1.port.Port attribute),
attribute), 474 391
listeners (openstack.network.v2.quota.Quota location (openstack.image.v1.image.Image at-
Index 611
location (openstack.resource.Resource at- Member (class in open-

tribute), 528 stack.load_balancer.v2.member), 467
locations (openstack.image.v2.image.Image member_id (open-
attribute), 451 stack.image.v2.member.Member at-
logical_resource_id (open- tribute), 455
stack.orchestration.v1.resource.Resource member_ids (openstack.network.v2.pool.Pool
members (openstack.load_balancer.v2.pool.Pool
M attribute), 466
mac_addr (open- members (open-
stack.compute.v2.server_interface.ServerInterface stack.load_balancer.v2.quota.Quota
mac_address (openstack.network.v2.port.Port message (open-
attribute), 498 stack.dns.v2.zone_export.ZoneExport
magic_fixes() (open- attribute), 433
stack.config.OpenStackConfig method), message (open-
19 stack.dns.v2.zone_import.ZoneImport
maintenance_reason (open- attribute), 434
stack.baremetal.v1.node.Node attribute), message (openstack.image.v2.task.Task at-
382 tribute), 455
management_interface (open- meta (openstack.key_manager.v1.order.Order at-
stack.baremetal.v1.node.Node attribute), tribute), 458
383 meta_data (openstack.clustering.v1.event.Event
masters (openstack.dns.v2.zone.Zone attribute), attribute), 414
431 meta_info (open-
max_burst_kbps (openstack.network.v2.service_profile.ServiceProfile
stack.network.v2.qos_bandwidth_limit_rule.QoSBandwidthLimitRule
attribute), 509
attribute), 499 meta_temp_url_key (open-
max_kbps (openstack.object_store.v1.account.Account
attribute), 518
attribute), 499 meta_temp_url_key (open-
max_retries (openstack.object_store.v1.container.Container
attribute), 519
attribute), 469 meta_temp_url_key_2 (open-
max_retries (openstack.object_store.v1.account.Account
stack.network.v2.health_monitor.HealthMonitor attribute), 518
attribute), 486 meta_temp_url_key_2 (open-
max_retries_down (openstack.object_store.v1.container.Container
attribute), 519
attribute), 469 metadata (open-
max_size (openstack.block_storage.v2.snapshot.Snapshot
tribute), 407 metadata (open-
maximum (openstack.block_storage.v2.volume.Volume
attribute), 401
attribute), 494 metadata (open-
maximum_prefix_length (openstack.clustering.v1.cluster.Cluster at-
stack.network.v2.subnet_pool.SubnetPool tribute), 407
attribute), 512 metadata (openstack.clustering.v1.node.Node
Member (class in openstack.image.v2.member), attribute), 409
454 metadata (open-
612 Index
stack.clustering.v1.profile.Profile at- minimum_prefix_length (open-

tribute), 404 stack.network.v2.subnet_pool.SubnetPool
metadata (openstack.compute.v2.image.Image attribute), 512
attribute), 417 mode (openstack.baremetal.v1.port_group.PortGroup
metadata (openstack.compute.v2.server.Server attribute), 392
attribute), 423 mode (openstack.key_manager.v1.secret.Secret at-
metadata (open- tribute), 459
stack.dns.v2.zone_export.ZoneExport model (openstack.accelerator.v2.device.Device
metadata (open- module
stack.dns.v2.zone_import.ZoneImport openstack.accelerator.v2._proxy,
attribute), 434 168
metadata (openstack.image.v2.image.Image at- openstack.accelerator.v2.accelerator_reque
tribute), 451 377
metering_label_id (open- openstack.accelerator.v2.deployable,
375
attribute), 490 openstack.accelerator.v2.device,
MeteringLabel (class in open- 374
stack.network.v2.metering_label), 489 openstack.accelerator.v2.device_profile,
MeteringLabelRule (class in open- 376
stack.network.v2.metering_label_rule), openstack.baremetal.v1._proxy,
490 171
microversion (openstack.resource.Resource openstack.baremetal.v1.allocation,
attribute), 529 392
migration_id (open- openstack.baremetal.v1.chassis,
stack.block_storage.v2.volume.Volume 380
attribute), 402 openstack.baremetal.v1.driver,
migration_status (open- 378
stack.block_storage.v2.volume.Volume openstack.baremetal.v1.node, 381
attribute), 402 openstack.baremetal.v1.port, 390
min_disk (openstack.compute.v2.image.Image openstack.baremetal.v1.port_group,
attribute), 417 391
min_disk (openstack.image.v1.image.Image at- openstack.baremetal.v1.volume_connector,
tribute), 449 393
min_disk (openstack.image.v2.image.Image at- openstack.baremetal.v1.volume_target,
tribute), 450 394
min_kbps (open- openstack.baremetal_introspection.v1._prox
stack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule
192
attribute), 500 openstack.baremetal_introspection.v1.intro
min_ram (openstack.compute.v2.image.Image at- 395
tribute), 417 openstack.block_storage.v2._proxy,
min_ram (openstack.image.v1.image.Image at- 194
tribute), 449 openstack.block_storage.v2.backup,
min_ram (openstack.image.v2.image.Image at- 397
tribute), 450 openstack.block_storage.v2.snapshot,
min_size (open- 399
stack.clustering.v1.cluster.Cluster at- openstack.block_storage.v2.type,
tribute), 407 400
minimum (open- openstack.block_storage.v2.volume,
401
attribute), 494 openstack.clustering.v1._proxy,
Index 613
199 openstack.dns.v2.zone, 430

openstack.clustering.v1.action, openstack.dns.v2.zone_export,
412 433
openstack.clustering.v1.build_info, openstack.dns.v2.zone_import,
403 434
openstack.clustering.v1.cluster, openstack.dns.v2.zone_transfer,
406 431
openstack.clustering.v1.cluster_policy,
openstack.identity.v2._proxy,
410 252
openstack.clustering.v1.event, openstack.identity.v2.extension,
413 437
openstack.clustering.v1.node, openstack.identity.v2.role, 438
408 openstack.identity.v2.tenant,
openstack.clustering.v1.policy, 439
405 openstack.identity.v2.user, 439
openstack.clustering.v1.policy_type,openstack.identity.v3._proxy,
405 256
openstack.clustering.v1.profile, openstack.identity.v3.credential,
404 440
openstack.clustering.v1.profile_type,
openstack.identity.v3.domain,
403 441
openstack.clustering.v1.receiver, openstack.identity.v3.endpoint,
411 442
openstack.compute.v2._proxy, 217 openstack.identity.v3.group, 443
openstack.compute.v2.extension, openstack.identity.v3.policy,
414 443
openstack.compute.v2.flavor, 415 openstack.identity.v3.project,
openstack.compute.v2.image, 417 444
openstack.compute.v2.keypair, openstack.identity.v3.service,
418 445
openstack.compute.v2.limits, 419 openstack.identity.v3.trust, 446
openstack.compute.v2.server, 421 openstack.identity.v3.user, 447
openstack.image.v1._proxy, 272
openstack.compute.v2.server_interface,
425 openstack.image.v1.image, 448
openstack.compute.v2.server_ip, openstack.image.v2._proxy, 274
426 openstack.image.v2.image, 450
openstack.config, 19 openstack.image.v2.member, 454
openstack.connection, 77 openstack.image.v2.service_info,
openstack.database.v1._proxy, 456
239 openstack.image.v2.task, 455
openstack.database.v1.database, openstack.key_manager.v1._proxy,
427 283
openstack.database.v1.flavor, openstack.key_manager.v1.container,
428 457
openstack.database.v1.instance, openstack.key_manager.v1.order,
428 458
openstack.database.v1.user, 430 openstack.key_manager.v1.secret,
openstack.dns.v2._proxy, 244 459
openstack.dns.v2.floating_ip, openstack.load_balancer.v2._proxy,
435 287
openstack.dns.v2.recordset, 436 openstack.load_balancer.v2.amphora,
614 Index
475 openstack.network.v2.metering_label_rule,
490
openstack.load_balancer.v2.availability_zone,
478 openstack.network.v2.network,
491
openstack.load_balancer.v2.availability_zone_profile,
478 openstack.network.v2.network_ip_availabili
openstack.load_balancer.v2.flavor, 492
473 openstack.network.v2.network_segment_range
493
openstack.load_balancer.v2.flavor_profile,
473 openstack.network.v2.pool, 494
openstack.load_balancer.v2.health_monitor,
openstack.network.v2.pool_member,
468 496
openstack.network.v2.port, 497
openstack.load_balancer.v2.l7_policy,
470 openstack.network.v2.qos_bandwidth_limit_r
openstack.load_balancer.v2.l7_rule, 499
471 openstack.network.v2.qos_dscp_marking_rule
openstack.load_balancer.v2.listener, 499
463 openstack.network.v2.qos_minimum_bandwidth
500
openstack.load_balancer.v2.load_balancer,
460 openstack.network.v2.qos_policy,
openstack.load_balancer.v2.member, 501
467 openstack.network.v2.qos_rule_type,
openstack.load_balancer.v2.pool, 502
466 openstack.network.v2.quota, 502
openstack.load_balancer.v2.provider,openstack.network.v2.rbac_policy,
472 503
openstack.load_balancer.v2.quota, openstack.network.v2.router, 504
474 openstack.network.v2.security_group,
openstack.message.v2._proxy, 305 506
openstack.network.v2._proxy, 310 openstack.network.v2.security_group_rule,
openstack.network.v2.address_group, 507
479 openstack.network.v2.segment,
openstack.network.v2.address_scope, 508
480 openstack.network.v2.service_profile,
openstack.network.v2.agent, 481 509
openstack.network.v2.auto_allocated_topology,
openstack.network.v2.service_provider,
482 510
openstack.network.v2.subnet, 510
openstack.network.v2.availability_zone,
483 openstack.network.v2.subnet_pool,
openstack.network.v2.extension, 512
483 openstack.object_store.v1._proxy,
openstack.network.v2.flavor, 484 361
openstack.network.v2.floating_ip, openstack.object_store.v1.account,
485 517
openstack.network.v2.health_monitor,openstack.object_store.v1.container,
486 518
openstack.network.v2.listener, openstack.object_store.v1.obj,
487 520
openstack.network.v2.load_balancer, openstack.orchestration.v1._proxy,
488 366
openstack.network.v2.metering_label,openstack.orchestration.v1.resource,
489 516
Index 615
openstack.orchestration.v1.stack,name (openstack.clustering.v1.policy.Policy at-

513 tribute), 405
openstack.resource, 525 name (openstack.clustering.v1.policy_type.PolicyType
openstack.service_description, attribute), 405
534 name (openstack.clustering.v1.profile.Profile at-
openstack.utils, 535 tribute), 404
openstack.workflow.v2._proxy, name (openstack.clustering.v1.profile_type.ProfileType
371 attribute), 403
openstack.workflow.v2.execution, name (openstack.clustering.v1.receiver.Receiver
523 attribute), 411
openstack.workflow.v2.workflow, name (openstack.compute.v2.extension.Extension
524 attribute), 414
monitor_address (open- name (openstack.compute.v2.flavor.Flavor at-
attribute), 467 name (openstack.compute.v2.image.Image at-
monitor_port (open- tribute), 417
stack.load_balancer.v2.member.Member name (openstack.compute.v2.keypair.Keypair at-
mtu (openstack.network.v2.network.Network at- name (openstack.database.v1.database.Database
multipart_manifest (open- name (openstack.database.v1.flavor.Flavor
stack.object_store.v1.obj.Object at- attribute), 428
tribute), 521 name (openstack.database.v1.instance.Instance
attribute), 428
N name (openstack.database.v1.user.User attribute),
name (openstack.accelerator.v2.deployable.Deployable 430
attribute), 375 name (openstack.dns.v2.recordset.Recordset at-
name (openstack.accelerator.v2.device_profile.DeviceProfile tribute), 436
attribute), 376 name (openstack.dns.v2.zone.Zone attribute), 431
name (openstack.baremetal.v1.allocation.Allocation name (openstack.identity.v2.extension.Extension
name (openstack.baremetal.v1.driver.Driver at- name (openstack.identity.v2.role.Role attribute),
tribute), 379 438
name (openstack.baremetal.v1.node.Node at- name (openstack.identity.v2.tenant.Tenant at-
name (openstack.baremetal.v1.port_group.PortGroupname (openstack.identity.v2.user.User attribute),
attribute), 391 440
name (openstack.block_storage.v2.backup.Backup name (openstack.identity.v3.domain.Domain at-
name (openstack.block_storage.v2.snapshot.Snapshot name (openstack.identity.v3.group.Group at-
name (openstack.block_storage.v2.type.Type at- name (openstack.identity.v3.project.Project
name (openstack.block_storage.v2.volume.Volume name (openstack.identity.v3.service.Service at-
name (openstack.clustering.v1.action.Action at- name (openstack.identity.v3.user.User attribute),
tribute), 412 447
name (openstack.clustering.v1.cluster.Cluster at- name (openstack.image.v1.image.Image at-
name (openstack.clustering.v1.node.Node at- name (openstack.image.v2.image.Image at-
616 Index
name (openstack.key_manager.v1.container.Container attribute), 493

attribute), 457 name (openstack.network.v2.pool.Pool attribute),
name (openstack.key_manager.v1.secret.Secret at- 495
tribute), 459 name (openstack.network.v2.pool_member.PoolMember
name (openstack.load_balancer.v2.availability_zone.AvailabilityZone
attribute), 496
attribute), 479 name (openstack.network.v2.port.Port attribute),
name (openstack.load_balancer.v2.availability_zone_profile.AvailabilityZoneProfile
498
attribute), 478 name (openstack.network.v2.qos_policy.QoSPolicy
name (openstack.load_balancer.v2.flavor.Flavor attribute), 501
attribute), 474 name (openstack.network.v2.router.Router at-
name (openstack.load_balancer.v2.flavor_profile.FlavorProfile tribute), 505
attribute), 473 name (openstack.network.v2.security_group.SecurityGroup
name (openstack.load_balancer.v2.health_monitor.HealthMonitor
attribute), 507
attribute), 469 name (openstack.network.v2.segment.Segment at-
name (openstack.load_balancer.v2.l7_policy.L7Policy tribute), 509
attribute), 470 name (openstack.network.v2.service_provider.ServiceProvider
name (openstack.load_balancer.v2.listener.Listener attribute), 510
attribute), 464 name (openstack.network.v2.subnet.Subnet
name (openstack.load_balancer.v2.load_balancer.LoadBalancerattribute), 511
attribute), 461 name (openstack.network.v2.subnet_pool.SubnetPool
name (openstack.load_balancer.v2.member.Member attribute), 512
attribute), 467 name (openstack.object_store.v1.container.Container
name (openstack.load_balancer.v2.pool.Pool at- attribute), 518
tribute), 466 name (openstack.object_store.v1.obj.Object at-
name (openstack.load_balancer.v2.provider.Provider tribute), 521
attribute), 472 name (openstack.orchestration.v1.resource.Resource
attribute), 517
name (openstack.load_balancer.v2.provider.ProviderFlavorCapabilities
attribute), 472 name (openstack.orchestration.v1.stack.Stack at-
name (openstack.network.v2.address_group.AddressGroup tribute), 514
attribute), 479 name (openstack.resource.Resource attribute),
name (openstack.network.v2.address_scope.AddressScope 528
attribute), 480 name (openstack.workflow.v2.workflow.Workflow
name (openstack.network.v2.availability_zone.AvailabilityZone
attribute), 524
attribute), 483 namespace (open-
name (openstack.network.v2.extension.Extension stack.compute.v2.extension.Extension
name (openstack.network.v2.flavor.Flavor at- namespace (open-
tribute), 484 stack.identity.v2.extension.Extension
name (openstack.network.v2.floating_ip.FloatingIP attribute), 437
attribute), 485 needs_config_drive (open-
name (openstack.network.v2.health_monitor.HealthMonitor stack.image.v2.image.Image attribute),
attribute), 486 452
name (openstack.network.v2.listener.Listener at- needs_secure_boot (open-
tribute), 488 stack.image.v2.image.Image attribute),
name (openstack.network.v2.load_balancer.LoadBalancer 452
attribute), 488 net_id (openstack.compute.v2.server_interface.ServerInterface
name (openstack.network.v2.metering_label.MeteringLabel attribute), 425
attribute), 489 Network (class in open-
name (openstack.network.v2.network.Network at- stack.network.v2.network), 491
tribute), 492 network_id (open-
stack.network.v2.network_ip_availability.NetworkIPAvaila
name (openstack.network.v2.network_segment_range.NetworkSegmentRange
Index 617
attribute), 493 node_id (open-

network_id (openstack.network.v2.port.Port stack.baremetal.v1.volume_connector.VolumeConnector
network_id (open- node_id (open-
stack.network.v2.segment.Segment stack.baremetal.v1.volume_target.VolumeTarget
network_id (open- node_ids (open-
stack.network.v2.subnet.Subnet at- stack.clustering.v1.cluster.Cluster at-
network_interface (open- node_set_provision_state() (open-
stack.baremetal.v1.node.Node attribute), stack.connection.Connection method),
383 140
network_label (open- nodes (openstack.baremetal.v1.chassis.Chassis
stack.compute.v2.server_ip.ServerIP attribute), 381
attribute), 426 notification_topics (open-
network_name (openstack.orchestration.v1.stack.Stack at-
stack.network.v2.network_ip_availability.NetworkIPAvailability
tribute), 514
attribute), 493 num_accelerators (open-
network_type (openstack.accelerator.v2.deployable.Deployable
attribute), 375
attribute), 494 numa_affinity_policy (open-
network_type (openstack.network.v2.port.Port attribute),
stack.network.v2.segment.Segment 498
attribute), 509
NetworkIPAvailability (class in open- O
stack.network.v2.network_ip_availability), obj_id (openstack.clustering.v1.event.Event at-
492 tribute), 413
networks (openstack.compute.v2.server.Server obj_name (openstack.clustering.v1.event.Event
networks (openstack.network.v2.quota.Quota obj_type (openstack.clustering.v1.event.Event
NetworkSegmentRange (class in open- object, 577
stack.network.v2.network_segment_range), Object (class in openstack.object_store.v1.obj),
493 520
new() (openstack.object_store.v1.container.Container
object_count (open-
class method), 520 stack.block_storage.v2.backup.Backup
new() (openstack.resource.Resource class attribute), 398
method), 529 object_count (open-
node, 577 stack.object_store.v1.container.Container
Node (class in openstack.baremetal.v1.node), 381 attribute), 519
Node (class in openstack.clustering.v1.node), 408 object_id (open-
node (openstack.baremetal.v1.allocation.Allocation stack.network.v2.rbac_policy.RBACPolicy
node_id (open- object_manifest (open-
stack.baremetal.v1.allocation.Allocation stack.object_store.v1.obj.Object at-
node_id (openstack.baremetal.v1.port.Port at- object_type (open-
tribute), 391 stack.network.v2.rbac_policy.RBACPolicy
node_id (open- attribute), 504
stack.baremetal.v1.port_group.PortGroup object-store, 578
attribute), 392 op() (openstack.clustering.v1.cluster.Cluster
618 Index
method), 407 openstack.clustering.v1.cluster

op() (openstack.clustering.v1.node.Node module, 406
method), 409 openstack.clustering.v1.cluster_policy
openstack.accelerator.v2._proxy module, 410
module, 168 openstack.clustering.v1.event
openstack.accelerator.v2.accelerator_request module, 413
module, 377 openstack.clustering.v1.node
openstack.accelerator.v2.deployable module, 408
module, 375 openstack.clustering.v1.policy
openstack.accelerator.v2.device module, 405
module, 374 openstack.clustering.v1.policy_type
openstack.accelerator.v2.device_profilemodule, 405
module, 376 openstack.clustering.v1.profile
openstack.baremetal.v1._proxy module, 404
module, 171 openstack.clustering.v1.profile_type
openstack.baremetal.v1.allocation module, 403
module, 392 openstack.clustering.v1.receiver
openstack.baremetal.v1.chassis module, 411
module, 380 openstack.compute.v2._proxy
openstack.baremetal.v1.driver module, 217
module, 378 openstack.compute.v2.extension
openstack.baremetal.v1.node module, 414
module, 381 openstack.compute.v2.flavor
openstack.baremetal.v1.port module, 415
module, 390 openstack.compute.v2.image
openstack.baremetal.v1.port_group module, 417
module, 391 openstack.compute.v2.keypair
openstack.baremetal.v1.volume_connectormodule, 418
module, 393 openstack.compute.v2.limits
openstack.baremetal.v1.volume_target module, 419
module, 394 openstack.compute.v2.server
openstack.baremetal_introspection.v1._proxy module, 421
module, 192 openstack.compute.v2.server_interface
module, 425
openstack.baremetal_introspection.v1.introspection
module, 395 openstack.compute.v2.server_ip
openstack.block_storage.v2._proxy module, 426
module, 194 openstack.config
openstack.block_storage.v2.backup module, 19
module, 397 openstack.connection
openstack.block_storage.v2.snapshot module, 77
module, 399 openstack.database.v1._proxy
openstack.block_storage.v2.type module, 239
module, 400 openstack.database.v1.database
openstack.block_storage.v2.volume module, 427
module, 401 openstack.database.v1.flavor
openstack.clustering.v1._proxy module, 428
module, 199 openstack.database.v1.instance
openstack.clustering.v1.action module, 428
module, 412 openstack.database.v1.user
openstack.clustering.v1.build_info module, 430
module, 403 openstack.dns.v2._proxy
Index 619
module, 244 openstack.image.v2.member

openstack.dns.v2.floating_ip module, 454
module, 435 openstack.image.v2.service_info
openstack.dns.v2.recordset module, 456
module, 436 openstack.image.v2.task
openstack.dns.v2.zone module, 455
module, 430 openstack.key_manager.v1._proxy
openstack.dns.v2.zone_export module, 283
module, 433 openstack.key_manager.v1.container
openstack.dns.v2.zone_import module, 457
module, 434 openstack.key_manager.v1.order
openstack.dns.v2.zone_transfer module, 458
module, 431 openstack.key_manager.v1.secret
openstack.identity.v2._proxy module, 459
module, 252 openstack.load_balancer.v2._proxy
openstack.identity.v2.extension module, 287
module, 437 openstack.load_balancer.v2.amphora
openstack.identity.v2.role module, 475
module, 438 openstack.load_balancer.v2.availability_zone
openstack.identity.v2.tenant module, 478
module, 439 openstack.load_balancer.v2.availability_zone_
openstack.identity.v2.user module, 478
module, 439 openstack.load_balancer.v2.flavor
openstack.identity.v3._proxy module, 473
module, 256 openstack.load_balancer.v2.flavor_profile
openstack.identity.v3.credential module, 473
module, 440 openstack.load_balancer.v2.health_monitor
openstack.identity.v3.domain module, 468
module, 441 openstack.load_balancer.v2.l7_policy
openstack.identity.v3.endpoint module, 470
module, 442 openstack.load_balancer.v2.l7_rule
openstack.identity.v3.group module, 471
module, 443 openstack.load_balancer.v2.listener
openstack.identity.v3.policy module, 463
module, 443 openstack.load_balancer.v2.load_balancer
openstack.identity.v3.project module, 460
module, 444 openstack.load_balancer.v2.member
openstack.identity.v3.service module, 467
module, 445 openstack.load_balancer.v2.pool
openstack.identity.v3.trust module, 466
module, 446 openstack.load_balancer.v2.provider
openstack.identity.v3.user module, 472
module, 447 openstack.load_balancer.v2.quota
openstack.image.v1._proxy module, 474
module, 272 openstack.message.v2._proxy
openstack.image.v1.image module, 305
module, 448 openstack.network.v2._proxy
openstack.image.v2._proxy module, 310
module, 274 openstack.network.v2.address_group
openstack.image.v2.image module, 479
module, 450 openstack.network.v2.address_scope
620 Index
module, 480 openstack.network.v2.security_group

openstack.network.v2.agent module, 506
module, 481 openstack.network.v2.security_group_rule
module, 507
openstack.network.v2.auto_allocated_topology
module, 482 openstack.network.v2.segment
openstack.network.v2.availability_zone module, 508
module, 483 openstack.network.v2.service_profile
openstack.network.v2.extension module, 509
module, 483 openstack.network.v2.service_provider
openstack.network.v2.flavor module, 510
module, 484 openstack.network.v2.subnet
openstack.network.v2.floating_ip module, 510
module, 485 openstack.network.v2.subnet_pool
openstack.network.v2.health_monitor module, 512
module, 486 openstack.object_store.v1._proxy
openstack.network.v2.listener module, 361
module, 487 openstack.object_store.v1.account
openstack.network.v2.load_balancer module, 517
module, 488 openstack.object_store.v1.container
openstack.network.v2.metering_label module, 518
module, 489 openstack.object_store.v1.obj
module, 520
openstack.network.v2.metering_label_rule
module, 490 openstack.orchestration.v1._proxy
openstack.network.v2.network module, 366
module, 491 openstack.orchestration.v1.resource
module, 516
openstack.network.v2.network_ip_availability
module, 492 openstack.orchestration.v1.stack
module, 513
openstack.network.v2.network_segment_range
module, 493 openstack.resource
openstack.network.v2.pool module, 525
module, 494 openstack.service_description
openstack.network.v2.pool_member module, 534
module, 496 openstack.utils
openstack.network.v2.port module, 535
module, 497 openstack.workflow.v2._proxy
module, 371
module, 499 openstack.workflow.v2.execution
module, 523
openstack.network.v2.qos_dscp_marking_rule
module, 499 openstack.workflow.v2.workflow
module, 524
openstack.network.v2.qos_minimum_bandwidth_rule
module, 500 OpenStackConfig (class in openstack.config),
openstack.network.v2.qos_policy 19
module, 501 operating_status (open-
openstack.network.v2.qos_rule_type stack.load_balancer.v2.health_monitor.HealthMonitor
module, 502 attribute), 469
openstack.network.v2.quota operating_status (open-
module, 502 stack.load_balancer.v2.l7_policy.L7Policy
openstack.network.v2.rbac_policy attribute), 470
module, 503 operating_status (open-
openstack.network.v2.router stack.load_balancer.v2.l7_rule.L7Rule
module, 504 attribute), 471
Index 621
operating_status (open- tribute), 381

stack.load_balancer.v2.listener.Listener owner (openstack.image.v1.image.Image at-
operating_status (open- owner (openstack.image.v2.image.Image at-
stack.load_balancer.v2.load_balancer.LoadBalancertribute), 451
attribute), 461 owner_id (open-
operating_status (openstack.clustering.v1.action.Action at-
attribute), 468 owner_id (openstack.image.v1.image.Image at-
operating_status (open- tribute), 449
stack.load_balancer.v2.pool.Pool at- owner_id (openstack.image.v2.image.Image at-
operating_status (open- owner_id (openstack.image.v2.task.Task at-
stack.network.v2.load_balancer.LoadBalancer tribute), 455
attribute), 488 owner_id (open-
option_prompt() (openstack.orchestration.v1.stack.Stack at-
stack.config.OpenStackConfig method), tribute), 514
19
Order (class in open- P
stack.key_manager.v1.order), 458 pagination_key (open-
order_id (openstack.resource.Resource attribute),
stack.key_manager.v1.order.Order 528
attribute), 458 parameters (open-
order_ref (openstack.orchestration.v1.stack.Stack at-
stack.key_manager.v1.order.Order tribute), 514
attribute), 458 params (openstack.clustering.v1.receiver.Receiver
os_admin_user (open- attribute), 411
stack.image.v2.image.Image attribute), params (openstack.workflow.v2.execution.Execution
453 attribute), 523
os_command_line (open- parent_id (open-
stack.image.v2.image.Image attribute), stack.accelerator.v2.deployable.Deployable
453 attribute), 375
os_distro (openstack.image.v2.image.Image parent_id (open-
attribute), 452 stack.identity.v3.project.Project at-
os_require_quiesce (open- tribute), 444
stack.image.v2.image.Image attribute), parent_id (open-
453 stack.orchestration.v1.stack.Stack at-
os_shutdown_timeout (open- tribute), 514
stack.image.v2.image.Image attribute), password (openstack.database.v1.user.User at-
452 tribute), 430
os_type (openstack.image.v2.image.Image at- password (openstack.identity.v3.user.User at-
os_version (openstack.image.v2.image.Image password_expires_at (open-
attribute), 452 stack.identity.v3.user.User attribute),
output (openstack.workflow.v2.execution.Execution 448
attribute), 523 patch() (open-
outputs (openstack.clustering.v1.action.Action stack.accelerator.v2.accelerator_request.AcceleratorRequ
attribute), 413 method), 377
outputs (openstack.orchestration.v1.stack.Stack patch() (openstack.baremetal.v1.node.Node
owner (openstack.baremetal.v1.node.Node at- patch() (openstack.resource.Resource method),
622 Index
532 attribute), 410

patch_machine() (open- PolicyType (class in open-
stack.connection.Connection method), stack.clustering.v1.policy_type), 405
141 Pool (class in openstack.load_balancer.v2.pool),
payload (open- 466
stack.key_manager.v1.secret.Secret Pool (class in openstack.network.v2.pool), 494
attribute), 459 pool_id (openstack.dns.v2.zone.Zone attribute),
payload_content_encoding (open- 431
stack.key_manager.v1.secret.Secret pool_id (open-
attribute), 460 stack.load_balancer.v2.health_monitor.HealthMonitor
payload_content_type (open- attribute), 469
stack.key_manager.v1.secret.Secret pool_id (open-
attribute), 459 stack.load_balancer.v2.member.Member
personality (open- attribute), 468
stack.compute.v2.limits.AbsoluteLimits pool_id (open-
attribute), 420 stack.network.v2.health_monitor.HealthMonitor
personality (open- attribute), 487
stack.compute.v2.server.Server attribute), pool_id (open-
423 stack.network.v2.pool_member.PoolMember
personality_size (open- attribute), 496
stack.compute.v2.limits.AbsoluteLimits pool_ids (open-
attribute), 420 stack.network.v2.health_monitor.HealthMonitor
pformat() (openstack.connection.Connection attribute), 486
method), 141 pool_ids (open-
physical_id (openstack.network.v2.load_balancer.LoadBalancer
stack.clustering.v1.node.Node attribute), attribute), 489
408 PoolMember (class in open-
physical_network (openstack.network.v2.pool_member), 496
stack.baremetal.v1.port.Port attribute), pools (openstack.load_balancer.v2.health_monitor.HealthMonito
391 attribute), 469
physical_network (open- pools (openstack.load_balancer.v2.load_balancer.LoadBalancer
attribute), 461
attribute), 494 pools (openstack.load_balancer.v2.quota.Quota
physical_network (open- attribute), 474
stack.network.v2.segment.Segment pools (openstack.network.v2.quota.Quota
physical_resource_id (open- Port (class in openstack.baremetal.v1.port), 390
stack.orchestration.v1.resource.Resource Port (class in openstack.network.v2.port), 497
attribute), 517 port_details (open-
Policy (class in openstack.clustering.v1.policy), stack.network.v2.floating_ip.FloatingIP
405 attribute), 485
Policy (class in openstack.identity.v3.policy), port_group_id (open-
443 stack.baremetal.v1.port.Port attribute),
policy_id (open- 391
port_groups (open-
attribute), 410 stack.baremetal.v1.node.Node attribute),
policy_name (open- 382
port_id (open-
attribute), 410 stack.compute.v2.server_interface.ServerInterface
policy_type (open- attribute), 425
port_id (open-
Index 623
stack.network.v2.floating_ip.FloatingIP stack.clustering.v1.profile), 404

attribute), 485 profile_id (open-
port_range_max (openstack.clustering.v1.cluster.Cluster at-
tribute), 406
attribute), 508 profile_id (open-
port_range_min (openstack.clustering.v1.node.Node attribute),
408
attribute), 508 profile_name (open-
port_state (openstack.clustering.v1.cluster.Cluster at-
stack.compute.v2.server_interface.ServerInterface tribute), 407
attribute), 425 profile_name (open-
PortGroup (class in openstack.clustering.v1.node.Node attribute),
stack.baremetal.v1.port_group), 391 408
ports (openstack.baremetal.v1.node.Node at- ProfileType (class in open-
tribute), 382 stack.clustering.v1.profile_type), 403
ports (openstack.baremetal.v1.port_group.PortGroupprogress (open-
attribute), 392 stack.block_storage.v2.snapshot.SnapshotDetail
ports (openstack.network.v2.quota.Quota attribute), 400
attribute), 503 progress (openstack.compute.v2.image.Image
position (open- attribute), 418
stack.load_balancer.v2.l7_policy.L7Policy progress (openstack.compute.v2.server.Server
power_interface (open- project, 578
stack.baremetal.v1.node.Node attribute), Project (class in openstack.identity.v3.project),
384 444
POWER_OFF (open- project_cleanup() (open-
stack.baremetal.v1.node.PowerAction stack.connection.Connection method),
attribute), 389 141
POWER_ON (open- project_id (open-
stack.baremetal.v1.node.PowerAction stack.block_storage.v2.snapshot.SnapshotDetail
power_state (open- project_id (open-
stack.baremetal.v1.node.Node attribute), stack.block_storage.v2.volume.Volume
382 attribute), 402
power_state (open- project_id (open-
stack.compute.v2.server.Server attribute), stack.clustering.v1.action.Action at-
423 tribute), 412
PowerAction (class in open- project_id (open-
stack.baremetal.v1.node), 389 stack.clustering.v1.cluster.Cluster at-
pprint() (openstack.connection.Connection tribute), 406
method), 141 project_id (open-
prefix_length (openstack.clustering.v1.event.Event attribute),
stack.network.v2.subnet.Subnet at- 414
tribute), 511 project_id (open-
prefixes (openstack.clustering.v1.node.Node attribute),
stack.network.v2.subnet_pool.SubnetPool 408
attribute), 513 project_id (open-
private_key (openstack.clustering.v1.policy.Policy at-
stack.compute.v2.keypair.Keypair attribute), 405
Profile (class in openstack.clustering.v1.profile.Profile at-
624 Index
tribute), 404 stack.network.v2.address_group.AddressGroup

project_id (open- attribute), 479
stack.clustering.v1.receiver.Receiver project_id (open-
attribute), 411 stack.network.v2.address_scope.AddressScope
stack.compute.v2.server.Server attribute), project_id (open-
423 stack.network.v2.auto_allocated_topology.AutoAllocatedT
stack.dns.v2.recordset.Recordset at- project_id (open-
tribute), 436 stack.network.v2.floating_ip.FloatingIP
project_id (openstack.dns.v2.zone.Zone at- attribute), 486
project_id (openstack.network.v2.health_monitor.HealthMonitor
stack.dns.v2.zone_export.ZoneExport attribute), 487
project_id (openstack.network.v2.listener.Listener at-
stack.dns.v2.zone_import.ZoneImport tribute), 488
project_id (openstack.network.v2.load_balancer.LoadBalancer
stack.identity.v3.credential.Credential attribute), 489
project_id (openstack.network.v2.metering_label.MeteringLabel
stack.identity.v3.policy.Policy attribute), attribute), 489
443 project_id (open-
project_id (openstack.identity.v3.trust.Trust stack.network.v2.metering_label_rule.MeteringLabelRule
project_id (open- project_id (open-
stack.network.v2.network.Network
stack.load_balancer.v2.l7_policy.L7Policy stack.network.v2.network_ip_availability.NetworkIPAvaila
stack.load_balancer.v2.l7_rule.L7Rule stack.network.v2.network_segment_range.NetworkSegmen
project_id (open- project_id (openstack.network.v2.pool.Pool
project_id (openstack.network.v2.pool_member.PoolMember
stack.load_balancer.v2.load_balancer.LoadBalancerattribute), 496
attribute), 461 project_id (openstack.network.v2.port.Port
stack.load_balancer.v2.member.Member project_id (open-
attribute), 468 stack.network.v2.qos_policy.QoSPolicy
stack.load_balancer.v2.pool.Pool at- project_id (open-
tribute), 466 stack.network.v2.quota.Quota attribute),
project_id (open- 503
stack.load_balancer.v2.quota.Quota project_id (open-
attribute), 474 stack.network.v2.rbac_policy.RBACPolicy
Index 625
project_id (open- protocol (open-

stack.network.v2.router.Router attribute), stack.network.v2.security_group_rule.SecurityGroupRule
505 attribute), 508
project_id (open- protocol_port (open-
stack.network.v2.security_group.SecurityGroup stack.load_balancer.v2.listener.Listener
stack.load_balancer.v2.member.Member
stack.network.v2.service_profile.ServiceProfile stack.network.v2.listener.Listener at-
stack.network.v2.subnet.Subnet at- stack.network.v2.pool_member.PoolMember
project_id (open- Provider (class in open-
stack.network.v2.subnet_pool.SubnetPool stack.load_balancer.v2.provider), 472
attribute), 513 provider (open-
project_id (openstack.load_balancer.v2.load_balancer.LoadBalancer
stack.workflow.v2.workflow.Workflow attribute), 461
attribute), 525 provider (open-
propagate_uplink_status (openstack.load_balancer.v2.provider.ProviderFlavorCapabiliti
498 provider (open-
properties (openstack.network.v2.load_balancer.LoadBalancer
stack.baremetal.v1.driver.Driver at- attribute), 489
tribute), 379 provider (openstack.network.v2.pool.Pool at-
properties (open- tribute), 495
stack.baremetal.v1.node.Node attribute), provider_name (open-
382 stack.load_balancer.v2.availability_zone_profile.Availabil
properties (open- attribute), 478
stack.baremetal.v1.port_group.PortGroup provider_name (open-
attribute), 392 stack.load_balancer.v2.flavor_profile.FlavorProfile
properties (open- attribute), 473
stack.baremetal.v1.volume_target.VolumeTarget
provider_network_type (open-
properties (openstack.image.v1.image.Image attribute), 492
attribute), 449 provider_physical_network (open-
properties (openstack.image.v2.image.Image stack.network.v2.network.Network
protocol (open- provider_segmentation_id (open-
stack.load_balancer.v2.listener.Listener stack.network.v2.network.Network
protocol (open- ProviderFlavorCapabilities (class in
stack.load_balancer.v2.pool.Pool at- openstack.load_balancer.v2.provider),
tribute), 466 472
protocol (open- provision_state (open-
stack.network.v2.listener.Listener at- stack.baremetal.v1.node.Node attribute),
tribute), 488 383
protocol (openstack.network.v2.pool.Pool at- provisioning_status (open-
tribute), 495 stack.load_balancer.v2.health_monitor.HealthMonitor
626 Index
attribute), 469 499

provisioning_status (open- QoSDSCPMarkingRule (class in open-
stack.load_balancer.v2.l7_policy.L7Policy stack.network.v2.qos_dscp_marking_rule),
attribute), 470 499
provisioning_status (open- QoSMinimumBandwidthRule (class in open-
stack.load_balancer.v2.l7_rule.L7Rule stack.network.v2.qos_minimum_bandwidth_rule),
attribute), 471 500
provisioning_status (open- QoSPolicy (class in open-
stack.load_balancer.v2.listener.Listener stack.network.v2.qos_policy), 501
attribute), 464 QoSRuleType (class in open-
provisioning_status (openstack.network.v2.qos_rule_type), 502
Quota (class in open-
attribute), 461 stack.load_balancer.v2.quota), 474
provisioning_status (open- Quota (class in openstack.network.v2.quota), 502
stack.load_balancer.v2.member.Member
attribute), 468 R
provisioning_status (open- raid_config (open-
stack.load_balancer.v2.pool.Pool at- stack.baremetal.v1.node.Node attribute),
tribute), 467 383
provisioning_status (open- raid_interface (open-
stack.network.v2.load_balancer.LoadBalancer stack.baremetal.v1.node.Node attribute),
attribute), 489 384
Proxy (class in openstack.proxy), 562 ram (openstack.compute.v2.flavor.Flavor at-
ptrdname (open- tribute), 415
stack.dns.v2.floating_ip.FloatingIP ram (openstack.database.v1.flavor.Flavor at-
public_key (open- ramdisk_id (open-
stack.compute.v2.keypair.Keypair at- stack.compute.v2.server.Server attribute),
tribute), 419 423
ramdisk_id (openstack.image.v2.image.Image
Q attribute), 452
qos_policy_id (open- range (openstack.object_store.v1.obj.Object at-
stack.network.v2.floating_ip.FloatingIP tribute), 521
attribute), 485 range_search() (open-
qos_policy_id (openstack.connection.Connection method),
stack.network.v2.network.Network 142
attribute), 492 RateLimit (class in open-
qos_policy_id (openstack.compute.v2.limits), 421
stack.network.v2.port.Port attribute), rbac_policies (open-
498 stack.network.v2.quota.Quota attribute),
qos_policy_id (open- 503
RBACPolicy (class in open-
attribute), 499 stack.network.v2.rbac_policy), 503
qos_policy_id (open- reactivate() (open-
stack.network.v2.qos_dscp_marking_rule.QoSDSCPMarkingRule
stack.image.v2.image.Image method),
attribute), 500 453
qos_policy_id (open- read_ACL (open-
stack.network.v2.qos_minimum_bandwidth_rule.QoSMinimumBandwidthRule
stack.object_store.v1.container.Container
QoSBandwidthLimitRule (class in open- REBOOT (openstack.baremetal.v1.node.PowerAction
stack.network.v2.qos_bandwidth_limit_rule), attribute), 389
Index 627
reboot() (openstack.compute.v2.server.Server stack.network.v2.security_group_rule.SecurityGroupRule

rebuild() (openstack.compute.v2.server.Server remove_addresses() (open-
method), 424 stack.network.v2.address_group.AddressGroup
Receiver (class in open- method), 480
stack.clustering.v1.receiver), 411 remove_extra_routes() (open-
records (openstack.dns.v2.recordset.Recordset stack.network.v2.router.Router method),
attribute), 436 505
Recordset (class in open- remove_flavor_access() (open-
stack.dns.v2.recordset), 436 stack.connection.Connection method),
recover() (openstack.clustering.v1.node.Node 143
method), 409 remove_gateway() (open-
redelegated_trust_id (openstack.network.v2.router.Router method),
stack.identity.v3.trust.Trust attribute), 506
446 remove_host_from_aggregate() (open-
redelegation_count (openstack.connection.Connection method),
stack.identity.v3.trust.Trust attribute), 143
446 remove_interface() (open-
redirect_pool_id (openstack.network.v2.router.Router method),
stack.load_balancer.v2.l7_policy.L7Policy 505
attribute), 470 remove_machine_from_maintenance()
redirect_prefix (open- (openstack.connection.Connection
stack.load_balancer.v2.l7_policy.L7Policy method), 143
attribute), 470 remove_router_interface() (open-
redirect_url (openstack.connection.Connection method),
stack.load_balancer.v2.l7_policy.L7Policy 143
attribute), 470 remove_rule_from_policy() (open-
regex (openstack.compute.v2.limits.RateLimit stack.connection.Connection method),
attribute), 421 144
region, 578 remove_server_security_groups()
region (openstack.database.v1.instance.Instance (openstack.connection.Connection
region_id (open- remove_tenant_access() (open-
stack.identity.v3.endpoint.Endpoint stack.compute.v2.flavor.Flavor method),
attribute), 442 416
register_argparse_arguments() (open- remove_trait() (open-
stack.config.OpenStackConfig method), stack.baremetal.v1.node.Node method),
19 388
register_machine() (open- remove_user_from_group() (open-
142 144
remaining_uses (open- remove_volume_type_access() (open-
stack.identity.v3.trust.Trust attribute), stack.connection.Connection method),
446 144
remote_group_id (open- replaced (open-
stack.orchestration.v1.stack.Stack at-
remote_ip_prefix (open- replication_driver_data (open-
stack.block_storage.v2.volume.Volume
remote_ip_prefix (open- replication_status (open-
628 Index
stack.block_storage.v2.volume.Volume resource_type (open-

attribute), 402 stack.orchestration.v1.resource.Resource
request_errors (open- attribute), 517
stack.load_balancer.v2.listener.ListenerStatsresources_key (openstack.resource.Resource
request_errors (open- resources_synced (open-
stack.load_balancer.v2.load_balancer.LoadBalancerStats
stack.network.v2.agent.Agent attribute),
attribute), 462 481
required_by (open- restart() (open-
stack.orchestration.v1.resource.Resource stack.database.v1.instance.Instance
requires_commit() (open- restore() (open-
stack.resource.Resource property), stack.block_storage.v2.backup.Backup
532 method), 398
requires_floating_ip() (open- result (openstack.image.v2.task.Task attribute),
method), 23 retired_reason (open-
requires_id (openstack.resource.Resource at- stack.baremetal.v1.node.Node attribute),
tribute), 529 383
rescue_interface (open- retriable_status_codes (open-
stack.baremetal.v1.node.Node attribute), stack.proxy.Proxy attribute), 562
384 revert_resize() (open-
reservation (openstack.compute.v2.server.Server method),
stack.baremetal.v1.node.Node attribute), 425
383 revision_number (open-
reservation_id (openstack.network.v2.router.Router attribute),
stack.compute.v2.server.Server attribute), 505
423 revision_number (open-
resize() (openstack.compute.v2.server.Server stack.network.v2.subnet_pool.SubnetPool
resize() (open- revoke_role() (open-
stack.database.v1.instance.Instance stack.connection.Connection method),
method), 429 145
resize_volume() (open- role, 578
stack.database.v1.instance.Instance Role (class in openstack.identity.v2.role), 438
method), 429 role (openstack.clustering.v1.node.Node at-
resource, 578 tribute), 408
Resource (class in open- role (openstack.load_balancer.v2.amphora.Amphora
stack.orchestration.v1.resource), 516 attribute), 475
Resource (class in openstack.resource), 528 role_links (openstack.identity.v3.trust.Trust
resource (open- attribute), 446
stack.network.v2.availability_zone.AvailabilityZone
roles (openstack.identity.v3.trust.Trust at-
resource_class (open- root_device_name (open-
stack.baremetal.v1.allocation.Allocation stack.compute.v2.server.Server attribute),
attribute), 393 424
resource_class (open- root_id (open-
stack.baremetal.v1.node.Node attribute), stack.accelerator.v2.deployable.Deployable
383 attribute), 375
resource_key (openstack.resource.Resource Router (class in openstack.network.v2.router),
attribute), 528 504
Index 629
router_id (open- 146

stack.network.v2.floating_ip.FloatingIP search_domains() (open-
routers (openstack.network.v2.quota.Quota at- 146
tribute), 503 search_endpoints() (open-
routes (openstack.network.v2.router.Router at- stack.connection.Connection method),
tribute), 505 147
rule_value (open- search_groups() (open-
stack.load_balancer.v2.l7_rule.L7Rule stack.connection.Connection method),
attribute), 471 147
rules (openstack.load_balancer.v2.l7_policy.L7Policy
search_networks() (open-
rules (openstack.network.v2.qos_policy.QoSPolicy 147
attribute), 501 search_objects() (open-
rxtx_factor (openstack.connection.Connection method),
stack.compute.v2.flavor.Flavor attribute), 147
415 search_ports() (open-
stack.connection.Connection method),
S 148
scheduler_hints (open- search_projects() (open-
stack.compute.v2.server.Server attribute), stack.connection.Connection method),
424 148
schema (openstack.clustering.v1.policy_type.PolicyType
search_qos_bandwidth_limit_rules()
attribute), 405 (openstack.connection.Connection
schema (openstack.clustering.v1.profile_type.ProfileType method), 148
attribute), 403 search_qos_dscp_marking_rules()
schema (openstack.image.v2.image.Image (openstack.connection.Connection
schema (openstack.image.v2.member.Member at- search_qos_minimum_bandwidth_rules()
tribute), 455 (openstack.connection.Connection
schema (openstack.image.v2.task.Task attribute), method), 149
456 search_qos_policies() (open-
scope (openstack.workflow.v2.workflow.Workflow stack.connection.Connection method),
attribute), 524 149
search_aggregates() (open- search_roles() (open-
145 149
search_baymodels() (open- search_routers() (open-
145 150
search_cluster_templates() (open- search_server_groups() (open-
145 150
search_coe_cluster_templates() search_services() (open-
(openstack.connection.Connection stack.connection.Connection method),
method), 146 150
search_coe_clusters() (open- search_stacks() (open-
146 150
search_containers() (open- search_subnets() (open-
630 Index
150 stack.network.v2.security_group_rule),
search_users() (open- 507
stack.connection.Connection method), Segment (class in open-
151 stack.network.v2.segment), 508
Secret (class in open- segment_id (open-
stack.key_manager.v1.secret), 459 stack.network.v2.subnet.Subnet at-
secret_id (open- tribute), 511
stack.key_manager.v1.order.Order segmentation_id (open-
attribute), 458 stack.network.v2.segment.Segment
secret_ref (open- attribute), 509
stack.key_manager.v1.order.Order segments (open-
secret_ref (open- attribute), 492
stack.key_manager.v1.secret.Secret serial (openstack.dns.v2.zone.Zone attribute),
attribute), 459 431
secret_refs (open- server, 578
stack.key_manager.v1.container.Container Server (class in openstack.compute.v2.server),
attribute), 457 421
secret_type (open- server_group_members (open-
stack.key_manager.v1.secret.Secret stack.compute.v2.limits.AbsoluteLimits
security_group_id (open- server_groups (open-
stack.compute.v2.limits.AbsoluteLimits
security_group_ids (open- server_groups (open-
stack.network.v2.port.Port attribute), stack.compute.v2.server.Server attribute),
498 424
security_group_rules (open- server_groups_used (open-
stack.compute.v2.limits.AbsoluteLimits stack.compute.v2.limits.AbsoluteLimits
security_group_rules (open- server_id (open-
stack.network.v2.quota.Quota attribute), stack.compute.v2.server_interface.ServerInterface
503 attribute), 426
security_group_rules (open- server_id (open-
stack.network.v2.security_group.SecurityGroup stack.compute.v2.server_ip.ServerIP
security_groups (open- server_meta (open-
stack.compute.v2.limits.AbsoluteLimits stack.compute.v2.limits.AbsoluteLimits
security_groups (open- ServerInterface (class in open-
stack.compute.v2.server.Server attribute), stack.compute.v2.server_interface),
424 425
security_groups (open- ServerIP (class in open-
stack.network.v2.quota.Quota attribute), stack.compute.v2.server_ip), 426
503 service, 578
security_groups_used (open- Service (class in openstack.identity.v3.service),
stack.compute.v2.limits.AbsoluteLimits 445
attribute), 420 service (openstack.resource.Resource at-
SecurityGroup (class in open- tribute), 528
stack.network.v2.security_group), 506 service catalog, 578
SecurityGroupRule (class in open- service_id (open-
Index 631
stack.identity.v3.endpoint.Endpoint set_machine_power_on() (open-

service_profile_ids (open- 152
stack.network.v2.flavor.Flavor attribute), set_machine_power_reboot() (open-
service_type (open- 152
stack.network.v2.flavor.Flavor attribute), set_maintenance() (open-
484 stack.baremetal.v1.node.Node method),
stack.network.v2.service_provider.ServiceProvider
set_network_quotas() (open-
stack.service_description.ServiceDescription set_one_cloud() (open-
attribute), 535 stack.config.OpenStackConfig static
service_types (open- method), 20
stack.network.v2.subnet.Subnet at- set_power_state() (open-
tribute), 511 stack.baremetal.v1.node.Node method),
ServiceDescription (class in open- 386
stack.service_description), 534 set_provision_state() (open-
ServiceProfile (class in openstack.baremetal.v1.node.Node method),
stack.network.v2.service_profile), 509 384
ServiceProvider (class in open- set_server_metadata() (open-
stack.network.v2.service_provider), stack.connection.Connection method),
510 153
session_persistence (open- set_session_constructor() (open-
stack.load_balancer.v2.pool.Pool at- stack.config.cloud_region.CloudRegion
session_persistence (open- set_tags() (open-
stack.network.v2.pool.Pool attribute), stack.network.v2.qos_policy.QoSPolicy
495 method), 501
set_aggregate_metadata() (open- set_temp_url_key() (open-
stack.connection.Connection method), stack.object_store.v1.account.Account
151 method), 518
set_boot_device() (open- set_temp_url_key() (open-
stack.baremetal.v1.node.Node method), stack.object_store.v1.container.Container
388 method), 520
set_compute_quotas() (open- set_traits() (open-
stack.connection.Connection method), stack.baremetal.v1.node.Node method),
151 388
set_container_access() (open- set_volume_bootable() (open-
151 153
set_flavor_specs() (open- set_volume_quotas() (open-
151 153
set_machine_maintenance_state() shared (openstack.network.v2.network_segment_range.NetworkS
(openstack.connection.Connection attribute), 493
method), 152 sign_coe_cluster_certificate()
set_machine_power_off() (open- (openstack.connection.Connection
152 signature (open-
632 Index
stack.object_store.v1.obj.Object at- stack.clustering.v1.action.Action at-

size (openstack.block_storage.v2.backup.Backup started_at (open-
attribute), 398 stack.baremetal_introspection.v1.introspection.Introspecti
size (openstack.block_storage.v2.snapshot.Snapshot attribute), 396
attribute), 399 started_at (openstack.network.v2.agent.Agent
size (openstack.block_storage.v2.volume.Volume attribute), 482
attribute), 401 state (openstack.accelerator.v2.accelerator_request.AcceleratorR
size (openstack.compute.v2.image.Image at- attribute), 377
tribute), 418 state (openstack.baremetal.v1.allocation.Allocation
size (openstack.image.v1.image.Image at- attribute), 393
tribute), 449 state (openstack.baremetal_introspection.v1.introspection.Introsp
size (openstack.image.v2.image.Image at- attribute), 396
tribute), 451 state (openstack.network.v2.availability_zone.AvailabilityZone
Snapshot (class in open- attribute), 483
stack.block_storage.v2.snapshot), 399 stateful (open-
snapshot_id (openstack.network.v2.security_group.SecurityGroup
stack.block_storage.v2.backup.Backup attribute), 507
attribute), 398 states (openstack.baremetal.v1.node.Node at-
snapshot_id (open- tribute), 383
stack.block_storage.v2.volume.Volume status (openstack.block_storage.v2.backup.Backup
SnapshotDetail (class in open- status (openstack.block_storage.v2.snapshot.Snapshot
stack.block_storage.v2.snapshot), 400 attribute), 399
sni_container_refs (open- status (openstack.block_storage.v2.volume.Volume
attribute), 464 status (openstack.clustering.v1.action.Action
sni_container_refs (open- attribute), 412
stack.network.v2.listener.Listener at- status (openstack.clustering.v1.cluster.Cluster
SOFT_POWER_OFF (open- status (openstack.clustering.v1.event.Event at-
stack.baremetal.v1.node.PowerAction tribute), 414
attribute), 389 status (openstack.clustering.v1.node.Node at-
SOFT_REBOOT (open- tribute), 409
stack.baremetal.v1.node.PowerAction status (openstack.compute.v2.image.Image at-
source_ip_prefix (open- status (openstack.compute.v2.server.Server at-
tribute), 424
attribute), 490 status (openstack.database.v1.instance.Instance
source_volume_id (open- attribute), 428
stack.block_storage.v2.volume.Volume status (openstack.dns.v2.floating_ip.FloatingIP
spec (openstack.clustering.v1.policy.Policy at- status (openstack.dns.v2.recordset.Recordset
spec (openstack.clustering.v1.profile.Profile at- status (openstack.dns.v2.zone.Zone attribute),
tribute), 404 431
Stack (class in open- status (openstack.dns.v2.zone_export.ZoneExport
stack.orchestration.v1.stack), 513 attribute), 433
stage() (openstack.image.v2.image.Image status (openstack.dns.v2.zone_import.ZoneImport
start_at (open- status (openstack.image.v1.image.Image
Index 633
attribute), 449 stack.accelerator.v2.device.Device

status (openstack.image.v2.image.Image attribute), 374
attribute), 451 storage_interface (open-
status (openstack.image.v2.member.Member at- stack.baremetal.v1.node.Node attribute),
tribute), 455 384
status (openstack.image.v2.task.Task attribute), Store (class in open-
456 stack.image.v2.service_info), 456
status (openstack.key_manager.v1.container.Container
store (openstack.image.v2.image.Image at-
status (openstack.key_manager.v1.secret.Secret stream_object() (open-
status (openstack.load_balancer.v2.amphora.Amphora 154
attribute), 475 sub_status (open-
status (openstack.network.v2.floating_ip.FloatingIP stack.key_manager.v1.order.Order
status (openstack.network.v2.network.Network sub_status_message (open-
attribute), 492 stack.key_manager.v1.order.Order
status (openstack.network.v2.pool.Pool at- attribute), 458
tribute), 495 Subnet (class in openstack.network.v2.subnet),
status (openstack.network.v2.port.Port at- 510
tribute), 498 subnet_id (open-
status (openstack.network.v2.router.Router at- stack.load_balancer.v2.member.Member
status (openstack.orchestration.v1.resource.Resource
subnet_id (open-
attribute), 517 stack.network.v2.floating_ip.FloatingIP
status (openstack.orchestration.v1.stack.Stack attribute), 486
attribute), 514 subnet_id (openstack.network.v2.pool.Pool at-
status (openstack.workflow.v2.execution.Execution tribute), 495
attribute), 523 subnet_id (open-
status_description (openstack.network.v2.pool_member.PoolMember
stack.network.v2.pool.Pool attribute), attribute), 496
495 subnet_ids (open-
status_info (openstack.network.v2.network.Network
stack.workflow.v2.execution.Execution attribute), 492
attribute), 523 subnet_ip_availability (open-
status_reason (openstack.network.v2.network_ip_availability.NetworkIPAvaila
tribute), 407 subnet_pool_id (open-
status_reason (openstack.network.v2.subnet.Subnet at-
stack.clustering.v1.event.Event attribute), tribute), 511
414 subnet_pools (open-
status_reason (openstack.network.v2.quota.Quota attribute),
stack.clustering.v1.node.Node attribute), 503
409 SubnetPool (class in open-
status_reason (openstack.network.v2.subnet_pool), 512
stack.orchestration.v1.resource.Resource subnets (openstack.network.v2.quota.Quota at-
status_reason (open- support_status (open-
stack.orchestration.v1.stack.Stack at- stack.clustering.v1.policy_type.PolicyType
std_board_info (open- support_status (open-
634 Index
stack.clustering.v1.profile_type.ProfileType stack.orchestration.v1.stack.Stack at-

supported_versions (open- tenant, 578
stack.service_description.ServiceDescription
Tenant (class in openstack.identity.v2.tenant),
attribute), 535 439
swap (openstack.compute.v2.flavor.Flavor at- tenant_id (open-
tribute), 415 stack.network.v2.security_group.SecurityGroup
sync_key (open- attribute), 507
stack.object_store.v1.container.Container tenant_id (open-
attribute), 519 stack.network.v2.security_group_rule.SecurityGroupRule
sync_to (open- attribute), 508
stack.object_store.v1.container.Container terminated_at (open-
attribute), 519 stack.compute.v2.server.Server attribute),
424
T timeout (openstack.clustering.v1.action.Action
tags (openstack.orchestration.v1.stack.Stack at- attribute), 412
tribute), 514 timeout (openstack.clustering.v1.cluster.Cluster
tainted (openstack.clustering.v1.node.Node at- attribute), 407
tribute), 409 timeout (open-
target_id (openstack.load_balancer.v2.health_monitor.HealthMonitor
stack.clustering.v1.action.Action at- attribute), 469
tribute), 412 timeout (open-
target_power_state (openstack.network.v2.health_monitor.HealthMonitor
383 timeout_client_data (open-
target_project_id (openstack.load_balancer.v2.listener.Listener
stack.dns.v2.zone_transfer.ZoneTransferRequest attribute), 464
attribute), 432 timeout_member_connect (open-
target_project_id (openstack.load_balancer.v2.listener.Listener
stack.network.v2.rbac_policy.RBACPolicy attribute), 465
attribute), 504 timeout_member_data (open-
target_provision_state (openstack.load_balancer.v2.listener.Listener
383 timeout_mins (open-
target_raid_config (openstack.orchestration.v1.stack.Stack at-
stack.baremetal.v1.node.Node attribute), tribute), 514
383 timeout_tcp_inspect (open-
Task (class in openstack.image.v2.task), 455 stack.load_balancer.v2.listener.Listener
task_execution_id (open- attribute), 465
stack.workflow.v2.execution.Execution timestamp (open-
attribute), 523 stack.object_store.v1.account.Account
task_state (open- attribute), 518
stack.compute.v2.server.Server attribute), timestamp (open-
424 stack.object_store.v1.container.Container
template (open- attribute), 519
stack.orchestration.v1.stack.Stack at- timestamp (open-
tribute), 514 stack.object_store.v1.obj.Object at-
template_description (open- tribute), 522
stack.orchestration.v1.stack.Stack at- tls_ciphers (open-
tribute), 514 stack.load_balancer.v2.listener.Listener
template_url (open- attribute), 465
Index 635
tls_ciphers (open- trusted_image_certificates (open-

stack.load_balancer.v2.pool.Pool at- stack.compute.v2.server.Server attribute),
tribute), 467 424
tls_enabled (open- trustee_user_id (open-
stack.load_balancer.v2.pool.Pool at- stack.identity.v3.trust.Trust attribute),
tribute), 467 446
tls_versions (open- trustor_user_id (open-
stack.load_balancer.v2.listener.Listener stack.identity.v3.trust.Trust attribute),
attribute), 465 447
tls_versions (open- ttl (openstack.dns.v2.floating_ip.FloatingIP at-
stack.load_balancer.v2.pool.Pool attribute), 435
tribute), 467 ttl (openstack.dns.v2.recordset.Recordset
to_dict() (openstack.resource.Resource attribute), 436
method), 529 ttl (openstack.dns.v2.zone.Zone attribute), 431
toDict() (openstack.resource.Resource Type (class in openstack.block_storage.v2.type),
method), 530 400
token, 578 type (openstack.accelerator.v2.device.Device at-
topic (openstack.network.v2.agent.Agent attribute), 374
tribute), 482 type (openstack.baremetal.v1.volume_connector.VolumeConnecto
total_connections (open- attribute), 394
stack.load_balancer.v2.listener.ListenerStatstype (openstack.clustering.v1.policy.Policy at-
total_connections (open- type (openstack.clustering.v1.profile.Profile at-
stack.load_balancer.v2.load_balancer.LoadBalancerStats
tribute), 404
attribute), 462 type (openstack.clustering.v1.receiver.Receiver
total_cores (open- attribute), 411
stack.compute.v2.limits.AbsoluteLimits type (openstack.compute.v2.keypair.Keypair at-
total_cores_used (open- type (openstack.dns.v2.recordset.Recordset at-
stack.compute.v2.limits.AbsoluteLimits tribute), 436
attribute), 420 type (openstack.dns.v2.zone.Zone attribute), 431
total_ips (open- type (openstack.identity.v3.credential.Credential
stack.network.v2.network_ip_availability.NetworkIPAvailability
attribute), 440
attribute), 493 type (openstack.identity.v3.policy.Policy at-
total_ram (open- tribute), 444
stack.compute.v2.limits.AbsoluteLimits type (openstack.identity.v3.service.Service at-
total_ram_used (open- type (openstack.image.v2.task.Task attribute),
stack.compute.v2.limits.AbsoluteLimits 456
attribute), 421 type (openstack.key_manager.v1.container.Container
traits (openstack.baremetal.v1.allocation.Allocation attribute), 457
attribute), 393 type (openstack.load_balancer.v2.health_monitor.HealthMonitor
traits (openstack.baremetal.v1.node.Node at- attribute), 469
tribute), 383 type (openstack.load_balancer.v2.l7_rule.L7Rule
transfer_encoding (open- attribute), 471
stack.object_store.v1.obj.Object at- type (openstack.network.v2.health_monitor.HealthMonitor
trunk_details (open- type (openstack.network.v2.qos_rule_type.QoSRuleType
498
Trust (class in openstack.identity.v3.trust), 446
636 Index
U 417
unassign_role_from_group() (open- update_firewall_group() (open-
stack.identity.v3.domain.Domain stack.connection.Connection method),
method), 441 156
unassign_role_from_group() (open- update_firewall_policy() (open-
stack.identity.v3.project.Project method), stack.connection.Connection method),
445 156
unassign_role_from_user() (open- update_firewall_rule() (open-
stack.identity.v3.domain.Domain stack.connection.Connection method),
method), 441 156
unassign_role_from_user() (open- update_group() (open-
stack.identity.v3.project.Project method), stack.connection.Connection method),
444 157
unbind_accelerator_request() (open- update_machine() (open-
154 157
unchanged (open- update_network() (open-
stack.orchestration.v1.stack.Stack at- stack.connection.Connection method),
tribute), 514 157
unregister_machine() (open- update_object() (open-
154 158
unset_flavor_specs() (open- update_port() (open-
154 158
unset_maintenance() (open- update_qos_bandwidth_limit_rule()
stack.baremetal.v1.node.Node method), (openstack.connection.Connection
387 method), 159
update() (open- update_qos_dscp_marking_rule()
stack.orchestration.v1.stack.Stack (openstack.connection.Connection
update_aggregate() (open- update_qos_minimum_bandwidth_rule()
154 method), 160
update_baymodel() (open- update_qos_policy() (open-
155 160
update_cluster_template() (open- update_recordset() (open-
155 160
update_coe_cluster() (open- update_role() (open-
155 161
update_coe_cluster_template() (open- update_router() (open-
155 161
update_container() (open- update_security_group() (open-
156 162
update_extra_specs_property() (open- update_server() (open-
stack.compute.v2.flavor.Flavor method), stack.connection.Connection method),
Index 637
162 stack.clustering.v1.node.Node attribute),

update_stack() (open- 409
stack.connection.Connection method), updated_at (open-
162 stack.clustering.v1.policy.Policy at-
update_subnet() (open- tribute), 406
163 stack.clustering.v1.profile.Profile at-
update_zone() (open- tribute), 404
164 stack.clustering.v1.receiver.Receiver
updated (openstack.orchestration.v1.stack.Stack attribute), 411
attribute), 514 updated_at (open-
updated_at (openstack.compute.v2.extension.Extension
stack.accelerator.v2.deployable.Deployable attribute), 414
updated_at (openstack.compute.v2.image.Image attribute),
stack.accelerator.v2.device.Device 418
updated_at (openstack.compute.v2.server.Server attribute),
stack.accelerator.v2.device_profile.DeviceProfile 424
updated_at (openstack.database.v1.instance.Instance
stack.baremetal.v1.allocation.Allocation attribute), 429
updated_at (openstack.dns.v2.recordset.Recordset at-
stack.baremetal.v1.chassis.Chassis tribute), 436
attribute), 381 updated_at (openstack.dns.v2.zone.Zone at-
updated_at (open- tribute), 431
stack.baremetal.v1.node.Node attribute), updated_at (open-
383 stack.dns.v2.zone_export.ZoneExport
updated_at (openstack.baremetal.v1.port.Port attribute), 433
updated_at (openstack.dns.v2.zone_import.ZoneImport
stack.baremetal.v1.port_group.PortGroup attribute), 434
updated_at (openstack.identity.v2.extension.Extension
attribute), 437
stack.baremetal.v1.volume_connector.VolumeConnector
attribute), 394 updated_at (openstack.image.v1.image.Image
updated_at (open- attribute), 449
updated_at (openstack.image.v2.image.Image
updated_at (open- updated_at (open-
stack.block_storage.v2.backup.Backup stack.image.v2.member.Member at-
updated_at (open- updated_at (openstack.image.v2.task.Task at-
stack.clustering.v1.action.Action attribute), 456
tribute), 413 updated_at (open-
updated_at (openstack.key_manager.v1.container.Container
tribute), 407 updated_at (open-
updated_at (openstack.key_manager.v1.order.Order
638 Index

updated_at (openstack.network.v2.subnet_pool.SubnetPool
stack.key_manager.v1.secret.Secret attribute), 513
updated_at (openstack.orchestration.v1.resource.Resource
updated_at (openstack.orchestration.v1.stack.Stack at-
stack.load_balancer.v2.health_monitor.HealthMonitortribute), 515
updated_at (openstack.workflow.v2.execution.Execution
stack.load_balancer.v2.l7_policy.L7Policy attribute), 524
updated_at (openstack.workflow.v2.workflow.Workflow
stack.load_balancer.v2.l7_rule.L7Rule attribute), 525
attribute), 471 upload() (openstack.image.v2.image.Image
updated_at (open- method), 454
stack.load_balancer.v2.listener.Listener URI (class in openstack.resource), 527
attribute), 464 uri (openstack.compute.v2.limits.RateLimit at-
updated_at (open- tribute), 421
url (openstack.identity.v3.endpoint.Endpoint at-
updated_at (open- url (openstack.image.v2.image.Image attribute),
stack.load_balancer.v2.member.Member 451
attribute), 468 url_path (open-
updated_at (openstack.load_balancer.v2.health_monitor.HealthMonitor
tribute), 467 url_path (open-
updated_at (openstack.network.v2.health_monitor.HealthMonitor
stack.network.v2.extension.Extension attribute), 487
attribute), 484 use_default_subnet_pool (open-
updated_at (openstack.network.v2.subnet.Subnet at-
stack.network.v2.floating_ip.FloatingIP tribute), 511
attribute), 486 used (openstack.network.v2.network_segment_range.NetworkSegm
stack.network.v2.network.Network used_ips (open-
attribute), 492 stack.network.v2.network_ip_availability.NetworkIPAvaila
updated_at (openstack.network.v2.port.Port attribute), 493
attribute), 499 User (class in openstack.database.v1.user), 430
updated_at (open- User (class in openstack.identity.v2.user), 439
stack.network.v2.router.Router attribute), User (class in openstack.identity.v3.user), 447
505 user_data (openstack.compute.v2.server.Server
stack.network.v2.security_group.SecurityGroup
user_id (open-
attribute), 507 stack.block_storage.v2.volume.Volume
user_id (openstack.clustering.v1.action.Action
updated_at (open- user_id (openstack.clustering.v1.cluster.Cluster
stack.network.v2.subnet.Subnet at- attribute), 406
tribute), 511 user_id (openstack.clustering.v1.event.Event
Index 639

user_id (openstack.clustering.v1.node.Node at- vendor (openstack.accelerator.v2.device.Device
user_id (openstack.clustering.v1.policy.Policy vendor_board_info (open-
attribute), 406 stack.accelerator.v2.device.Device
user_id (openstack.clustering.v1.profile.Profile attribute), 375
attribute), 404 vendor_interface (open-
user_id (openstack.baremetal.v1.node.Node attribute),
stack.clustering.v1.receiver.Receiver 384
attribute), 411 version (open-
user_id (openstack.compute.v2.keypair.Keypair stack.dns.v2.zone_export.ZoneExport
user_id (openstack.compute.v2.server.Server version (open-
attribute), 424 stack.dns.v2.zone_import.ZoneImport
user_id (open- attribute), 434
stack.identity.v3.credential.Credential versions_location (open-
attribute), 440 stack.object_store.v1.container.Container
user_id (openstack.identity.v3.policy.Policy at- attribute), 519
tribute), 444 vip_address (open-
user_project_id (openstack.load_balancer.v2.load_balancer.LoadBalancer
tribute), 515 vip_address (open-
stack.network.v2.load_balancer.LoadBalancer
uuid (openstack.accelerator.v2.accelerator_request.AcceleratorRequest
uuid (openstack.accelerator.v2.device.Device at- vip_network_id (open-
tribute), 375 stack.load_balancer.v2.load_balancer.LoadBalancer
uuid (openstack.accelerator.v2.device_profile.DeviceProfile attribute), 461
attribute), 376 vip_port_id (open-
V attribute), 461
validate() (open- vip_port_id (open-
stack.baremetal.v1.node.Node method), stack.network.v2.load_balancer.LoadBalancer
387 attribute), 489
validate_group_has_role() (open- vip_subnet_id (open-
stack.identity.v3.domain.Domain stack.load_balancer.v2.load_balancer.LoadBalancer
validate_group_has_role() (open- vip_subnet_id (open-
stack.identity.v3.project.Project method), stack.network.v2.load_balancer.LoadBalancer
445 attribute), 489
validate_machine() (open- virtual_ip_id (open-
stack.connection.Connection method), stack.network.v2.pool.Pool attribute),
164 495
validate_user_has_role() (open- virtual_size (open-
stack.identity.v3.domain.Domain stack.image.v2.image.Image attribute),
method), 441 451
validate_user_has_role() (open- visibility (openstack.image.v2.image.Image
444 vm_mode (openstack.image.v2.image.Image at-
ValidationResult (class in open- tribute), 452
stack.baremetal.v1.node), 389 vm_state (openstack.compute.v2.server.Server
vcpus (openstack.compute.v2.flavor.Flavor at- attribute), 424
640 Index
vmware_adaptertype (open- W
stack.image.v2.image.Image attribute), wait() (openstack.baremetal.v1.allocation.Allocation
453 method), 393
vmware_ostype (open- wait() (openstack.baremetal_introspection.v1.introspection.Intro
453 wait_for_baremetal_node_lock()
volume, 578 (openstack.connection.Connection
Volume (class in open- method), 164
stack.block_storage.v2.volume), 401 wait_for_power_state() (open-
volume (openstack.database.v1.instance.Instance stack.baremetal.v1.node.Node method),
attribute), 429 385
volume_id (open- wait_for_provision_state() (open-
stack.baremetal.v1.volume_target.VolumeTarget stack.baremetal.v1.node.Node method),
attribute), 395 385
volume_id (open- wait_for_reservation() (open-
stack.block_storage.v2.backup.Backup stack.baremetal.v1.node.Node method),
attribute), 398 386
volume_id (open- wait_for_server() (open-
stack.block_storage.v2.snapshot.Snapshot stack.connection.Connection method),
attribute), 399 164
volume_image_metadata (open- WaitResult (class in open-
stack.block_storage.v2.volume.Volume stack.baremetal.v1.node), 390
attribute), 402 weight (openstack.load_balancer.v2.member.Member
volume_type (open- attribute), 468
weight (openstack.network.v2.pool_member.PoolMember
volume_type (open- Workflow (class in open-
stack.block_storage.v2.volume.Volume stack.workflow.v2.workflow), 524
attribute), 401 workflow_id (open-
VolumeConnector (class in openstack.workflow.v2.execution.Execution
stack.baremetal.v1.volume_connector), attribute), 523
393 workflow_name (open-
VolumeTarget (class in openstack.workflow.v2.execution.Execution
stack.baremetal.v1.volume_target), attribute), 523
394 write_ACL (open-
vrrp_id (openstack.object_store.v1.container.Container
attribute), 476
vrrp_interface (open- Z
stack.load_balancer.v2.amphora.Amphora Zone (class in openstack.dns.v2.zone), 430
attribute), 476 zone_id (openstack.dns.v2.recordset.Recordset
vrrp_ip (open- attribute), 436
stack.load_balancer.v2.amphora.Amphora zone_id (open-
attribute), 475 stack.dns.v2.zone_export.ZoneExport
vrrp_port_id (open- attribute), 433
stack.load_balancer.v2.amphora.Amphora zone_id (open-
attribute), 475 stack.dns.v2.zone_import.ZoneImport
vrrp_priority (open- attribute), 434
stack.load_balancer.v2.amphora.Amphora zone_name (open-
attribute), 476 stack.dns.v2.recordset.Recordset at-
tribute), 436
Index 641
zone_name (open-
stack.dns.v2.zone_transfer.ZoneTransferRequest
attribute), 432
zone_transfer_request_id (open-
stack.dns.v2.zone_transfer.ZoneTransferAccept
attribute), 432
ZoneExport (class in open-
stack.dns.v2.zone_export), 433
ZoneImport (class in open-
stack.dns.v2.zone_import), 434
ZoneTransferAccept (class in open-
stack.dns.v2.zone_transfer), 432
ZoneTransferRequest (class in open-
stack.dns.v2.zone_transfer), 431
642 Index

Openstacksdk

Uploaded by

Copyright:

Available Formats

Openstacksdk

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

Openstacksdk

Uploaded by

Copyright:

Available Formats

OpenStackSDK Documentation

Nov 20, 2020

3 For Contributors 553

6 Cloud Layer 573

Python Module Index 579

This documentation is split into three sections:

At the command line:

$ pip install openstacksdk

Or, if you have virtualenv wrapper installed:

2.1 Getting started with the OpenStack SDK

$ pip install openstacksdk

$ python -m openstack version

2.1.2 User Guides

Conﬁguring OpenStack SDK Applications

Site Speciﬁc File Locations

6 Chapter 2. For Users

(continued from previous page)

2.1. Getting started with the OpenStack SDK 7

8 Chapter 2. For Users

2.1. Getting started with the OpenStack SDK 9

(continued from previous page)

10 Chapter 2. For Users

Using openstack.conﬁg in an Application

The simplest and least useful thing you can do is:

Or, get all of the clouds.

2.1. Getting started with the OpenStack SDK 11

These are the default behaviors unless a cloud is conﬁgured differently.

Region Name Location

• Public IPv4 is provided via NAT with Neutron Floating IP

Region Name Location

• Identity API Version is 3

12 Chapter 2. For Users

Region Name Location

• Identity API Version is 3

Region Name Location

• Identity API Version is 3

Region Name Location

• Image upload is not supported

2.1. Getting started with the OpenStack SDK 13

Region Name Location

• Identity API Version is 3

Open Telekom Cloud

Region Name Location

• Identity API Version is 3

Region Name Location

• Identity API Version is 3

Enter Cloud Suite

Region Name Location

• Compute API Version is 2

14 Chapter 2. For Users

Region Name Location

• Identity API Version is 3

Region Name Location

• Floating IPs are not supported

Region Name Location

• Identity API Version is 3

Region Name Location

• Images may be in raw format. The qcow2 default is also supported

2.1. Getting started with the OpenStack SDK 15