broadcom / broadcom.endevor_bridge_for_git / 2.6.0 / module / work_area_reserve Reserve work area in Endevor | "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_reserve (2.6.0) — module
Install with ansible-galaxy collection install broadcom.endevor_bridge_for_git:==2.6.0
collections: - name: broadcom.endevor_bridge_for_git version: 2.6.0
Reserve the first found available Endevor work area. When success, returns the reserved work area id.
- name: Reserve the first found available Endevor work area using an existing Endevor profile broadcom.endevor_bridge_for_git.work_area_reserve: endevor_instance: ENDEVOR
- name: Reserve the work area with ID "WORKAREA1", if available, using an existing Endevor profile broadcom.endevor_bridge_for_git.work_area_reserve: work_area_id: WORKAREA1 endevor_instance: ENDEVOR
host: description: - Host name of service on the mainframe. required: false type: str port: description: - Port number of service on the mainframe. required: false type: int user: description: - User name to authenticate to service on the mainframe. required: false type: str password: description: - Password to authenticate to service on the mainframe. required: false type: str work_dir: default: ./ description: - The local working directory of your Git-Endevor mapping that you are building. 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 endevor_host: description: - The Endevor Rest API hostname. required: false type: str endevor_port: description: - The Endevor Rest API port. required: false type: int endevor_user: description: - Mainframe (Endevor) username, which can be the same as your TSO login. required: false type: str work_area_id: description: - Reserve the Endevor work area with the ID specified. Name-masking is not allowed. required: false type: str cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path endevor_instance: description: - The Endevor Web Services Endevor configuration name. required: false type: str endevor_password: description: - Mainframe (Endevor) password, which can be the same as your TSO password. required: false type: str endevor_protocol: choices: - http - https description: - 'The Endevor SCM Rest API protocol. ' - '' - 'Default value: http' required: false type: str endevor_base_path: description: - 'The Endevor SCM Rest API base path. ' - '' - 'Default value: EndevorService/rest' required: false type: str reject_unauthorized: default: true description: - Reject self-signed certificates. required: false type: bool endevor_reject_unauthorized: description: - 'Reject self-signed certificates. ' - '' - 'Default value: true' 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