Synopsis
fcli ssc appversion create [--auto-required-attrs] [--[no-]refresh] [--skip-if-exists] [--active=<active>] [-d=<description>] [--delim=<delimiter>] [--issue-template=<issueTemplateNameOrId>] [--refresh-timeout=<timeoutPeriod>] [--add-users=<authEntitySpecs>[, <authEntitySpecs>…]]… [--attrs=ATTR=VALUE[, ATTR=VALUE…]]… [[-h] [--env-prefix=<envPrefix>] [--log-file=<logFile>] [--log-level=<logLevel>]] [[--session=<sessionName>]] ] [--store=_variableName[=<propertyNames>]] [--to-file=<outputFile>]] [--from=<appVersionNameOrId> [--copy=<copyOptions>[, <copyOptions>…]]…] <app>:<version>
Description
This command allows for creating a new SSC application version, optionally skipping creation if the application version already exists (see --skip-if-exists option), and/or copying configuration and state of an existing application version (see --copy and --copy-from options).
Note that depending on user and token permissions, SSC may reject some of the application version configuration settings. In particular, user access permissions as specified through the --add-users option or when copying an existing application version may not be applied if the fcli session was created using a CIToken.
Options
- --active=<active>
-
Specify whether application version should be activated (true, default) or not (false).
- --add-users=<authEntitySpecs>[,<authEntitySpecs>…]
-
Assign one or more (comma-separated) users or LDAP groups to the application version; accepts user id, entity name or email address. Option is repeatable.
- --attrs, --attributes=ATTR=VALUE[,ATTR=VALUE…]
-
Example: ATTR1=[VAL1;VAL2],CATEGORY:ATTR2=VAL3
Set values for one or more attributes. This option accepts a comma-separated list of KEY=VALUE assignments.
Each KEY accepts either the Attribute’s GUID or its Name with the optional Category (InfoClassification or "BUSINESS:Data Classification" or "Data Classification")
Each VALUE accepts a semicolon-separated list of Attribute’s Values, encapsulated in brackets (optional for single value)
- --auto-required-attrs
-
Automatically set a default value for required application version attributes.
- --copy=<copyOptions>[,<copyOptions>…]
-
Comma separated list of elements to copy (Requires --copy-from). By default, all are copied. Allowed values: custom-tags, bugtracker, BugTrackerConfiguration, processing-rules, AnalysisProcessingRules, attributes, users, state. The BugTrackerConfiguration and AnalysisProcessingRules values are deprecated and will be removed in a future fcli version.
- -d, --description=<description>
-
Application version description.
- --delim=<delimiter>
-
Change the default delimiter character when using options that accept "application:version" as an argument or parameter.
- --from, --copy-from=<appVersionNameOrId>
-
Copy FROM application version:
id or <application>:<version> name.
- --issue-template=<issueTemplateNameOrId>
-
Issue template name or id.
- --[no-]refresh
-
By default, this command will refresh the source application version’s metrics when copying from it. Note that for large applications this can lead to an error if the timeout expires.
- --refresh-timeout=<timeoutPeriod>
-
Time-out, for example 30s (30 seconds), 5m (5 minutes), 1h (1 hour). Default value: 60s
- --skip-if-exists
-
Skip application version creation if an application version with the specified name already exists.
Session options
- --session=<sessionName>
-
Name of the SSC session to use for executing this command. Default value: default.
Output options
- -o, --output=format[=<options>]
-
Specify output format and options. Available output formats: csv, csv-plain, json, json-flat, table, table-plain, tree, tree-flat, xml, xml-flat, yaml, yaml-flat, expr, json-properties. The 'expr' output format takes a string containing '{property}' placeholders, other output formats take an optional, comma-separated list of properties to include in the output. Use '-o json-properties' on the current command to see available properties.
- --store=variableName[=<propertyNames>]
-
Store the JSON results of this command in a variable. Variables can be managed through the 'fcli util variable' command, and can be referenced using ::variable::[property] on any subsequent command.
- --to-file=<outputFile>
-
Write command output to the specified file instead of stdout.
Generic fcli options
- --env-prefix=<envPrefix>
-
Environment variable prefix for resolving default option and parameter values. Default value is FCLI_DEFAULT.
- -h, --help
-
Show this help message and exit. Use 'fcli <command> -h' to display help for subcommands.
- --log-file=<logFile>
-
File where logging data will be written. Defaults to fcli.log in current directory if --log-level is specified.
- --log-level=<logLevel>
-
Set logging level. Note that DEBUG and TRACE levels may result in sensitive data being written to the log file. Allowed values: TRACE, DEBUG, INFO, WARN, ERROR.