The freezerclient.shell Module¶

class freezerclient.shell.FreezerCommandManager(namespace, convert_underscores=True)[source]¶

Bases: cliff.commandmanager.CommandManager

All commands available for the shell are registered here

SHELL_COMMANDS = {'job-list': <class 'freezerclient.v1.jobs.JobList'>, 'client-list': <class 'freezerclient.v1.clients.ClientList'>, 'session-delete': <class 'freezerclient.v1.sessions.SessionDelete'>, 'job-abort': <class 'freezerclient.v1.jobs.JobAbort'>, 'session-remove-job': <class 'freezerclient.v1.sessions.SessionRemoveJob'>, 'backup-list': <class 'freezerclient.v1.backups.BackupList'>, 'action-list': <class 'freezerclient.v1.actions.ActionList'>, 'backup-delete': <class 'freezerclient.v1.backups.BackupDelete'>, 'action-show': <class 'freezerclient.v1.actions.ActionShow'>, 'job-create': <class 'freezerclient.v1.jobs.JobCreate'>, 'action-update': <class 'freezerclient.v1.actions.ActionUpdate'>, 'session-list': <class 'freezerclient.v1.sessions.SessionList'>, 'session-start': <class 'freezerclient.v1.sessions.SessionStart'>, 'session-show': <class 'freezerclient.v1.sessions.SessionShow'>, 'job-start': <class 'freezerclient.v1.jobs.JobStart'>, 'job-get': <class 'freezerclient.v1.jobs.JobGet'>, 'backup-show': <class 'freezerclient.v1.backups.BackupShow'>, 'client-show': <class 'freezerclient.v1.clients.ClientShow'>, 'action-delete': <class 'freezerclient.v1.actions.ActionDelete'>, 'job-update': <class 'freezerclient.v1.jobs.JobUpdate'>, 'client-delete': <class 'freezerclient.v1.clients.ClientDelete'>, 'session-update': <class 'freezerclient.v1.sessions.SessionUpdate'>, 'job-delete': <class 'freezerclient.v1.jobs.JobDelete'>, 'session-create': <class 'freezerclient.v1.sessions.SessionCreate'>, 'action-create': <class 'freezerclient.v1.actions.ActionCreate'>, 'job-stop': <class 'freezerclient.v1.jobs.JobStop'>, 'session-add-job': <class 'freezerclient.v1.sessions.SessionAddJob'>, 'client-register': <class 'freezerclient.v1.clients.ClientRegister'>, 'job-show': <class 'freezerclient.v1.jobs.JobShow'>}¶

actions = <module 'freezerclient.v1.actions' from '/home/zuul/src/git.openstack.org/openstack/python-freezerclient/freezerclient/v1/actions.py'>¶

backups = <module 'freezerclient.v1.backups' from '/home/zuul/src/git.openstack.org/openstack/python-freezerclient/freezerclient/v1/backups.py'>¶

clients = <module 'freezerclient.v1.clients' from '/home/zuul/src/git.openstack.org/openstack/python-freezerclient/freezerclient/v1/clients.py'>¶

jobs = <module 'freezerclient.v1.jobs' from '/home/zuul/src/git.openstack.org/openstack/python-freezerclient/freezerclient/v1/jobs.py'>¶

load_commands(namespace)[source]¶

sessions = <module 'freezerclient.v1.sessions' from '/home/zuul/src/git.openstack.org/openstack/python-freezerclient/freezerclient/v1/sessions.py'>¶

class freezerclient.shell.FreezerShell[source]¶

Bases: cliff.app.App

build_option_parser(description, version)[source]¶

client¶

Factory function to create a new freezer service client.

The returned client will be either a V1 or V2 client.

Returns:	freezerclient object

freezerclient.shell.check_api_version()[source]¶

Check freezer version API to use 1: not multi-tenant, useful for infrastructure 2: multi-tenant, useful for backup as a service :return: str

freezerclient.shell.main(argv=['build_sphinx'])[source]¶