SupportConsoleDevelopersStart a trialContact

Chapter 60. project

This chapter describes the commands under the project command.

60.1. project cleanup

Clean resources associated with a project

Usage:

openstack project cleanup [-h] [--dry-run]
                                 (--auth-project | --project <project>)
                                 [--created-before <YYYY-MM-DDTHH24:MI:SS>]
                                 [--updated-before <YYYY-MM-DDTHH24:MI:SS>]
                                 [--project-domain <project-domain>]

Table 60.1. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--dry-run

List a project’s resources

--auth-project

Delete resources of the project used to authenticate

--project <project>

Project to clean (name or id)

--created-before <YYYY-MM-DDTHH24:MI:SS>

Drop resources created before the given time

--updated-before <YYYY-MM-DDTHH24:MI:SS>

Drop resources updated before the given time

--project-domain <project-domain>

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

60.2. project create

Create new project

Usage:

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

Table 60.2. Positional arguments
ValueSummary

<project-name>

New project name

Table 60.3. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning the project (name or id)

--parent <project>

Parent of the project (name or id)

--description <description>

Project description

--enable

Enable project

--disable

Disable project

--property <key=value>

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

--or-show

Return existing project

--immutable

Make resource immutable. an immutable project may not be deleted or modified except to remove the immutable flag

--no-immutable

Make resource mutable (default)

--tag <tag>

Tag to be added to the project (repeat option to set multiple tags)

Table 60.4. 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 60.5. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 60.6. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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

60.3. project delete

Delete project(s)

Usage:

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

Table 60.8. Positional arguments
ValueSummary

<project>

Project(s) to delete (name or id)

Table 60.9. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <project> (name or id)

60.4. project list

List projects

Usage:

openstack project 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]
                              [--domain <domain>] [--parent <parent>]
                              [--user <user>] [--my-projects] [--long]
                              [--sort <key>[:<direction>]]
                              [--tags <tag>[,<tag>,...]]
                              [--tags-any <tag>[,<tag>,...]]
                              [--not-tags <tag>[,<tag>,...]]
                              [--not-tags-any <tag>[,<tag>,...]]

Table 60.10. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Filter projects by <domain> (name or id)

--parent <parent>

Filter projects whose parent is <parent> (name or id)

--user <user>

Filter projects by <user> (name or id)

--my-projects

List projects for the authenticated user. supersedes other filters.

--long

List additional fields in output

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

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

--tags <tag>[,<tag>,…​]

List projects which have all given tag(s) (comma- separated list of tags)

--tags-any <tag>[,<tag>,…​]

List projects which have any given tag(s) (comma- separated list of tags)

--not-tags <tag>[,<tag>,…​]

Exclude projects which have all given tag(s) (comma- separated list of tags)

--not-tags-any <tag>[,<tag>,…​]

Exclude projects which have any given tag(s) (comma- separated list of tags)

Table 60.11. 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 60.12. CSV formatter options
ValueSummary

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

When to include quotes, defaults to nonnumeric

Table 60.13. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

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

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

-h, --help

Show this help message and exit

--dry-run

List a project’s resources

--keep-project

Clean project resources, but don’t delete the project

--auth-project

Delete resources of the project used to authenticate

--project <project>

Project to clean (name or id)

--project-domain <project-domain>

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

60.6. project set

Set project properties

Usage:

openstack project set [-h] [--name <name>] [--domain <domain>]
                             [--description <description>]
                             [--enable | --disable] [--property <key=value>]
                             [--immutable | --no-immutable] [--tag <tag>]
                             [--clear-tags] [--remove-tag <tag>]
                             <project>

Table 60.16. Positional arguments
ValueSummary

<project>

Project to modify (name or id)

Table 60.17. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--name <name>

Set project name

--domain <domain>

Domain owning <project> (name or id)

--description <description>

Set project description

--enable

Enable project

--disable

Disable project

--property <key=value>

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

--immutable

Make resource immutable. an immutable project may not be deleted or modified except to remove the immutable flag

--no-immutable

Make resource mutable (default)

--tag <tag>

Tag to be added to the project (repeat option to set multiple tags)

--clear-tags

Clear tags associated with the project. specify both --tag and --clear-tags to overwrite current tags

--remove-tag <tag>

Tag to be deleted from the project (repeat option to delete multiple tags)

60.7. project show

Display project details

Usage:

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

Table 60.18. Positional arguments
ValueSummary

<project>

Project to display (name or id)

Table 60.19. Command arguments
ValueSummary

-h, --help

Show this help message and exit

--domain <domain>

Domain owning <project> (name or id)

--parents

Show the project’s parents as a list

--children

Show project’s subtree (children) as a list

Table 60.20. 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 60.21. JSON formatter options
ValueSummary

--noindent

Whether to disable indenting the json

Table 60.22. Shell formatter options
ValueSummary

--prefix PREFIX

Add a prefix to all variable names

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