diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/compute-service.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 32 | ||||
| -rw-r--r-- | doc/source/command-objects/host.rst | 35 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 108 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-floating.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 4 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 108 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 14 |
10 files changed, 255 insertions, 74 deletions
diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index 25a133d9..aefe55db 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -31,6 +31,7 @@ List service command os compute service list [--host <host>] [--service <service>] + [--long] .. _compute-service-list: .. describe:: --host <host> @@ -41,6 +42,10 @@ List service command Name of service +.. describe:: --long + + List additional fields in output + compute service set ------------------- diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 2389f7dc..5893ff07 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -118,22 +118,6 @@ List flavors Maximum number of flavors to display -flavor show ------------ - -Display flavor details - -.. program:: flavor show -.. code:: bash - - os flavor show - <flavor> - -.. _flavor_show-flavor: -.. describe:: <flavor> - - Flavor to display (name or ID) - flavor set ---------- @@ -154,6 +138,22 @@ Set flavor properties Flavor to modify (name or ID) +flavor show +----------- + +Display flavor details + +.. program:: flavor show +.. code:: bash + + os flavor show + <flavor> + +.. _flavor_show-flavor: +.. describe:: <flavor> + + Flavor to display (name or ID) + flavor unset ------------ diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst index 680efcc2..ede62c56 100644 --- a/doc/source/command-objects/host.rst +++ b/doc/source/command-objects/host.rst @@ -21,6 +21,41 @@ List all hosts Only return hosts in the availability zone +host set +-------- + +Set host command + +.. program:: host set +.. code:: bash + + os host set + [--enable | --disable] + [--enable-maintenance | --disable-maintenance] + <host> + +.. _host-set: +.. option:: --enable + + Enable the host + +.. option:: --disable + + Disable the host + +.. _maintenance-set: +.. option:: --enable-maintenance + + Enable maintenance mode for the host + +.. option:: --disable-maintenance + + Disable maintenance mode for the host + +.. describe:: <host> + + The host (name or ID) + host show --------- diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index 61872ec4..942c03d5 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -4,6 +4,33 @@ image Image v1, v2 +image add project +----------------- + +*Only supported for Image v2* + +Associate project with image + +.. program:: image add project +.. code:: bash + + os image add project + [--project-domain <project-domain>] + <image> <project> + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. describe:: <image> + + Image to share (name or ID). + +.. describe:: <project> + + Project to associate with image (name or ID) + image create ------------ @@ -206,6 +233,33 @@ List available images The last image (name or ID) of the previous page. Display list of images after marker. Display all images if not specified. +image remove project +-------------------- + +*Only supported for Image v2* + +Disassociate project with image + +.. program:: image remove project +.. code:: bash + + os image remove remove + [--project-domain <project-domain>] + <image> <project> + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + +.. describe:: <image> + + Image to unshare (name or ID). + +.. describe:: <project> + + Project to disassociate with image (name or ID) + image save ---------- @@ -445,57 +499,3 @@ Display image details .. describe:: <image> Image to display (name or ID) - -image add project ------------------ - -*Only supported for Image v2* - -Associate project with image - -.. program:: image add project -.. code:: bash - - os image add project - [--project-domain <project-domain>] - <image> <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. describe:: <image> - - Image to share (name or ID). - -.. describe:: <project> - - Project to associate with image (name or ID) - -image remove project --------------------- - -*Only supported for Image v2* - -Disassociate project with image - -.. program:: image remove project -.. code:: bash - - os image remove remove - [--project-domain <project-domain>] - <image> <project> - -.. option:: --project-domain <project-domain> - - Domain the project belongs to (name or ID). - This can be used in case collisions between project names exist. - -.. describe:: <image> - - Image to unshare (name or ID). - -.. describe:: <project> - - Project to disassociate with image (name or ID) diff --git a/doc/source/command-objects/ip-floating.rst b/doc/source/command-objects/ip-floating.rst index 99d06d07..05e4a132 100644 --- a/doc/source/command-objects/ip-floating.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -45,7 +45,7 @@ ip floating delete Delete floating IP .. program:: ip floating delete - .. code:: bash +.. code:: bash os ip floating delete <floating-ip> @@ -89,7 +89,7 @@ ip floating show Display floating IP details .. program:: ip floating show - .. code:: bash +.. code:: bash os ip floating show <floating-ip> diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index 0ee6212b..4d58745b 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -108,6 +108,11 @@ List ports .. code:: bash os port list + [--router <router>] + +.. option:: --router <router> + + List only ports attached to this router (name or ID) port set -------- diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst index 22ea5cb7..9fc4c987 100644 --- a/doc/source/command-objects/security-group.rst +++ b/doc/source/command-objects/security-group.rst @@ -14,12 +14,26 @@ Create a new security group os security group create [--description <description>] + [--project <project> [--project-domain <project-domain>]] <name> .. option:: --description <description> Security group description +.. option:: --project <project> + + Owner's project (name or ID) + + *Network version 2 only* + +.. option:: --project-domain <project-domain> + + Domain the project belongs to (name or ID). + This can be used in case collisions between project names exist. + + *Network version 2 only* + .. describe:: <name> New security group name diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 722f9299..439c4f50 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -10,7 +10,7 @@ subnet pool create Create subnet pool .. program:: subnet pool create - .. code:: bash +.. code:: bash os subnet pool create [--pool-prefix <pool-prefix> [...]] @@ -78,7 +78,7 @@ subnet pool set Set subnet pool properties .. program:: subnet pool set - .. code:: bash +.. code:: bash os subnet pool set [--name <name>] diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 97d5c68b..56a28d73 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -20,6 +20,114 @@ Delete a subnet Subnet to delete (name or ID) +subnet create +-------------- + +Create new subnet + +.. program:: subnet create +.. code:: bash + + os subnet create + [--project <project> [--project-domain <project-domain>]] + [--subnet-pool <subnet-pool> | --use-default-subnet-pool [--prefix-length <prefix-length>]] + [--subnet-range <subnet-range>] + [--allocation-pool start=<ip-address>,end=<ip-address>] + [--dhcp | --no-dhcp] + [--dns-nameserver <dns-nameserver>] + [--gateway <gateway>] + [--host-route destination=<subnet>,gateway=<ip-address>] + [--ip-version {4,6}] + [--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] + [--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}] + --network <network> + <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:: --subnet-pool <subnet-pool> + + Subnet pool from which this subnet will obtain a CIDR (name or ID) + +.. option:: --use-default-subnet-pool + + Use default subnet pool for --ip-version + +.. option:: --prefix-length <prefix-length> + + Prefix length for subnet allocation from subnet pool + +.. option:: --subnet-range <subnet-range> + + Subnet range in CIDR notation + (required if --subnet-pool is not specified, optional otherwise) + +.. option:: --allocation-pool start=<ip-address>,end=<ip-address> + + Allocation pool IP addresses for this subnet e.g.: + start=192.168.199.2,end=192.168.199.254 (This option can be repeated) + +.. option:: --dhcp + + Enable DHCP (default) + +.. option:: --no-dhcp + + Disable DHCP + +.. option:: --dns-nameserver <dns-nameserver> + + DNS name server for this subnet (This option can be repeated) + +.. option:: --gateway <gateway> + + Specify a gateway for the subnet. The three options are: + <ip-address>: Specific IP address to use as the gateway + 'auto': Gateway address should automatically be chosen from + within the subnet itself + 'none': This subnet will not use a gateway + e.g.: --gateway 192.168.9.1, --gateway auto, --gateway none + (default is 'auto') + +.. option:: --host-route destination=<subnet>,gateway=<ip-address> + + Additional route for this subnet e.g.: + destination=10.10.0.0/16,gateway=192.168.71.254 + destination: destination subnet (in CIDR notation) + gateway: nexthop IP address + (This option can be repeated) + +.. option:: --ip-version {4,6} + + IP version (default is 4). Note that when subnet pool is specified, + IP version is determined from the subnet pool and this option + is ignored. + +.. option:: --ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} + + IPv6 RA (Router Advertisement) mode, + valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + +.. option:: --ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac} + + IPv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac] + +.. option:: --network <network> + + Network this subnet belongs to (name or ID) + +.. _subnet_create-name: +.. describe:: <name> + + Name of subnet to create + subnet list ----------- diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index bf89dc44..fd32c327 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -164,6 +164,7 @@ Set volume properties [--description <description>] [--size <size>] [--property <key=value> [...] ] + [--image-property <key=value> [...] ] <volume> .. option:: --name <name> @@ -182,6 +183,13 @@ Set volume properties Property to add or modify for this volume (repeat option to set multiple properties) +.. option:: --image-property <key=value> + + To add or modify image properties for this volume. + (repeat option to set multiple image properties) + + *Volume version 2 only* + .. describe:: <volume> Volume to modify (name or ID) @@ -211,12 +219,18 @@ Unset volume properties os volume unset [--property <key>] + [--image-property <key>] <volume> .. option:: --property <key> Property to remove from volume (repeat option to remove multiple properties) +.. option:: --image-property <key> + + To remove image properties from volume + (repeat option to remove multiple image properties) + .. describe:: <volume> Volume to modify (name or ID) |