Chapter 13. catalog

This chapter describes the commands under the catalog command.

13.1. catalog list

List services in the service catalog

Usage:

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

Table 13.1. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.2. 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 13.3. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 13.4. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

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

13.2. catalog show

Display service catalog details

Usage:

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

Table 13.6. Positional arguments

ValueSummary

<service>

Service to display (type or name)

Table 13.7. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 13.8. 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 13.9. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 13.10. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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