project¶
project create¶
Usage
usage: symp project create
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--domain-id DOMAIN_ID] [--disabled]
[--description DESCRIPTION]
[--custom-project-id CUSTOM_PROJECT_ID]
name
Description
Create a new project in a domain.
Returns
Returns dict: Details of the project
Mandatory
positional arguments:
name Name of the new project
Optional
optional arguments:
-h, --help show this help message and exit
--domain-id DOMAIN_ID
Domain to create the project in
--disabled Whether the new project is disabled
--description DESCRIPTION
Description for the new project
--custom-project-id CUSTOM_PROJECT_ID
Force custom id for the created project
project delete¶
Usage
usage: symp project delete
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--force]
project_id
Description
Delete a project.
Mandatory
positional arguments:
project_id ID of project to delete
Optional
optional arguments:
-h, --help show this help message and exit
--force When provided by a system admin, skip resource validation
project get¶
Usage
usage: symp project get
[-h] [-f {adaptive_table,json,shell,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX] [-m [NAME=VALUE [NAME=VALUE ...]]]
project_id
Description
Get details of a project.
Returns
Returns dict: Details of the project
Mandatory
positional arguments:
project_id ID of project
Optional
optional arguments:
-h, --help show this help message and exit
project grant-group-role¶
Usage
usage: symp project grant-group-role
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
project_id group_id role_id
Description
Grant a group a role in a project (for LDAP use).
Mandatory
positional arguments:
project_id ID of project to grant role in
group_id ID of user to grant role to
role_id ID of the role to grant to the user
Optional
optional arguments:
-h, --help show this help message and exit
project grant-role¶
Usage
usage: symp project grant-role
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
project_id user_id role_id
Description
Grant a user a role in a project.
Mandatory
positional arguments:
project_id ID of project to grant role in
user_id ID of user to grant role to
role_id ID of the role to grant to the user
Optional
optional arguments:
-h, --help show this help message and exit
project list¶
Usage
usage: symp project list
[-h] [-f {adaptive_table,csv,json,table,value,yaml}] [-c COLUMN] [--max-width <integer>] [--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
[--domain-id DOMAIN_ID] [--parent-id PARENT_ID]
[--name NAME] [--enabled ENABLED]
Description
List projects in domain.
Returns
Returns list: List of projects
Optional
optional arguments:
-h, --help show this help message and exit
--domain-id DOMAIN_ID
Filters by a domain ID
--parent-id PARENT_ID
Filters the response by a parent ID
--name NAME Filters by a project name
--enabled ENABLED Filters by either enabled (true) or disabled (false) projects
project list-group-roles-on-project¶
Usage
usage: symp project list-group-roles-on-project
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN]
[--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
project_id group_id
Description
List group’s roles in a project.
Returns
Returns list: The roles the group has on the project
Mandatory
positional arguments:
project_id ID of project to list roles for
group_id ID of group to list roles for
Optional
optional arguments:
-h, --help show this help message and exit
project list-roles-on-project¶
Usage
usage: symp project list-roles-on-project
[-f {adaptive_table,csv,json,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent]
[--quote {all,minimal,none,nonnumeric}]
[-m [NAME=VALUE [NAME=VALUE ...]]]
project_id user_id
Description
List user’s roles in a project.
Returns
Returns list: The roles the user has on the project
Mandatory
positional arguments:
project_id ID of project to list roles for
user_id ID of user to list roles for
Optional
optional arguments:
-h, --help show this help message and exit
project revoke-group-role¶
Usage
usage: symp project revoke-group-role
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
project_id group_id role_id
Description
Revoke a group’s role from a project (for LDAP use).
Mandatory
positional arguments:
project_id ID of project to revoke role from
group_id ID of user to revoke role from
role_id ID of the role to revoke from the user
Optional
optional arguments:
-h, --help show this help message and exit
project revoke-role¶
Usage
usage: symp project revoke-role
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>]
[--noindent] [--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]]
project_id user_id role_id
Description
Revoke a user’s role from a project.
Mandatory
positional arguments:
project_id ID of project to revoke role from
user_id ID of user to revoke role from
role_id ID of the role to revoke from the user
Optional
optional arguments:
-h, --help show this help message and exit
project update¶
Usage
usage: symp project update
[-f {adaptive_table,json,shell,table,value,yaml}]
[-c COLUMN] [--max-width <integer>] [--noindent]
[--prefix PREFIX]
[-m [NAME=VALUE [NAME=VALUE ...]]] [--name NAME]
[--description DESCRIPTION] [--domain-id DOMAIN_ID]
[--enabled ENABLED]
project_id
Description
Update project’s attributes.
Returns
Returns dict: The project’s details after the update
Mandatory
positional arguments:
project_id ID of project to update
Optional
optional arguments:
-h, --help show this help message and exit
--name NAME The project's name
--description DESCRIPTION
The project's description
--domain-id DOMAIN_ID
The ID of the domain of the project
--enabled ENABLED Whether the project is enabled