zowe › endevor › queryacm › elements-using-comment🖨️

Query elements using a comment component with the Endevor ACM Query facility.

Usage

zowe endevor queryacm elements-using-comment <comment> [options]

Positional Arguments

• comment (string)

  • Endevor component of type comment.

options

• --excCirculars | --exc (boolean)

  • Filters the result to exclude components that have a circular relationship to the subject of your search.

• --excIndirect | --exi (boolean)

  • Filters the result to exclude indirectly related components.

• --excRelated | --exr (boolean)

  • Filters the result to exclude related components.

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 if it isn't already included in basePath

    Default value:

output customization options

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

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

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

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

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

• --cert-account (string)

  • The account name for PKCS 12 certificate stored in credential manager

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

• Query all the elements using specified component "COMMENTN" from the specified inventory location with the Endevor profile set up.:

  • zowe endevor queryacm elements-using-comment COMMENTN -i ENDEVOR Copy