Search
SupportConsoleDevelopersStart a trialContact

Chapter 31. endpoint

download PDF

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>

Table 31.1. Positional arguments
ValueSummary

<endpoint>

Endpoint to associate with specified project (name or ID)

<project>

Project to associate with specified endpoint name or ID)

Table 31.2. Command arguments
ValueSummary

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

Table 31.3. Positional arguments
ValueSummary

<service>

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

<interface>

New endpoint interface type (admin, public or internal)

<url>

New endpoint url

Table 31.4. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--region <region-id>

New endpoint region id

--enable

Enable endpoint (default)

--disable

Disable endpoint

Table 31.5. Output formatter options
ValueSummary

-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

Table 31.6. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 31.7. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 31.8. Table formatter options
ValueSummary

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

Table 31.9. Positional arguments
ValueSummary

<endpoint-id>

Endpoint(s) to delete (id only)

Table 31.10. Command arguments
ValueSummary

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

Table 31.11. Positional arguments
ValueSummary

<endpoint-group>

Endpoint group (name or id)

<project>

Project to associate (name or id)

Table 31.12. Command arguments
ValueSummary

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

Table 31.13. Positional arguments
ValueSummary

<name>

Name of the endpoint group

<filename>

Filename that contains a new set of filters

Table 31.14. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--description DESCRIPTION

Description of the endpoint group

Table 31.15. Output formatter options
ValueSummary

-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

Table 31.16. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 31.17. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 31.18. Table formatter options
ValueSummary

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

Table 31.19. Positional arguments
ValueSummary

<endpoint-group>

Endpoint group(s) to delete (name or id)

Table 31.20. Command arguments
ValueSummary

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

Table 31.21. Command arguments
ValueSummary

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

Table 31.22. Output formatter options
ValueSummary

-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

Table 31.23. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 31.24. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 31.25. Table formatter options
ValueSummary

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

Table 31.26. Positional arguments
ValueSummary

<endpoint-group>

Endpoint group (name or id)

<project>

Project to remove (name or id)

Table 31.27. Command arguments
ValueSummary

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

Table 31.28. Positional arguments
ValueSummary

<endpoint-group>

Endpoint group to modify (name or id)

Table 31.29. Command arguments
ValueSummary

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

Table 31.30. Positional arguments
ValueSummary

<endpointgroup>

Endpoint group (name or id)

Table 31.31. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 31.32. Output formatter options
ValueSummary

-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

Table 31.33. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 31.34. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 31.35. Table formatter options
ValueSummary

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

Table 31.36. Command arguments
ValueSummary

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

Table 31.37. Output formatter options
ValueSummary

-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

Table 31.38. CSV formatter options
ValueSummary

--quote {all,minimal,none,nonnumeric}

When to include quotes, defaults to nonnumeric

Table 31.39. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 31.40. Table formatter options
ValueSummary

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

Table 31.41. Positional arguments
ValueSummary

<endpoint>

Endpoint to dissociate from specified project (name or ID)

<project>

Project to dissociate from specified endpoint name or ID)

Table 31.42. Command arguments
ValueSummary

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

Table 31.43. Positional arguments
ValueSummary

<endpoint-id>

Endpoint to modify (id only)

Table 31.44. Command arguments
ValueSummary

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

Table 31.45. Positional arguments
ValueSummary

<endpoint>

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

Table 31.46. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 31.47. Output formatter options
ValueSummary

-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

Table 31.48. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 31.49. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 31.50. Table formatter options
ValueSummary

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

Red Hat logoGithubRedditYoutubeTwitter

Learn

Try, buy, & sell

Communities

About Red Hat Documentation

We help Red Hat users innovate and achieve their goals with our products and services with content they can trust.

Making open source more inclusive

Red Hat is committed to replacing problematic language in our code, documentation, and web properties. For more details, see the Red Hat Blog.

About Red Hat

We deliver hardened solutions that make it easier for enterprises to work across platforms and environments, from the core datacenter to the network edge.

© 2024 Red Hat, Inc.