diff options
Diffstat (limited to 'doc/source/cli/command-objects')
| -rw-r--r-- | doc/source/cli/command-objects/image.rst | 7 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/network_segment_range.rst | 168 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/quota.rst | 14 | ||||
| -rw-r--r-- | doc/source/cli/command-objects/volume.rst | 17 |
4 files changed, 205 insertions, 1 deletions
diff --git a/doc/source/cli/command-objects/image.rst b/doc/source/cli/command-objects/image.rst index b6e3594b..459a0770 100644 --- a/doc/source/cli/command-objects/image.rst +++ b/doc/source/cli/command-objects/image.rst @@ -209,6 +209,7 @@ List available images [--property <key=value>] [--name <name>] [--status <status>] + [--member-status <member-status>] [--tag <tag>] [--long] [--sort <key>[:<direction>]] @@ -251,6 +252,12 @@ List available images *Image version 2 only* +.. option:: --member-status <member-status> + + Filter images based on member status + + *Image version 2 only* + .. option:: --tag <tag> Filter images based on tag diff --git a/doc/source/cli/command-objects/network_segment_range.rst b/doc/source/cli/command-objects/network_segment_range.rst new file mode 100644 index 00000000..71155d22 --- /dev/null +++ b/doc/source/cli/command-objects/network_segment_range.rst @@ -0,0 +1,168 @@ +===================== +network segment range +===================== + +A **network segment range** is a resource for tenant network segment +allocation. +A network segment range exposes the segment range management to be administered +via the Neutron API. In addition, it introduces the ability for the +administrator to control the segment ranges globally or on a per-tenant basis. + +Network v2 + +network segment range create +---------------------------- + +Create new network segment range + +.. program:: network segment range create +.. code:: bash + + openstack network segment range create + (--private | --shared) + [--project <project> [--project-domain <project-domain>]] + --network-type <network-type> + [--physical-network <physical-network-name>] + --minimum <minimum-segmentation-id> + --maximum <maximum-segmentation-id> + <name> + +.. option:: --private + + Network segment range is assigned specifically to the project + +.. option:: --shared + + Network segment range is shared with other projects + +.. option:: --project <project> + + Network segment range owner (name or ID). Optional when the segment + range is shared + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. option:: --physical-network <physical-network-name> + + Physical network name of this network segment range + +.. option:: --network-type <network-type> + + Network type of this network segment range + (geneve, gre, vlan or vxlan) + +.. option:: --minimum <minimum-segmentation-id> + + Minimum segment identifier for this network segment range which is based + on the network type, VLAN ID for vlan network type and tunnel ID for + geneve, gre and vxlan network types + +.. option:: --maximum <maximum-segmentation-id> + + Maximum segment identifier for this network segment range which is based + on the network type, VLAN ID for vlan network type and tunnel ID for + geneve, gre and vxlan network types + +.. _network_segment_range_create-name: +.. describe:: <name> + + Name of new network segment range + +network segment range delete +---------------------------- + +Delete network segment range(s) + +.. program:: network segment range delete +.. code:: bash + + openstack network segment range delete + <network-segment-range> [<network-segment-range> ...] + +.. _network_segment_range_delete-network-segment-range: +.. describe:: <network-segment-range> + + Network segment range (s) to delete (name or ID) + +network segment range list +-------------------------- + +List network segment ranges + +.. program:: network segment range list +.. code:: bash + + openstack network segment range list + [--long] + [--used | --unused] + [--available | --unavailable] + +.. option:: --long + + List additional fields in output + +.. option:: --used + + List network segment ranges that have segments in use + +.. option:: --unused + + List network segment ranges that do not have segments not in use + +.. option:: --available + + List network segment ranges that have available segments + +.. option:: --unavailable + + List network segment ranges without available segments + +network segment range set +------------------------- + +Set network segment range properties + +.. program:: network segment range set +.. code:: bash + + openstack network segment range set + [--name <name>] + [--minimum <minimum-segmentation-id>] + [--maximum <maximum-segmentation-id>] + <network-segment-range> + +.. option:: --name <name> + + Set network segment range name + +.. option:: --minimum <minimum-segmentation-id> + + Set network segment range minimum segment identifier + +.. option:: --maximum <maximum-segmentation-id> + + Set network segment range maximum segment identifier + +.. _network_segment_range_set-network-segment-range: +.. describe:: <network-segment-range> + + Network segment range to modify (name or ID) + +network segment range show +-------------------------- + +Display network segment range details + +.. program:: network segment range show +.. code:: bash + + openstack network segment range show + <network-segment-range> + +.. _network_segment_range_show-network-segment-range: +.. describe:: <network-segment-range> + + Network segment range to display (name or ID) diff --git a/doc/source/cli/command-objects/quota.rst b/doc/source/cli/command-objects/quota.rst index f39536af..8c8cea6d 100644 --- a/doc/source/cli/command-objects/quota.rst +++ b/doc/source/cli/command-objects/quota.rst @@ -17,6 +17,8 @@ List quotas for all projects with non-default quota values openstack quota list --compute | --network | --volume + [--project <project>] + [--detail] .. option:: --network @@ -30,6 +32,14 @@ List quotas for all projects with non-default quota values List volume quotas +.. option:: --project <project> + + List quotas for this project <project> (name or ID) + +.. option:: --detail + + Show details about quotas usage + quota set --------- @@ -234,7 +244,9 @@ Set quotas for class quota show ---------- -Show quotas for project or class +Show quotas for project or class. Specify ``--os-compute-api-version 2.50`` or +higher to see ``server-groups`` and ``server-group-members`` output for a given +quota class. .. program:: quota show .. code:: bash diff --git a/doc/source/cli/command-objects/volume.rst b/doc/source/cli/command-objects/volume.rst index 5c86d10d..fc6188c0 100644 --- a/doc/source/cli/command-objects/volume.rst +++ b/doc/source/cli/command-objects/volume.rst @@ -262,6 +262,7 @@ Set volume properties [--property <key=value> [...] ] [--image-property <key=value> [...] ] [--state <state>] + [--attached | --detached ] [--type <volume-type>] [--retype-policy <retype-policy>] [--bootable | --non-bootable] @@ -341,6 +342,22 @@ Set volume properties *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> |