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, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
- create_secret(**attrs)
Create a new secret from attributes
- 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.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the secret does not exist. When set toTrue
, no exception 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.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- 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
- Raises:
ResourceNotFound
when no resource can be found.
- secrets(**query)
Return a generator of secrets
- Parameters:
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of secret objects
- Return type:
Container Operations¶
- class openstack.key_manager.v1._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
- create_container(**attrs)
Create a new container from attributes
- 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.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the container does not exist. When set toTrue
, 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.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- 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
- Raises:
ResourceNotFound
when no resource can be found.
- containers(**query)
Return a generator of containers
- Parameters:
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of container objects
- Return type:
Order Operations¶
- class openstack.key_manager.v1._proxy.Proxy(session, statsd_client=None, statsd_prefix=None, prometheus_counter=None, prometheus_histogram=None, influxdb_config=None, influxdb_client=None, *args, **kwargs)
- create_order(**attrs)
Create a new order from attributes
- 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.ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the order does not exist. When set toTrue
, 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.
ignore_missing (bool) – When set to
False
ResourceNotFound
will be raised when the resource does not exist. When set toTrue
, None will be returned when attempting to find a nonexistent resource.
- 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
- Raises:
ResourceNotFound
when no resource can be found.
- orders(**query)
Return a generator of orders
- Parameters:
query (kwargs) – Optional query parameters to be sent to limit the resources being returned.
- Returns:
A generator of order objects
- Return type: