summaryrefslogtreecommitdiff
path: root/doc/source/cli/command-objects/endpoint.rst
blob: 030947c2291cd04dd3702fdff3cc6381e6f5893d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
========
endpoint
========

Identity v2, v3

endpoint add project
--------------------

Associate a project to and endpoint for endpoint filtering

.. program:: endpoint add project
.. code:: bash

    openstack endpoint add project
        [--project-domain <project-domain>]
        <endpoint>
        <project>

.. option:: --project-domain <project-domain>

    Domain the project belongs to (name or ID).
    This can be used in case collisions between project names exist.

.. _endpoint_add_project-endpoint:
.. describe:: <endpoint>

    Endpoint to associate with specified project (name or ID)

.. _endpoint_add_project-project:
.. describe:: <project>

    Project to associate with specified endpoint (name or ID)

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]
        [--endpoint <endpoint> |
        --project <project> [--project-domain <project-domain>]]

.. 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*

.. option:: --endpoint

    List projects that have access to that endpoint using
    endpoint filtering

    *Identity version 3 only*

.. option:: --project

    List endpoints available for the project using
    endpoint filtering

    *Identity version 3 only*

.. option:: --project-domain

    Domain the project belongs to (name or ID).
    This can be used in case collisions between project names exist.

    *Identity version 3 only*

endpoint remove project
-----------------------

Dissociate a project from an endpoint.

.. program:: endpoint remove project
.. code:: bash

    openstack endpoint remove project
        [--project-domain <project-domain>]
        <endpoint>
        <project>

.. option:: --project-domain <project-domain>

    Domain the project belongs to (name or ID).
    This can be used in case collisions between project names exist.

.. _endpoint_remove_project-endpoint:
.. describe:: <endpoint>

    Endpoint to dissociate with specified project (name or ID)

.. _endpoint_remove_project-project:
.. describe:: <project>

    Project to dissociate with specified endpoint (name or ID)

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)