diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/compute-service.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/image.rst | 25 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 13 | ||||
| -rw-r--r-- | doc/source/command-objects/router.rst | 131 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 71 | ||||
| -rw-r--r-- | doc/source/command-objects/snapshot.rst | 5 |
7 files changed, 222 insertions, 33 deletions
diff --git a/doc/source/command-objects/compute-service.rst b/doc/source/command-objects/compute-service.rst index 95a77bdf..7bcab4d6 100644 --- a/doc/source/command-objects/compute-service.rst +++ b/doc/source/command-objects/compute-service.rst @@ -57,7 +57,7 @@ Set service command .. _compute-service-set: .. describe:: --enable - Enable service + Enable service (default) .. describe:: --disable diff --git a/doc/source/command-objects/image.rst b/doc/source/command-objects/image.rst index d4b99162..f1893efa 100644 --- a/doc/source/command-objects/image.rst +++ b/doc/source/command-objects/image.rst @@ -33,6 +33,7 @@ Create/upload an image [--public | --private] [--property <key=value> [...] ] [--tag <tag> [...] ] + [--project-domain <project-domain>] <image-name> .. option:: --id <id> @@ -127,6 +128,11 @@ Create/upload an image .. versionadded:: 2 +.. 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-name> New image name @@ -243,6 +249,8 @@ Set image properties [--os-distro <os-distro>] [--os-version <os-version>] [--ramdisk-id <ramdisk-id>] + [--activate|--deactivate] + [--project-domain <project-domain>] <image> .. option:: --name <name> @@ -387,6 +395,23 @@ Set image properties .. versionadded:: 2 +.. option:: --activate + + Activate the image. + + .. versionadded:: 2 + +.. option:: --deactivate + + Deactivate the image. + + .. versionadded:: 2 + +.. 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 modify (name or ID) diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 6b63c35d..7c791840 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -59,10 +59,10 @@ Delete network(s) os network delete <network> [<network> ...] -.. _network_delete-project: +.. _network_delete-network: .. describe:: <network> - Network to delete (name or ID) + Network(s) to delete (name or ID) network list ------------ @@ -74,17 +74,12 @@ List networks os network list [--external] - [--dhcp <dhcp-id>] [--long] .. option:: --external List external networks -.. option:: --dhcp <dhcp-id> - - DHCP agent ID - .. option:: --long List additional fields in output @@ -123,7 +118,7 @@ Set network properties Do not share the network between projects -.. _network_set-name: +.. _network_set-network: .. describe:: <network> Network to modify (name or ID) @@ -139,7 +134,7 @@ Display network details os network show <network> -.. _network_show-name: +.. _network_show-network: .. describe:: <network> Network to display (name or ID) diff --git a/doc/source/command-objects/router.rst b/doc/source/command-objects/router.rst new file mode 100644 index 00000000..e881065d --- /dev/null +++ b/doc/source/command-objects/router.rst @@ -0,0 +1,131 @@ +====== +router +====== + +Network v2 + +router create +------------- + +Create new router + +.. program:: router create +.. code:: bash + + os router create + [--project <project> [--project-domain <project-domain>]] + [--enable | --disable] + [--distributed] + <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:: --enable + + Enable router (default) + +.. option:: --disable + + Disable router + +.. option:: --distributed + + Create a distributed router + +.. _router_create-name: +.. describe:: <name> + + New router name + +router delete +------------- + +Delete router(s) + +.. program:: router delete +.. code:: bash + + os router delete + <router> [<router> ...] + +.. _router_delete-router: +.. describe:: <router> + + Router(s) to delete (name or ID) + +router list +----------- + +List routers + +.. program:: router list +.. code:: bash + + os router list + [--long] + +.. option:: --long + + List additional fields in output + +router set +---------- + +Set router properties + +.. program:: router set +.. code:: bash + + os router set + [--name <name>] + [--enable | --disable] + [--distributed | --centralized] + <router> + +.. option:: --name <name> + + Set router name + +.. option:: --enable + + Enable router + +.. option:: --disable + + Disable router + +.. option:: --distributed + + Set router to distributed mode (disabled router only) + +.. option:: --centralized + + Set router to centralized mode (disabled router only) + +.. _router_set-router: +.. describe:: <router> + + Router to modify (name or ID) + +router show +----------- + +Display router details + +.. program:: router show +.. code:: bash + + os router show + <router> + +.. _router_show-router: +.. describe:: <router> + + Router to display (name or ID) diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst index 8bd0d061..ce2e4d34 100644 --- a/doc/source/command-objects/security-group-rule.rst +++ b/doc/source/command-objects/security-group-rule.rst @@ -14,7 +14,7 @@ Create a new security group rule os security group rule create [--proto <proto>] - [--src-ip <ip-address>] + [--src-ip <ip-address> | --src-group <group>] [--dst-port <port-range>] <group> @@ -24,7 +24,11 @@ Create a new security group rule .. option:: --src-ip <ip-address> - Source IP (may use CIDR notation; default: 0.0.0.0/0) + Source IP address block (may use CIDR notation; default: 0.0.0.0/0) + +.. option:: --src-group <group> + + Source security group (ID only) .. option:: --dst-port <port-range> diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 6ae4d254..fd487b8e 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -77,19 +77,20 @@ Create a new server .. option:: --image <image> - Create server from this image + Create server from this image (name or ID) .. option:: --volume <volume> - Create server from this volume + Create server from this volume (name or ID) .. option:: --flavor <flavor> - Create server with this flavor + Create server with this flavor (name or ID) .. option:: --security-group <security-group-name> - Security group to assign to this server (repeat for multiple groups) + Security group to assign to this server (name or ID) + (repeat for multiple groups) .. option:: --key-name <key-name> @@ -187,6 +188,8 @@ List servers [--all-projects] [--project <project> [--project-domain <project-domain>]] [--long] + [--marker <server>] + [--limit <limit>] .. option:: --reservation-id <reservation-id> @@ -214,11 +217,11 @@ List servers .. option:: --flavor <flavor> - Search by flavor ID + Search by flavor (name or ID) .. option:: --image <image> - Search by image ID + Search by image (name or ID) .. option:: --host <hostname> @@ -250,6 +253,17 @@ List servers List additional fields in output +.. option:: --marker <server> + + The last server (name or ID) of the previous page. Display list of servers + after marker. Display all servers if not specified. + +.. option:: --limit <limit> + + Maximum number of servers to display. If limit equals -1, all servers will + be displayed. If limit is greater than 'osapi_max_limit' option of Nova + API, 'osapi_max_limit' will be used instead. + server lock ----------- @@ -495,21 +509,6 @@ Resume server(s) Server(s) to resume (name or ID) -server shelve -------------- - -Shelve server(s) - -.. program:: server shelve -.. code:: bash - - os server shelve - <server> [<server> ...] - -.. describe:: <server> - - Server(s) to shelve (name or ID) - server set ---------- @@ -542,6 +541,21 @@ Set server properties Server (name or ID) +server shelve +------------- + +Shelve server(s) + +.. program:: server shelve +.. code:: bash + + os server shelve + <server> [<server> ...] + +.. describe:: <server> + + Server(s) to shelve (name or ID) + server show ----------- @@ -720,3 +734,18 @@ Unset server properties .. describe:: <server> Server (name or ID) + +server unshelve +--------------- + +Unshelve server(s) + +.. program:: server unshelve +.. code:: bash + + os server unshelve + <server> [<server> ...] + +.. describe:: <server> + + Server(s) to unshelve (name or ID) diff --git a/doc/source/command-objects/snapshot.rst b/doc/source/command-objects/snapshot.rst index 307db2e1..b4838684 100644 --- a/doc/source/command-objects/snapshot.rst +++ b/doc/source/command-objects/snapshot.rst @@ -60,6 +60,11 @@ List snapshots .. code:: bash os snapshot list + [--all-projects] + +.. option:: --all-projects + + Include all projects (admin only) .. option:: --long |