Merge "docs: Migrate remaining block storage commands to autocommand"
This commit is contained in:
		| @@ -9,53 +9,11 @@ rule comprises of a service type, a request path, and a request method. Access | ||||
| rules may only be created as attributes of application credentials, but they may | ||||
| be viewed and deleted independently. | ||||
|  | ||||
| .. autoprogram-cliff:: openstack.identity.v3 | ||||
|    :command: access rule delete | ||||
|  | ||||
| access rule delete | ||||
| ------------------ | ||||
| .. autoprogram-cliff:: openstack.identity.v3 | ||||
|    :command: access rule list | ||||
|  | ||||
| Delete access rule(s) | ||||
|  | ||||
| .. program:: access rule delete | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack access rule delete <access-rule> [<access-rule> ...] | ||||
|  | ||||
| .. describe:: <access-rule> | ||||
|  | ||||
|     Access rule(s) to delete (ID) | ||||
|  | ||||
| access rule list | ||||
| ---------------- | ||||
|  | ||||
| List access rules | ||||
|  | ||||
| .. program:: access rule list | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack access rule list | ||||
|         [--user <user>] | ||||
|         [--user-domain <user-domain>] | ||||
|  | ||||
| .. option:: --user | ||||
|  | ||||
|     User whose access rules to list (name or ID). If not provided, looks up the | ||||
|     current user's access rules. | ||||
|  | ||||
| .. option:: --user-domain | ||||
|  | ||||
|     Domain the user belongs to (name or ID). This can be | ||||
|     used in case collisions between user names exist. | ||||
|  | ||||
| access rule show | ||||
| --------------------------- | ||||
|  | ||||
| Display access rule details | ||||
|  | ||||
| .. program:: access rule show | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack access rule show <access-rule> | ||||
|  | ||||
| .. describe:: <access-rule> | ||||
|  | ||||
|     Access rule to display (ID) | ||||
| .. autoprogram-cliff:: openstack.identity.v3 | ||||
|    :command: access rule show | ||||
|   | ||||
| @@ -2,95 +2,16 @@ | ||||
| consistency group snapshot | ||||
| ========================== | ||||
|  | ||||
| Block Storage v2 | ||||
| Block Storage v2, v3 | ||||
|  | ||||
| consistency group snapshot create | ||||
| --------------------------------- | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group snapshot create | ||||
|  | ||||
| Create new consistency group snapshot. | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group snapshot delete | ||||
|  | ||||
| .. program:: consistency group snapshot create | ||||
| .. code:: bash | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group snapshot list | ||||
|  | ||||
|     openstack consistency group snapshot create | ||||
|         [--consistency-group <consistency-group>] | ||||
|         [--description <description>] | ||||
|         [<snapshot-name>] | ||||
|  | ||||
| .. option:: --consistency-group <consistency-group> | ||||
|  | ||||
|     Consistency group to snapshot (name or ID) | ||||
|     (default to be the same as <snapshot-name>) | ||||
|  | ||||
| .. option:: --description <description> | ||||
|  | ||||
|     Description of this consistency group snapshot | ||||
|  | ||||
| .. _consistency_group_snapshot_create-snapshot-name: | ||||
| .. describe:: <snapshot-name> | ||||
|  | ||||
|     Name of new consistency group snapshot (default to None) | ||||
|  | ||||
| consistency group snapshot delete | ||||
| --------------------------------- | ||||
|  | ||||
| Delete consistency group snapshot(s) | ||||
|  | ||||
| .. program:: consistency group snapshot delete | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group snapshot delete | ||||
|         <consistency-group-snapshot> [<consistency-group-snapshot> ...] | ||||
|  | ||||
| .. _consistency_group_snapshot_delete-consistency-group-snapshot: | ||||
| .. describe:: <consistency-group-snapshot> | ||||
|  | ||||
|     Consistency group snapshot(s) to delete (name or ID) | ||||
|  | ||||
| consistency group snapshot list | ||||
| ------------------------------- | ||||
|  | ||||
| List consistency group snapshots. | ||||
|  | ||||
| .. program:: consistency group snapshot list | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group snapshot list | ||||
|         [--all-projects] | ||||
|         [--long] | ||||
|         [--status <status>] | ||||
|         [--consistency-group <consistency-group>] | ||||
|  | ||||
| .. option:: --all-projects | ||||
|  | ||||
|     Show detail for all projects. Admin only. | ||||
|     (defaults to False) | ||||
|  | ||||
| .. option:: --long | ||||
|  | ||||
|     List additional fields in output | ||||
|  | ||||
| .. option:: --status <status> | ||||
|  | ||||
|     Filters results by a status | ||||
|     ("available", "error", "creating", "deleting" or "error_deleting") | ||||
|  | ||||
| .. option:: --consistency-group <consistency-group> | ||||
|  | ||||
|     Filters results by a consistency group (name or ID) | ||||
|  | ||||
| consistency group snapshot show | ||||
| ------------------------------- | ||||
|  | ||||
| Display consistency group snapshot details. | ||||
|  | ||||
| .. program:: consistency group snapshot show | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group snapshot show | ||||
|         <consistency-group-snapshot> | ||||
|  | ||||
| .. _consistency_group_snapshot_show-consistency-group-snapshot: | ||||
| .. describe:: <consistency-group-snapshot> | ||||
|  | ||||
|     Consistency group snapshot to display (name or ID) | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group snapshot show | ||||
|   | ||||
| @@ -2,172 +2,25 @@ | ||||
| consistency group | ||||
| ================= | ||||
|  | ||||
| Block Storage v2 | ||||
| Block Storage v2, v3 | ||||
|  | ||||
| consistency group add volume | ||||
| ---------------------------- | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group add volume | ||||
|  | ||||
| Add volume(s) to consistency group. | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group create | ||||
|  | ||||
| .. program:: consistency group add volume | ||||
| .. code:: bash | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group delete | ||||
|  | ||||
|     openstack consistency group add volume | ||||
|         <consistency-group> | ||||
|         <volume> [<volume> ...] | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group list | ||||
|  | ||||
| .. _consistency_group_add_volume: | ||||
| .. describe:: <consistency-group> | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group remove volume | ||||
|  | ||||
|     Consistency group to contain <volume> (name or ID) | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group set | ||||
|  | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume(s) to add to <consistency-group> (name or ID) | ||||
|     (repeat option to add multiple volumes) | ||||
|  | ||||
| consistency group create | ||||
| ------------------------ | ||||
|  | ||||
| Create new consistency group. | ||||
|  | ||||
| .. program:: consistency group create | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group create | ||||
|         --volume-type <volume-type> | --consistency-group-source <consistency-group> | --consistency-group-snapshot <consistency-group-snapshot> | ||||
|         [--description <description>] | ||||
|         [--availability-zone <availability-zone>] | ||||
|         [<name>] | ||||
|  | ||||
| .. option:: --volume-type <volume-type> | ||||
|  | ||||
|     Volume type of this consistency group (name or ID) | ||||
|  | ||||
| .. option:: --consistency-group-source <consistency-group> | ||||
|  | ||||
|     Existing consistency group (name or ID) | ||||
|  | ||||
| .. option:: --consistency-group-snapshot <consistency-group-snapshot> | ||||
|  | ||||
|     Existing consistency group snapshot (name or ID) | ||||
|  | ||||
| .. option:: --description <description> | ||||
|  | ||||
|     Description of this consistency group | ||||
|  | ||||
| .. option:: --availability-zone <availability-zone> | ||||
|  | ||||
|     Availability zone for this consistency group | ||||
|     (not available if creating consistency group from source) | ||||
|  | ||||
| .. _consistency_group_create-name: | ||||
| .. describe:: <name> | ||||
|  | ||||
|     Name of new consistency group (default to None) | ||||
|  | ||||
| consistency group delete | ||||
| ------------------------ | ||||
|  | ||||
| Delete consistency group(s). | ||||
|  | ||||
| .. program:: consistency group delete | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group delete | ||||
|         [--force] | ||||
|         <consistency-group> [<consistency-group> ...] | ||||
|  | ||||
| .. option:: --force | ||||
|  | ||||
|     Allow delete in state other than error or available | ||||
|  | ||||
| .. _consistency_group_delete-consistency-group: | ||||
| .. describe:: <consistency-group> | ||||
|  | ||||
|     Consistency group(s) to delete (name or ID) | ||||
|  | ||||
| consistency group list | ||||
| ---------------------- | ||||
|  | ||||
| List consistency groups. | ||||
|  | ||||
| .. program:: consistency group list | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group list | ||||
|         [--all-projects] | ||||
|         [--long] | ||||
|  | ||||
| .. option:: --all-projects | ||||
|  | ||||
|     Show detail for all projects. Admin only. | ||||
|     (defaults to False) | ||||
|  | ||||
| .. option:: --long | ||||
|  | ||||
|     List additional fields in output | ||||
|  | ||||
| consistency group remove volume | ||||
| ------------------------------- | ||||
|  | ||||
| Remove volume(s) from consistency group. | ||||
|  | ||||
| .. program:: consistency group remove volume | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group remove volume | ||||
|         <consistency-group> | ||||
|         <volume> [<volume> ...] | ||||
|  | ||||
| .. _consistency_group_remove_volume: | ||||
| .. describe:: <consistency-group> | ||||
|  | ||||
|     Consistency group containing <volume> (name or ID) | ||||
|  | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume(s) to remove from <consistency-group> (name or ID) | ||||
|     (repeat option to remove multiple volumes) | ||||
|  | ||||
| consistency group set | ||||
| --------------------- | ||||
|  | ||||
| Set consistency group properties. | ||||
|  | ||||
| .. program:: consistency group set | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group set | ||||
|         [--name <name>] | ||||
|         [--description <description>] | ||||
|         <consistency-group> | ||||
|  | ||||
| .. option:: --name <name> | ||||
|  | ||||
|     New consistency group name | ||||
|  | ||||
| .. option:: --description <description> | ||||
|  | ||||
|     New consistency group description | ||||
|  | ||||
| .. _consistency_group_set-consistency-group: | ||||
| .. describe:: <consistency-group> | ||||
|  | ||||
|     Consistency group to modify (name or ID) | ||||
|  | ||||
| consistency group show | ||||
| ---------------------- | ||||
|  | ||||
| Display consistency group details. | ||||
|  | ||||
| .. program:: consistency group show | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack consistency group show | ||||
|         <consistency-group> | ||||
|  | ||||
| .. _consistency_group_show-consistency-group: | ||||
| .. describe:: <consistency-group> | ||||
|  | ||||
|     Consistency group to display (name or ID) | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: consistency group show | ||||
|   | ||||
| @@ -4,103 +4,5 @@ role assignment | ||||
|  | ||||
| Identity v2, v3 | ||||
|  | ||||
| role assignment list | ||||
| -------------------- | ||||
|  | ||||
| List role assignments | ||||
|  | ||||
| .. program:: role assignment list | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack role assignment list | ||||
|         [--role <role>] | ||||
|         [--role-domain <role-domain>] | ||||
|         [--user <user>] | ||||
|         [--user-domain <user-domain>] | ||||
|         [--group <group>] | ||||
|         [--group-domain <group-domain>] | ||||
|         [--domain <domain>] | ||||
|         [--project <project>] | ||||
|         [--project-domain <project-domain>] | ||||
|         [--effective] | ||||
|         [--inherited] | ||||
|         [--names] | ||||
|  | ||||
| .. option:: --role <role> | ||||
|  | ||||
|     Role to filter (name or ID) | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --role-domain <role-domain> | ||||
|  | ||||
|     Domain the role belongs to (name or ID). | ||||
|     This can be used in case collisions between role names exist. | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --user <user> | ||||
|  | ||||
|     User to filter (name or ID) | ||||
|  | ||||
| .. option:: --user-domain <user-domain> | ||||
|  | ||||
|     Domain the user belongs to (name or ID). | ||||
|     This can be used in case collisions between user names exist. | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --group <group> | ||||
|  | ||||
|     Group to filter (name or ID) | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --group-domain <group-domain> | ||||
|  | ||||
|     Domain the group belongs to (name or ID). | ||||
|     This can be used in case collisions between group names exist. | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --domain <domain> | ||||
|  | ||||
|     Domain to filter (name or ID) | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --project <project> | ||||
|  | ||||
|     Project to filter (name or ID) | ||||
|  | ||||
| .. option:: --project-domain <project-domain> | ||||
|  | ||||
|     Domain the project belongs to (name or ID). | ||||
|     This can be used in case collisions between project names exist. | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --effective | ||||
|  | ||||
|     Returns only effective role assignments (defaults to False) | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --inherited | ||||
|  | ||||
|     Specifies if the role grant is inheritable to the sub projects | ||||
|  | ||||
|     .. versionadded:: 3 | ||||
|  | ||||
| .. option:: --names | ||||
|  | ||||
|     Returns role assignments with names instead of IDs | ||||
|  | ||||
| .. option:: --auth-user | ||||
|  | ||||
|     Returns role assignments for the authenticated user. | ||||
|  | ||||
| .. option:: --auth-project | ||||
|  | ||||
|     Returns role assignments for the project to which the authenticated user | ||||
|     is scoped. | ||||
| .. autoprogram-cliff:: openstack.identity.v3 | ||||
|    :command: role assignment list | ||||
|   | ||||
| @@ -4,395 +4,31 @@ volume | ||||
|  | ||||
| Block Storage v1, v2 | ||||
|  | ||||
| volume create | ||||
| ------------- | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume create | ||||
|  | ||||
| Create new volume | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume delete | ||||
|  | ||||
| .. program:: volume create | ||||
| .. code:: bash | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume list | ||||
|  | ||||
|     openstack volume create | ||||
|         [--size <size>] | ||||
|         [--type <volume-type>] | ||||
|         [--image <image> | --snapshot <snapshot> | --source <volume> ] | ||||
|         [--description <description>] | ||||
|         [--availability-zone <availability-zone>] | ||||
|         [--consistency-group <consistency-group>] | ||||
|         [--property <key=value> [...] ] | ||||
|         [--hint <key=value> [...] ] | ||||
|         [--bootable | --non-bootable] | ||||
|         [--read-only | --read-write] | ||||
|         <name> | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume migrate | ||||
|  | ||||
| .. option:: --size <size> | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume set | ||||
|  | ||||
|     Volume size in GB | ||||
|     (Required unless --snapshot or --source is specified) | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume show | ||||
|  | ||||
| .. option:: --type <volume-type> | ||||
|  | ||||
|     Set the type of volume | ||||
|  | ||||
|     Select ``<volume-type>`` from the available types as shown | ||||
|     by ``volume type list``. | ||||
|  | ||||
| .. option:: --image <image> | ||||
|  | ||||
|     Use ``<image>`` as source of volume (name or ID) | ||||
|  | ||||
|     This is commonly used to create a boot volume for a server. | ||||
|  | ||||
| .. option:: --snapshot <snapshot> | ||||
|  | ||||
|     Use ``<snapshot>`` as source of volume (name or ID) | ||||
|  | ||||
| .. option:: --source <volume> | ||||
|  | ||||
|     Volume to clone (name or ID) | ||||
|  | ||||
| .. option:: --description <description> | ||||
|  | ||||
|     Volume description | ||||
|  | ||||
| .. option:: --availability-zone <availability-zone> | ||||
|  | ||||
|     Create volume in ``<availability-zone>`` | ||||
|  | ||||
| .. option:: --consistency-group <consistency-group> | ||||
|  | ||||
|     Consistency group where the new volume belongs to | ||||
|  | ||||
| .. option:: --property <key=value> | ||||
|  | ||||
|     Set a property on this volume (repeat option to set multiple properties) | ||||
|  | ||||
| .. option:: --hint <key=value> | ||||
|  | ||||
|     Arbitrary scheduler hint key-value pairs to help boot an instance | ||||
|     (repeat option to set multiple hints) | ||||
|  | ||||
| .. option:: --bootable | ||||
|  | ||||
|     Mark volume as bootable | ||||
|  | ||||
| .. option:: --non-bootable | ||||
|  | ||||
|     Mark volume as non-bootable (default) | ||||
|  | ||||
| .. option:: --read-only | ||||
|  | ||||
|     Set volume to read-only access mode | ||||
|  | ||||
| .. option:: --read-write | ||||
|  | ||||
|     Set volume to read-write access mode (default) | ||||
|  | ||||
| .. _volume_create-name: | ||||
| .. describe:: <name> | ||||
|  | ||||
|     Volume name | ||||
|  | ||||
| volume delete | ||||
| ------------- | ||||
|  | ||||
| Delete volume(s) | ||||
|  | ||||
| .. program:: volume delete | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack volume delete | ||||
|         [--force | --purge] | ||||
|         <volume> [<volume> ...] | ||||
|  | ||||
| .. option:: --force | ||||
|  | ||||
|     Attempt forced removal of volume(s), regardless of state (defaults to False) | ||||
|  | ||||
| .. option:: --purge | ||||
|  | ||||
|     Remove any snapshots along with volume(s) (defaults to False) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. _volume_delete-volume: | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume(s) to delete (name or ID) | ||||
|  | ||||
| volume list | ||||
| ----------- | ||||
|  | ||||
| List volumes | ||||
|  | ||||
| .. program:: volume list | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack volume list | ||||
|         [--project <project> [--project-domain <project-domain>]] | ||||
|         [--user <user> [--user-domain <user-domain>]] | ||||
|         [--name <name>] | ||||
|         [--status <status>] | ||||
|         [--all-projects] | ||||
|         [--long] | ||||
|         [--limit <num-volumes>] | ||||
|         [--marker <volume>] | ||||
|  | ||||
| .. option:: --project <project> | ||||
|  | ||||
|     Filter results by ``<project>`` (name or ID) (admin only) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --project-domain <project-domain> | ||||
|  | ||||
|     Domain the project belongs to (name or ID). | ||||
|  | ||||
|     This can be used in case collisions between project names exist. | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --user <user> | ||||
|  | ||||
|     Filter results by ``<user>`` (name or ID) (admin only) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --user-domain <user-domain> | ||||
|  | ||||
|     Domain the user belongs to (name or ID). | ||||
|  | ||||
|     This can be used in case collisions between user names exist. | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --name <name> | ||||
|  | ||||
|     Filter results by volume name | ||||
|  | ||||
| .. option:: --status <status> | ||||
|  | ||||
|     Filter results by status | ||||
|  | ||||
| .. option:: --all-projects | ||||
|  | ||||
|     Include all projects (admin only) | ||||
|  | ||||
| .. option:: --long | ||||
|  | ||||
|     List additional fields in output | ||||
|  | ||||
| .. option:: --limit <num-volumes> | ||||
|  | ||||
|     Maximum number of volumes to display | ||||
|  | ||||
| .. option:: --marker <volume> | ||||
|  | ||||
|     The last volume ID of the previous page | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| volume migrate | ||||
| -------------- | ||||
|  | ||||
| Migrate volume to a new host | ||||
|  | ||||
| .. program:: volume migrate | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack volume migrate | ||||
|         --host <host> | ||||
|         [--force-host-copy] | ||||
|         [--lock-volume] | ||||
|         <volume> | ||||
|  | ||||
| .. option:: --host <host> | ||||
|  | ||||
|     Destination host (takes the form: host@backend-name#pool) (required) | ||||
|  | ||||
| .. option:: --force-host-copy | ||||
|  | ||||
|     Enable generic host-based force-migration, | ||||
|     which bypasses driver optimizations | ||||
|  | ||||
| .. option:: --lock-volume | ||||
|  | ||||
|     If specified, the volume state will be locked and will not allow | ||||
|     a migration to be aborted (possibly by another operation) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. _volume_migrate-volume: | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume to migrate (name or ID) | ||||
|  | ||||
| volume set | ||||
| ---------- | ||||
|  | ||||
| Set volume properties | ||||
|  | ||||
| .. program:: volume set | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack volume set | ||||
|         [--name <name>] | ||||
|         [--size <size>] | ||||
|         [--description <description>] | ||||
|         [--no-property] | ||||
|         [--property <key=value> [...] ] | ||||
|         [--image-property <key=value> [...] ] | ||||
|         [--state <state>] | ||||
|         [--attached | --detached ] | ||||
|         [--type <volume-type>] | ||||
|         [--retype-policy <retype-policy>] | ||||
|         [--bootable | --non-bootable] | ||||
|         [--read-only | --read-write] | ||||
|         <volume> | ||||
|  | ||||
| .. option:: --name <name> | ||||
|  | ||||
|     New volume name | ||||
|  | ||||
| .. option:: --size <size> | ||||
|  | ||||
|     Extend volume size in GB | ||||
|  | ||||
| .. option:: --description <description> | ||||
|  | ||||
|     New volume description | ||||
|  | ||||
| .. option:: --no-property | ||||
|  | ||||
|     Remove all properties from :ref:`\<volume\> <volume_set-volume>` | ||||
|     (specify both :option:`--no-property` and :option:`--property` to | ||||
|     remove the current properties before setting new properties.) | ||||
|  | ||||
| .. option:: --property <key=value> | ||||
|  | ||||
|     Set a property on this volume (repeat option to set multiple properties) | ||||
|  | ||||
| .. option:: --type <volume-type> | ||||
|  | ||||
|     New volume type (name or ID) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --retype-policy <retype-policy> | ||||
|  | ||||
|     Migration policy while re-typing volume | ||||
|     ("never" or "on-demand", default is "never" ) | ||||
|     (available only when :option:`--type` option is specified) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --bootable | ||||
|  | ||||
|     Mark volume as bootable | ||||
|  | ||||
| .. option:: --non-bootable | ||||
|  | ||||
|     Mark volume as non-bootable | ||||
|  | ||||
| .. option:: --read-only | ||||
|  | ||||
|     Set volume to read-only access mode | ||||
|  | ||||
| .. option:: --read-write | ||||
|  | ||||
|     Set volume to read-write access mode | ||||
|  | ||||
| .. option:: --image-property <key=value> | ||||
|  | ||||
|     Set an image property on this volume | ||||
|     (repeat option to set multiple image properties) | ||||
|  | ||||
|     Image properties are copied along with the image when creating a volume | ||||
|     using ``--image``.  Note that these properties are immutable on the image | ||||
|     itself, this option updates the copy attached to this volume. | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --state <state> | ||||
|  | ||||
|     New volume state | ||||
|     ("available", "error", "creating", "deleting", "in-use", | ||||
|     "attaching", "detaching", "error_deleting" or "maintenance") (admin only) | ||||
|     (This option simply changes the state of the volume in the database with | ||||
|     no regard to actual status, exercise caution when using) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --attached | ||||
|  | ||||
|     Set volume attachment status to "attached" (admin only) | ||||
|     (This option simply changes the state of the volume in the database with | ||||
|     no regard to actual status, exercise caution when using) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. option:: --deattach | ||||
|  | ||||
|     Set volume attachment status to "detached" (admin only) | ||||
|     (This option simply changes the state of the volume in the database with | ||||
|     no regard to actual status, exercise caution when using) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. _volume_set-volume: | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume to modify (name or ID) | ||||
|  | ||||
| volume show | ||||
| ----------- | ||||
|  | ||||
| Show volume details | ||||
|  | ||||
| .. program:: volume show | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack volume show | ||||
|         <volume> | ||||
|  | ||||
| .. _volume_show-volume: | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume to display (name or ID) | ||||
|  | ||||
| volume unset | ||||
| ------------ | ||||
|  | ||||
| Unset volume properties | ||||
|  | ||||
| .. program:: volume unset | ||||
| .. code:: bash | ||||
|  | ||||
|     openstack volume unset | ||||
|         [--property <key>] | ||||
|         [--image-property <key>] | ||||
|         <volume> | ||||
|  | ||||
| .. option:: --property <key> | ||||
|  | ||||
|     Remove a property from volume (repeat option to remove multiple properties) | ||||
|  | ||||
| .. option:: --image-property <key> | ||||
|  | ||||
|     Remove an image property from volume | ||||
|     (repeat option to remove multiple image properties) | ||||
|  | ||||
|     *Volume version 2 only* | ||||
|  | ||||
| .. _volume_unset-volume: | ||||
| .. describe:: <volume> | ||||
|  | ||||
|     Volume to modify (name or ID) | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|    :command: volume unset | ||||
|  | ||||
| Block Storage v3 | ||||
|  | ||||
|  .. autoprogram-cliff:: openstack.volume.v3 | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|     :command: volume summary | ||||
|  | ||||
|  .. autoprogram-cliff:: openstack.volume.v3 | ||||
| .. autoprogram-cliff:: openstack.volume.v3 | ||||
|     :command: volume revert | ||||
|   | ||||
		Reference in New Issue
	
	Block a user
	 Zuul
					Zuul