openstackclient.volume.v1 package¶

Submodules¶

openstackclient.volume.v1.qos_specs module¶

Volume v1 QoS action implementations

class openstackclient.volume.v1.qos_specs.AssociateQos(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.AssociateQos (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.qos_specs.CreateQos(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.CreateQos (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.qos_specs.DeleteQos(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.DeleteQos (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.qos_specs.DisassociateQos(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.DisassociateQos (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.qos_specs.ListQos(app, app_args, cmd_name=None)¶

Bases: Lister

log = <Logger openstackclient.volume.v1.qos_specs.ListQos (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.volume.v1.qos_specs.SetQos(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.SetQos (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.qos_specs.ShowQos(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.ShowQos (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.qos_specs.UnsetQos(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.qos_specs.UnsetQos (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

openstackclient.volume.v1.service module¶

Service action implementations

class openstackclient.volume.v1.service.ListService(app, app_args, cmd_name=None)¶

Bases: Lister

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.service.ListService (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.volume.v1.service.SetService(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.service.SetService (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

openstackclient.volume.v1.volume module¶

Volume v1 Volume action implementations

class openstackclient.volume.v1.volume.AttachmentsColumn(value, server_cache=None)¶

Bases: FormattableColumn

Formattable column for attachments column.

Unlike the parent FormattableColumn class, the initializer of the class takes server_cache as the second argument. osc_lib.utils.get_item_properties instantiate cliff FormattableColumn object with a single parameter “column value”, so you need to pass a partially initialized class like functools.partial(AttachmentsColumn, server_cache).

human_readable()¶

Return a formatted string of a volume’s attached instances

Return type:

a string of formatted instances

class openstackclient.volume.v1.volume.CreateVolume(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.CreateVolume (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume.DeleteVolume(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.DeleteVolume (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume.ListVolume(app, app_args, cmd_name=None)¶

Bases: Lister

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.ListVolume (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.volume.v1.volume.MigrateVolume(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.MigrateVolume (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume.SetVolume(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.SetVolume (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume.ShowVolume(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.ShowVolume (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume.UnsetVolume(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume.UnsetVolume (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

openstackclient.volume.v1.volume_backup module¶

Volume v1 Backup action implementations

class openstackclient.volume.v1.volume_backup.CreateVolumeBackup(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_backup.CreateVolumeBackup (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_backup.DeleteVolumeBackup(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_backup.DeleteVolumeBackup (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_backup.ListVolumeBackup(app, app_args, cmd_name=None)¶

Bases: Lister

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_backup.ListVolumeBackup (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.volume.v1.volume_backup.RestoreVolumeBackup(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_backup.RestoreVolumeBackup (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_backup.ShowVolumeBackup(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_backup.ShowVolumeBackup (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_backup.VolumeIdColumn(value, volume_cache=None)¶

Bases: FormattableColumn

Formattable column for volume ID column.

Unlike the parent FormattableColumn class, the initializer of the class takes volume_cache as the second argument. osc_lib.utils.get_item_properties instantiate cliff FormattableColumn object with a single parameter “column value”, so you need to pass a partially initialized class like functools.partial(VolumeIdColumn, volume_cache).

human_readable()¶

Return a volume name if available

Return type:

either the volume ID or name

openstackclient.volume.v1.volume_snapshot module¶

Volume v1 Snapshot action implementations

class openstackclient.volume.v1.volume_snapshot.CreateVolumeSnapshot(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_snapshot.CreateVolumeSnapshot (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_snapshot.DeleteVolumeSnapshot(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_snapshot.DeleteVolumeSnapshot (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_snapshot.ListVolumeSnapshot(app, app_args, cmd_name=None)¶

Bases: Lister

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_snapshot.ListVolumeSnapshot (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.volume.v1.volume_snapshot.SetVolumeSnapshot(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_snapshot.SetVolumeSnapshot (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_snapshot.ShowVolumeSnapshot(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_snapshot.ShowVolumeSnapshot (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_snapshot.UnsetVolumeSnapshot(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_snapshot.UnsetVolumeSnapshot (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_snapshot.VolumeIdColumn(value, volume_cache=None)¶

Bases: FormattableColumn

Formattable column for volume ID column.

Unlike the parent FormattableColumn class, the initializer of the class takes volume_cache as the second argument. osc_lib.utils.get_item_properties instantiate cliff FormattableColumn object with a single parameter “column value”, so you need to pass a partially initialized class like functools.partial(VolumeIdColumn, volume_cache).

human_readable()¶

Return a volume name if available

Return type:

either the volume ID or name

openstackclient.volume.v1.volume_transfer_request module¶

Volume v1 transfer action implementations

class openstackclient.volume.v1.volume_transfer_request.AcceptTransferRequest(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_transfer_request.AcceptTransferRequest (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_transfer_request.CreateTransferRequest(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_transfer_request.CreateTransferRequest (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_transfer_request.DeleteTransferRequest(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_transfer_request.DeleteTransferRequest (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_transfer_request.ListTransferRequest(app, app_args, cmd_name=None)¶

Bases: Lister

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_transfer_request.ListTransferRequest (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.volume.v1.volume_transfer_request.ShowTransferRequest(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_transfer_request.ShowTransferRequest (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

openstackclient.volume.v1.volume_type module¶

Volume v1 Type action implementations

class openstackclient.volume.v1.volume_type.CreateVolumeType(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_type.CreateVolumeType (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_type.DeleteVolumeType(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_type.DeleteVolumeType (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_type.EncryptionInfoColumn(value, encryption_data=None)¶

Bases: FormattableColumn

Formattable column for encryption info column.

Unlike the parent FormattableColumn class, the initializer of the class takes encryption_data as the second argument. osc_lib.utils.get_item_properties instantiate cliff FormattableColumn object with a single parameter “column value”, so you need to pass a partially initialized class like functools.partial(EncryptionInfoColumn encryption_data).

human_readable()¶

Return a basic human readable version of the data.

machine_readable()¶

Return a raw data structure using only Python built-in types.

It must be possible to serialize the return value directly using a formatter like JSON, and it will be up to the formatter plugin to decide how to make that transformation.

class openstackclient.volume.v1.volume_type.ListVolumeType(app, app_args, cmd_name=None)¶

Bases: Lister

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_type.ListVolumeType (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.volume.v1.volume_type.SetVolumeType(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_type.SetVolumeType (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

class openstackclient.volume.v1.volume_type.ShowVolumeType(app, app_args, cmd_name=None)¶

Bases: ShowOne

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_type.ShowVolumeType (WARNING)>¶

take_action(parsed_args)¶

Return a two-part tuple with a tuple of column names and a tuple of values.

class openstackclient.volume.v1.volume_type.UnsetVolumeType(app, app_args, cmd_name=None)¶

Bases: Command

get_parser(prog_name)¶

Return an argparse.ArgumentParser.

log = <Logger openstackclient.volume.v1.volume_type.UnsetVolumeType (WARNING)>¶

take_action(parsed_args)¶

Override to do something useful.

The returned value will be returned by the program.

Module contents¶