The cinder.cmd.manage Module

CLI interface for cinder management.

class BackupCommands

Bases: object

Methods for managing backups.

list()

List all backups.

List all backups (including ones in progress) and the host on which the backup operation is running.

update_backup_host(currenthost, newhost)

Modify the host name associated with a backup.

Particularly to recover from cases where one has moved their Cinder Backup node, and not set backup_use_same_backend.

class BaseCommand

Bases: object

class ClusterCommands

Bases: cinder.cmd.manage.BaseCommand

Methods for managing clusters.

list()

Show a list of all cinder services.

remove(recursive, binary, cluster_name)

Completely removes a cluster.

rename(partial, current, new)

Rename cluster name for Volumes and Consistency Groups.

Useful when you want to rename a cluster, particularly when the backend_name has been modified in a multi-backend config or we have moved from a single backend to multi-backend.

class ConfigCommands

Bases: object

Class for exposing the flags defined by flag_file(s).

list(param=None)

List parameters configured for cinder.

Lists all parameters configured for cinder unless an optional argument is specified. If the parameter is specified we only print the requested parameter. If the parameter is not found an appropriate error is produced by .get*().

class ConsistencyGroupCommands

Bases: object

Methods for managing consistency groups.

update_cg_host(currenthost, newhost)

Modify the host name associated with a Consistency Group.

Particularly to recover from cases where one has moved a host from single backend to multi-backend, or changed the host configuration option, or modified the backend_name in a multi-backend config.

class DbCommands

Bases: object

Class for managing the database.

online_data_migrations(max_count=None, ignore_state=False)

Perform online data migrations for the release in batches.

online_migrations = (<function migrate_consistencygroups_to_groups at 0x7fa3663d1938>, <function migrate_add_message_prefix at 0x7fa3663d1410>)

purge(age_in_days)

Purge deleted rows older than a given age from cinder tables.

sync(version=None)

Sync the database up to the most recent version.

version()

Print the current database version.

class GetLogCommands

Bases: object

Get logging information.

errors()

Get all of the errors from the log files.

syslog(num_entries=10)

Get <num_entries> of the cinder syslog events.

class HostCommands

Bases: object

List hosts.

list(zone=None)

Show a list of all physical hosts.

Can be filtered by zone. args: [zone]

class ServiceCommands

Bases: cinder.cmd.manage.BaseCommand

Methods for managing services.

list()

Show a list of all cinder services.

remove(binary, host_name)

Completely removes a service.

class ShellCommands

Bases: object

bpython()

Runs a bpython shell.

Falls back to Ipython/python shell if unavailable

ipython()

Runs an Ipython shell.

Falls back to Python shell if unavailable

python()

Runs a python shell.

Falls back to Python shell if unavailable

run(shell=None)

Runs a Python interactive interpreter.

script(path)

Runs the script from the specified path with flags set properly.

class VersionCommands

Bases: object

Class for exposing the codebase version.

list()

class VolumeCommands

Bases: object

Methods for dealing with a cloud in an odd state.

delete(volume_id)

Delete a volume, bypassing the check that it must be available.

update_host(currenthost, newhost)

Modify the host name associated with a volume.

Particularly to recover from cases where one has moved their Cinder Volume node, or modified their backend_name in a multi-backend config.

add_command_parsers(subparsers)

args(*args, **kwargs)

fetch_func_args(func)

get_arg_string(args)

main()

methods_of(obj)

Return non-private methods from an object.

Get all callable methods of an object that don’t start with underscore :return: a list of tuples of the form (method_name, method)