# openstackclient.volume.v2 package

## Submodules

## openstackclient.volume.v2.backup_record module

Volume v2 Backup action implementations

class openstackclient.volume.v2.backup_record.ExportBackupRecord(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.backup_record.ExportBackupRecord (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.v2.backup_record.ImportBackupRecord(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.backup_record.ImportBackupRecord (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

## openstackclient.volume.v2.consistency_group module

Volume v2 consistency group action implementations

class openstackclient.volume.v2.consistency_group.AddVolumeToConsistencyGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.AddVolumeToConsistencyGroup (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.consistency_group.CreateConsistencyGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.CreateConsistencyGroup (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.v2.consistency_group.DeleteConsistencyGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.DeleteConsistencyGroup (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.consistency_group.ListConsistencyGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.ListConsistencyGroup (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.v2.consistency_group.RemoveVolumeFromConsistencyGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.RemoveVolumeFromConsistencyGroup (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.consistency_group.SetConsistencyGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.SetConsistencyGroup (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.consistency_group.ShowConsistencyGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group.ShowConsistencyGroup (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

## openstackclient.volume.v2.consistency_group_snapshot module

Volume v2 consistency group snapshot action implementations

class openstackclient.volume.v2.consistency_group_snapshot.CreateConsistencyGroupSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group_snapshot.CreateConsistencyGroupSnapshot (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.v2.consistency_group_snapshot.DeleteConsistencyGroupSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group_snapshot.DeleteConsistencyGroupSnapshot (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.consistency_group_snapshot.ListConsistencyGroupSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group_snapshot.ListConsistencyGroupSnapshot (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.v2.consistency_group_snapshot.ShowConsistencyGroupSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.consistency_group_snapshot.ShowConsistencyGroupSnapshot (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

## openstackclient.volume.v2.qos_specs module

Volume v2 QoS action implementations

class openstackclient.volume.v2.qos_specs.AssociateQos(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.qos_specs.CreateQos(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.qos_specs.CreateQos (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.v2.qos_specs.DeleteQos(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.qos_specs.DisassociateQos(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.qos_specs.ListQos(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.qos_specs.SetQos(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.qos_specs.ShowQos(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.qos_specs.ShowQos (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.v2.qos_specs.UnsetQos(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.qos_specs.UnsetQos (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.volume.v2.service module

Service action implementations

class openstackclient.volume.v2.service.ListService(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.service.SetService(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.service.SetService (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.volume.v2.volume module

Volume V2 Volume action implementations

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

  Bases: `FormattableColumn`[`list`[`Any`]]

  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.v2.volume.CreateVolume(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume.CreateVolume (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.v2.volume.DeleteVolume(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume.DeleteVolume (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.volume.KeyValueHintAction(*args, **kwargs)

  Bases: `Action`

  Uses KeyValueAction or KeyValueAppendAction based on the given key

  APPEND_KEYS = ('same_host', 'different_host')

class openstackclient.volume.v2.volume.ListVolume(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume.MigrateVolume(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume.MigrateVolume (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.volume.SetVolume(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume.SetVolume (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.volume.ShowVolume(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume.ShowVolume (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.v2.volume.UnsetVolume(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume.UnsetVolume (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.volume.v2.volume_backend module

Storage backend action implementations

class openstackclient.volume.v2.volume_backend.ListPool(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_backend.ListPool (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.v2.volume_backend.ShowCapability(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_backend.ShowCapability (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

## openstackclient.volume.v2.volume_backup module

Volume v2 Backup action implementations

class openstackclient.volume.v2.volume_backup.CreateVolumeBackup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_backup.CreateVolumeBackup (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.v2.volume_backup.DeleteVolumeBackup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_backup.ListVolumeBackup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_backup.RestoreVolumeBackup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_backup.RestoreVolumeBackup (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.v2.volume_backup.SetVolumeBackup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_backup.SetVolumeBackup (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.volume_backup.ShowVolumeBackup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_backup.ShowVolumeBackup (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.v2.volume_backup.VolumeIdColumn(value, volume_cache=None)

  Bases: `FormattableColumn`[`str`]

  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.v2.volume_host module

Volume v2 host action implementations

class openstackclient.volume.v2.volume_host.FailoverVolumeHost(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_host.FailoverVolumeHost (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.volume.v2.volume_host.SetVolumeHost(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_host.SetVolumeHost (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.volume.v2.volume_snapshot module

Volume v2 snapshot action implementations

class openstackclient.volume.v2.volume_snapshot.CreateVolumeSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_snapshot.CreateVolumeSnapshot (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.v2.volume_snapshot.DeleteVolumeSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_snapshot.ListVolumeSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_snapshot.SetVolumeSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_snapshot.ShowVolumeSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_snapshot.ShowVolumeSnapshot (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.v2.volume_snapshot.UnsetVolumeSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_snapshot.VolumeIdColumn(value, volume_cache=None)

  Bases: `FormattableColumn`[`str`]

  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.v2.volume_transfer_request module

Volume v2 transfer action implementations

class openstackclient.volume.v2.volume_transfer_request.AcceptTransferRequest(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_transfer_request.AcceptTransferRequest (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.v2.volume_transfer_request.CreateTransferRequest(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_transfer_request.CreateTransferRequest (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.v2.volume_transfer_request.DeleteTransferRequest(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_transfer_request.ListTransferRequest(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_transfer_request.ShowTransferRequest(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_transfer_request.ShowTransferRequest (WARNING)>
  take_action(parsed_args)

    Run command.

    Return a tuple containing the column names and an iterable containing the data to be listed.

## openstackclient.volume.v2.volume_type module

Volume v2 Type action implementations

class openstackclient.volume.v2.volume_type.CreateVolumeType(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_type.CreateVolumeType (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.v2.volume_type.DeleteVolumeType(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_type.EncryptionInfoColumn(value, encryption_data=None)

  Bases: `FormattableColumn`[`Any`]

  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.v2.volume_type.ListVolumeType(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_type.SetVolumeType(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.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.v2.volume_type.ShowVolumeType(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_type.ShowVolumeType (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.v2.volume_type.UnsetVolumeType(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name)

    Return an `argparse.ArgumentParser`.

  log: logging.Logger = <Logger openstackclient.volume.v2.volume_type.UnsetVolumeType (WARNING)>
  take_action(parsed_args)

    Override to do something useful.

    The returned value will be returned by the program.

## Module contents

this page last updated: 2026-04-01 09:44:20

Except where otherwise noted, this document is licensed under Creative Commons Attribution 3.0 License. See all OpenStack Legal Documents.