diff options
Diffstat (limited to 'doc/source/command-objects')
| -rw-r--r-- | doc/source/command-objects/availability_zone.rst | 20 | ||||
| -rw-r--r-- | doc/source/command-objects/container.rst | 105 | ||||
| -rw-r--r-- | doc/source/command-objects/domain.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/flavor.rst | 105 | ||||
| -rw-r--r-- | doc/source/command-objects/object.rst | 140 | ||||
| -rw-r--r-- | doc/source/command-objects/project.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/role.rst | 6 | ||||
| -rw-r--r-- | doc/source/command-objects/server-image.rst | 10 | ||||
| -rw-r--r-- | doc/source/command-objects/server.rst | 8 | ||||
| -rw-r--r-- | doc/source/command-objects/user.rst | 6 |
10 files changed, 394 insertions, 20 deletions
diff --git a/doc/source/command-objects/availability_zone.rst b/doc/source/command-objects/availability_zone.rst new file mode 100644 index 00000000..37435230 --- /dev/null +++ b/doc/source/command-objects/availability_zone.rst @@ -0,0 +1,20 @@ +================= +availability zone +================= + +Compute v2 + +availability zone list +---------------------- + +List availability zones and their status + +.. program availability zone list +.. code:: bash + + os availability zone list + [--long] + +.. option:: --long + + List additional fields in output diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst new file mode 100644 index 00000000..3afaeb92 --- /dev/null +++ b/doc/source/command-objects/container.rst @@ -0,0 +1,105 @@ +========= +container +========= + +Object Store v1 + +container create +---------------- + +Create new container + +.. program:: container create +.. code:: bash + + os container create + <container-name> [<container-name> ...] + +.. option:: <container-name> + + New container name(s) + +container delete +---------------- + +Delete container + +.. program:: container delete +.. code:: bash + + os container delete + <container> [<container> ...] + +.. option:: <container> + + Container(s) to delete + +container list +-------------- + +List containers + +.. program:: container list +.. code::bash + + os container list + [--prefix <prefix>] + [--marker <marker>] + [--end-marker <end-marker>] + [--limit <limit>] + [--long] + [--all] + +.. option:: --prefix <prefix> + + Filter list using <prefix> + +.. option:: --marker <marker> + + Anchor for paging + +.. option:: --end-marker <end-marker> + + End anchor for paging + +.. option:: --limit <limit> + + Limit the number of containers returned + +.. option:: --long + + List additional fields in output + +.. options:: --all + + List all containers (default is 10000) + +container save +-------------- + +Save container contents locally + +.. program:: container save +.. code:: bash + + os container save + <container> + +.. option:: <container> + + Container to save + +container show +-------------- + +Show container details + +.. program:: container show +.. code:: bash + + os container show + [<container>] + +.. option:: <container> + + Container to display diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 057296ac..66697ac3 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -36,7 +36,7 @@ Create new domain If the domain already exists, return the existing domain data and do not fail. -.. option:: <domain-name> +.. describe:: <domain-name> New domain name @@ -51,7 +51,7 @@ Delete domain os domain delete <domain> -.. option:: <domain> +.. describe:: <domain> Domain to delete (name or ID) @@ -95,7 +95,7 @@ Set domain properties Disable domain -.. option:: <domain> +.. describe:: <domain> Domain to modify (name or ID) @@ -110,6 +110,6 @@ Show domain details os domain show <domain> -.. option:: <domain> +.. describe:: <domain> Domain to display (name or ID) diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst new file mode 100644 index 00000000..4c98e858 --- /dev/null +++ b/doc/source/command-objects/flavor.rst @@ -0,0 +1,105 @@ +====== +flavor +====== + +flavor create +------------- + +Create new flavor + +.. program:: flavor create +.. code:: bash + + os flavor create + [--id <id>] + [--ram <size-mb>] + [--disk <size-gb>] + [--ephemeral-disk <size-gb>] + [--swap <size-mb>] + [--vcpus <num-cpu>] + [--rxtx-factor <factor>] + [--public | --private] + <flavor-name> + +.. option:: --id <id> + + Unique flavor ID; 'auto' creates a UUID (default: auto) + +.. option:: --ram <size-mb> + + Memory size in MB (default 256M) + +.. option:: --disk <size-gb> + + Disk size in GB (default 0G) + +.. option:: --ephemeral-disk <size-gb> + + Ephemeral disk size in GB (default 0G) + +.. option:: --swap <size-gb> + + Swap space size in GB (default 0G) + +.. option:: --vcpus <num-cpu> + + Number of vcpus (default 1) + +.. option:: --rxtx-factor <factor> + + RX/TX factor (default 1) + +.. option:: --public + + Flavor is available to other projects (default) + +.. option:: --private + + Flavor is not available to other projects + +.. _flavor_create-flavor-name: +.. describe:: <flavor-name> + + New flavor name + +flavor delete +------------- + +Delete a flavor + +.. program:: flavor delete +.. code:: bash + + os flavor delete + <flavor> + +.. _flavor_delete-flavor: +.. describe:: <flavor> + + Flavor to delete (name or ID) + +flavor list +----------- + +List flavors + +.. program:: flavor list +.. code:: bash + + os flavor list + +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) diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst new file mode 100644 index 00000000..5cbc95d7 --- /dev/null +++ b/doc/source/command-objects/object.rst @@ -0,0 +1,140 @@ +====== +object +====== + +Object Store v1 + +object create +------------- + +Upload object to container + +.. program:: object create +.. code:: bash + + os object create + <container> + <filename> [<filename> ...] + +.. option:: <container> + + Container for new object + +.. option:: <filename> + + Local filename(s) to upload + +object delete +------------- + +Delete object from container + +.. program:: object delete +.. code:: bash + + os object delete + <container> + <object> [<object> ...] + +.. option:: <container> + + Delete object(s) from <container> + +.. option:: <object> + + Object(s) to delete + +list object +----------- + +List objects + +.. program object list +.. code:: bash + + os object list + [--prefix <prefix>] + [--delimiter <delimiter>] + [--marker <marker>] + [--end-marker <end-marker>] + [--limit <limit>] + [--long] + [--all] + <container>] + +.. option:: --prefix <prefix> + + Filter list using <prefix> + +.. option:: --delimiter <delimiter> + + Roll up items with <delimiter> + +.. option:: --marker <marker> + + Anchor for paging + +.. option:: --end-marker <end-marker> + + End anchor for paging + +.. option:: --limit <limit> + + Limit number of objects returned + +.. option:: --long + + List additional fields in output + +.. options:: --all + + List all objects in <container> (default is 10000) + +.. option:: <container> + + Container to list + +object save +----------- + +Save object locally + +.. program:: object save +.. code:: bash + + os object save + [--file <filename>] + [<container>] + [<object>] + +.. option:: --file <filename> + + Destination filename (defaults to object name) + +.. option:: <container> + + Download <object> from <container> + +.. option:: <object> + + Object to save + +object show +----------- + +Show object details + +.. program:: object show +.. code:: bash + + os object show + <container> + <object> + +.. option:: <container> + + Display <object> from <container> + +.. option:: <object> + + Object to display diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 56f2196f..6b55b424 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -47,12 +47,12 @@ Create new project New project name -project(s) delete ------------------ +project delete +-------------- Delete project(s) -.. program:: project(s) delete +.. program:: project delete .. code:: bash os project delete diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 4c37fc38..19195eb5 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -56,12 +56,12 @@ Create new role New role name -role(s) delete --------------- +role delete +----------- Delete role(s) -.. program:: role(s) delete +.. program:: role delete .. code:: bash os role delete diff --git a/doc/source/command-objects/server-image.rst b/doc/source/command-objects/server-image.rst index 681f6e4f..4577b25b 100644 --- a/doc/source/command-objects/server-image.rst +++ b/doc/source/command-objects/server-image.rst @@ -10,6 +10,7 @@ server image create Create a new disk image from a running server +.. program:: server image create .. code:: bash os server image create @@ -17,11 +18,14 @@ Create a new disk image from a running server [--wait] <server> -:option:`--name` <image-name> +.. option:: --name <image-name> + Name of new image (default is server name) -:option:`--wait` +.. option:: --wait + Wait for image create to complete -:option:`<server>` +.. describe:: <server> + Server (name or ID) diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 7d5cdce5..2f5aef10 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -117,10 +117,10 @@ Create a new server :option:`<server-name>` New server name -server(s) delete ----------------- +server delete +------------- -Delete server(s) command +Delete server(s) .. code:: bash @@ -128,7 +128,7 @@ Delete server(s) command <server> [<server> ...] :option:`<server>` - Server (name or ID) + Server to delete (name or ID) server list ----------- diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index 281e8e0d..e54c6567 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -69,12 +69,12 @@ Create new user New user name -user(s) delete --------------- +user delete +----------- Delete user(s) -.. program:: user(s) delete +.. program:: user delete .. code:: bash os user delete |
