diff options
Diffstat (limited to 'doc/source')
| -rw-r--r-- | doc/source/command-objects/floating-ip.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 15 | ||||
| -rw-r--r-- | doc/source/command-objects/usage.rst | 10 |
5 files changed, 45 insertions, 10 deletions
diff --git a/doc/source/command-objects/floating-ip.rst b/doc/source/command-objects/floating-ip.rst index 093bb8e4..2ab21f36 100644 --- a/doc/source/command-objects/floating-ip.rst +++ b/doc/source/command-objects/floating-ip.rst @@ -17,6 +17,7 @@ Create floating IP [--port <port>] [--floating-ip-address <floating-ip-address>] [--fixed-ip-address <fixed-ip-address>] + [--description <description>] <network> .. option:: --subnet <subnet> @@ -39,6 +40,11 @@ Create floating IP Fixed IP address mapped to the floating IP *Network version 2 only* +.. option:: --description <description> + + Set floating IP description + *Network version 2 only* + .. describe:: <network> Network to allocate floating IP from (name or ID) diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 04cf59a2..e3e783ad 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -144,11 +144,13 @@ Set port properties .. code:: bash os port set - [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip] + [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] + [--no-fixed-ip] [--device <device-id>] [--device-owner <device-owner>] [--vnic-type <vnic-type>] - [--binding-profile <binding-profile> | --no-binding-profile] + [--binding-profile <binding-profile>] + [--no-binding-profile] [--host <host-id>] [--enable | --disable] [--name <name>] @@ -162,7 +164,9 @@ Set port properties .. option:: --no-fixed-ip - Clear existing information of fixed IP addresses + Clear existing information of fixed IP addresses. + Specify both --fixed-ip and --no-fixed-ip + to overwrite the current fixed IP addresses. .. option:: --device <device-id> @@ -186,7 +190,9 @@ Set port properties .. option:: --no-binding-profile - Clear existing information of binding:profile + Clear existing information of binding:profile. + Specify both --binding-profile and --no-binding-profile + to overwrite the current binding:profile information. .. option:: --host <host-id> diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst index bbdca054..13a75158 100644 --- a/doc/source/command-objects/router.rst +++ b/doc/source/command-objects/router.rst @@ -64,6 +64,7 @@ Create new router [--project <project> [--project-domain <project-domain>]] [--enable | --disable] [--distributed] + [--description <description>] [--availability-zone-hint <availability-zone>] <name> @@ -88,6 +89,10 @@ Create new router Create a distributed router +.. option:: --description <description> + + Set router description + .. option:: --availability-zone-hint <availability-zone> Availability Zone in which to create this router @@ -186,6 +191,7 @@ Set router properties [--name <name>] [--enable | --disable] [--distributed | --centralized] + [--description <description>] [--route destination=<subnet>,gateway=<ip-address> | --no-route] <router> @@ -209,6 +215,10 @@ Set router properties Set router to centralized mode (disabled router only) +.. option:: --description <description> + + Set router description + .. option:: --route destination=<subnet>,gateway=<ip-address> Routes associated with the router diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 64130ee1..00401dda 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -232,10 +232,12 @@ Set subnet properties os subnet set [--allocation-pool start=<ip-address>,end=<ip-address>] + [--no-allocation-pool] [--dhcp | --no-dhcp] [--dns-nameserver <dns-nameserver>] [--gateway <gateway-ip>] [--host-route destination=<subnet>,gateway=<ip-address>] + [--no-host-route] [--service-type <service-type>] [--name <new-name>] [--description <description>] @@ -247,6 +249,12 @@ Set subnet properties ``start=192.168.199.2,end=192.168.199.254`` (repeat option to add multiple IP addresses) +.. option:: --no-allocation-pool + + Clear associated allocation pools from this subnet. + Specify both --allocation-pool and --no-allocation-pool + to overwrite the current allocation pool information. + .. option:: --dhcp Enable DHCP @@ -272,7 +280,12 @@ Set subnet properties ``destination=10.10.0.0/16,gateway=192.168.71.254`` destination: destination subnet (in CIDR notation) gateway: nexthop IP address - (repeat option to add multiple routes) + +.. option:: --no-host-route + + Clear associated host routes from this subnet. + Specify both --host-route and --no-host-route + to overwrite the current host route information. .. option:: --service-type <service-type> diff --git a/doc/source/command-objects/usage.rst b/doc/source/command-objects/usage.rst index 0c866086..589123a6 100644 --- a/doc/source/command-objects/usage.rst +++ b/doc/source/command-objects/usage.rst @@ -13,8 +13,8 @@ List resource usage per project .. code:: bash os usage list - --start <start> - --end <end> + [--start <start>] + [--end <end>] .. option:: --start <start> @@ -33,9 +33,9 @@ Show resource usage for a single project .. code:: bash os usage show - --project <project> - --start <start> - --end <end> + [--project <project>] + [--start <start>] + [--end <end>] .. option:: --project <project> |