l.c.o.OpenStackBaseConnection(ConnectionUserAndKey) : class documentation

Part of libcloud.common.openstack View Source View In Hierarchy

Base class for OpenStack connections.

@param user_id: User name to use when authenticating
@type user_id: C{string}

@param key: Secret to use when authenticating.
@type key: C{string}

@param secure: Use HTTPS?  (True by default.)
@type secure: C{bool}

@param ex_force_base_url: Base URL for connection requests.  If
not specified, this will be determined by authenticating.
@type ex_force_base_url: C{string}

@param ex_force_auth_url: Base URL for authentication requests.
@type ex_force_auth_url: C{string}

@param ex_force_auth_version: Authentication version to use.  If
not specified, defaults to AUTH_API_VERSION.
@type ex_force_auth_version: C{string}

@param ex_force_auth_token: Authentication token to use for
connection requests.  If specified, the connection will not attempt
to authenticate, and the value of ex_force_base_url will be used to
determine the base request URL.  If ex_force_auth_token is passed in,
ex_force_base_url must also be provided.
@type ex_force_auth_token: C{string}

@param ex_tenant_name: When authenticating, provide this tenant
name to the identity service.  A scoped token will be returned.
Some cloud providers require the tenant name to be provided at
authentication time.  Others will use a default tenant if none
is provided.
@type ex_tenant_name: C{string}

@param ex_force_service_type: Service type to use when selecting an
service.  If not specified, a provider specific default will be used.
@type ex_force_service_type: C{string}

@param ex_force_service_name: Service name to use when selecting an
service.  If not specified, a provider specific default will be used.
@type ex_force_service_name: C{string}

@param ex_force_service_region: Region to use when selecting an
service.  If not specified, a provider specific default will be used.
@type ex_force_service_region: C{string}

@param ex_auth_connection: OpenStackAuthConnection instance to use for
making HTTP requests. If not specified, a new one is instantiated.
@type ex_auth_connection: C{OpenStackAuthConnection}

Selects the endpoint to use based on provider specific values,
or overrides passed in by the user when setting up the driver.

@returns: url of the relevant endpoint for the driver

Return an OpenStackAuthConnection instance for this connection.

OpenStack uses a separate host for API calls which is only provided
after an initial authentication request.