broadcom / broadcom.endevor / 7.7.2 / module / commit_package The commit package module commits a Package, which removes all backout/backin data while retaining Package event information | "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.commit_package (7.7.2) — module
Install with ansible-galaxy collection install broadcom.endevor:==7.7.2
collections: - name: broadcom.endevor version: 7.7.2
The commit package module commits a Package, which removes all backout/backin data while retaining Package event information.
- name: Commit package with endevor profile set up, specifying deletion of all promotion history broadcom.endevor.commit_package: package: packageName delete_promotion_history: y instance: ENDEVOR
host: description: - Specifies the base host name. required: false type: str port: description: - Specifies the port number. 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 package: description: - Name of the Endevor package. 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 older_than: description: - Specify the minimum age of the package. required: false type: int report_dir: description: - Directory for saving reports from Endevor SCM locally, if wasn't specified. Defaults to current directory. required: false type: str report_file: description: - File name for saving reports from Endevor SCM locally. required: false type: str asynchronous: description: - Submit this module as an asynchronous Endevor Web Services task. required: false type: bool 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 suppress_messages: description: - Suppress all [INFO]/[WARN] messages from terminal output. 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 delete_promotion_history: description: - Specifies whether you want to delete all promotion history associated with previous versions of the Package. 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