diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/aggregate.rst | 25 | ||||
| -rw-r--r-- | doc/source/command-objects/compute-service.rst | 13 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/host.rst | 35 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-floating.rst | 30 | ||||
| -rw-r--r-- | doc/source/command-objects/limits.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 43 | ||||
| -rw-r--r-- | doc/source/command-objects/port.rst | 38 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 14 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet-pool.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/subnet.rst | 93 | ||||
| -rw-r--r-- | doc/source/command-objects/volume-type.rst | 27 | ||||
| -rw-r--r-- | doc/source/command-objects/volume.rst | 90 |
15 files changed, 355 insertions, 74 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 6a1dd908..6c4baa53 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -2,7 +2,7 @@ aggregate ========= -Server aggregates provide a mechanism to group servers according to certain +Host aggregates provide a mechanism to group hosts according to certain criteria. Compute v2 @@ -150,3 +150,26 @@ Display aggregate details .. describe:: <aggregate> Aggregate to display (name or ID) + +aggregate unset +--------------- + +Unset aggregate properties + +.. program:: aggregate unset +.. code-block:: bash + + os aggregate unset + --property <key> + [--property <key>] ... + <aggregate> + +.. option:: --property <key> + + Property to remove from :ref:`\<aggregate\> <aggregate_unset-aggregate>` + (repeat option to remove multiple properties) + +.. _aggregate_unset-aggregate: +.. describe:: <aggregate> + + Aggregate to modify (name or ID) diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index aefe55db..bda64c81 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -34,15 +34,15 @@ List service command [--long] .. _compute-service-list: -.. describe:: --host <host> +.. option:: --host <host> - Name of host + List services on specified host (name only) -.. describe:: --service <service> +.. option:: --service <service> - Name of service + List only specified service (name only) -.. describe:: --long +.. option:: --long List additional fields in output @@ -71,7 +71,8 @@ Set service command .. option:: --disable-reason <reason> - Reason for disabling the service (in quotes) + Reason for disabling the service (in quotes). Note that when the service + is enabled, this option is ignored. .. describe:: <host> diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 5893ff07..322943d7 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -49,7 +49,7 @@ Create new flavor .. option:: --rxtx-factor <factor> - RX/TX factor (default 1) + RX/TX factor (default 1.0) .. option:: --public 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/ip-floating.rst b/doc/source/command-objects/ip-floating.rst index 05e4a132..869b7af8 100644 --- a/doc/source/command-objects/ip-floating.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -33,11 +33,35 @@ Create new floating IP address .. code:: bash os ip floating create - <pool> + [--subnet <subnet>] + [--port <port>] + [--floating-ip-address <floating-ip-address>] + [--fixed-ip-address <fixed-ip-address>] + <network> -.. describe:: <pool> +.. option:: --subnet <subnet> - Pool to fetch IP address from (name or ID) + Subnet on which you want to create the floating IP (name or ID) + (Network v2 only) + +.. option:: --port <port> + + Port to be associated with the floating IP (name or ID) + (Network v2 only) + +.. option:: --floating-ip-address <floating-ip-address> + + Floating IP address + (Network v2 only) + +.. option:: --fixed-ip-address <fixed-ip-address> + + Fixed IP address mapped to the floating IP + (Network v2 only) + +.. describe:: <network> + + Network to allocate floating IP from (name or ID) ip floating delete ------------------ diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index 6a7509f2..87a5b33c 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -37,4 +37,4 @@ Show compute and block storage limits .. option:: --domain <domain> - Domain that owns --project (name or ID) [only valid with --absolute] + Domain the project belongs to (name or ID) [only valid with --absolute] diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 9e109279..9fbc0216 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -17,6 +17,10 @@ Create new network [--enable | --disable] [--share | --no-share] [--availability-zone-hint <availability-zone>] + [--external [--default | --no-default] | --internal] + [--provider-network-type <provider-network-type>] + [--provider-physical-network <provider-physical-network>] + [--provider-segmentation-id <provider-segmentation-id>] <name> .. option:: --project <project> @@ -59,6 +63,45 @@ Create new network IPv4 subnet for fixed IPs (in CIDR notation) (Compute v2 network only) +.. option:: --external + + Set this network as an external network. + Requires the "external-net" extension to be enabled. + (Network v2 only) + +.. option:: --internal + + Set this network as an internal network (default) + (Network v2 only) + +.. option:: --default + + Specify if this network should be used as + the default external network + (Network v2 only) + +.. option:: --no-default + + Do not use the network as the default external network. + By default, no network is set as an external network. + (Network v2 only) + +.. option:: --provider-network-type <provider-network-type> + + The physical mechanism by which the virtual network is implemented. + The supported options are: flat, gre, local, vlan, vxlan + (Network v2 only) + +.. option:: --provider-physical-network <provider-physical-network> + + Name of the physical network over which the virtual network is implemented + (Network v2 only) + +.. option:: --provider-segmentation-id <provider-segmentation-id> + + VLAN ID for VLAN networks or tunnel-id for GRE/VXLAN networks + (Network v2 only) + .. _network_create-name: .. describe:: <name> diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst index e9c09173..2e83eea1 100644 --- a/doc/source/command-objects/port.rst +++ b/doc/source/command-objects/port.rst @@ -15,11 +15,11 @@ Create new port os port create --network <network> [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] - [--device-id <device-id>] + [--device <device-id>] [--device-owner <device-owner>] [--vnic-type <vnic-type>] [--binding-profile <binding-profile>] - [--host-id <host-id>] + [--host <host-id>] [--enable | --disable] [--mac-address <mac-address>] [--project <project> [--project-domain <project-domain>]] @@ -35,9 +35,9 @@ Create new port subnet=<subnet>,ip-address=<ip-address> (this option can be repeated) -.. option:: --device-id <device-id> +.. option:: --device <device-id> - Device ID of this port + Port device ID .. option:: --device-owner <device-owner> @@ -53,9 +53,9 @@ Create new port Custom data to be passed as binding:profile: <key>=<value> (this option can be repeated) -.. option:: --host-id <host-id> +.. option:: --host <host-id> - The ID of the host where the port is allocated + Allocate port on host ``<host-id>`` (ID only) .. option:: --enable @@ -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 -------- @@ -118,20 +123,25 @@ Set port properties .. code:: bash os port set - [--fixed-ip subnet=<subnet>,ip-address=<ip-address>] + [--fixed-ip subnet=<subnet>,ip-address=<ip-address> | --no-fixed-ip] [--device-id <device-id>] [--device-owner <device-owner>] [--vnic-type <vnic-type>] - [--binding-profile <binding-profile>] + [--binding-profile <binding-profile> | --no-binding-profile] [--host-id <host-id>] [--enable | --disable] + [--name <name>] <port> .. option:: --fixed-ip subnet=<subnet>,ip-address=<ip-address> - Desired IP and/or subnet for this port: + Desired IP and/or subnet (name or ID) for this port: subnet=<subnet>,ip-address=<ip-address> - (you can repeat this option) + (this option can be repeated) + +.. option:: --no-fixed-ip + + Clear existing information of fixed-ips .. option:: --device-id <device-id> @@ -151,6 +161,10 @@ Set port properties Custom data to be passed as binding:profile: <key>=<value> (this option can be repeated) +.. option:: --no-binding-profile + + Clear existing information of binding:profile + .. option:: --host-id <host-id> The ID of the host where the port is allocated @@ -163,6 +177,10 @@ Set port properties Disable port +.. option:: --name + + Set port name + .. _port_set-port: .. describe:: <port> diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 58e7a0a5..fa07c377 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -28,11 +28,12 @@ Create a new security group rule .. option:: --src-group <group> - Source security group (ID only) + Source security group (name or ID) .. option:: --dst-port <port-range> - Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp) + Destination port, may be a single port or port range: 137:139 + (only required for IP protocols tcp and udp) .. describe:: <group> 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/server.rst b/doc/source/command-objects/server.rst index 54f4ee73..5141600d 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -764,7 +764,7 @@ Unset server properties .. option:: --property <key> - Property key to remove from server (repeat to set multiple values) + Property key to remove from server (repeat to remove multiple values) .. describe:: <server> diff --git a/doc/source/command-objects/subnet-pool.rst b/doc/source/command-objects/subnet-pool.rst index 439c4f50..cb86e227 100644 --- a/doc/source/command-objects/subnet-pool.rst +++ b/doc/source/command-objects/subnet-pool.rst @@ -17,6 +17,7 @@ Create subnet pool [--default-prefix-length <default-prefix-length>] [--min-prefix-length <min-prefix-length>] [--max-prefix-length <max-prefix-length>] + [--project <project> [--project-domain <project-domain>]] <name> .. option:: --pool-prefix <pool-prefix> @@ -36,6 +37,15 @@ Create subnet pool Set subnet pool maximum prefix length +.. 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. + .. _subnet_pool_create-name: .. describe:: <name> diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst index 56a28d73..e81a3359 100644 --- a/doc/source/command-objects/subnet.rst +++ b/doc/source/command-objects/subnet.rst @@ -4,24 +4,8 @@ subnet Network v2 -subnet delete -------------- - -Delete a subnet - -.. program:: subnet delete -.. code:: bash - - os subnet delete - <subnet> - -.. _subnet_delete-subnet: -.. describe:: <subnet> - - Subnet to delete (name or ID) - subnet create --------------- +------------- Create new subnet @@ -128,6 +112,22 @@ Create new subnet Name of subnet to create +subnet delete +------------- + +Delete a subnet + +.. program:: subnet delete +.. code:: bash + + os subnet delete + <subnet> + +.. _subnet_delete-subnet: +.. describe:: <subnet> + + Subnet to delete (name or ID) + subnet list ----------- @@ -143,6 +143,65 @@ List subnets List additional fields in output +subnet set +---------- + +Set subnet properties + +.. program:: subnet set +.. code:: bash + + os subnet set + [--allocation-pool start=<ip-address>,end=<ip-address>] + [--dhcp | --no-dhcp] + [--dns-nameserver <dns-nameserver>] + [--gateway <gateway-ip>] + [--host-route destination=<subnet>,gateway=<ip-address>] + [--name <new-name>] + <subnet> + +.. 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 + +.. 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 options are: + <ip-address>: Specific IP address to use as the gateway + 'none': This subnet will not use a gateway + e.g.: --gateway 192.168.9.1, --gateway none + +.. 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:: --name + + Updated name of the subnet + +.. _subnet_set-subnet: +.. describe:: <subnet> + + Subnet to modify (name or ID) + + subnet show ----------- diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst index 8a113847..69944fb9 100644 --- a/doc/source/command-objects/volume-type.rst +++ b/doc/source/command-objects/volume-type.rst @@ -20,7 +20,7 @@ Create new volume type .. option:: --description <description> - New volume type description + Volume type description .. versionadded:: 2 @@ -40,9 +40,10 @@ Create new volume type Set a property on this volume type (repeat option to set multiple properties) +.. _volume_type_create-name: .. describe:: <name> - New volume type name + Volume type name volume type delete ------------------ @@ -55,6 +56,7 @@ Delete volume type os volume type delete <volume-type> +.. _volume_type_delete-volume-type: .. describe:: <volume-type> Volume type to delete (name or ID) @@ -102,12 +104,30 @@ Set volume type properties .. option:: --property <key=value> - Property to add or modify for this volume type (repeat option to set multiple properties) + Set a property on this volume type (repeat option to set multiple properties) +.. _volume_type_set-volume-type: .. describe:: <volume-type> Volume type to modify (name or ID) +volume type show +---------------- + +Display volume type details + + +.. program:: volume type show +.. code:: bash + + os volume type show + <volume-type> + +.. _volume_type_show-volume-type: +.. describe:: <volume-type> + + Volume type to display (name or ID) + volume type unset ----------------- @@ -124,6 +144,7 @@ Unset volume type properties Property to remove from volume type (repeat option to remove multiple properties) +.. _volume_type_unset-volume-type: .. describe:: <volume-type> Volume type to modify (name or ID) diff --git a/doc/source/command-objects/volume.rst b/doc/source/command-objects/volume.rst index bf89dc44..a51d1117 100644 --- a/doc/source/command-objects/volume.rst +++ b/doc/source/command-objects/volume.rst @@ -14,32 +14,45 @@ Create new volume os volume create --size <size> + [--type <volume-type>] + [--image <image>] [--snapshot <snapshot>] + [--source <volume>] [--description <description>] - [--type <volume-type>] [--user <user>] [--project <project>] [--availability-zone <availability-zone>] - [--image <image>] - [--source <volume>] [--property <key=value> [...] ] <name> .. option:: --size <size> (required) - New volume size in GB + Volume size in GB + +.. option:: --type <volume-type> + + Set the type of volume + + Select :option:`\<volume-type\>` from the available types as shown + by ``volume type list``. + +.. option:: --image <image> + + Use :option:`\<image\>` as source of volume (name or ID) + + This is commonly used to create a boot volume for a server. .. option:: --snapshot <snapshot> - Use <snapshot> as source of new volume + Use :option:`\<snapshot\>` as source of volume (name or ID) -.. option:: --description <description> +.. option:: --source <source> - New volume description + Volume to clone (name or ID) -.. option:: --type <volume-type> +.. option:: --description <description> - Use <volume-type> as the new volume type + Volume description .. option:: --user <user> @@ -51,23 +64,16 @@ Create new volume .. option:: --availability-zone <availability-zone> - Create new volume in <availability-zone> - -.. option:: --image <image> - - Use <image> as source of new volume (name or ID) - -.. option:: --source <source> - - Volume to clone (name or ID) + Create volume in :option:`\<availability-zone\>` .. option:: --property <key=value> Set a property on this volume (repeat option to set multiple properties) +.. _volume_create-name: .. describe:: <name> - New volume name + Volume name The :option:`--project` and :option:`--user` options are typically only useful for admin users, but may be allowed for other users depending on @@ -83,12 +89,13 @@ Delete volume(s) os volume delete [--force] - <volume> [<volume> ...] + <volume> [<volume> ...] .. option:: --force Attempt forced removal of volume(s), regardless of state (defaults to False) +.. _volume_delete-volume: .. describe:: <volume> Volume(s) to delete (name or ID) @@ -102,35 +109,37 @@ List volumes .. code:: bash os volume list - [--all-projects] [--project <project> [--project-domain <project-domain>]] [--user <user> [--user-domain <user-domain>]] [--name <name>] [--status <status>] + [--all-projects] [--long] .. option:: --project <project> - Filter results by project (name or ID) (admin only) + Filter results by :option:`\<project\>` (name or ID) (admin only) *Volume 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. *Volume version 2 only* .. option:: --user <user> - Filter results by user (name or ID) (admin only) + Filter results by :option:`\<user\>` (name or ID) (admin only) *Volume version 2 only* .. option:: --user-domain <user-domain> Domain the user belongs to (name or ID). + This can be used in case collisions between user names exist. *Volume version 2 only* @@ -161,27 +170,40 @@ Set volume properties os volume set [--name <name>] - [--description <description>] [--size <size>] + [--description <description>] [--property <key=value> [...] ] + [--image-property <key=value> [...] ] <volume> .. option:: --name <name> New volume name +.. option:: --size <size> + + Extend volume size in GB + .. option:: --description <description> New volume description -.. option:: --size <size> +.. option:: --property <key=value> - Extend volume size in GB + Set a property on this volume (repeat option to set multiple properties) -.. option:: --property <key=value> +.. option:: --image-property <key=value> + + Set an image property on this volume + (repeat option to set multiple image properties) - Property to add or modify for this volume (repeat option to set multiple properties) + Image properties are copied along with the image when creating a volume + using :option:`--image`. Note that these properties are immutable on the + image itself, this option updates the copy attached to this volume. + *Volume version 2 only* + +.. _volume_set-volume: .. describe:: <volume> Volume to modify (name or ID) @@ -197,6 +219,7 @@ Show volume details os volume show <volume> +.. _volume_show-volume: .. describe:: <volume> Volume to display (name or ID) @@ -211,12 +234,21 @@ 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) + Remove a property from volume (repeat option to remove multiple properties) + +.. option:: --image-property <key> + + Remove an image property from volume + (repeat option to remove multiple image properties) + + *Volume version 2 only* +.. _volume_unset-volume: .. describe:: <volume> Volume to modify (name or ID) |