broadcom / broadcom.view / 2.0.8 / module / export_report Export text report to spreadsheet | "added in version" 1.0.0 of broadcom.view" Authors: Marcel Veselovsky <marcel.veselovsky@broadcom.com> (@broadcom) | supported by Broadcom This plugin has a corresponding action plugin.broadcom.view.export_report (2.0.8) — module
Install with ansible-galaxy collection install broadcom.view:==2.0.8
collections: - name: broadcom.view version: 2.0.8
Export text report to spreadsheet using a predefined export rule.
host: description: - Hostname or ip address of the target View REST API instance. required: false type: str port: default: 443 description: - Port of the target View REST API instance. required: false type: int user: description: - User name used to authenticate against the target View REST API instance. required: false type: str pages: choices: - ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$ description: - Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas. - Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are exported. required: false type: str rule_id: description: - Export rule identifier. required: true type: int password: description: - Password used to authenticate against the target View REST API instance. required: false type: str protocol: choices: - http - https default: https description: - Protocol of the target View REST API instance. required: false type: str base_path: default: web-viewer description: - Context name of the target View REST API instance. 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 file_target: description: - Local file path. - If the path represents a directory location, the report will be exported into that directory using a default file name. - If the path does not represent a directory location, the report will be exported into the specified path. - If the path is not specified, the file will be saved to the current working directory using the default file name. - Any missing directories will be created. If the target file already exists, the file will be overwritten. required: false type: str cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path report_handle: description: - Report handle. required: true type: str repository_id: description: - Repository identifier. required: true type: int reject_unauthorized: default: true description: - Reject self-signed certificates. 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