python-openstackclient/doc/source/command-objects/endpoint.rst
Dean Troyer b56da8dde2 Add endpoint v3 docs
(update: change version description formats for API versioning)

Change-Id: I499ea1d80ad6ad6392468305f761e695d7261e33
2015-01-02 11:29:07 -06:00

3.0 KiB

endpoint

Identity v2, v3

endpoint create

Create new endpoint

Identity version 2 only

endpoint create

os 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

New endpoint service (name or ID)

Identity version 3 only

endpoint create

os 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>

New endpoint service (name or ID)

<interface>

New endpoint interface type (admin, public or internal)

<url>

New endpoint URL

endpoint delete

Delete endpoint

endpoint delete

os endpoint delete
    <endpoint-id>




Endpoint ID to delete

endpoint list

List endpoints

endpoint list

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

--service <service>

Filter by service

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

os 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 ID to modify

endpoint show

Display endpoint details

endpoint show

os endpoint show
    <endpoint-id>




Endpoint ID to display