openstack.compute.v2.keypair¶

The Keypair Class¶

The Keypair class inherits from Resource.

class openstack.compute.v2.keypair.Keypair(_synchronized=False, connection=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.

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.

classmethod list(session, paginated=False, base_path=None)¶

This method is a generator which yields resource objects.

This resource object list generator handles pagination and takes query params for response filtering.

Parameters:	session (Adapter) – The session to use for making this request. paginated (bool) – True if a GET to this resource returns a paginated series of responses, 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 API’s support of pagination. base_path (str) – Base part of the URI for listing resources, if different from base_path. params (dict) – These keyword arguments are passed through the _transpose() method to find if any of them match expected query parameters to be sent in the params argument 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.