openstackclient.common package

Submodules

openstackclient.common.availability_zone module

Availability Zone action implementations

class openstackclient.common.availability_zone.ListAvailabilityZone(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List availability zones and their status

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2e53c90>

take_action(parsed_args)

openstackclient.common.client_config module

OpenStackConfig subclass for argument compatibility

class openstackclient.common.client_config.OSC_Config(config_files=None, vendor_files=None, override_defaults=None, force_ipv4=None, envvar_prefix=None, secure_files=None, pw_func=None)

Bases: os_client_config.config.OpenStackConfig

auth_config_hook(config)

Allow examination of config values before loading auth plugin

OpenStackClient will override this to perform additional chacks on auth_type.

load_auth_plugin(config)

Get auth plugin and validate args

openstackclient.common.clientmanager module

Manage access to the clients, including authenticating when needed.

class openstackclient.common.clientmanager.ClientManager(cli_options=None, api_version=None)

Bases: osc_lib.clientmanager.ClientManager

Manages access to API clients, including authentication

Wrap osc_lib’s ClientManager to maintain compatibility for the existing plugin V2 interface. Some currently private attributes become public in osc-lib so we need to maintain a transition period.

PLUGIN_INTERFACE_VERSION = '2'

is_network_endpoint_enabled()

Check if the network endpoint is enabled

setup_auth()

Set up authentication

openstackclient.common.clientmanager.build_plugin_option_parser(parser)

Add plugin options to the parser

openstackclient.common.clientmanager.get_plugin_modules(group)

Find plugin entry points

openstackclient.common.command module

openstackclient.common.commandmanager module

Modify cliff.CommandManager

class openstackclient.common.commandmanager.CommandManager(namespace, convert_underscores=True)

Bases: cliff.commandmanager.CommandManager

Add additional functionality to cliff.CommandManager

Load additional command groups after initialization Add _command_group() methods

add_command_group(group=None)

Adds another group of command entrypoints

get_command_groups()

Returns a list of the loaded command groups

get_command_names(group=None)

Returns a list of commands loaded for the specified group

load_commands(namespace)

openstackclient.common.configuration module

Configuration action implementations

class openstackclient.common.configuration.ShowConfiguration(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Display configuration details

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2c21110>

take_action(parsed_args)

openstackclient.common.exceptions module

openstackclient.common.extension module

Extension action implementations

class openstackclient.common.extension.ListExtension(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List API extensions

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2c21910>

take_action(parsed_args)

openstackclient.common.limits module

Limits Action Implementation

class openstackclient.common.limits.ShowLimits(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

Show compute and block storage limits

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2aacbd0>

take_action(parsed_args)

openstackclient.common.logs module

openstackclient.common.module module

Module action implementation

class openstackclient.common.module.ListCommand(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Lister

List recognized commands by group

auth_required = False

log = <logging.Logger object at 0x7f75a2bb9110>

take_action(parsed_args)

class openstackclient.common.module.ListModule(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

List module versions

auth_required = False

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2bb9650>

take_action(parsed_args)

openstackclient.common.parseractions module

openstackclient.common.quota module

Quota action implementations

class openstackclient.common.quota.SetQuota(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.Command

Set quotas for project or class

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2b4b350>

take_action(parsed_args)

class openstackclient.common.quota.ShowQuota(app, app_args, cmd_name=None)

Bases: osc_lib.command.command.ShowOne

Show quotas for project or class

get_compute_volume_quota(client, parsed_args)

get_network_quota(parsed_args)

get_parser(prog_name)

log = <logging.Logger object at 0x7f75a2b4b750>

take_action(parsed_args)

openstackclient.common.session module

Subclass of keystoneauth1.session

class openstackclient.common.session.TimingSession(**kwargs)

Bases: keystoneauth1.session.Session

A Session that supports collection of timing data per Method URL

get_timings()

request(url, method, **kwargs)

Wrap the usual request() method with the timers

reset_timings()

openstackclient.common.timing module

openstackclient.common.utils module

Module contents