summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/aggregate.rst6
-rw-r--r--doc/source/command-objects/backup.rst11
-rw-r--r--doc/source/command-objects/compute-agent.rst4
-rw-r--r--doc/source/command-objects/compute-service.rst10
-rw-r--r--doc/source/command-objects/ec2-credentials.rst4
-rw-r--r--doc/source/command-objects/endpoint.rst6
-rw-r--r--doc/source/command-objects/flavor.rst18
-rw-r--r--doc/source/command-objects/host.rst6
-rw-r--r--doc/source/command-objects/keypair.rst6
-rw-r--r--doc/source/command-objects/network.rst4
-rw-r--r--doc/source/command-objects/port.rst6
-rw-r--r--doc/source/command-objects/router.rst26
-rw-r--r--doc/source/command-objects/service.rst8
-rw-r--r--doc/source/command-objects/subnet.rst54
-rw-r--r--doc/source/command-objects/user.rst2
-rw-r--r--doc/source/command-objects/volume-qos.rst5
-rw-r--r--doc/source/command-objects/volume-type.rst6
17 files changed, 139 insertions, 43 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst
index 7616c496..25c7041a 100644
--- a/doc/source/command-objects/aggregate.rst
+++ b/doc/source/command-objects/aggregate.rst
@@ -56,17 +56,17 @@ Create a new aggregate
aggregate delete
----------------
-Delete an existing aggregate
+Delete existing aggregate(s)
.. program:: aggregate delete
.. code:: bash
os aggregate delete
- <aggregate>
+ <aggregate> [<aggregate> ...]
.. describe:: <aggregate>
- Aggregate to delete (name or ID)
+ Aggregate(s) to delete (name or ID)
aggregate list
--------------
diff --git a/doc/source/command-objects/backup.rst b/doc/source/command-objects/backup.rst
index 9d7fb95d..8e657b32 100644
--- a/doc/source/command-objects/backup.rst
+++ b/doc/source/command-objects/backup.rst
@@ -16,6 +16,7 @@ Create new backup
[--container <container>]
[--name <name>]
[--description <description>]
+ [--force]
<volume>
.. option:: --container <container>
@@ -30,6 +31,10 @@ Create new backup
Description of the backup
+.. option:: --force
+
+ Allow to back up an in-use volume
+
.. _backup_create-backup:
.. describe:: <volume>
@@ -49,7 +54,7 @@ Delete backup(s)
.. _backup_delete-backup:
.. describe:: <backup>
- Backup(s) to delete (ID only)
+ Backup(s) to delete (name or ID)
backup list
-----------
@@ -81,7 +86,7 @@ Restore backup
.. _backup_restore-backup:
.. describe:: <backup>
- Backup to restore (ID only)
+ Backup to restore (name or ID)
.. describe:: <volume>
@@ -101,4 +106,4 @@ Display backup details
.. _backup_show-backup:
.. describe:: <backup>
- Backup to display (ID only)
+ Backup to display (name or ID)
diff --git a/doc/source/command-objects/compute-agent.rst b/doc/source/command-objects/compute-agent.rst
index b00a981d..ae057dc9 100644
--- a/doc/source/command-objects/compute-agent.rst
+++ b/doc/source/command-objects/compute-agent.rst
@@ -59,7 +59,7 @@ Delete compute agent(s)
compute agent list
------------------
-List compute agent command
+List compute agents
.. program:: compute agent list
.. code:: bash
@@ -74,7 +74,7 @@ List compute agent command
compute agent set
-----------------
-Set compute agent command
+Set compute agent properties
.. program:: agent set
.. code:: bash
diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst
index f43b5fa6..57dd2ba5 100644
--- a/doc/source/command-objects/compute-service.rst
+++ b/doc/source/command-objects/compute-service.rst
@@ -7,23 +7,23 @@ Compute v2
compute service delete
----------------------
-Delete service command
+Delete compute service(s)
.. program:: compute service delete
.. code:: bash
os compute service delete
- <service>
+ <service> [<service> ...]
.. _compute-service-delete:
.. describe:: <service>
- Compute service to delete (ID only)
+ Compute service(s) to delete (ID only)
compute service list
--------------------
-List service command
+List compute services
.. program:: compute service list
.. code:: bash
@@ -50,7 +50,7 @@ List service command
compute service set
-------------------
-Set service command
+Set compute service properties
.. program:: compute service set
.. code:: bash
diff --git a/doc/source/command-objects/ec2-credentials.rst b/doc/source/command-objects/ec2-credentials.rst
index 6748422e..caf7fd69 100644
--- a/doc/source/command-objects/ec2-credentials.rst
+++ b/doc/source/command-objects/ec2-credentials.rst
@@ -55,7 +55,7 @@ Delete EC2 credentials
os ec2 credentials delete
[--user <user>]
[--user-domain <user-domain>]
- <access-key>
+ <access-key> [<access-key> ...]
.. option:: --user <user>
@@ -71,7 +71,7 @@ Delete EC2 credentials
.. _ec2_credentials_delete-access-key:
.. describe:: access-key
- Credentials access key
+ Credentials access key(s)
The :option:`--user` option is typically only useful for admin users, but
may be allowed for other users depending on the policy of the cloud and
diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst
index 817ad491..c058c844 100644
--- a/doc/source/command-objects/endpoint.rst
+++ b/doc/source/command-objects/endpoint.rst
@@ -81,18 +81,18 @@ Create new endpoint
endpoint delete
---------------
-Delete endpoint
+Delete endpoint(s)
.. program:: endpoint delete
.. code:: bash
os endpoint delete
- <endpoint-id>
+ <endpoint-id> [<endpoint-id> ...]
.. _endpoint_delete-endpoint:
.. describe:: <endpoint-id>
- Endpoint to delete (ID only)
+ Endpoint(s) to delete (ID only)
endpoint list
-------------
diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst
index a30bedec..a886b9ff 100644
--- a/doc/source/command-objects/flavor.rst
+++ b/doc/source/command-objects/flavor.rst
@@ -21,6 +21,8 @@ Create new flavor
[--vcpus <num-cpu>]
[--rxtx-factor <factor>]
[--public | --private]
+ [--project <project>]
+ [--project-domain <project-domain>]
<flavor-name>
.. option:: --id <id>
@@ -59,6 +61,16 @@ Create new flavor
Flavor is not available to other projects
+.. option:: --project <project>
+
+ Allow <project> to access private flavor (name or ID)
+ (Must be used with :option:`--private` option)
+
+.. option:: --project-domain <project-domain>
+
+ Domain the project belongs to (name or ID).
+ This can be used in case collisions between project names exist.
+
.. _flavor_create-flavor-name:
.. describe:: <flavor-name>
@@ -67,18 +79,18 @@ Create new flavor
flavor delete
-------------
-Delete flavor
+Delete flavor(s)
.. program:: flavor delete
.. code:: bash
os flavor delete
- <flavor>
+ <flavor> [<flavor> ...]
.. _flavor_delete-flavor:
.. describe:: <flavor>
- Flavor to delete (name or ID)
+ Flavor(s) to delete (name or ID)
flavor list
-----------
diff --git a/doc/source/command-objects/host.rst b/doc/source/command-objects/host.rst
index ede62c56..409b834b 100644
--- a/doc/source/command-objects/host.rst
+++ b/doc/source/command-objects/host.rst
@@ -9,7 +9,7 @@ The physical computer running a hypervisor.
host list
---------
-List all hosts
+List hosts
.. program:: host list
.. code:: bash
@@ -24,7 +24,7 @@ List all hosts
host set
--------
-Set host command
+Set host properties
.. program:: host set
.. code:: bash
@@ -54,7 +54,7 @@ Set host command
.. describe:: <host>
- The host (name or ID)
+ Host to modify (name only)
host show
---------
diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst
index 6638b8c9..64cc20cd 100644
--- a/doc/source/command-objects/keypair.rst
+++ b/doc/source/command-objects/keypair.rst
@@ -30,17 +30,17 @@ Create new public key
keypair delete
--------------
-Delete public key
+Delete public key(s)
.. program:: keypair delete
.. code:: bash
os keypair delete
- <key>
+ <key> [<key> ...]
.. describe:: <key>
- Public key to delete (name only)
+ Public key(s) to delete (name only)
keypair list
------------
diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst
index 1cf442f2..0c472e7f 100644
--- a/doc/source/command-objects/network.rst
+++ b/doc/source/command-objects/network.rst
@@ -108,7 +108,7 @@ Create new network
.. option:: --provider-network-type <provider-network-type>
The physical mechanism by which the virtual network is implemented.
- The supported options are: flat, geneve, gre, local, vlan, vxlan
+ The supported options are: flat, geneve, gre, local, vlan, vxlan.
*Network version 2 only*
@@ -238,7 +238,7 @@ Set network properties
.. 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
+ The supported options are: flat, gre, local, vlan, vxlan.
.. option:: --provider-physical-network <provider-physical-network>
diff --git a/doc/source/command-objects/port.rst b/doc/source/command-objects/port.rst
index 0a74f88c..9d93ee62 100644
--- a/doc/source/command-objects/port.rst
+++ b/doc/source/command-objects/port.rst
@@ -55,7 +55,8 @@ Create new port
.. option:: --binding-profile <binding-profile>
- Custom data to be passed as binding:profile: <key>=<value>
+ Custom data to be passed as binding:profile. Data may
+ be passed as <key>=<value> or JSON.
(repeat option to set multiple binding:profile data)
.. option:: --host <host-id>
@@ -170,7 +171,8 @@ Set port properties
.. option:: --binding-profile <binding-profile>
- Custom data to be passed as binding:profile: <key>=<value>
+ Custom data to be passed as binding:profile. Data may
+ be passed as <key>=<value> or JSON.
(repeat option to set multiple binding:profile data)
.. option:: --no-binding-profile
diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst
index 9ca7661e..bbdca054 100644
--- a/doc/source/command-objects/router.rst
+++ b/doc/source/command-objects/router.rst
@@ -150,7 +150,7 @@ Remove a port from a router
.. describe:: <port>
- Port to be removed (name or ID)
+ Port to be removed and deleted (name or ID)
router remove subnet
--------------------
@@ -240,3 +240,27 @@ Display router details
.. describe:: <router>
Router to display (name or ID)
+
+router unset
+------------
+
+Unset router properties
+
+.. program:: router unset
+.. code:: bash
+
+ os router unset
+ [--route destination=<subnet>,gateway=<ip-address>]
+ <router>
+
+.. option:: --route destination=<subnet>,gateway=<ip-address>
+
+ Routes to be removed from the router
+ destination: destination subnet (in CIDR notation)
+ gateway: nexthop IP address
+ (repeat option to unset multiple routes)
+
+.. _router_unset-router:
+.. describe:: <router>
+
+ Router to modify (name or ID)
diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst
index 352f68a0..b5ec2d99 100644
--- a/doc/source/command-objects/service.rst
+++ b/doc/source/command-objects/service.rst
@@ -46,18 +46,18 @@ Create new service
service delete
--------------
-Delete service
+Delete service(s)
.. program:: service delete
.. code-block:: bash
os service delete
- <service>
+ <service> [<service> ...]
.. _service_delete-type:
.. describe:: <service>
- Service to delete (type, name or ID)
+ Service(s) to delete (type, name or ID)
service list
------------
@@ -117,7 +117,7 @@ Set service properties
.. _service_set-service:
.. describe:: <service>
- Service to update (type, name or ID)
+ Service to modify (type, name or ID)
service show
------------
diff --git a/doc/source/command-objects/subnet.rst b/doc/source/command-objects/subnet.rst
index c52d73f9..f0d5e90a 100644
--- a/doc/source/command-objects/subnet.rst
+++ b/doc/source/command-objects/subnet.rst
@@ -28,6 +28,7 @@ Create new subnet
[--ip-version {4,6}]
[--ipv6-ra-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
[--ipv6-address-mode {dhcpv6-stateful,dhcpv6-stateless,slaac}]
+ [--network-segment <network-segment>]
--network <network>
<name>
@@ -82,7 +83,7 @@ Create new subnet
'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')
+ ``--gateway none`` (default is 'auto').
.. option:: --host-route destination=<subnet>,gateway=<ip-address>
@@ -107,6 +108,14 @@ Create new subnet
IPv6 address mode, valid modes: [dhcpv6-stateful, dhcpv6-stateless, slaac]
+.. option:: --network-segment <network-segment>
+
+ Network segment to associate with this subnet (ID only)
+
+ .. caution:: This is a beta command option and subject
+ to change. Use global option ``--os-beta-command``
+ to enable this command option.
+
.. option:: --network <network>
Network this subnet belongs to (name or ID)
@@ -149,7 +158,8 @@ List subnets
.. option:: --ip-version {4, 6}
- List only subnets of given IP version in output
+ List only subnets of given IP version in output.
+ Allowed values for IP version are 4 and 6.
subnet set
----------
@@ -191,7 +201,7 @@ Set subnet properties
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``
+ e.g.: ``--gateway 192.168.9.1``, ``--gateway none``.
.. option:: --host-route destination=<subnet>,gateway=<ip-address>
@@ -226,3 +236,41 @@ Display subnet details
.. describe:: <subnet>
Subnet to display (name or ID)
+
+subnet unset
+------------
+
+Unset subnet properties
+
+.. program:: subnet unset
+.. code:: bash
+
+ os subnet unset
+ [--allocation-pool start=<ip-address>,end=<ip-address> [...]]
+ [--dns-nameserver <dns-nameserver> [...]]
+ [--host-route destination=<subnet>,gateway=<ip-address> [...]]
+ <subnet>
+
+.. option:: --dns-nameserver <dns-nameserver>
+
+ DNS server to be removed from this subnet
+ (repeat option to unset multiple DNS servers)
+
+.. option:: --allocation-pool start=<ip-address>,end=<ip-address>
+
+ Allocation pool to be removed from this subnet e.g.:
+ ``start=192.168.199.2,end=192.168.199.254``
+ (repeat option to unset multiple Allocation pools)
+
+.. option:: --host-route destination=<subnet>,gateway=<ip-address>
+
+ Route to be removed from 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
+ (repeat option to unset multiple host routes)
+
+.. _subnet_unset-subnet:
+.. describe:: <subnet>
+
+ subnet to modify (name or ID)
diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst
index b3707a2a..a9fee728 100644
--- a/doc/source/command-objects/user.rst
+++ b/doc/source/command-objects/user.rst
@@ -95,7 +95,7 @@ Delete user(s)
.. _user_delete-user:
.. describe:: <user>
- User to delete (name or ID)
+ User(s) to delete (name or ID)
user list
---------
diff --git a/doc/source/command-objects/volume-qos.rst b/doc/source/command-objects/volume-qos.rst
index 2d9d14a4..f3c7ec21 100644
--- a/doc/source/command-objects/volume-qos.rst
+++ b/doc/source/command-objects/volume-qos.rst
@@ -58,8 +58,13 @@ Delete QoS specification
.. code:: bash
os volume qos delete
+ [--force]
<qos-spec> [<qos-spec> ...]
+.. option:: --force
+
+ Allow to delete in-use QoS specification(s)
+
.. describe:: <qos-spec>
QoS specification(s) to delete (name or ID)
diff --git a/doc/source/command-objects/volume-type.rst b/doc/source/command-objects/volume-type.rst
index 50acf9fa..dfc169cd 100644
--- a/doc/source/command-objects/volume-type.rst
+++ b/doc/source/command-objects/volume-type.rst
@@ -48,18 +48,18 @@ Create new volume type
volume type delete
------------------
-Delete volume type
+Delete volume type(s)
.. program:: volume type delete
.. code:: bash
os volume type delete
- <volume-type>
+ <volume-type> [<volume-type> ...]
.. _volume_type_delete-volume-type:
.. describe:: <volume-type>
- Volume type to delete (name or ID)
+ Volume type(s) to delete (name or ID)
volume type list
----------------