broadcom / broadcom.sysview / 1.4.3 / module / display Display a real-time SYSVIEW primary command | "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.display (1.4.3) — module
Install with ansible-galaxy collection install broadcom.sysview:==1.4.3
collections: - name: broadcom.sysview version: 1.4.3
Issue a SYSVIEW primary command and display output, including any messages.
- name: Issue the CSMSTAT command and show the 'message' field from the context area of the response broadcom.sysview.display: command_string: CSMSTAT context_fields: - "message"
- name: Issue the JOBSUM command to list jobs starting with "CS" showing only the fields Jobname, Jobid, and Status broadcom.sysview.display: command_string: jobs CS&VLMC fields: - "Jobname" - "Jobid" - "Status"
host: description: - The hostname of the SYSVIEW REST API. required: false type: str info: description: - Display the information area, if any. required: false type: bool 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 fields: description: - 'Fields to be returned (by name). For example: "jobname" "cpu".' elements: str required: false type: list pretty: description: - Display formatted data. required: false type: bool row_end: default: 100 description: - The last row of the response data to display. required: false type: int timeout: default: 30 description: - The number of seconds to wait before timing out. required: false type: int all_rows: description: - Return all rows of data, no matter how many. Overrides and --row-end. required: false type: bool overview: description: - Display the overview section. required: false type: bool password: description: - Your z/OS password used to authenticate to the SYSVIEW REST API. required: false type: str truncate: description: - Truncate displays that are too wide for the console. required: false type: bool 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 row_start: default: 1 description: - The first row of the response data to display. required: false type: int blank_if_zero: description: - Show a blank space instead of '0' values. required: false type: bool cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path command_string: description: - 'Command(s) to be issued ' - (If more than one command, separated by a semi-colon) - 'Example: "ACTIVITY;SORT CPU% D"' - . required: true type: str context_fields: description: - Context fields to display. Defaults to hiding all context. elements: str required: false type: list reject_unauthorized: description: - If set, the server certificate is verified against the list of supplied CAs. required: false type: bool response_format_csv: description: - Format data as a set of Comma Seperated Values. 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