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. Command 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 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 58.4. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 58.5. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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. Command 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]
                             [--sort-ascending | --sort-descending] [--long]

Table 58.9. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--long

List additional fields in output

Table 58.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 58.11. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 58.12. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

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. Command 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. Command arguments
ValueSummary

-h, --help

Show this help message and exit

Table 58.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 58.19. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 58.20. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

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.