The list elements command lists element information in Endevor
Usage
zowe endevor list elements [element] [options]
Positional Arguments
-
element (string)
- Name of the Endevor element
endevor-location definition options
-
--environment | --env (string)
- The Endevor environment where your project resides.
-
--system | --sys (string)
- The Endevor system where your project resides.
-
--subsystem | --sub (string)
- The Endevor subsystem where your project resides.
-
--type | --typ (string)
- Name of the Endevor element's type.
-
--stage-number | --sn (string)
-
The Endevor stage number where your project resides.
Allowed values: \*, \%, 1, 2
-
--maxrc (number)
- The return code of a failed action
-
--instance | -i (string)
- Specifies Endevor Web Services dataSource name.
options
-
--path | --pa (string)
-
--return | --ret (string)
-
--search | --sea (boolean)
- Enables the search through the Endevor map.
-
--data | --dat (string)
-
Allows to select the type of summary data returned in the element list (defaults to all).
Default value: all
Allowed values: all, bas, ele, comp
-
--where-ccid-current | --wcc (string)
- Instructs Endevor to search through the CCID fields in the Master Control File to find a specified CCIDs.
Accept up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-generate | --wcg (string)
- Instructs Endevor to search using the generate CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastact | --wcla (string)
- Instructs Endevor to search using the last action CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-lastlvl | --wcll (string)
- Instructs Endevor to search using the last level CCID associated with an Element.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-change | --wcchg (string)
- This option is only valid when the data option is ele or comp. Instructs Endevor to filter the results of the list data summary function that is based on the specified ccids.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-ccid-retrieve | --wcr (string)
- Instructs Endevor to use the CCID in the Master Control File RETRIEVE CCID field.
Accepts up to 8 CCIDs separated by ", ". Enclose CCIDs that contain special characters in quotes.
-
--where-proc-type | --wpt (string)
-
Lets you select Elements according to a specified Processor type.
Allowed values: GEN, GENERATE, MOV, MOVE, DEL, DELETE
-
--where-proc-group | --wpg (string)
- Lets you select Elements according to a specified Processor group. You can use a wildcard when specifying the Processor group name.
Accepts up to 8 Processor group names separated by ", ".
scl generation options
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 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)
-
--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