# openstackclient.share.v2 package

## Submodules

## openstackclient.share.v2.messages module

class openstackclient.share.v2.messages.DeleteMessage(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Remove one or more messages.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.messages.DeleteMessage (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.messages.ListMessage(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  Lists all messages.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.messages.ListMessage (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.share.v2.messages.ShowMessage(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show details about a message.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.messages.ShowMessage (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], tuple[Any, ...]]

    Run command.

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

## openstackclient.share.v2.resource_locks module

class openstackclient.share.v2.resource_locks.CreateResourceLock(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create a new resource lock.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.resource_locks.CreateResourceLock (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.resource_locks.DeleteResourceLock(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Remove one or more resource locks.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.resource_locks.DeleteResourceLock (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.resource_locks.ListResourceLock(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  Lists all resource locks.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.resource_locks.ListResourceLock (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.share.v2.resource_locks.SetResourceLock(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Set resource lock properties.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.resource_locks.SetResourceLock (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.resource_locks.ShowResourceLock(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show details about a resource lock.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.resource_locks.ShowResourceLock (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.resource_locks.UnsetResourceLock(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Unsets a property on a resource lock.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.resource_locks.UnsetResourceLock (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

openstackclient.share.v2.resource_locks.is_uuid_like(value: str) → bool

  Returns validation of a value as a UUID.

  Parameters:

    val (string) – Value to verify

  Returns:

    bool

  Changed in version 1.1.1: Support non-lowercase UUIDs.

## openstackclient.share.v2.security_services module

class openstackclient.share.v2.security_services.CreateShareSecurityService(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create security service used by project.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.security_services.CreateShareSecurityService (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.security_services.DeleteShareSecurityService(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete one or more security services.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.security_services.DeleteShareSecurityService (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.security_services.ListShareSecurityService(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List security services.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.security_services.ListShareSecurityService (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.share.v2.security_services.SetShareSecurityService(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Set security service.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.security_services.SetShareSecurityService (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.security_services.ShowShareSecurityService(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show security service.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.security_services.ShowShareSecurityService (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.security_services.UnsetShareSecurityService(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Unset security service.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.security_services.UnsetShareSecurityService (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.share.v2.services module

class openstackclient.share.v2.services.EnsureShareService(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Run ensure shares in a back end (Admin only).

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.services.EnsureShareService (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.services.ListShareService(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List share services (Admin only).

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.services.ListShareService (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.share.v2.services.SetShareService(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Enable/disable share service (Admin only).

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.services.SetShareService (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.share.v2.share_group_snapshots module

class openstackclient.share.v2.share_group_snapshots.CreateShareGroupSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create a share group snapshot.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.CreateShareGroupSnapshot (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.share_group_snapshots.DeleteShareGroupSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete one or more share group snapshots.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.DeleteShareGroupSnapshot (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_group_snapshots.ListShareGroupSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List share group snapshots.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.ListShareGroupSnapshot (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.share.v2.share_group_snapshots.ListShareGroupSnapshotMembers(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List members for share group snapshot.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.ListShareGroupSnapshotMembers (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.share.v2.share_group_snapshots.SetShareGroupSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Set share group snapshot properties.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.SetShareGroupSnapshot (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_group_snapshots.ShowShareGroupSnapshot(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Display a share group snapshot

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.ShowShareGroupSnapshot (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.share_group_snapshots.UnsetShareGroupSnapshot(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Unset a share group snapshot property.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_snapshots.UnsetShareGroupSnapshot (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.share.v2.share_group_type_access module

class openstackclient.share.v2.share_group_type_access.ListShareGroupTypeAccess(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  Get access list for share group type.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_type_access.ListShareGroupTypeAccess (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.share.v2.share_group_type_access.ShareGroupTypeAccessAllow(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Allow a project to access a share group type.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_type_access.ShareGroupTypeAccessAllow (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_group_type_access.ShareGroupTypeAccessDeny(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Deny a project to access a share group type.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_type_access.ShareGroupTypeAccessDeny (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.share.v2.share_group_types module

class openstackclient.share.v2.share_group_types.CreateShareGroupType(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create new share group type.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_types.CreateShareGroupType (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.share_group_types.DeleteShareGroupType(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete a share group type.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_types.DeleteShareGroupType (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_group_types.ListShareGroupType(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List Share Group Types.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_types.ListShareGroupType (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.share.v2.share_group_types.SetShareGroupType(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Set share type properties.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_types.SetShareGroupType (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_group_types.ShowShareGroupType(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show Share Group Types.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_types.ShowShareGroupType (WARNING)>
  take_action(parsed_args: Namespace) → tuple[Sequence[str], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.share_group_types.UnsetShareGroupType(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Unset share group type extra specs.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_group_types.UnsetShareGroupType (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## openstackclient.share.v2.share_groups module

class openstackclient.share.v2.share_groups.CreateShareGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Create new share group.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_groups.CreateShareGroup (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.share_groups.DeleteShareGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Delete one or more share groups.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_groups.DeleteShareGroup (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_groups.ListShareGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Lister`

  List share groups.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_groups.ListShareGroup (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.share.v2.share_groups.SetShareGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Set share group.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_groups.SetShareGroup (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

class openstackclient.share.v2.share_groups.ShowShareGroup(app: App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `ShowOne`

  Show share group.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_groups.ShowShareGroup (WARNING)>
  take_action(parsed_args: Namespace) → tuple[tuple[str, ...], tuple[Any, ...]]

    Run command.

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

class openstackclient.share.v2.share_groups.UnsetShareGroup(app: _app.App, app_args: Namespace | None, cmd_name: str | None = None)

  Bases: `Command`

  Unset a share group property.

  get_parser(prog_name: str) → ArgumentParser

    Return an `argparse.ArgumentParser`.

  log = <Logger openstackclient.share.v2.share_groups.UnsetShareGroup (WARNING)>
  take_action(parsed_args: Namespace) → None

    Override to do something useful.

    The returned value will be returned by the program.

## 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.