summaryrefslogtreecommitdiff
path: root/doc/source/command-objects/endpoint.rst
diff options
context:
space:
mode:
authorDoug Hellmann <doug@doughellmann.com>2017-06-13 15:55:33 -0400
committerAndreas Jaeger <aj@suse.com>2017-06-23 11:54:32 +0200
commit9599ffe65d9dcd4b3aa780d346eccd1e760890bf (patch)
tree9281e521e50b8bed66eca087bc11fa03adf2aed3 /doc/source/command-objects/endpoint.rst
parent19c8cabeca1ea3c83da734ab5269318b27eb5634 (diff)
downloadpython-openstackclient-9599ffe65d9dcd4b3aa780d346eccd1e760890bf.tar.gz
reorganize existing documentation according to the new standard layout
Move existing content around based on the doc-migration specification. Replace :doc: markup with :ref: to have sphinx keep track of where the files move and generate valid hyperlinks. Add a few toctrees and index pages for the new directories. Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Change-Id: I253ee8f89d3ec40e39310c18bb87ed1d3d5de330 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
Diffstat (limited to 'doc/source/command-objects/endpoint.rst')
-rw-r--r--doc/source/command-objects/endpoint.rst196
1 files changed, 0 insertions, 196 deletions
diff --git a/doc/source/command-objects/endpoint.rst b/doc/source/command-objects/endpoint.rst
deleted file mode 100644
index 02a75bea..00000000
--- a/doc/source/command-objects/endpoint.rst
+++ /dev/null
@@ -1,196 +0,0 @@
-========
-endpoint
-========
-
-Identity v2, v3
-
-endpoint create
----------------
-
-Create new endpoint
-
-*Identity version 2 only*
-
-.. program:: endpoint create (v2)
-.. code:: bash
-
- openstack 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>
-
- Service to be associated with new endpoint (name or ID)
-
-*Identity version 3 only*
-
-.. program:: endpoint create (v3)
-.. code:: bash
-
- openstack endpoint create
- [--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>
-
- Service to be associated with new endpoint(name or ID)
-
-.. describe:: <interface>
-
- New endpoint interface type (admin, public or internal)
-
-.. describe:: <url>
-
- New endpoint URL
-
-endpoint delete
----------------
-
-Delete endpoint(s)
-
-.. program:: endpoint delete
-.. code:: bash
-
- openstack endpoint delete
- <endpoint-id> [<endpoint-id> ...]
-
-.. _endpoint_delete-endpoint:
-.. describe:: <endpoint-id>
-
- Endpoint(s) to delete (ID only)
-
-endpoint list
--------------
-
-List endpoints
-
-.. program:: endpoint list
-.. code:: bash
-
- openstack endpoint list
- [--service <service>]
- [--interface <interface>]
- [--region <region-id>]
- [--long]
-
-.. option:: --service <service>
-
- Filter by service (type, name or ID)
-
- *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
-
- openstack 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 to modify (ID only)
-
-endpoint show
--------------
-
-Display endpoint details
-
-.. program:: endpoint show
-.. code:: bash
-
- openstack endpoint show
- <endpoint>
-
-.. _endpoint_show-endpoint:
-.. describe:: <endpoint>
-
- Endpoint to display (endpoint ID, service ID, service name, service type)