zowe › endevor › create › package🖨️

The create package command lets you create a package in Endevor.

Usage

zowe endevor create package [package] [options]

Positional Arguments

• package (string)

  • Name of the Endevor package.

input sources options

• --from-file | --ff (string)

  • Use this input to provide source file.

• --from-dataset | --fd (string)

  • Use this input to provide source data set name.

• --from-member | --fm (string)

  • Use this input to provide source member name in the data set.

• --from-package | --fp (string)

  • Directs the Create/Update action to copy the SCL from the package you specify into the package you are creating or updating.

• --from-text | --ft (string)

  • Provides a string to use as input SCL.

options

• --description | -d (string)

  • Allows you to associate a 50-character description when creating or updating package.

• --from-date-time | --fdt (string)

  • Specify the beginning of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.

• --to-date-time | --tdt (string)

  • Specify the end of time frame within which the package can be executed. Use yyyy-mm-ddThh:mm or see ISO 8601 standard for syntax.

• --backout (boolean)

  • Set this option to false (or specify --no-backout) if you don't want to have the backout facility available for this package. By default backout is enabled.

    Default value: true

• --notes | -n (string)

  • Notes for package.

• --notes-from-file | --nff (string)

  • Local file of notes for package.

• --emergency-package | --ep (boolean)

  • Specify if the package should be an emergency package. When not specified, the package is a standard package.

• --sharable | --sh (boolean)

  • Specify this option if the package can be edited by more than one person when in In-edit status.

• --promotion | --pr (boolean)

  • Specify this option to define the package as a promotion package.

• --validate-scl | --vs (boolean)

  • Set this option to false (or specify --no-validate-scl) to skip validion of the package components while creating a package. By default the SCL is validated

    Default value: true

endevor-location definition options

• --maxrc (number)

  • The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the command fails

    Default value: 8

• --instance | -i (string)

  • Specifies Endevor Web Services dataSource name.

endevor session definition options

• --host | --hostname (string)

  • Specifies the base host name.

• --port | -p (string)

  • Specifies the port number.

• --protocol | --prot (string)

  • Specifies the protocol used for connecting to Endevor Rest API

    Default value: https
    Allowed values: http, https

• --user | --username (string)

  • Specifies the user name.

• --password | --pass (string)

  • Specifies the user's password.

• --reject-unauthorized | --ru (boolean)

  • Specify this option to have the server certificate verified against the list of supplied CAs

• --base-path | --bp (string)

  • Specifies the base path used for connecting to Endevor Rest API

output customization options

• --suppress-messages | --sm (boolean)

  • Suppress all [INFO]/[WARN] messages from terminal output.

• --report-file | --file-name (string)

  • File name for saving reports from Endevor SCM locally.

• --report-dir (string)

  • Directory for saving reports from Endevor SCM locally, if --report-file wasn't specified. Defaults to current directory.

• --write-report (boolean)

  • Write the endevor reports to a file. By default, when return code is 0, no report will be written, unless this option is specified. When return code is bigger than 0, reports will be written to a file, unless this option is specifed to be false

Profile Options

• --endevor-profile | --endevor-p (string)

  • The name of a (endevor) profile to load for this command execution.

• --endevor-location-profile | --endevor-location-p (string)

  • The name of a (endevor-location) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Examples

• Create package from local file with endevor profile set up:

  • zowe endevor create package packageName -d "package description" --ff localfile.txt -i ENDEVOR Copy