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.rst2
-rw-r--r--doc/source/command-objects/console-log.rst2
-rw-r--r--doc/source/command-objects/console-url.rst2
-rw-r--r--doc/source/command-objects/credentials.rst2
-rw-r--r--doc/source/command-objects/flavor.rst2
-rw-r--r--doc/source/command-objects/keypair.rst2
-rw-r--r--doc/source/command-objects/limits.rst2
-rw-r--r--doc/source/command-objects/quota.rst2
-rw-r--r--doc/source/command-objects/server-image.rst2
-rw-r--r--doc/source/command-objects/server.rst1
-rw-r--r--doc/source/command-objects/service.rst144
-rw-r--r--doc/source/command-objects/user-role.rst2
12 files changed, 165 insertions, 0 deletions
diff --git a/doc/source/command-objects/aggregate.rst b/doc/source/command-objects/aggregate.rst
index 474d811f..6497f632 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
------------------
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/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/flavor.rst b/doc/source/command-objects/flavor.rst
index 4c98e858..31b8e902 100644
--- a/doc/source/command-objects/flavor.rst
+++ b/doc/source/command-objects/flavor.rst
@@ -2,6 +2,8 @@
flavor
======
+Compute v2
+
flavor create
-------------
diff --git a/doc/source/command-objects/keypair.rst b/doc/source/command-objects/keypair.rst
index 9ba0ee8f..89d12a30 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
--------------
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/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/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
--------------