Menu Close

Chapter 48. project

This chapter describes the commands under the project command.

48.1. project create

Create new project

Usage:

openstack project create [-h] [-f {json,shell,table,value,yaml}]
                                [-c COLUMN] [--max-width <integer>]
                                [--fit-width] [--print-empty] [--noindent]
                                [--prefix PREFIX]
                                [--description <description>]
                                [--enable | --disable]
                                [--property <key=value>] [--or-show]
                                <project-name>

Table 48.1. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 48.2. Positional Arguments

ValueSummary

<project-name>

New project name

Table 48.3. Output Formatters

ValueSummary

output formatter options-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

ValueSummary

--noindent

Whether to disable indenting the json

Table 48.5. Optional Arguments

ValueSummary

--description <description>

Project description

--enable

Enable project (default)

--or-show

Return existing project

--property <key=value>

Add a property to <name> (repeat option to set multiple properties)

-h, --help

Show this help message and exit

--disable

Disable project

Table 48.6. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

48.2. project delete

Delete project(s)

Usage:

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

Table 48.7. Positional Arguments

ValueSummary

<project>

Project(s) to delete (name or id)

Table 48.8. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

48.3. project list

List projects

Usage:

openstack project list [-h] [-f {csv,json,table,value,yaml}]
                              [-c COLUMN] [--max-width <integer>]
                              [--fit-width] [--print-empty] [--noindent]
                              [--quote {all,minimal,none,nonnumeric}]
                              [--sort-column SORT_COLUMN] [--long]
                              [--sort <key>[:<direction>]]

Table 48.9. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 48.10. CSV Formatter

ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 48.11. Output Formatters

ValueSummary

output formatter options-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.12. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 48.13. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

--sort <key>[:<direction>]

Sort output by selected keys and directions (asc or desc) (default: asc), repeat this option to specify multiple keys and directions.

--long

List additional fields in output

48.4. project purge

Clean resources associated with a project

Usage:

openstack project purge [-h] [--dry-run] [--keep-project]
                               (--auth-project | --project <project>)
                               [--project-domain <project-domain>]

Table 48.14. Optional Arguments

ValueSummary

--auth-project

Delete resources of the project used to authenticate

--project <project>

Project to clean (name or id)

--dry-run

List a project’s resources

--keep-project

Clean project resources, but don’t delete the project

-h, --help

Show this help message and exit

--project-domain <project-domain>

Domain the project belongs to (name or id). this can be used in case collisions between project names exist.

48.5. project set

Set project properties

Usage:

openstack project set [-h] [--name <name>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             <project>

Table 48.15. Positional Arguments

ValueSummary

<project>

Project to modify (name or id)

Table 48.16. Optional Arguments

ValueSummary

--description <description>

Set project description

--enable

Enable project

--name <name>

Set project name

--property <key=value>

Set a project property (repeat option to set multiple properties)

-h, --help

Show this help message and exit

--disable

Disable project

48.6. project show

Display project details

Usage:

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

Table 48.17. Table Formatter

ValueSummary

--print-empty

Print empty table if there is no data to show.

--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

Table 48.18. Positional Arguments

ValueSummary

<project>

Project to display (name or id)

Table 48.19. Output Formatters

ValueSummary

output formatter options-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.20. JSON Formatter

ValueSummary

--noindent

Whether to disable indenting the json

Table 48.21. Optional Arguments

ValueSummary

-h, --help

Show this help message and exit

Table 48.22. Shell Formatter

ValueSummary

a format a UNIX shell can parse (variable="value")--prefix PREFIX

Add a prefix to all variable names

48.7. project unset

Unset project properties

Usage:

openstack project unset [-h] [--property <key>] <project>

Table 48.23. Positional Arguments

ValueSummary

<project>

Project to modify (name or id)

Table 48.24. Optional Arguments

ValueSummary

--property <key>

Unset a project property (repeat option to unset multiple properties)

-h, --help

Show this help message and exit