From 9599ffe65d9dcd4b3aa780d346eccd1e760890bf Mon Sep 17 00:00:00 2001 From: Doug Hellmann Date: Tue, 13 Jun 2017 15:55:33 -0400 Subject: 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 --- doc/source/cli/command-objects/endpoint.rst | 196 ++++++++++++++++++++++++++++ 1 file changed, 196 insertions(+) create mode 100644 doc/source/cli/command-objects/endpoint.rst (limited to 'doc/source/cli/command-objects/endpoint.rst') diff --git a/doc/source/cli/command-objects/endpoint.rst b/doc/source/cli/command-objects/endpoint.rst new file mode 100644 index 00000000..02a75bea --- /dev/null +++ b/doc/source/cli/command-objects/endpoint.rst @@ -0,0 +1,196 @@ +======== +endpoint +======== + +Identity v2, v3 + +endpoint create +--------------- + +Create new endpoint + +*Identity version 2 only* + +.. program:: endpoint create (v2) +.. code:: bash + + openstack endpoint create + --publicurl + [--adminurl ] + [--internalurl ] + [--region ] + + +.. option:: --publicurl + + New endpoint public URL (required) + +.. option:: --adminurl + + New endpoint admin URL + +.. option:: --internalurl + + New endpoint internal URL + +.. option:: --region + + New endpoint region ID + +.. _endpoint_create-endpoint: +.. describe:: + + Service to be associated with new endpoint (name or ID) + +*Identity version 3 only* + +.. program:: endpoint create (v3) +.. code:: bash + + openstack endpoint create + [--region ] + [--enable | --disable] + + + + +.. option:: --region + + New endpoint region ID + +.. option:: --enable + + Enable endpoint (default) + +.. option:: --disable + + Disable endpoint + +.. describe:: + + Service to be associated with new endpoint(name or ID) + +.. describe:: + + New endpoint interface type (admin, public or internal) + +.. describe:: + + New endpoint URL + +endpoint delete +--------------- + +Delete endpoint(s) + +.. program:: endpoint delete +.. code:: bash + + openstack endpoint delete + [ ...] + +.. _endpoint_delete-endpoint: +.. describe:: + + Endpoint(s) to delete (ID only) + +endpoint list +------------- + +List endpoints + +.. program:: endpoint list +.. code:: bash + + openstack endpoint list + [--service ] + [--interface ] + [--region ] + [--long] + +.. option:: --service + + Filter by service (type, name or ID) + + *Identity version 3 only* + +.. option:: --interface + + Filter by interface type (admin, public or internal) + + *Identity version 3 only* + +.. option:: --region + + 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 ] + [--interface ] + [--url ] + [--service ] + [--enable | --disable] + + +.. option:: --region + + New endpoint region ID + +.. option:: --interface + + New endpoint interface type (admin, public or internal) + +.. option:: --url + + New endpoint URL + +.. option:: --service + + New endpoint service (name or ID) + +.. option:: --enable + + Enable endpoint + +.. option:: --disable + + Disable endpoint + +.. _endpoint_set-endpoint: +.. describe:: + + Endpoint to modify (ID only) + +endpoint show +------------- + +Display endpoint details + +.. program:: endpoint show +.. code:: bash + + openstack endpoint show + + +.. _endpoint_show-endpoint: +.. describe:: + + Endpoint to display (endpoint ID, service ID, service name, service type) -- cgit v1.2.1