Chapter 50. mapping

This chapter describes the commands under the mapping command.

50.1. mapping create

Create new mapping

Usage:

openstack mapping create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--noindent] [--prefix PREFIX]
                                [--max-width <integer>] [--fit-width]
                                [--print-empty] --rules <filename>
                                <name>

Table 50.1. Positional arguments

ValueSummary

<name>

New mapping name (must be unique)

Table 50.2. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--rules <filename>

Filename that contains a set of mapping rules (required)

Table 50.3. 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 50.4. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 50.5. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

50.2. mapping delete

Delete mapping(s)

Usage:

openstack mapping delete [-h] <mapping> [<mapping> ...]

Table 50.7. Positional arguments

ValueSummary

<mapping>

Mapping(s) to delete

Table 50.8. Command arguments

ValueSummary

-h, --help

Show this help message and exit

50.3. mapping list

List mappings

Usage:

openstack mapping 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 50.9. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 50.10. 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 50.11. CSV formatter options

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 50.12. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

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

50.4. mapping set

Set mapping properties

Usage:

openstack mapping set [-h] [--rules <filename>] <name>

Table 50.14. Positional arguments

ValueSummary

<name>

Mapping to modify

Table 50.15. Command arguments

ValueSummary

-h, --help

Show this help message and exit

--rules <filename>

Filename that contains a new set of mapping rules

50.5. mapping show

Display mapping details

Usage:

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

Table 50.16. Positional arguments

ValueSummary

<mapping>

Mapping to display

Table 50.17. Command arguments

ValueSummary

-h, --help

Show this help message and exit

Table 50.18. 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 50.19. JSON formatter options

ValueSummary

--noindent

Whether to disable indenting the json

Table 50.20. Shell formatter options

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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