Chapter 31. endpoint
This chapter describes the commands under the endpoint
command.
31.1. endpoint add project
Associate a project to an endpoint
Usage:
openstack endpoint add project [-h] [--project-domain <project-domain>] <endpoint> <project>
openstack endpoint add project [-h] [--project-domain <project-domain>]
<endpoint> <project>
Value | Summary |
---|---|
<endpoint> | Endpoint to associate with specified project (name or ID) |
<project> | Project to associate with specified endpoint name or ID) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
31.2. endpoint create
Create new endpoint
Usage:
openstack endpoint create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--region <region-id>] [--enable | --disable] <service> <interface> <url>
openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty] [--region <region-id>]
[--enable | --disable]
<service> <interface> <url>
Value | Summary |
---|---|
<service> | Service to be associated with new endpoint (name or ID) |
<interface> | New endpoint interface type (admin, public or internal) |
<url> | New endpoint url |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--region <region-id> | New endpoint region id |
--enable | Enable endpoint (default) |
--disable | Disable endpoint |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
31.3. endpoint delete
Delete endpoint(s)
Usage:
openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
openstack endpoint delete [-h] <endpoint-id> [<endpoint-id> ...]
Value | Summary |
---|---|
<endpoint-id> | Endpoint(s) to delete (id only) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
31.4. endpoint group add project
Add a project to an endpoint group
Usage:
openstack endpoint group add project [-h] [--project-domain <project-domain>] <endpoint-group> <project>
openstack endpoint group add project [-h]
[--project-domain <project-domain>]
<endpoint-group> <project>
Value | Summary |
---|---|
<endpoint-group> | Endpoint group (name or id) |
<project> | Project to associate (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
31.5. endpoint group create
Create new endpoint group
Usage:
openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] [--description DESCRIPTION] <name> <filename>
openstack endpoint group create [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
[--description DESCRIPTION]
<name> <filename>
Value | Summary |
---|---|
<name> | Name of the endpoint group |
<filename> | Filename that contains a new set of filters |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--description DESCRIPTION | Description of the endpoint group |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
31.6. endpoint group delete
Delete endpoint group(s)
Usage:
openstack endpoint group delete [-h] <endpoint-group> [<endpoint-group> ...]
openstack endpoint group delete [-h]
<endpoint-group> [<endpoint-group> ...]
Value | Summary |
---|---|
<endpoint-group> | Endpoint group(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
31.7. endpoint group list
List endpoint groups
Usage:
openstack endpoint group list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--endpointgroup <endpoint-group> | --project <project>] [--domain <domain>]
openstack endpoint group list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--endpointgroup <endpoint-group> | --project <project>]
[--domain <domain>]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--endpointgroup <endpoint-group> | Endpoint group (name or id) |
--project <project> | Project (name or id) |
--domain <domain> | Domain owning <project> (name or id) |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated to show multiple columns |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
--sort-ascending | Sort the column(s) in ascending order |
--sort-descending | Sort the column(s) in descending order |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
31.8. endpoint group remove project
Remove project from endpoint group
Usage:
openstack endpoint group remove project [-h] [--project-domain <project-domain>] <endpoint-group> <project>
openstack endpoint group remove project [-h]
[--project-domain <project-domain>]
<endpoint-group> <project>
Value | Summary |
---|---|
<endpoint-group> | Endpoint group (name or id) |
<project> | Project to remove (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
31.9. endpoint group set
Set endpoint group properties
Usage:
openstack endpoint group set [-h] [--name <name>] [--filters <filename>] [--description <description>] <endpoint-group>
openstack endpoint group set [-h] [--name <name>]
[--filters <filename>]
[--description <description>]
<endpoint-group>
Value | Summary |
---|---|
<endpoint-group> | Endpoint group to modify (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--name <name> | New enpoint group name |
--filters <filename> | Filename that contains a new set of filters |
--description <description> | New endpoint group description |
31.10. endpoint group show
Display endpoint group details
Usage:
openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <endpointgroup>
openstack endpoint group show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent]
[--prefix PREFIX] [--max-width <integer>]
[--fit-width] [--print-empty]
<endpointgroup>
Value | Summary |
---|---|
<endpointgroup> | Endpoint group (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
31.11. endpoint list
List endpoints
Usage:
openstack endpoint list [-h] [-f {csv,json,table,value,yaml}] [-c COLUMN] [--quote {all,minimal,none,nonnumeric}] [--noindent] [--max-width <integer>] [--fit-width] [--print-empty] [--sort-column SORT_COLUMN] [--sort-ascending | --sort-descending] [--service <service>] [--interface <interface>] [--region <region-id>] [--endpoint <endpoint-group> | --project <project>] [--project-domain <project-domain>]
openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
[-c COLUMN]
[--quote {all,minimal,none,nonnumeric}]
[--noindent] [--max-width <integer>]
[--fit-width] [--print-empty]
[--sort-column SORT_COLUMN]
[--sort-ascending | --sort-descending]
[--service <service>] [--interface <interface>]
[--region <region-id>]
[--endpoint <endpoint-group> | --project <project>]
[--project-domain <project-domain>]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--service <service> | Filter by service (type, name or id) |
--interface <interface> | Filter by interface type (admin, public or internal) |
--region <region-id> | Filter by region id |
--endpoint <endpoint-group> | Endpoint to list filters |
--project <project> | Project to list filters (name or id) |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
Value | Summary |
---|---|
-f {csv,json,table,value,yaml}, --format {csv,json,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated to show multiple columns |
--sort-column SORT_COLUMN | Specify the column(s) to sort the data (columns specified first have a priority, non-existing columns are ignored), can be repeated |
--sort-ascending | Sort the column(s) in ascending order |
--sort-descending | Sort the column(s) in descending order |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |
31.12. endpoint remove project
Dissociate a project from an endpoint
Usage:
openstack endpoint remove project [-h] [--project-domain <project-domain>] <endpoint> <project>
openstack endpoint remove project [-h]
[--project-domain <project-domain>]
<endpoint> <project>
Value | Summary |
---|---|
<endpoint> | Endpoint to dissociate from specified project (name or ID) |
<project> | Project to dissociate from specified endpoint name or ID) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--project-domain <project-domain> | Domain the project belongs to (name or id). this can be used in case collisions between project names exist. |
31.13. endpoint set
Set endpoint properties
Usage:
openstack endpoint set [-h] [--region <region-id>] [--interface <interface>] [--url <url>] [--service <service>] [--enable | --disable] <endpoint-id>
openstack endpoint set [-h] [--region <region-id>]
[--interface <interface>] [--url <url>]
[--service <service>] [--enable | --disable]
<endpoint-id>
Value | Summary |
---|---|
<endpoint-id> | Endpoint to modify (id only) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--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 |
31.14. endpoint show
Display endpoint details
Usage:
openstack endpoint show [-h] [-f {json,shell,table,value,yaml}] [-c COLUMN] [--noindent] [--prefix PREFIX] [--max-width <integer>] [--fit-width] [--print-empty] <endpoint>
openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
[-c COLUMN] [--noindent] [--prefix PREFIX]
[--max-width <integer>] [--fit-width]
[--print-empty]
<endpoint>
Value | Summary |
---|---|
<endpoint> | Endpoint to display (endpoint id, service id, service name, service type) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
Value | Summary |
---|---|
-f {json,shell,table,value,yaml}, --format {json,shell,table,value,yaml} | The output format, defaults to table |
-c COLUMN, --column COLUMN | Specify the column(s) to include, can be repeated to show multiple columns |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
Value | Summary |
---|---|
--max-width <integer> | Maximum display width, <1 to disable. you can also use the CLIFF_MAX_TERM_WIDTH environment variable, but the parameter takes precedence. |
--fit-width | Fit the table to the display width. implied if --max- width greater than 0. Set the environment variable CLIFF_FIT_WIDTH=1 to always enable |
--print-empty | Print empty table if there is no data to show. |