diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/container.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-fixed.rst | 45 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-floating-pool.rst | 15 | ||||
| -rw-r--r-- | doc/source/command-objects/ip-floating.rst (renamed from doc/source/command-objects/floatingip.rst) | 36 | ||||
| -rw-r--r-- | doc/source/command-objects/network.rst | 5 | ||||
| -rw-r--r-- | doc/source/command-objects/object-store-account.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/object.rst | 2 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group-rule.rst | 65 | ||||
| -rw-r--r-- | doc/source/command-objects/security-group.rst | 95 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 86 | ||||
| -rw-r--r-- | doc/source/command-objects/snapshot.rst | 5 |
11 files changed, 311 insertions, 47 deletions
diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index 251e3f31..e6517e9b 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -2,7 +2,7 @@ container ========= -Object Store v1 +Object Storage v1 container create ---------------- diff --git a/doc/source/command-objects/ip-fixed.rst b/doc/source/command-objects/ip-fixed.rst new file mode 100644 index 00000000..3a55b995 --- /dev/null +++ b/doc/source/command-objects/ip-fixed.rst @@ -0,0 +1,45 @@ +======== +ip fixed +======== + +Compute v2 + +ip fixed add +------------ + +Add fixed IP address to server + +.. program:: ip fixed add +.. code:: bash + + os ip fixed add + <network> + <server> + +.. describe:: <network> + + Network to fetch an IP address from (name or ID) + +.. describe:: <server> + + Server to receive the IP address (name or ID) + +ip fixed remove +--------------- + +Remove fixed IP address from server + +.. program:: ip fixed remove +.. code:: bash + + os ip fixed remove + <ip-address> + <server> + +.. describe:: <ip-address> + + IP address to remove from server (name only) + +.. describe:: <server> + + Server to remove the IP address from (name or ID) diff --git a/doc/source/command-objects/ip-floating-pool.rst b/doc/source/command-objects/ip-floating-pool.rst new file mode 100644 index 00000000..63a450eb --- /dev/null +++ b/doc/source/command-objects/ip-floating-pool.rst @@ -0,0 +1,15 @@ +================ +ip floating pool +================ + +Compute v2 + +ip floating pool list +--------------------- + +List pools of floating IP addresses + +.. program:: ip floating pool list +.. code:: bash + + os ip floating pool list diff --git a/doc/source/command-objects/floatingip.rst b/doc/source/command-objects/ip-floating.rst index 1ae3041e..6bfd7f44 100644 --- a/doc/source/command-objects/floatingip.rst +++ b/doc/source/command-objects/ip-floating.rst @@ -1,24 +1,24 @@ -========== -floatingip -========== +=========== +ip floating +=========== Compute v2 ip floating add --------------- -Add floating-ip to server +Add floating IP address to server .. program:: ip floating add .. code:: bash os ip floating add - <ip_address> + <ip-address> <server> -.. describe:: <ip_address> +.. describe:: <ip-address> - IP address to add to server + IP address to add to server (name only) .. describe:: <server> @@ -27,7 +27,7 @@ Add floating-ip to server ip floating create ------------------ -Create new floating-ip +Create new floating IP address .. program:: ip floating create .. code:: bash @@ -37,27 +37,27 @@ Create new floating-ip .. describe:: <pool> - Pool to fetch floating IP from + Pool to fetch IP address from (name or ID) ip floating delete ------------------ -Delete a floating-ip +Delete a floating IP address .. program:: ip floating delete .. code:: bash os ip floating delete - <ip_address> + <ip-address> -.. describe:: <ip_address> +.. describe:: <ip-address> - IP address to delete + IP address to delete (ID only) ip floating list ---------------- -List floating-ips +List floating IP addresses .. program:: ip floating list .. code:: bash @@ -67,18 +67,18 @@ List floating-ips ip floating remove ------------------ -Remove floating-ip from server +Remove floating IP address from server .. program:: ip floating remove .. code:: bash os ip floating remove - <ip_address> + <ip-address> <server> -.. describe:: <ip_address> +.. describe:: <ip-address> - IP address to remove from server + IP address to remove from server (name only) .. describe:: <server> diff --git a/doc/source/command-objects/network.rst b/doc/source/command-objects/network.rst index 6b63c35d..6199d024 100644 --- a/doc/source/command-objects/network.rst +++ b/doc/source/command-objects/network.rst @@ -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 diff --git a/doc/source/command-objects/object-store-account.rst b/doc/source/command-objects/object-store-account.rst index bdc9393e..ba37078e 100644 --- a/doc/source/command-objects/object-store-account.rst +++ b/doc/source/command-objects/object-store-account.rst @@ -2,7 +2,7 @@ object store account ==================== -Object Store v1 +Object Storage v1 object store account set ------------------------ diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index ac814417..5aaad8a5 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -2,7 +2,7 @@ object ====== -Object Store v1 +Object Storage v1 object create ------------- diff --git a/doc/source/command-objects/security-group-rule.rst b/doc/source/command-objects/security-group-rule.rst new file mode 100644 index 00000000..8bd0d061 --- /dev/null +++ b/doc/source/command-objects/security-group-rule.rst @@ -0,0 +1,65 @@ +=================== +security group rule +=================== + +Compute v2 + +security group rule create +-------------------------- + +Create a new security group rule + +.. program:: security group rule create +.. code:: bash + + os security group rule create + [--proto <proto>] + [--src-ip <ip-address>] + [--dst-port <port-range>] + <group> + +.. option:: --proto <proto> + + IP protocol (icmp, tcp, udp; default: tcp) + +.. option:: --src-ip <ip-address> + + Source IP (may use CIDR notation; default: 0.0.0.0/0) + +.. option:: --dst-port <port-range> + + Destination port, may be a range: 137:139 (default: 0; only required for proto tcp and udp) + +.. describe:: <group> + + Create rule in this security group (name or ID) + +security group rule delete +-------------------------- + +Delete a security group rule + +.. program:: security group rule delete +.. code:: bash + + os security group rule delete + <rule> + +.. describe:: <rule> + + Security group rule to delete (ID only) + +security group rule list +------------------------ + +List security group rules + +.. program:: security group rule list +.. code:: bash + + os security group rule list + <group> + +.. describe:: <group> + + List all rules in this security group (name or ID) diff --git a/doc/source/command-objects/security-group.rst b/doc/source/command-objects/security-group.rst new file mode 100644 index 00000000..60de41d8 --- /dev/null +++ b/doc/source/command-objects/security-group.rst @@ -0,0 +1,95 @@ +============== +security group +============== + +Compute v2 + +security group create +--------------------- + +Create a new security group + +.. program:: security group create +.. code:: bash + + os security group create + [--description <description>] + <name> + +.. option:: --description <description> + + Security group description + +.. describe:: <name> + + New security group name + +security group delete +--------------------- + +Delete a security group + +.. program:: security group delete +.. code:: bash + + os security group delete + <group> + +.. describe:: <group> + + Security group to delete (name or ID) + +security group list +------------------- + +List security groups + +.. program:: security group list +.. code:: bash + + os security group list + [--all-projects] + +.. option:: --all-projects + + Display information from all projects (admin only) + +security group set +------------------ + +Set security group properties + +.. program:: security group set +.. code:: bash + + os security group set + [--name <new-name>] + [--description <description>] + <group> + +.. option:: --name <new-name> + + New security group name + +.. option:: --description <description> + + New security group description + +.. describe:: <group> + + Security group to modify (name or ID) + +security group show +------------------- + +Display security group details + +.. program:: security group show +.. code:: bash + + os security group show + <group> + +.. describe:: <group> + + Security group to display (name or ID) diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 83f83ddc..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,20 +253,31 @@ 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 ----------- -Lock a server. A non-admin user will not be able to execute actions +Lock server(s). A non-admin user will not be able to execute actions .. program:: server lock .. code:: bash os server lock - <server> + <server> [<server> ...] .. describe:: <server> - Server (name or ID) + Server(s) to lock (name or ID) server migrate -------------- @@ -483,17 +497,17 @@ a revert to release the new server and restart the old one. server resume ------------- -Resume server +Resume server(s) .. program:: server resume .. code:: bash os server resume - <server> + <server> [<server> ...] .. describe:: <server> - Server (name or ID) + Server(s) to resume (name or ID) server set ---------- @@ -527,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 ----------- @@ -628,47 +657,47 @@ Stop server(s) server suspend -------------- -Suspend server +Suspend server(s) .. program:: server suspend .. code:: bash os server suspend - <server> + <server> [<server> ...] .. describe:: <server> - Server (name or ID) + Server(s) to suspend (name or ID) server unlock ------------- -Unlock server +Unlock server(s) .. program:: server unlock .. code:: bash os server unlock - <server> + <server> [<server> ...] .. describe:: <server> - Server (name or ID) + Server(s) to unlock (name or ID) server unpause -------------- -Unpause server +Unpause server(s) .. program:: server unpause .. code:: bash os server unpause - <server> + <server> [<server> ...] .. describe:: <server> - Server (name or ID) + Server(s) to unpause (name or ID) server unrescue --------------- @@ -705,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 7bfd1d92..e05673b8 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 |