sked artifacts user-role

Manage the retrieval and deployment of user roles.

Overview

Manage the retrieval and deployment of user roles.

$ sked artifact user-role <command>

Commands

Command Description
Create Create a user role from a state file [deprecated, use upsert instead]
Delete Delete a user role
Get Get the state file off a user role.
List List the existing user roles
Update Update a user role from a state file [deprecated, use upsert instead]
Upsert Create or Update a user rolee from a state file

Create

Description

Create a user role from a state file.

Usage 

  $ sked artifacts user-role create -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename= The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the user role. No

Global flags

Flag Description Required
--json Format output as json. No

Delete

Description

Delete a user role from a parent object (standard or custom).

Usage 

  $ sked artifacts user-role delete [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
--name=<value> The name of the user role. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No

Global flags

Flag Description Required
--json Format output as json. No

Get

Description

Get the state of a user role

Usage 

  $ sked artifacts user-role get --name <value> [--json] [-o <value>] [-a <value>]

Flags

Flag Description Required
--name The name of the user role. Yes
-a, --alias The alias to use to authenticate. No
-o, --outputdir The output directory. No

Global flags

Flag Description Required
--json Format output as json. No

List

Description

List the existing user role

Usage 

  $ sked artifacts user-role list [--json] [--columns <value> | -x] [--filter <value>] [--no-header | [--csv | --no-truncate]] [--output csv|json|yaml |  | ] [--sort <value>] [-a <value>]

Flags

Flag Description Required
-a, --alias=<value> The alias to use to authenticate. No
-x, --extended Show extra columns. No
--columns=<value> Only show provided columns (comma-separated). No
--csv Output is CSV format [alias: --output=csv]. No
--filter=<value> Filter property by partial string matching, ex: name=foo. No
--no-header Hide table header from output. No
--no-truncate Do not truncate output to fit screen. No
--output=<option> Output in a more machine-friendly format. <options: csv|json|yaml>. No
--sort=<value> Property to sort by (prepend ‘-’ for descending). No

Global flags

Flag Description Required
--json Format output as json. No

Update

Description

Update a user role from a state file [deprecated, use upsert instead]

Usage 

  $ sked artifacts user-role update -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the user role. No

Global flags

Flag Description Required
--json Format output as json. No

Upsert

Description

Create or Update a user role from a state file

Usage 

  $ sked artifacts user-role upsert -f <value> [--json] [-a <value>] [-w <value>] [--name <value>]

Flags

Flag Description Required
-f, --filename=<value> The state file. Yes
-a, --alias=<value> The alias to use to authenticate. No
-w, --wait=<value> [default: 900] Number of seconds to wait for the command to complete and display results to the terminal window. No
--name=<value> The name of the user role. No

Global flags

Flag Description Required
--json Format output as json. No