diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/command.rst | 17 | ||||
| -rw-r--r-- | doc/source/command-objects/configuration.rst | 9 | ||||
| -rw-r--r-- | doc/source/command-objects/host.rst | 37 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-floating.rst | 27 | ||||
| -rw-r--r-- | doc/source/command-objects/module.rst | 22 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/role-assignment.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 15 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 52 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 16 | ||||
| -rw-r--r-- | doc/source/command-objects/token.rst | 2 |
11 files changed, 193 insertions, 10 deletions
diff --git a/doc/source/command-objects/command.rst b/doc/source/command-objects/command.rst new file mode 100644 index 00000000..ac4f8514 --- /dev/null +++ b/doc/source/command-objects/command.rst @@ -0,0 +1,17 @@ +======= +command +======= + +Internal + +Installed commands in the OSC process. + +command list +------------ + +List recognized commands by group + +.. program:: command list +.. code:: bash + + os command list diff --git a/doc/source/command-objects/configuration.rst b/doc/source/command-objects/configuration.rst index 0ee8bd63..7bf054c0 100644 --- a/doc/source/command-objects/configuration.rst +++ b/doc/source/command-objects/configuration.rst @@ -16,3 +16,12 @@ show different configurations. .. code:: bash os configuration show + [--mask | --unmask] + +.. option:: --mask + + Attempt to mask passwords (default) + +.. option:: --unmask + + Show password in clear text diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst new file mode 100644 index 00000000..680efcc2 --- /dev/null +++ b/doc/source/command-objects/host.rst @@ -0,0 +1,37 @@ +==== +host +==== + +Compute v2 + +The physical computer running a hypervisor. + +host list +--------- + +List all hosts + +.. program:: host list +.. code:: bash + + os host list + [--zone <availability-zone>] + +.. option:: --zone <availability-zone> + + Only return hosts in the availability zone + +host show +--------- + +Display host details + +.. program:: host show +.. code:: bash + + os host show + <host> + +.. describe:: <host> + + Name of host diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/command-objects/ip-floating.rst index 6bfd7f44..99d06d07 100644 --- a/doc/source/command-objects/ip-floating.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -2,7 +2,7 @@ ip floating =========== -Compute v2 +Compute v2, Network v2 ip floating add --------------- @@ -42,17 +42,16 @@ Create new floating IP address ip floating delete ------------------ -Delete a floating IP address +Delete floating IP .. program:: ip floating delete -.. code:: bash + .. code:: bash - os ip floating delete - <ip-address> + os ip floating delete <floating-ip> -.. describe:: <ip-address> +.. describe:: <floating-ip> - IP address to delete (ID only) + Floating IP to delete (IP address or ID) ip floating list ---------------- @@ -83,3 +82,17 @@ Remove floating IP address from server .. describe:: <server> Server to remove the IP address from (name or ID) + +ip floating show +---------------- + +Display floating IP details + +.. program:: ip floating show + .. code:: bash + + os ip floating show <floating-ip> + +.. describe:: <floating-ip> + + Floating IP to display (IP address or ID) diff --git a/doc/source/command-objects/module.rst b/doc/source/command-objects/module.rst new file mode 100644 index 00000000..c3bc1372 --- /dev/null +++ b/doc/source/command-objects/module.rst @@ -0,0 +1,22 @@ +====== +module +====== + +Internal + +Installed Python modules in the OSC process. + +module list +----------- + +List module versions + +.. program:: module list +.. code:: bash + + os module list + [--all] + +.. option:: --all + + Show all modules that have version information diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index bb366672..0ef8f56d 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -2,7 +2,7 @@ network ======= -Network v2 +Compute v2, Network v2 network create -------------- diff --git a/doc/source/command-objects/role-assignment.rst b/doc/source/command-objects/role-assignment.rst index 6bb24cb3..893ebdc4 100644 --- a/doc/source/command-objects/role-assignment.rst +++ b/doc/source/command-objects/role-assignment.rst @@ -66,3 +66,7 @@ List role assignments .. option:: --inherited Specifies if the role grant is inheritable to the sub projects + +.. option:: --names + + Returns role assignments with names instead of IDs diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 50bc64aa..58e7a0a5 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -67,3 +67,18 @@ List security group rules .. describe:: <group> List all rules in this security group (name or ID) + +security group rule show +------------------------ + +Display security group rule details + +.. program:: security group rule show +.. code:: bash + + os security group rule show + <rule> + +.. describe:: <rule> + + Security group rule to display (ID only) diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst new file mode 100644 index 00000000..e181caec --- /dev/null +++ b/doc/source/command-objects/subnet-pool.rst @@ -0,0 +1,52 @@ +=========== +subnet pool +=========== + +Network v2 + +subnet pool delete +------------------ + +Delete subnet pool + +.. program:: subnet pool delete +.. code:: bash + + os subnet pool delete + <subnet-pool> + +.. _subnet_pool_delete-subnet-pool: +.. describe:: <subnet-pool> + + Subnet pool to delete (name or ID) + +subnet pool list +---------------- + +List subnet pools + +.. program:: subnet pool list +.. code:: bash + + os subnet pool list + [--long] + +.. option:: --long + + List additional fields in output + +subnet pool show +---------------- + +Display subnet pool details + +.. program:: subnet pool show +.. code:: bash + + os subnet pool show + <subnet-pool> + +.. _subnet_pool_show-subnet-pool: +.. describe:: <subnet-pool> + + Subnet pool to display (name or ID) diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 70a0eedf..12b05665 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -18,3 +18,19 @@ List subnets .. option:: --long List additional fields in output + +subnet show +----------- + +Show subnet details + +.. program:: subnet show +.. code:: bash + + os subnet show + <subnet> + +.. _subnet_show-subnet: +.. describe:: <subnet> + + Subnet to show (name or ID) diff --git a/doc/source/command-objects/token.rst b/doc/source/command-objects/token.rst index 22260f0d..5e7c7b26 100644 --- a/doc/source/command-objects/token.rst +++ b/doc/source/command-objects/token.rst @@ -17,8 +17,6 @@ Issue new token token revoke ------------ -*Identity version 2 only.* - Revoke existing token .. program:: token revoke |