Chapter 48. mapping
This chapter describes the commands under the mapping command.
48.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 48.1. Positional arguments
| Value | Summary |
|---|---|
| <name> | New mapping name (must be unique) |
Table 48.2. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --rules <filename> | Filename that contains a set of mapping rules (required) |
Table 48.3. Output formatter options
| Value | Summary |
|---|---|
| -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 48.4. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 48.5. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 48.6. Table formatter options
| Value | Summary |
|---|---|
| --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. |
48.2. mapping delete
Delete mapping(s)
Usage:
openstack mapping delete [-h] <mapping> [<mapping> ...]
Table 48.7. Positional arguments
| Value | Summary |
|---|---|
| <mapping> | Mapping(s) to delete |
Table 48.8. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
48.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 48.9. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 48.10. Output formatter options
| Value | Summary |
|---|---|
| -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 48.11. CSV formatter options
| Value | Summary |
|---|---|
| --quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Table 48.12. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 48.13. Table formatter options
| Value | Summary |
|---|---|
| --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. |
48.4. mapping set
Set mapping properties
Usage:
openstack mapping set [-h] [--rules <filename>] <name>
Table 48.14. Positional arguments
| Value | Summary |
|---|---|
| <name> | Mapping to modify |
Table 48.15. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
| --rules <filename> | Filename that contains a new set of mapping rules |
48.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 48.16. Positional arguments
| Value | Summary |
|---|---|
| <mapping> | Mapping to display |
Table 48.17. Command arguments
| Value | Summary |
|---|---|
| -h, --help | Show this help message and exit |
Table 48.18. Output formatter options
| Value | Summary |
|---|---|
| -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 48.19. JSON formatter options
| Value | Summary |
|---|---|
| --noindent | Whether to disable indenting the json |
Table 48.20. Shell formatter options
| Value | Summary |
|---|---|
| --prefix PREFIX | Add a prefix to all variable names |
Table 48.21. Table formatter options
| Value | Summary |
|---|---|
| --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. |
