Chapter 58. project
This chapter describes the commands under the project
command.
58.1. 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] [--tag <tag>] <project-name>
Value | Summary |
---|---|
<project-name> | New project name |
Value | Summary |
---|---|
-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 |
--tag <tag> | Tag to be added to the project (repeat option to set multiple tags) |
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 |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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. |
58.2. project delete
Delete project(s)
Usage:
openstack project delete [-h] [--domain <domain>] <project> [<project> ...]
Value | Summary |
---|---|
<project> | Project(s) to delete (name or id) |
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--domain <domain> | Domain owning <project> (name or id) |
58.3. 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] [--domain <domain>] [--user <user>] [--my-projects] [--long] [--sort <key>[:<direction>]] [--tags <tag>[,<tag>,...]] [--tags-any <tag>[,<tag>,...]] [--not-tags <tag>[,<tag>,...]] [--not-tags-any <tag>[,<tag>,...]]
Value | Summary |
---|---|
-h, --help | Show this help message and exit |
--domain <domain> | Filter projects by <domain> (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) |
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 |
Value | Summary |
---|---|
--quote {all,minimal,none,nonnumeric} | When to include quotes, defaults to nonnumeric |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
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. |
58.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>]
Value | Summary |
---|---|
-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. |
58.5. project set
Set project properties
Usage:
openstack project set [-h] [--name <name>] [--domain <domain>] [--description <description>] [--enable | --disable] [--property <key=value>] [--tag <tag>] [--clear-tags] [--remove-tag <tag>] <project>
Value | Summary |
---|---|
<project> | Project to modify (name or id) |
Value | Summary |
---|---|
-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) |
--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) |
58.6. 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>
Value | Summary |
---|---|
<project> | Project to display (name or id) |
Value | Summary |
---|---|
-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 |
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 |
Value | Summary |
---|---|
--noindent | Whether to disable indenting the json |
Value | Summary |
---|---|
--prefix PREFIX | Add a prefix to all variable names |
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. |