zowe › endevor › execute › package
The execute package command executes a Package that have a status of Approved or Execfailed.
Usage
zowe endevor execute package [package] [options]
Positional Arguments
-
package
(string)- Name of the Endevor package.
options
-
--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.
-
--status
|--st
(string)-
Specify the status of the packages. Valid values are [APPROVED, EXECFAILED] for execute action, and additional values [INEDIT, INAPPROVAL, INEXECUTION, EXECUTED, COMMITTED, DENIED] for list action, additional value [ALLSTATE] for delete action.
It is possible to specify multiple status separated by "," during list and delete package.Allowed values: ALLSTATE, INEDIT, INAPPROVAL, APPROVED, INEXECUTION, EXECUTED, COMMITTED, DENIED, EXECFAILED
-
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.
asynchronous task options
-
--asynchronous
|--async
(boolean)- Submit this command as an asynchronous Endevor Web Services task
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.
Note: The CLI does not support certificate files that require a password. For more information, search Troubleshooting PEM Certificates in Zowe Docs.
-
-
--cert-key-file
(local file path)- The file path to a certificate key file to use for authentication
Examples
-
Execute package with endevor profile set up, specifying the time frame within which to execute the Package:
zowe endevor execute package packageName --fdt 2018-01-01T00:00 --tdt 2018-12-31T12:00 -i ENDEVOR