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
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.availability_zone.ListAvailabilityZone (WARNING)>¶
- take_action(parsed_args)¶
Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
openstackclient.common.clientmanager module¶
Manage access to the clients, including authenticating when needed.
- class openstackclient.common.clientmanager.ClientManager(cli_options=None, api_version=None, pw_func=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_compute_endpoint_enabled()¶
Check if Compute endpoint is enabled
- is_network_endpoint_enabled()¶
Check if the network endpoint is enabled
- is_volume_endpoint_enabled(volume_client)¶
Check if volume 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.configuration module¶
Configuration action implementations
- class openstackclient.common.configuration.ShowConfiguration(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.ShowOne
- auth_required = False¶
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.configuration.ShowConfiguration (WARNING)>¶
- take_action(parsed_args)¶
Return a two-part tuple with a tuple of column names and a tuple of values.
openstackclient.common.extension module¶
Extension action implementations
- class openstackclient.common.extension.ListExtension(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Lister
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.extension.ListExtension (WARNING)>¶
- take_action(parsed_args)¶
Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class openstackclient.common.extension.ShowExtension(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.ShowOne
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.extension.ShowExtension (WARNING)>¶
- take_action(parsed_args)¶
Return a two-part tuple with a tuple of column names and a tuple of values.
openstackclient.common.limits module¶
Limits Action Implementation
- class openstackclient.common.limits.ShowLimits(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Lister
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.limits.ShowLimits (WARNING)>¶
- take_action(parsed_args)¶
Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
openstackclient.common.module module¶
Module action implementation
- class openstackclient.common.module.ListCommand(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Lister
- auth_required = False¶
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.module.ListCommand (WARNING)>¶
- take_action(parsed_args)¶
Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class openstackclient.common.module.ListModule(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.ShowOne
- auth_required = False¶
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.module.ListModule (WARNING)>¶
- take_action(parsed_args)¶
Return a two-part tuple with a tuple of column names and a tuple of values.
openstackclient.common.progressbar module¶
- class openstackclient.common.progressbar.VerboseFileWrapper(wrapped, totalsize)¶
Bases:
openstackclient.common.progressbar._ProgressBarBase
A file wrapper with a progress bar.
The file wrapper shows and advances a progress bar whenever the wrapped file’s read method is called.
- read(*args, **kwargs)¶
openstackclient.common.project_cleanup module¶
- class openstackclient.common.project_cleanup.ProjectCleanup(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Command
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.project_cleanup.ProjectCleanup (WARNING)>¶
- take_action(parsed_args)¶
Override to do something useful.
The returned value will be returned by the program.
- openstackclient.common.project_cleanup.ask_user_yesno(msg, default=True)¶
Ask user Y/N question
- Parameters
msg (str) – question text
default (bool) – default value
- Return bool
User choice
openstackclient.common.project_purge module¶
- class openstackclient.common.project_purge.ProjectPurge(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Command
- delete_objects(func_delete, data, resource, dry_run)¶
- delete_one_volume_backup(backup_id)¶
- delete_one_volume_snapshot(snapshot_id)¶
- delete_resources(dry_run, project_id)¶
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.project_purge.ProjectPurge (WARNING)>¶
- take_action(parsed_args)¶
Override to do something useful.
The returned value will be returned by the program.
openstackclient.common.quota module¶
Quota action implementations
- class openstackclient.common.quota.BaseQuota¶
Bases:
object
- get_compute_quota(client, parsed_args)¶
- get_network_quota(parsed_args)¶
- get_volume_quota(client, parsed_args)¶
- class openstackclient.common.quota.ListQuota(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Lister
,openstackclient.common.quota.BaseQuota
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.quota.ListQuota (WARNING)>¶
- take_action(parsed_args)¶
Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.
- class openstackclient.common.quota.SetQuota(app, app_args, cmd_name=None)¶
Bases:
openstackclient.network.common.NetDetectionMixin
,osc_lib.command.command.Command
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.quota.SetQuota (WARNING)>¶
- take_action(parsed_args)¶
Override to do something useful.
The returned value will be returned by the program.
- class openstackclient.common.quota.ShowQuota(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.ShowOne
,openstackclient.common.quota.BaseQuota
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.quota.ShowQuota (WARNING)>¶
- take_action(parsed_args)¶
Return a two-part tuple with a tuple of column names and a tuple of values.
openstackclient.common.versions module¶
Versions Action Implementation
- class openstackclient.common.versions.ShowVersions(app, app_args, cmd_name=None)¶
Bases:
osc_lib.command.command.Lister
- get_parser(prog_name)¶
Return an
argparse.ArgumentParser
.
- log = <Logger openstackclient.common.versions.ShowVersions (WARNING)>¶
- take_action(parsed_args)¶
Run command.
Return a tuple containing the column names and an iterable containing the data to be listed.