summaryrefslogtreecommitdiff
path: root/doc/source/command-objects
diff options
context:
space:
mode:
authorDean Troyer <dtroyer@gmail.com>2014-12-30 17:46:02 -0600
committerDean Troyer <dtroyer@gmail.com>2015-01-02 11:29:07 -0600
commitb56da8dde2ef78f057e67b0b307ee7ce2dff2d7d (patch)
tree51bb0d95a05cf9efc4044866de9ea34795ec1bbe /doc/source/command-objects
parent457f4c899845abc1f9fe54fbb694efeeb61313d8 (diff)
downloadpython-openstackclient-b56da8dde2ef78f057e67b0b307ee7ce2dff2d7d.tar.gz
Add endpoint v3 docs
(update: change version description formats for API versioning) Change-Id: I499ea1d80ad6ad6392468305f761e695d7261e33
Diffstat (limited to 'doc/source/command-objects')
-rw-r--r--doc/source/command-objects/endpoint.rst161
1 files changed, 156 insertions, 5 deletions
diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst
index 128ddfa0..7846a1b1 100644
--- a/doc/source/command-objects/endpoint.rst
+++ b/doc/source/command-objects/endpoint.rst
@@ -7,39 +7,190 @@ Identity v2, v3
endpoint create
---------------
+Create new endpoint
+
+*Identity version 2 only*
+
+.. program:: endpoint create
+.. code:: bash
+
+ os endpoint create
+ --publicurl <url>
+ [--adminurl <url>]
+ [--internalurl <url>]
+ [--region <region-id>]
+ <service>
+
+.. option:: --publicurl <url>
+
+ New endpoint public URL (required)
+
+.. option:: --adminurl <url>
+
+ New endpoint admin URL
+
+.. option:: --internalurl <url>
+
+ New endpoint internal URL
+
+.. option:: --region <region-id>
+
+ New endpoint region ID
+
+.. _endpoint_create-endpoint:
+.. describe:: <service>
+
+ New endpoint service (name or ID)
+
+*Identity version 3 only*
+
.. program:: endpoint create
.. code:: bash
os endpoint create
- --publicurl <public-url>
- [--adminurl <admin-url>]
- [--internalurl <internal-url>]
- [--region <endpoint-region>]
+ [--region <region-id>
+ [--enable | --disable]
<service>
+ <interface>
+ <url>
+
+.. option:: --region <region-id>
+
+ New endpoint region ID
+
+.. option:: --enable
+
+ Enable endpoint (default)
+
+.. option:: --disable
+
+ Disable endpoint
+
+.. describe:: <service>
+
+ New endpoint service (name or ID)
+
+.. describe:: <interface>
+
+ New endpoint interface type (admin, public or internal)
+
+.. describe:: <url>
+
+ New endpoint URL
endpoint delete
---------------
+Delete endpoint
+
.. program:: endpoint delete
.. code:: bash
os endpoint delete
<endpoint-id>
+.. _endpoint_delete-endpoint:
+.. describe:: <endpoint-id>
+
+ Endpoint ID to delete
+
endpoint list
-------------
+List endpoints
+
.. program:: endpoint list
.. code:: bash
os endpoint list
+ [--service <service]
+ [--interface <interface>]
+ [--region <region-id>]
[--long]
+.. option:: --service <service>
+
+ Filter by service
+
+ *Identity version 3 only*
+
+.. option:: --interface <interface>
+
+ Filter by interface type (admin, public or internal)
+
+ *Identity version 3 only*
+
+.. option:: --region <region-id>
+
+ Filter by region ID
+
+ *Identity version 3 only*
+
+.. option:: --long
+
+ List additional fields in output
+
+ *Identity version 2 only*
+
+endpoint set
+------------
+
+Set endpoint properties
+
+*Identity version 3 only*
+
+.. program:: endpoint set
+.. code:: bash
+
+ os endpoint set
+ [--region <region-id>]
+ [--interface <interface>]
+ [--url <url>]
+ [--service <service>]
+ [--enable | --disable]
+ <endpoint-id>
+
+.. option:: --region <region-id>
+
+ New endpoint region ID
+
+.. option:: --interface <interface>
+
+ New endpoint interface type (admin, public or internal)
+
+.. option:: --url <url>
+
+ New endpoint URL
+
+.. option:: --service <service>
+
+ New endpoint service (name or ID)
+
+.. option:: --enable
+
+ Enable endpoint
+
+.. option:: --disable
+
+ Disable endpoint
+
+.. _endpoint_set-endpoint:
+.. describe:: <endpoint-id>
+
+ Endpoint ID to modify
+
endpoint show
-------------
+Display endpoint details
+
.. program:: endpoint show
.. code:: bash
os endpoint show
- <endpoint_or_service-type>
+ <endpoint-id>
+
+.. _endpoint_show-endpoint:
+.. describe:: <endpoint-id>
+
+ Endpoint ID to display