broadcom / broadcom.view / 2.0.8 / module / list_reports List reports in a repository | "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.list_reports (2.0.8) — module
Install with ansible-galaxy collection install broadcom.view:==2.0.8
collections: - name: broadcom.view version: 2.0.8
List reports in a repository.
Use the returned 'ReportHandle' to reference a report in other commands.
For example, use the 'ReportHandle' in the 'download report' command to download that report.
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 limit: default: 1000 description: - Limit (maximum number) of retrieved records. required: false 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 filter_name: default: '*' description: - Filter (include) based on report name. Use the asterisk (*) as a wildcard to represent any number of characters. required: false type: str output_field: default: - ReportName - Lines - Pages - Type - ArchivalDate - Description - UserComments - ReportHandle description: - Field to include in the output. Multiple fields can be specified. - Fields appear in the order you specify. - '' - 'Allowed values: ReportName,Lines,Pages,Type,ArchivalDate,Description,UserComments,ReportHandle,TotalPages,OriginalType,Destination,JobName,Origin,Generation,SequenceNumber,SysoutClass,Status,JobID,Forms,XCode,UserID,ReadDate,PrintDate,OnDisk,OnTape,OnOptical,IndexOnDisk,Location,TapeSequence,TapePosition,TapeCount,ExtendedRetentionOptionID,RemainingDays,RemainingGenerations,RemainingCopy,RemainingDiskDays,RemainingDiskGeneration,RemainingDiskCopy,RemainingDisk2days.' elements: str required: false type: list cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path output_format: choices: - ^tabular$ - ^csv$ - ^json$ - ^xml$ default: tabular description: - Output format. This option is ignored if '--response-format-json' is specified. required: false type: str output_header: default: true description: - Include header with field names in the output when you specify 'tabular' or 'csv' for the output format. - This option is ignored when you specify any other output format. required: false type: bool repository_id: description: - Repository identifier. required: true type: int archival_since: description: - Date of earliest archived reports to include based on archival date. Specify a value in the ISO-8601 format. required: false type: str archival_until: description: - Date of latest archived reports to include based on archival date. Specify a value in the ISO-8601 format. required: false type: str latest_versions: description: - Number of latest versions (of reports) to include. If not specified, all versions of reports are included. required: false 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