diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/address-scope.rst | 120 | ||||
| -rw-r--r-- | doc/source/command-objects/availability-zone.rst | 3 | ||||
| -rw-r--r-- | doc/source/command-objects/credential.rst (renamed from doc/source/command-objects/credentials.rst) | 10 | ||||
| -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 | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 45 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/server-group.rst | 80 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 42 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-service.rst | 31 |
13 files changed, 342 insertions, 28 deletions
diff --git a/doc/source/command-objects/address-scope.rst b/doc/source/command-objects/address-scope.rst new file mode 100644 index 00000000..a2ab566c --- /dev/null +++ b/doc/source/command-objects/address-scope.rst @@ -0,0 +1,120 @@ +============= +address scope +============= + +An **address scope** is a scope of IPv4 or IPv6 addresses that belongs +to a given project and may be shared between projects. + +Network v2 + +address scope create +-------------------- + +Create new address scope + +.. program:: address scope create +.. code:: bash + + os address scope create + [--project <project> [--project-domain <project-domain>]] + [--ip-version <ip-version>] + [--share | --no-share] + <name> + +.. option:: --project <project> + + Owner's project (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. + +.. option:: --ip-version <ip-version> + + IP version (4 or 6, default is 4) + +.. option:: --share + + Share the address scope between projects + +.. option:: --no-share + + Do not share the address scope between projects (default) + +.. _address_scope_create-name: +.. describe:: <name> + + New address scope name + +address scope delete +-------------------- + +Delete an address scope + +.. program:: address scope delete +.. code:: bash + + os address scope delete + <address-scope> + +.. _address_scope_delete-address-scope: +.. describe:: <address-scope> + + Address scope to delete (name or ID) + +address scope list +------------------ + +List address scopes + +.. program:: address scope list +.. code:: bash + + os address scope list + +address scope set +----------------- + +Set address scope properties + +.. program:: address scope set +.. code:: bash + + os address scope set + [--name <name>] + [--share | --no-share] + <address-scope> + +.. option:: --name <name> + + Set address scope name + +.. option:: --share + + Share the address scope between projects + +.. option:: --no-share + + Do not share the address scope between projects + +.. _address_scope_set-address-scope: +.. describe:: <address-scope> + + Address scope to modify (name or ID) + +address scope show +------------------ + +Display address scope details + +.. program:: address scope show +.. code:: bash + + os address scope show + <address-scope> + +.. _address_scope_show-address-scope: +.. describe:: <address-scope> + + Address scope to display (name or ID) 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/credentials.rst b/doc/source/command-objects/credential.rst index 9f4aabe4..ed8a00db 100644 --- a/doc/source/command-objects/credentials.rst +++ b/doc/source/command-objects/credential.rst @@ -1,27 +1,27 @@ =========== -credentials +credential =========== Identity v3 -credentials create +credential create ------------------ .. ''[consider rolling the ec2 creds into this too]'' .. code:: bash - os credentials create + os credential create --x509 [<private-key-file>] [<certificate-file>] -credentials show +credential show ---------------- .. code:: bash - os credentials show + os credential show [--token] [--user] [--x509 [--root]] diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index bb8947e3..8668daee 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..9ca7661e 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 @@ -182,7 +186,7 @@ Set router properties [--name <name>] [--enable | --disable] [--distributed | --centralized] - [--route destination=<subnet>,gateway=<ip-address> | --clear-routes] + [--route destination=<subnet>,gateway=<ip-address> | --no-route] <router> .. option:: --name <name> @@ -212,7 +216,7 @@ Set router properties gateway: nexthop IP address (repeat option to set multiple routes) -.. option:: --clear-routes +.. option:: --no-route Clear routes associated with the router diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 8218c81a..97cce35c 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 @@ -13,18 +16,14 @@ Create a new security group rule .. code:: bash os security group rule create - [--proto <proto>] [--src-ip <ip-address> | --src-group <group>] - [--dst-port <port-range>] + [--dst-port <port-range> | [--icmp-type <icmp-type> [--icmp-code <icmp-code>]]] + [--protocol <protocol>] [--ingress | --egress] [--ethertype <ethertype>] [--project <project> [--project-domain <project-domain>]] <group> -.. option:: --proto <proto> - - IP protocol (icmp, tcp, udp; default: tcp) - .. option:: --src-ip <ip-address> Source IP address block @@ -36,8 +35,35 @@ Create a new security group rule .. option:: --dst-port <port-range> - Destination port, may be a single port or port range: 137:139 - (only required for IP protocols tcp and udp) + Destination port, may be a single port or a starting and + ending port range: 137:139. Required for IP protocols TCP + and UDP. Ignored for ICMP IP protocols. + +.. option:: --icmp-type <icmp-type> + + ICMP type for ICMP IP protocols + + *Network version 2 only* + +.. option:: --icmp-code <icmp-code> + + ICMP code for ICMP IP protocols + + *Network version 2 only* + +.. option:: --protocol <protocol> + + IP protocol (icmp, tcp, udp; default: tcp) + + *Compute version 2* + + IP protocol (ah, dccp, egp, esp, gre, icmp, igmp, + ipv6-encap, ipv6-frag, ipv6-icmp, ipv6-nonxt, + ipv6-opts, ipv6-route, ospf, pgm, rsvp, sctp, tcp, + udp, udplite, vrrp and integer representations [0-255]; + default: tcp) + + *Network version 2* .. option:: --ingress @@ -53,7 +79,8 @@ Create a new security group rule .. option:: --ethertype <ethertype> - Ethertype of network traffic (IPv4, IPv6; default: IPv4) + Ethertype of network traffic + (IPv4, IPv6; default: based on IP protocol) *Network version 2 only* 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/server-group.rst b/doc/source/command-objects/server-group.rst new file mode 100644 index 00000000..55d789c7 --- /dev/null +++ b/doc/source/command-objects/server-group.rst @@ -0,0 +1,80 @@ +============ +server group +============ + +Server group provides a mechanism to group servers according to certain policy. + +Compute v2 + +server group create +------------------- + +Create a new server group + +.. program:: server group create +.. code-block:: bash + + os server group create + --policy <policy> [--policy <policy>] ... + <name> + +.. option:: --policy <policy> + + Add a policy to :ref:`\<name\> <server_group_create-name>` + (repeat option to add multiple policies) + +.. _server_group_create-name: +.. describe:: <name> + + New server group name + +server group delete +------------------- + +Delete an existing server group + +.. program:: server group delete +.. code-block:: bash + + os server group delete + <server-group> [<server-group> ...] + +.. describe:: <server-group> + + Server group(s) to delete (name or ID) + (repeat to delete multiple server groups) + +server group list +----------------- + +List all server groups + +.. program:: server group list +.. code-block:: bash + + os server group list + [--all-projects] + [--long] + +.. option:: --all-projects + + Display information from all projects (admin only) + +.. option:: --long + + List additional fields in output + +server group show +----------------- + +Display server group details + +.. program:: server group show +.. code-block:: bash + + os server group show + <server-group> + +.. describe:: <server-group> + + Server group to display (name or ID) diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 3b7d0e91..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 @@ -13,19 +16,16 @@ Create subnet pool .. code:: bash os subnet pool create - [--pool-prefix <pool-prefix> [...]] [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] [--project <project> [--project-domain <project-domain>]] [--address-scope <address-scope>] + [--default | --no-default] + [--share | --no-share] + --pool-prefix <pool-prefix> [...] <name> -.. option:: --pool-prefix <pool-prefix> - - Set subnet pool prefixes (in CIDR notation) - (repeat option to set multiple prefixes) - .. option:: --default-prefix-length <default-prefix-length> Set subnet pool default prefix length @@ -52,6 +52,27 @@ Create subnet pool Set address scope associated with the subnet pool (name or ID), prefixes must be unique across address scopes +.. option:: --default + + Set this as a default subnet pool + +.. option:: --no-default + + Set this as a non-default subnet pool + +.. option:: --share + + Set this subnet pool as shared + +.. option:: --no-share + + Set this subnet pool as not shared + +.. describe:: --pool-prefix <pool-prefix> + + Set subnet pool prefixes (in CIDR notation) + (repeat option to set multiple prefixes) + .. _subnet_pool_create-name: .. describe:: <name> @@ -103,6 +124,7 @@ Set subnet pool properties [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] [--address-scope <address-scope> | --no-address-scope] + [--default | --no-default] <subnet-pool> .. option:: --name <name> @@ -135,6 +157,14 @@ Set subnet pool properties Remove address scope associated with the subnet pool +.. option:: --default + + Set this as a default subnet pool + +.. option:: --no-default + + Set this as a non-default subnet pool + .. _subnet_pool_set-subnet-pool: .. describe:: <subnet-pool> 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 |