Connection

updated: None

Connection

Connection¶

The Connection class is the primary interface to the Python SDK it maintains a context for a connection to a cloud provider. The connection has an attribute to access each supported service. The service attributes are created dynamically based on user profiles and the service catalog.

Examples¶

At a minimum, the Connection class needs to be created with an authenticator or the parameters to build one.

Create a connection¶

The following example constructor uses the identity authenticator using username and password. The default settings for the transport are used by this connection.:

from openstack import connection
auth_args = {
    'auth_url': 'http://172.20.1.108:5000/v3',
    'project_name': 'admin',
    'username': 'admin',
    'password': 'admin',
}
conn = connection.Connection(**auth_args)

List¶

Services are accessed through an attribute named after the service. A list of all the projects is retrieved in this manner:

projects = conn.identity.list_projects()

Find or create¶

If you wanted to make sure you had a network named ‘jenkins’, you would first try to find it and if that fails, you would create it:

network = conn.network.find_network("jenkins")
if network is None:
    network = conn.network.create_network({"name": "jenkins"})

from_config¶

openstack.connection.from_config(cloud_name=None, cloud_config=None, options=None)¶

Create a Connection using os-client-config

Parameters:

Parameters:	cloud_name (str) – Use the cloud_name configuration details when creating the Connection instance. cloud_config – An instance of os_client_config.config.OpenStackConfig as returned from the os-client-config library. If no config is provided, os_client_config.OpenStackConfig will be called, and the provided cloud_name will be used in determining which cloud’s configuration details will be used in creation of the Connection instance. options – A namespace object; allows direct passing in of options to be added to the cloud config. This does not have to be an instance of argparse.Namespace, despite the naming of the the os_client_config.config.OpenStackConfig.get_one_cloud argument to which it is passed.
Return type:	`Connection`

cloud_name (str) – Use the cloud_name configuration details when creating the Connection instance.
cloud_config – An instance of os_client_config.config.OpenStackConfig as returned from the os-client-config library. If no config is provided, os_client_config.OpenStackConfig will be called, and the provided cloud_name will be used in determining which cloud’s configuration details will be used in creation of the Connection instance.
options – A namespace object; allows direct passing in of options to be added to the cloud config. This does not have to be an instance of argparse.Namespace, despite the naming of the the os_client_config.config.OpenStackConfig.get_one_cloud argument to which it is passed.

Return type:

Connection

Connection Object¶

class openstack.connection.Connection(session=None, authenticator=None, profile=None, verify=True, cert=None, user_agent=None, auth_plugin='password', **auth_args)¶

Create a context for a connection to a cloud provider.

A connection needs a transport and an authenticator. The user may pass in a transport and authenticator they want to use or they may pass in the parameters to create a transport and authenticator. The connection creates a Session which uses the profile and authenticator to perform HTTP requests.