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

Table 50.4. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 50.5. Shell Formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

Table 50.6. Table Formatter
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. Optional 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]

Table 50.9. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 50.10. Output Formatters
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

--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 50.11. CSV Formatter
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 50.12. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 50.13. Table Formatter
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. Optional 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. Optional Arguments
ValueSummary

-h, --help

Show this help message and exit

Table 50.18. Output Formatters
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

Table 50.19. JSON Formatter
ValueSummary

--noindent

Whether to disable indenting the json

Table 50.20. Shell Formatter
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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