python-openstackclient/doc/source/command-objects/endpoint.rst
Stephen Finucane 70170656fd doc: Correct Sphinx warnings
- Fix option-describe typos
- Correct option and envvar markup, for commands that are using the
  reference form instead of the definition form or are marking up
  option arguments as options
- Avoid duplicate commands
- Fix some invalid docstrings
- Fix some invalid indentation
- Disable the murano plugin, which has invalid docs
- Correct issues with- and track the network-topology spec
- Include API modules in docs

Change-Id: I3d5ed5e872540fe13f3e4bd5e9335829dc9a5226
2017-03-28 16:41:54 +01:00

3.2 KiB

endpoint

Identity v2, v3

endpoint create

Create new endpoint

Identity version 2 only

endpoint create (v2)

openstack endpoint create
    --publicurl <url>
    [--adminurl <url>]
    [--internalurl <url>]
    [--region <region-id>]
    <service>

--publicurl <url>

New endpoint public URL (required)

--adminurl <url>

New endpoint admin URL

--internalurl <url>

New endpoint internal URL

--region <region-id>

New endpoint region ID

Service to be associated with new endpoint (name or ID)

Identity version 3 only

endpoint create (v3)

openstack endpoint create
    [--region <region-id>]
    [--enable | --disable]
    <service>
    <interface>
    <url>

--region <region-id>

New endpoint region ID

--enable

Enable endpoint (default)

--disable

Disable endpoint

<service>

Service to be associated with new endpoint(name or ID)

<interface>

New endpoint interface type (admin, public or internal)

<url>

New endpoint URL

endpoint delete

Delete endpoint(s)

endpoint delete

openstack endpoint delete
    <endpoint-id> [<endpoint-id> ...]




Endpoint(s) to delete (ID only)

endpoint list

List endpoints

endpoint list

openstack endpoint list
    [--service <service>]
    [--interface <interface>]
    [--region <region-id>]
    [--long]

--service <service>

Filter by service (type, name or ID)

Identity version 3 only

--interface <interface>

Filter by interface type (admin, public or internal)

Identity version 3 only

--region <region-id>

Filter by region ID

Identity version 3 only

--long

List additional fields in output

Identity version 2 only

endpoint set

Set endpoint properties

Identity version 3 only

endpoint set

openstack endpoint set
    [--region <region-id>]
    [--interface <interface>]
    [--url <url>]
    [--service <service>]
    [--enable | --disable]
    <endpoint-id>

--region <region-id>

New endpoint region ID

--interface <interface>

New endpoint interface type (admin, public or internal)

--url <url>

New endpoint URL

--service <service>

New endpoint service (name or ID)

--enable

Enable endpoint

--disable

Disable endpoint

Endpoint to modify (ID only)

endpoint show

Display endpoint details

endpoint show

openstack endpoint show
    <endpoint>




Endpoint to display (endpoint ID, service ID, service name, service type)