Menu Close

Chapter 26. endpoint

This chapter describes the commands under the endpoint command.

26.1. endpoint create

Create new endpoint

Usage:

openstack endpoint create [-h] [-f {json,shell,table,value,yaml}]
                                 [-c COLUMN] [--max-width <integer>]
                                 [--fit-width] [--print-empty] [--noindent]
                                 [--prefix PREFIX] --publicurl <url>
                                 [--adminurl <url>] [--internalurl <url>]
                                 [--region <region-id>]
                                 <service>

Table 26.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 26.2. Positional Arguments

ValueSummary

<service>

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

Table 26.3. Output Formatters

ValueSummary

output formatter options-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

Table 26.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.5. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--region <region-id>

New endpoint region id

--internalurl <url>

New endpoint internal url

--publicurl <url>

New endpoint public url (required)

--adminurl <url>

New endpoint admin url

Table 26.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

26.2. endpoint delete

Delete endpoint(s)

Usage:

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

Table 26.7. Positional Arguments

ValueSummary

<endpoint-id>

Endpoint(s) to delete (id only)

Table 26.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

26.3. endpoint list

List endpoints

Usage:

openstack endpoint list [-h] [-f {csv,json,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--quote {all,minimal,none,nonnumeric}]
                               [--sort-column SORT_COLUMN] [--long]

Table 26.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 26.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 26.11. Output Formatters

ValueSummary

output formatter options-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

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

Table 26.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

26.4. endpoint show

Display endpoint details

Usage:

openstack endpoint show [-h] [-f {json,shell,table,value,yaml}]
                               [-c COLUMN] [--max-width <integer>]
                               [--fit-width] [--print-empty] [--noindent]
                               [--prefix PREFIX]
                               <endpoint>

Table 26.14. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

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

Table 26.15. Positional Arguments

ValueSummary

<endpoint>

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

Table 26.16. Output Formatters

ValueSummary

output formatter options-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

Table 26.17. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 26.18. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 26.19. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names