broadcom / broadcom.endevor / 7.7.2 / module / update_element The update element module updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage. | "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.update_element (7.7.2) — module
Install with ansible-galaxy collection install broadcom.endevor:==7.7.2
collections: - name: broadcom.endevor version: 7.7.2
The update element module updates an Element in the entry Stage, thereby creating a new level for the Element in the entry Stage. .
- name: Update element from local file with endevor profile set up broadcom.endevor.update_element: element: elementName from_file: localfile.txt environment: ENV system: SYS subsystem: SUB type: TYPE ccid: CCID comment: updating element instance: ENDEVOR
ccid: description: - The CCID you want to use when performing an Element action. required: false type: str host: description: - Specifies the base host name. required: false type: str port: description: - Specifies the port number. required: false type: str sync: description: - Specify if you want to synchronize source and current level of the Elements while performing this action. required: false type: bool 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 system: description: - The Endevor system where your project resides. required: false type: str charset: description: - Specifies the clients preferred character set when retrieving, printing or updating elements. required: false type: str comment: description: - The comment you want to have when performing an Element action. required: false type: str element: description: - Name of the Endevor element. required: true type: str generate: description: - Specifies if you want to Generate Element after Add/Update action. required: false type: bool 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 from_file: description: - Use this input to provide source file. required: false type: str from_path: description: - Use this input to provide the path of source USS file. It must be used with from-uss-file. required: false type: str subsystem: description: - The Endevor subsystem where your project resides. required: false type: str proc_group: description: - The Endevor processor group you would like to use. 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 environment: description: - The Endevor environment where your project resides. required: false type: str fingerprint: description: - Specifies the fingerprint of the element to Add or Update. Use value 'NEW' when adding a new element that shouldn't exist in the map yet. required: false type: str from_member: description: - Use this input to provide source member name in the data set. required: false type: str report_file: description: - File name for saving reports from Endevor SCM locally. required: false type: str from_dataset: description: - Use this input to provide source data set name. 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 from_uss_file: description: - Use this input to provide source USS file name. It must be used with from-path. required: false type: str get_fingerprint: description: - Return fingerprint of a retrieved, added or updated element as the first line of the response. required: false type: bool override_signout: description: - Specify if you want to override the Signout of an Endevor element while performing this action. required: false type: bool sync_fingerprint: description: - Specifies the fingerprint of the element directly up the map that the updated element should be synchronized with. Prevents the sync if the element up the map doesn't match the fingerprint. required: false type: str suppress_messages: description: - Suppress all [INFO]/[WARN] messages from terminal output. required: false type: bool sync_with_history: description: - Specify if you want to preserve the change history of the Elements while performing the synchronization during element update. required: false type: bool reject_unauthorized: description: - Specify this option to have the server certificate verified against the list of supplied CAs. 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