zowe › endevor › list › packages🖨️

The list packages command lists package information in Endevor

Usage

zowe endevor list packages [package] [options]

Positional Arguments

• package (string)

  • Name of the Endevor package.

options

• --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

• --type | -t (string)

  • Specify the package type, where S = STANDARD and E = EMERGENCY, by default S is used.

    Allowed values: S, E

• --enterprise | --ent (string)

  • Specify to filter the list by enterprise Package parameter. A - All, E - Enterprise, X - eXclude.

    Allowed values: A, E, X

• --promotion-status | --ps (string)

  • Specify to filter the list by promotion Package parameter. A - All, P - Promotion, X - eXclude.

    Allowed values: A, P, X

• --prom-target-env | --pte (string)

  • Promotion target environment. Specifies the promotion package target environment. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.

• --prom-target-stgID | --pts (string)

  • Promotion target stage ID. Specifies the promotion package target stage ID. This field only applies to promotion packages and can only be specified when the promotion package type is A or P.

• --approver | --apr (string)

  • Specifies a one to eight character approver ID. Only one approver ID can be specified and name masking is not supported.

output customization options

• --full-output | --fo (boolean)

  • Specify this option if you want a full output of list action.

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

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

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

  • File name for saving output messages from Endevor locally.

endevor-location definition options

• --maxrc (number)

  • The return code of a failed action

• --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

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

Response Format Options

• --response-format-filter | --rff (array)

  • Filter (include) fields in the response. Accepts an array of field/property names to include in the output response. You can filter JSON objects properties OR table columns/fields. In addition, you can use this option in conjunction with '--response-format-type' to reduce the output of a command to a single field/property or a list of a single field/property.

• --response-format-type | --rft (string)

  • The command response output format type. Must be one of the following:

    table: Formats output data as a table. Use this option when the output data is an array of homogeneous JSON objects. Each property of the object will become a column in the table.

    list: Formats output data as a list of strings. Can be used on any data type (JSON objects/arrays) are stringified and a new line is added after each entry in an array.

    object: Formats output data as a list of prettified objects (or single object). Can be used in place of "table" to change from tabular output to a list of prettified objects.

    string: Formats output data as a string. JSON objects/arrays are stringified.

    Allowed values: table, list, object, string

• --response-format-header | --rfh (boolean)

  • If "--response-format-type table" is specified, include the column headers in the output.

Examples

• List all packages in Endevor with endevor profile set up:

  • zowe endevor list packages -i ENDEVOR Copy