diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/availability-zone.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 7 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/quota.rst | 12 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-service.rst | 31 |
10 files changed, 69 insertions, 6 deletions
diff --git a/doc/source/command-objects/availability-zone.rst b/doc/source/command-objects/availability-zone.rst index 1f568438..149e1081 100644 --- a/doc/source/command-objects/availability-zone.rst +++ b/doc/source/command-objects/availability-zone.rst @@ -2,6 +2,9 @@ availability zone ================= +An **availability zone** is a logical partition of cloud block storage, +compute and network services. + Block Storage v2, Compute v2, Network v2 availability zone list diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 5d534c59..91eb2b08 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -2,6 +2,13 @@ network ======= +A **network** is an isolated Layer 2 networking segment. There are two types +of networks, project and provider networks. Project networks are fully isolated +and are not shared with other projects. Provider networks map to existing +physical networks in the data center and provide external network access for +servers and other resources. Only an OpenStack administrator can create +provider networks. Networks can be connected via routers. + Compute v2, Network v2 network create diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 36e83082..e4cf2cd2 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -2,6 +2,10 @@ port ==== +A **port** is a connection point for attaching a single device, such as the +NIC of a server, to a network. The port also describes the associated network +configuration, such as the MAC and IP addresses to be used on that port. + Network v2 port create diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index 98e6df33..9e09bd48 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -4,7 +4,7 @@ quota Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties. -Compute v2, Block Storage v1 +Block Storage v1, Compute v2, Network v2 quota set --------- @@ -129,14 +129,14 @@ Set quotas for class quota show ---------- -Show quotas for project +Show quotas for project or class .. program:: quota show .. code:: bash os quota show [--default] - <project> + [<project>] .. option:: --default @@ -146,13 +146,13 @@ Show quotas for project .. _quota_show-project: .. describe:: <project> - Show quotas for class + Show quotas for this project (name or ID) .. code:: bash os quota show --class - <class> + [<class>] .. option:: --class @@ -161,4 +161,4 @@ Show quotas for project .. _quota_show-class: .. describe:: <class> - Class to show + Show quotas for this class (name or ID) diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index 1503516e..1bb9341e 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -2,6 +2,10 @@ router ====== +A **router** is a logical component that forwards data packets between +networks. It also provides Layer 3 and NAT forwarding to provide external +network access for servers on project networks. + Network v2 router add port diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 8218c81a..b0ac3c94 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -2,6 +2,9 @@ security group rule =================== +A **security group rule** specifies the network access rules for servers +and other resources on the network. + Compute v2, Network v2 security group rule create diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst index 2c6e7a8a..3af11b5a 100644 --- a/doc/source/command-objects/security-group.rst +++ b/doc/source/command-objects/security-group.rst @@ -2,6 +2,10 @@ security group ============== +A **security group** acts as a virtual firewall for servers and other +resources on a network. It is a container for security group rules +which specify the network access rules. + Compute v2, Network v2 security group create diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 523f78c2..8abf25a6 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -2,6 +2,9 @@ subnet pool =========== +A **subnet pool** contains a collection of prefixes in CIDR notation +that are available for IP address allocation. + Network v2 subnet pool create diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 35134f46..8daa251f 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -2,6 +2,10 @@ subnet ====== +A **subnet** is a block of IP addresses and associated configuration state. +Subnets are used to allocate IP addresses when new ports are created on a +network. + Network v2 subnet create diff --git a/doc/source/command-objects/volume-service.rst b/doc/source/command-objects/volume-service.rst new file mode 100644 index 00000000..aa9fa6d2 --- /dev/null +++ b/doc/source/command-objects/volume-service.rst @@ -0,0 +1,31 @@ +============== +volume service +============== + +Volume v1, v2 + +volume service list +------------------- + +List volume service + +.. program:: volume service list +.. code:: bash + + os volume service list + [--host <host>] + [--service <service>] + [--long] + +.. _volume-service-list: +.. option:: --host <host> + + List services on specified host (name only) + +.. option:: --service <service> + + List only specified service (name only) + +.. option:: --long + + List additional fields in output |
