## zowe › endevor › list › elements

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

#### options

- `--path` | `--pa` (string)

  - Specifies a PHYsical or LOGical path.

    Allowed values: log, phy

- `--return` | `--ret` (string)

  - Sets mapping options for returned results: return FIRst match or ALL matching results.

    Allowed values: fir, all

- `--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:
    ALL - Full element information
    BAS - Basic element information
    ELE - Element change level summary
    COMP - Component change level summary

    When data=ALL --fo (full-output) always takes place unless there is a --rff (response-format-filter).
    In all other cases default set of columns will be shown.

    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 ", ".

#### endevor search text options

- `--search-text` | `--stext` (string)

  - Search string(s) separated with AND or OR. E.g.: string_1 AND string_2 AND string_3 OR string_4.
    For complex search strings with quotation marks use search-text-file parameter.

- `--search-text-file` | `--stf` (string)

  - File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks.

- `--search-in` | `--si` (string)

  - 2 letters describing where search should be performed:
    es - Element Source
    eh - Element History
    ec - Element Changes
    eu - Element Summary
    cs - Components Source
    ch - Components History
    cc - Components Changes
    cu - Components Summary.

    Allowed values: es, eh, ec, eu, cs, ch, cc, cu

- `--search-from` | `--sf` (number)

  - Beginning interval of the column range for the search-text.

- `--search-to` | `--st` (number)

  - Ending interval of the column range for the search-text.

- `--search-ignore-case` | `--ic` (boolean)

  - Ignore search case.

- `--search-in-binary` | `--bin` (boolean)

  - Should the text search be performed in binary elements.

- `--search-limit` | `--sl` (number)

  - Maximum search limit where 0 is NOLIMIT.

#### scl generation options

- `--to-package` | `--tp` (string)

  - Specifies the package to which the SCL has to be appended. This option requires scl-action

- `--scl-action` | `--sa` (string)

  - Specifies the action for the SCL that has to be built.

    Allowed values: GENERATE, MOVE

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

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

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

#### asynchronous task options

- `--asynchronous` | `--async` (boolean)

  - Submit this command as an asynchronous Endevor Web Services task

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

#### 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 elements in Endevor from the specified inventory location with the endevor profile set up:

  - `zowe endevor list elements -i ENDEVOR --env ENVNAME --sn 1 --sys SYSNAME --sub SUBNAME --typ TYPENAME`

- List elements in Endevor using search text string:

  - `zowe endevor list elements --stext "first or second and third"`