broadcom / broadcom.sysview / 1.4.3 / module / capture_immediate Submit a capture request1 | "added in version" 1.0.0 of broadcom.sysview" Authors: Michael Heuzey <michael.heuzey@broadcom.com> (@broadcom), Rachita Issar <rachita.issar@broadcom.com> (@broadcom) | supported by Broadcom This plugin has a corresponding action plugin.broadcom.sysview.capture_immediate (1.4.3) — module
Install with ansible-galaxy collection install broadcom.sysview:==1.4.3
collections: - name: broadcom.sysview version: 1.4.3
Submit a capture request2.
host: description: - The hostname of the SYSVIEW REST API. required: false type: str port: description: - The port number of the SYSVIEW REST API. required: false type: int ssid: default: GSVX description: - 'SSID of the SYSVIEW instance. Default value: GSVX' required: false type: str user: description: - Your z/OS username used to authenticate to the SYSVIEW REST API. required: false type: str password: description: - Your z/OS password used to authenticate to the SYSVIEW REST API. required: false type: str base_path: default: /api/v1 description: - The base path for your Zowe API Mediation Layer instance. Do not specify this option if you are not using an Zowe API Mediation Layer. 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 capture_file: description: - The list of SYSVIEW commands to be executed as an Event Capture.This takes the same form as a CAPLIB member. required: true type: str cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path context_fields: description: - Context fields to display. Defaults to hiding all context. elements: str required: false type: list capture_description: description: - The description of the capture. required: false type: str reject_unauthorized: description: - If set, the server certificate is 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