diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/image.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 45 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 15 | ||||
| -rw-r--r-- | doc/source/command-objects/usage.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-backup.rst | 31 |
6 files changed, 106 insertions, 13 deletions
diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index d6451af7..842eab8d 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -1,6 +1,6 @@ -====== +===== image -====== +===== Image v1, v2 diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 8075d509..d133674f 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -186,17 +186,60 @@ List networks .. code:: bash os network list - [--external] + [--external | --internal] [--long] + [--name <name>] + [--enable | --disable] + [--project <project> [--project-domain <project-domain>]] + [--share | --no-share] + [--status <status>] .. option:: --external List external networks +.. option:: --internal + + List internal networks + .. option:: --long List additional fields in output +.. option:: --name <name> + + List networks according to their name + +.. option:: --enable + + List enabled networks + +.. option:: --disable + + List disabled networks + +.. option:: --project <project> + + List networks according to their 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:: --share + + List networks shared between projects + +.. option:: --no-share + + List networks not shared between projects + +.. option:: --status <status> + + List networks according to their status + ('ACTIVE', 'BUILD', 'DOWN', 'ERROR') + network set ----------- 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/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> diff --git a/doc/source/command-objects/volume-backup.rst b/doc/source/command-objects/volume-backup.rst index 3a8f0213..05b02345 100644 --- a/doc/source/command-objects/volume-backup.rst +++ b/doc/source/command-objects/volume-backup.rst @@ -115,6 +115,37 @@ Restore volume backup Volume to restore to (name or ID) +volume backup set +----------------- + +Set volume backup properties + +.. program:: volume backup set +.. code:: bash + + os volume backup set + [--name <name>] + [--description <description>] + [--state <state>] + <backup> + +.. option:: --name <name> + + New backup name + +.. option:: --description <description> + + New backup description + +.. option:: --state <state> + + New backup state ("available" or "error") (admin only) + +.. _backup_set-volume-backup: +.. describe:: <backup> + + Backup to modify (name or ID) + volume backup show ------------------ |