broadcom / broadcom.endevor_bridge_for_git / 2.5.8 / module / work_area_list List Endevor work areas | "added in version" 1.0.0 of broadcom.endevor_bridge_for_git" Authors: Zachariah Mullen <zachariah.mullen@broadcom.com> (@broadcom) | supported by Broadcom This plugin has a corresponding action plugin.broadcom.endevor_bridge_for_git.work_area_list (2.5.8) — module
Install with ansible-galaxy collection install broadcom.endevor_bridge_for_git:==2.5.8
collections: - name: broadcom.endevor_bridge_for_git version: 2.5.8
List Endevor work areas.
- name: Show the details of all the work areas in the current working directory broadcom.endevor_bridge_for_git.work_area_list:
- name: Show the details of work area with ID "WORKAREA1" broadcom.endevor_bridge_for_git.work_area_list: work_area_id: WORKAREA1
work_dir: default: ./ description: - The local working directory of your Git-Endevor mapping that you are building. required: false type: str work_area_id: description: - Specify to list only one Endevor work area ID. Name-masking is not allowed. required: false type: str response_format_type: choices: - table - list - object - string description: - '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.' 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 command 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