Chapter 58. policy

This chapter describes the commands under the policy command.

58.1. policy create

Create new policy

Usage:

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

Table 58.1. Positional Arguments

ValueSummary

<filename>

New serialized policy rules file

Table 58.2. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

New mime type of the policy rules file (defaults to application/json)

Table 58.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 58.4. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 58.5. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

58.2. policy delete

Delete policy(s)

Usage:

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

Table 58.7. Positional Arguments

ValueSummary

<policy>

Policy(s) to delete

Table 58.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

58.3. policy list

List policies

Usage:

openstack policy 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] [--long]

Table 58.9. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 58.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 58.11. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 58.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

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

58.4. policy set

Set policy properties

Usage:

openstack policy set [-h] [--type <type>] [--rules <filename>] <policy>

Table 58.14. Positional Arguments

ValueSummary

<policy>

Policy to modify

Table 58.15. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--type <type>

New mime type of the policy rules file

--rules <filename>

New serialized policy rules file

58.5. policy show

Display policy details

Usage:

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

Table 58.16. Positional Arguments

ValueSummary

<policy>

Policy to display

Table 58.17. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 58.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 58.19. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 58.20. Shell Formatter

ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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