# openstackclient.image.v2 package

## Submodules

## openstackclient.image.v2.cache module

class openstackclient.image.v2.cache.ClearCachedImage(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.cache.ClearCachedImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.cache.DeleteCachedImage(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.cache.DeleteCachedImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.cache.ListCachedImage(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.cache.ListCachedImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[tuple[Any, ...]]]

    Run command.

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

class openstackclient.image.v2.cache.QueueCachedImage(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.cache.QueueCachedImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.image.v2.image module

Image V2 Action Implementations

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

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.AddProjectToImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

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

  Bases: `ShowOne`

  deadopts = ('size', 'location', 'copy-from', 'checksum', 'store')
  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.CreateImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

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

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.DeleteImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

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

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.ImportImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

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

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.ListImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]

    Run command.

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

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

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.ListImageProjects (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]

    Run command.

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

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

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.RemoveProjectImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

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

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.SaveImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

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

  Bases: `Command`

  deadopts = ('visibility',)
  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.SetImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

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

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.ShowImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

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

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.ShowProjectImage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

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

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.StageImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

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

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.StoresInfo (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]

    Run command.

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

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

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.image.UnsetImage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

openstackclient.image.v2.image.get_data_from_stdin() → Any

## openstackclient.image.v2.info module

class openstackclient.image.v2.info.ImportInfo(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  log = <Logger openstackclient.image.v2.info.ImportInfo (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

## openstackclient.image.v2.metadef_namespaces module

Image V2 Action Implementations

class openstackclient.image.v2.metadef_namespaces.CreateMetadefNamespace(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_namespaces.CreateMetadefNamespace (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

class openstackclient.image.v2.metadef_namespaces.DeleteMetadefNamespace(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_namespaces.DeleteMetadefNamespace (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_namespaces.ListMetadefNamespace(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_namespaces.ListMetadefNamespace (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[tuple[Any, ...]]]

    Run command.

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

class openstackclient.image.v2.metadef_namespaces.SetMetadefNamespace(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_namespaces.SetMetadefNamespace (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_namespaces.ShowMetadefNamespace(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_namespaces.ShowMetadefNamespace (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

class openstackclient.image.v2.metadef_namespaces.UnsetMetadefNamespace(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_namespaces.UnsetMetadefNamespace (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.image.v2.metadef_objects module

Image V2 Action Implementations

class openstackclient.image.v2.metadef_objects.CreateMetadefObjects(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_objects.CreateMetadefObjects (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

class openstackclient.image.v2.metadef_objects.DeleteMetadefObject(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_objects.DeleteMetadefObject (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_objects.ListMetadefObjects(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_objects.ListMetadefObjects (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[tuple[Any, ...]]]

    Run command.

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

class openstackclient.image.v2.metadef_objects.SetMetadefObject(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_objects.SetMetadefObject (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_objects.ShowMetadefObjectProperty(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_objects.ShowMetadefObjectProperty (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

class openstackclient.image.v2.metadef_objects.ShowMetadefObjects(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_objects.ShowMetadefObjects (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

## openstackclient.image.v2.metadef_properties module

class openstackclient.image.v2.metadef_properties.CreateMetadefProperty(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_properties.CreateMetadefProperty (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

class openstackclient.image.v2.metadef_properties.DeleteMetadefProperty(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_properties.DeleteMetadefProperty (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_properties.ListMetadefProperties(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_properties.ListMetadefProperties (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[tuple[Any, ...]]]

    Run command.

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

class openstackclient.image.v2.metadef_properties.SetMetadefProperty(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_properties.SetMetadefProperty (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_properties.ShowMetadefProperty(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_properties.ShowMetadefProperty (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

## openstackclient.image.v2.metadef_resource_type_association module

class openstackclient.image.v2.metadef_resource_type_association.CreateMetadefResourceTypeAssociation(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_resource_type_association.CreateMetadefResourceTypeAssociation (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

class openstackclient.image.v2.metadef_resource_type_association.DeleteMetadefResourceTypeAssociation(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_resource_type_association.DeleteMetadefResourceTypeAssociation (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.image.v2.metadef_resource_type_association.ListMetadefResourceTypeAssociations(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.metadef_resource_type_association.ListMetadefResourceTypeAssociations (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

## openstackclient.image.v2.metadef_resource_types module

Image V2 Action Implementations

class openstackclient.image.v2.metadef_resource_types.ListMetadefResourceTypes(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  log = <Logger openstackclient.image.v2.metadef_resource_types.ListMetadefResourceTypes (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[tuple[Any, ...]]]

    Run command.

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

## openstackclient.image.v2.task module

class openstackclient.image.v2.task.ListTask(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.task.ListTask (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], Iterable[tuple[Any, ...]]]

    Run command.

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

class openstackclient.image.v2.task.ShowTask(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.image.v2.task.ShowTask (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], Iterable[Any]]

    Run command.

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

## Module contents

this page last updated: 2026-07-15 15:33:41

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