API Reference¶
-
class
os_client_config.
OpenStackConfig
(config_files=None, vendor_files=None, override_defaults=None, force_ipv4=None, envvar_prefix=None)¶ -
auth_config_hook
(config)¶ Allow examination of config values before loading auth plugin
OpenStackClient will override this to perform additional chacks on auth_type.
-
get_one_cloud
(cloud=None, validate=True, argparse=None, **kwargs)¶ Retrieve a single cloud configuration 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. It’s 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
Raises: keystoneauth1.exceptions.MissingRequiredOptions on missing required 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
-