broadcom / broadcom.endevor / 7.7.2 / module / list_elements The list elements module lists element information in Endevor | "added in version" 1.0.0 of broadcom.endevor" Authors: Michal Vasak <michal.vasak@broadcom.com> (@broadcom), Andrey Makarenko <andrey.makarenko@broadcom.com> (@broadcom) | supported by Broadcom This plugin has a corresponding action plugin.broadcom.endevor.list_elements (7.7.2) — module
Install with ansible-galaxy collection install broadcom.endevor:==7.7.2
collections: - name: broadcom.endevor version: 7.7.2
The list elements module lists element information in Endevor.
- name: List elements in Endevor from the specified inventory location with the endevor profile set up broadcom.endevor.list_elements: environment: ENVNAME system: SYSNAME subsystem: SUBNAME type: TYPENAME stage_number: 1 instance: ENDEVOR
- name: List elements in Endevor using search text string broadcom.endevor.list_elements: search_text: first or second and third
data: choices: - all - bas - ele - comp description: - '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 (full-output) always takes place unless there is a (response-format-filter). ' - In all other cases default set of columns will be shown. required: false type: str host: description: - Specifies the base host name. required: false type: str path: choices: - log - phy description: - Specifies a PHYsical or LOGical path. required: false type: str port: description: - Specifies the port number. required: false type: str type: description: - Name of the Endevor element's type. required: false type: str user: description: - Specifies the user name. required: false type: str maxrc: default: 8 description: - The maximum value of the return code of a successful action. When the return code is greater than the maxrc value, the module fails. required: false type: int return: choices: - fir - all description: - 'Sets mapping options for returned results: return FIRst match or ALL matching results.' required: false type: str search: description: - Enables the search through the Endevor map. required: false type: bool system: description: - The Endevor system where your project resides. required: false type: str element: description: - Name of the Endevor element. required: false type: str instance: description: - Specifies Endevor Web Services dataSource name. required: false type: str password: description: - Specifies the user's password. required: false type: str protocol: choices: - http - https default: https description: - Specifies the protocol used for connecting to Endevor Rest API. required: false type: str base_path: description: - Specifies the base path used for connecting to Endevor Rest API. required: false type: str cert_file: description: - 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.' required: false type: path search_in: choices: - es - eh - ec - eu - cs - ch - cc - cu description: - '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. required: false type: str search_to: description: - Ending interval of the column range for the search-text. required: false type: int subsystem: description: - The Endevor subsystem where your project resides. required: false type: str report_dir: description: - Directory for saving reports from Endevor SCM locally, if wasn't specified. Defaults to current directory. required: false type: str scl_action: choices: - GENERATE - MOVE description: - Specifies the action for the SCL that has to be built. required: false type: str to_package: description: - Specifies the package to which the SCL has to be appended. This option requires scl-action. required: false type: str environment: description: - The Endevor environment where your project resides. required: false type: str full_output: description: - Specify this option if you want a full output of list action. required: false type: bool report_file: description: - File name for saving reports from Endevor SCM locally. required: false type: str search_from: description: - Beginning interval of the column range for the search-text. required: false type: int search_text: description: - '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. required: false type: str asynchronous: description: - Submit this module as an asynchronous Endevor Web Services task. required: false type: bool search_limit: description: - Maximum search limit where 0 is NOLIMIT. required: false type: int stage_number: choices: - \* - \% - '1' - '2' description: - The Endevor stage number where your project resides. required: false type: str write_report: description: - 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. required: false type: bool cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path where_proc_type: choices: - GEN - GENERATE - MOV - MOVE - DEL - DELETE description: - Lets you select Elements according to a specified Processor type. required: false type: str search_in_binary: description: - Should the text search be performed in binary elements. required: false type: bool search_text_file: description: - File which contains search string(s) separated with AND or OR. Recommended for complex search strings with quotation marks. required: false type: str where_proc_group: description: - '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 ", ". ' required: false type: str suppress_messages: description: - Suppress all [INFO]/[WARN] messages from terminal output. required: false type: bool where_ccid_change: description: - '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. required: false type: str search_ignore_case: description: - Ignore search case. required: false type: bool where_ccid_current: description: - '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. required: false type: str where_ccid_lastact: description: - '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. required: false type: str where_ccid_lastlvl: description: - '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. required: false type: str reject_unauthorized: description: - Specify this option to have the server certificate verified against the list of supplied CAs. required: false type: bool where_ccid_generate: description: - '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. required: false type: str where_ccid_retrieve: description: - '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. required: false type: str response_format_type: choices: - table - list - object - string description: - 'The module 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.' required: false type: str response_format_filter: description: - 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 module to a single field/property or a list of a single field/property. elements: str required: false type: list response_format_header: description: - If "--response-format-type table" is specified, include the column headers in the output. required: false type: bool
data: description: Data from the module execution (a data structure). The items of this dict are set as individual return values on the top level as well. elements: dict returned: when returned data is a dictionary type: list error: contains: additional_details: description: Detailed message about the failure. type: str msg: description: Short description of the result or failure. type: str request: description: HTTP method used to invoke API service request. returned: API request failed type: str resource: description: URI of the resource of the API service request. returned: API request failed type: str description: More details about why the action has failed. If the failure is when calling an API service, the response contains the connection parameters. returned: error type: complex failed: description: A boolean that indicates if the task was failed or not. returned: always type: bool list: description: Data from the module execution (a list of data structures). elements: dict returned: when returned data is a list type: list msg: description: Short description of the result or failure. returned: sometimes type: str rc: description: Exit code of the module, successful exit code is 0, failure is typically 1 or higher. returned: always type: int stderr: description: Details of the error. returned: error type: str stdout: description: Summary of the result. returned: success type: str