diff options
Diffstat (limited to 'doc/source/command-objects')
25 files changed, 295 insertions, 19 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst index 474d811f..2a40d234 100644 --- a/doc/source/command-objects/aggregate.rst +++ b/doc/source/command-objects/aggregate.rst @@ -5,6 +5,8 @@ aggregate Server aggregates provide a mechanism to group servers according to certain criteria. +Compute v2 + aggregate add host ------------------ @@ -137,7 +139,7 @@ Set aggregate properties aggregate show -------------- -Show a specific aggregate +Display aggregate details .. program aggregate show .. code:: bash @@ -147,4 +149,4 @@ Show a specific aggregate .. describe:: <aggregate> - Aggregate to show (name or ID) + Aggregate to display (name or ID) diff --git a/doc/source/command-objects/catalog.rst b/doc/source/command-objects/catalog.rst index 99746dd7..89db95d5 100644 --- a/doc/source/command-objects/catalog.rst +++ b/doc/source/command-objects/catalog.rst @@ -7,6 +7,9 @@ Identity v2 catalog list ------------ +List services in the service catalog + +.. program:: catalog list .. code:: bash os catalog list @@ -14,7 +17,14 @@ catalog list catalog show ------------ +Display service catalog details + +.. program:: catalog show .. code:: bash os catalog show <service> + +.. describe:: <service> + + Service to display (type or name) diff --git a/doc/source/command-objects/console-log.rst b/doc/source/command-objects/console-log.rst index 8e56a073..9eafb61a 100644 --- a/doc/source/command-objects/console-log.rst +++ b/doc/source/command-objects/console-log.rst @@ -4,6 +4,8 @@ console log Server console text dump +Compute v2 + console log show ---------------- diff --git a/doc/source/command-objects/console-url.rst b/doc/source/command-objects/console-url.rst index 45a0a527..9cab8798 100644 --- a/doc/source/command-objects/console-url.rst +++ b/doc/source/command-objects/console-url.rst @@ -4,6 +4,8 @@ console url Server remote console URL +Compute v2 + console url show ---------------- diff --git a/doc/source/command-objects/consumer.rst b/doc/source/command-objects/consumer.rst index 59ace845..91294fa2 100644 --- a/doc/source/command-objects/consumer.rst +++ b/doc/source/command-objects/consumer.rst @@ -24,7 +24,7 @@ Create new consumer consumer delete --------------- -Delete a consumer +Delete consumer .. program:: consumer delete .. code:: bash diff --git a/doc/source/command-objects/container.rst b/doc/source/command-objects/container.rst index 3afaeb92..845933d4 100644 --- a/doc/source/command-objects/container.rst +++ b/doc/source/command-objects/container.rst @@ -92,7 +92,7 @@ Save container contents locally container show -------------- -Show container details +Display container details .. program:: container show .. code:: bash diff --git a/doc/source/command-objects/credentials.rst b/doc/source/command-objects/credentials.rst index ea8fc08f..9f4aabe4 100644 --- a/doc/source/command-objects/credentials.rst +++ b/doc/source/command-objects/credentials.rst @@ -2,6 +2,8 @@ credentials =========== +Identity v3 + credentials create ------------------ diff --git a/doc/source/command-objects/domain.rst b/doc/source/command-objects/domain.rst index 66697ac3..94473570 100644 --- a/doc/source/command-objects/domain.rst +++ b/doc/source/command-objects/domain.rst @@ -102,7 +102,7 @@ Set domain properties domain show ----------- -Show domain details +Display domain details .. program:: domain show .. code:: bash diff --git a/doc/source/command-objects/federation-protocol.rst b/doc/source/command-objects/federation-protocol.rst index 0ed0980a..5b4ea48a 100644 --- a/doc/source/command-objects/federation-protocol.rst +++ b/doc/source/command-objects/federation-protocol.rst @@ -34,7 +34,7 @@ Create new federation protocol federation protocol delete -------------------------- -Delete a federation protocol +Delete federation protocol .. program:: federation protocol delete .. code:: bash diff --git a/doc/source/command-objects/flavor.rst b/doc/source/command-objects/flavor.rst index 4c98e858..0083da0d 100644 --- a/doc/source/command-objects/flavor.rst +++ b/doc/source/command-objects/flavor.rst @@ -2,6 +2,8 @@ flavor ====== +Compute v2 + flavor create ------------- @@ -65,7 +67,7 @@ Create new flavor flavor delete ------------- -Delete a flavor +Delete flavor .. program:: flavor delete .. code:: bash diff --git a/doc/source/command-objects/identity-provider.rst b/doc/source/command-objects/identity-provider.rst index f08cde01..47e274dd 100644 --- a/doc/source/command-objects/identity-provider.rst +++ b/doc/source/command-objects/identity-provider.rst @@ -38,7 +38,7 @@ Create new identity provider identity provider delete ------------------------ -Delete an identity provider +Delete identity provider .. program:: identity provider delete .. code:: bash diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst index 9ba0ee8f..04c5721f 100644 --- a/doc/source/command-objects/keypair.rst +++ b/doc/source/command-objects/keypair.rst @@ -5,6 +5,8 @@ keypair The badly named keypair is really the public key of an OpenSSH key pair to be used for access to created servers. +Compute v2 + keypair create -------------- @@ -28,7 +30,7 @@ Create new public key keypair delete -------------- -Delete a public key +Delete public key .. program keypair delete .. code:: bash @@ -53,7 +55,7 @@ List public key fingerprints keypair show ------------ -Show public key details +Display public key details .. program keypair show .. code:: bash @@ -68,4 +70,4 @@ Show public key details .. describe:: <key> - Public key to show + Public key to display diff --git a/doc/source/command-objects/limits.rst b/doc/source/command-objects/limits.rst index ac388e0f..1eae4889 100644 --- a/doc/source/command-objects/limits.rst +++ b/doc/source/command-objects/limits.rst @@ -4,6 +4,8 @@ limits The Compute and Volume APIs have resource usage limits. +Compute v2, Volume v1 + limits show ----------- diff --git a/doc/source/command-objects/mapping.rst b/doc/source/command-objects/mapping.rst index 5c7535bd..25af4740 100644 --- a/doc/source/command-objects/mapping.rst +++ b/doc/source/command-objects/mapping.rst @@ -30,7 +30,7 @@ Create new mapping mapping delete -------------- -Delete a mapping +Delete mapping .. program:: mapping delete .. code:: bash diff --git a/doc/source/command-objects/object.rst b/doc/source/command-objects/object.rst index 5cbc95d7..c45c1051 100644 --- a/doc/source/command-objects/object.rst +++ b/doc/source/command-objects/object.rst @@ -122,7 +122,7 @@ Save object locally object show ----------- -Show object details +Display object details .. program:: object show .. code:: bash diff --git a/doc/source/command-objects/policy.rst b/doc/source/command-objects/policy.rst new file mode 100644 index 00000000..195a89f2 --- /dev/null +++ b/doc/source/command-objects/policy.rst @@ -0,0 +1,95 @@ +====== +policy +====== + +Identity v3 + +policy create +------------- + +Create new policy + +.. program:: policy create +.. code:: bash + + os policy create + [--type <type>] + <filename> + +.. option:: --type <type> + + New MIME type of the policy rules file (defaults to application/json) + +.. describe:: <filename> + + New serialized policy rules file + +policy delete +------------- + +Delete policy + +.. program:: policy delete +.. code:: bash + + os policy delete + <policy> + +.. describe:: <policy> + + Policy to delete + +policy list +----------- + +List policies + +.. program:: policy list +.. code:: bash + + os policy list + [--long] + +.. option:: --long + + List additional fields in output + +policy set +---------- + +Set policy properties + +.. program:: policy set +.. code:: bash + + os policy set + [--type <type>] + [--rules <filename>] + <policy> + +.. option:: --type <type> + + New MIME type of the policy rules file + +.. describe:: --rules <filename> + + New serialized policy rules file + +.. describe:: <policy> + + Policy to modify + +policy show +----------- + +Display policy details + +.. program:: policy show +.. code:: bash + + os policy show + <policy> + +.. describe:: <policy> + + Policy to display diff --git a/doc/source/command-objects/project.rst b/doc/source/command-objects/project.rst index 6b55b424..b39edb4d 100644 --- a/doc/source/command-objects/project.rst +++ b/doc/source/command-objects/project.rst @@ -149,6 +149,8 @@ Set project properties project show ------------ +Display project details + .. program:: project show .. code:: bash @@ -165,4 +167,4 @@ project show .. _project_show-project: .. describe:: <project> - Project to show (name or ID) + Project to display (name or ID) diff --git a/doc/source/command-objects/quota.rst b/doc/source/command-objects/quota.rst index ba6712c0..053fb47a 100644 --- a/doc/source/command-objects/quota.rst +++ b/doc/source/command-objects/quota.rst @@ -4,6 +4,8 @@ quota Resource quotas appear in multiple APIs, OpenStackClient presents them as a single object with multiple properties. +Compute v2, Volume v1 + quota set --------- diff --git a/doc/source/command-objects/region.rst b/doc/source/command-objects/region.rst index d1aedb31..cb4a059e 100644 --- a/doc/source/command-objects/region.rst +++ b/doc/source/command-objects/region.rst @@ -95,7 +95,7 @@ Set region properties .. _region_set-region-id: .. describe:: <region-id> - Region ID to modify + Region to modify region show ----------- @@ -111,4 +111,4 @@ Display region details .. _region_show-region-id: .. describe:: <region-id> - Region ID to display + Region to display diff --git a/doc/source/command-objects/role.rst b/doc/source/command-objects/role.rst index 19195eb5..57161b06 100644 --- a/doc/source/command-objects/role.rst +++ b/doc/source/command-objects/role.rst @@ -142,7 +142,7 @@ Remove role from domain/project : user/group .. describe:: <role> - Role to remove from `<project>`:`<user>` (name or ID) + Role to remove (name or ID) role set -------- @@ -169,6 +169,8 @@ Set role properties role show --------- +Display role details + .. program:: role show .. code:: bash @@ -177,4 +179,4 @@ role show .. describe:: <role> - Role to show (name or ID) + Role to display (name or ID) diff --git a/doc/source/command-objects/server-image.rst b/doc/source/command-objects/server-image.rst index 4577b25b..8b489342 100644 --- a/doc/source/command-objects/server-image.rst +++ b/doc/source/command-objects/server-image.rst @@ -5,6 +5,8 @@ server image A server image is a disk image created from a running server instance. The image is created in the Image store. +Compute v2 + server image create ------------------- diff --git a/doc/source/command-objects/server.rst b/doc/source/command-objects/server.rst index 48cefe6a..360ec24e 100644 --- a/doc/source/command-objects/server.rst +++ b/doc/source/command-objects/server.rst @@ -2,6 +2,7 @@ server ====== +Compute v2 server add security group ------------------------- diff --git a/doc/source/command-objects/service.rst b/doc/source/command-objects/service.rst new file mode 100644 index 00000000..d4f63de8 --- /dev/null +++ b/doc/source/command-objects/service.rst @@ -0,0 +1,144 @@ +======= +service +======= + +Identity v2, v3 + +service create +-------------- + +Create new service + +.. program:: service create +.. code-block:: bash + + os service create + [--name <name>] + [--description <description>] + [--enable | --disable] + <type> + +.. option:: --name <name> + + New service name + +.. option:: --description <description> + + New service description + +.. option:: --enable + + Enable service (default) + + *Identity version 3 only* + +.. option:: --disable + + Disable service + + *Identity version 3 only* + +.. _service_create-type: +.. describe:: <type> + + New service type (compute, image, identity, volume, etc) + +service delete +-------------- + +Delete service + +.. program:: service delete +.. code-block:: bash + + os service delete + <service> + +:option:`<service>` + Service to delete (type, name or ID) + +service list +------------ + +List services + +.. program:: service list +.. code-block:: bash + + os service list + [--long] + +.. option:: --long + + List additional fields in output + + *Identity version 2 only* + +Returns service fields ID and Name, `--long` adds Type and Description +to the output. When Identity API version 3 is selected all columns are +always displayed, `--long` is silently accepted for backward-compatibility. + +service set +----------- + +Set service properties + +* Identity version 3 only* + +.. program:: service set +.. code-block:: bash + + os service set + [--type <type>] + [--name <name>] + [--description <description>] + [--enable | --disable] + <service> + +.. option:: --type <type> + + New service type (compute, image, identity, volume, etc) + +.. option:: --name <name> + + New service name + +.. option:: --description <description> + + New service description + +.. option:: --enable + + Enable service + +.. option:: --disable + + Disable service + +.. _service_set-service: +.. describe:: <service> + + Service to update (type, name or ID) + +service show +------------ + +Display service details + +.. program:: service show +.. code-block:: bash + + os service show + [--catalog] + <service> + +.. option:: --catalog + + Show service catalog information + + *Identity version 2 only* + +.. _service_show-service: +.. describe:: <service> + + Service to display (type, name or ID) diff --git a/doc/source/command-objects/user-role.rst b/doc/source/command-objects/user-role.rst index a25e90ff..8283f911 100644 --- a/doc/source/command-objects/user-role.rst +++ b/doc/source/command-objects/user-role.rst @@ -2,6 +2,8 @@ user role ========= +Identity v2 + user role list -------------- diff --git a/doc/source/command-objects/user.rst b/doc/source/command-objects/user.rst index a9a98fe1..9c81a403 100644 --- a/doc/source/command-objects/user.rst +++ b/doc/source/command-objects/user.rst @@ -191,6 +191,8 @@ Set user properties user show --------- +Display user details + .. program:: user show .. code:: bash @@ -207,4 +209,4 @@ user show .. _user_show-user: .. describe:: <user> - User to show (name or ID) + User to display (name or ID) |