broadcom / broadcom.mat / 2.0.8 / module / monitor_db2_sqlstmt Get DB2 SQL statement details | "added in version" 1.0.0 of broadcom.mat" Authors: G. T. Shawo <gashawtsegaye.shawo@broadcom.com> (@broadcom), Petr Klomfar <petr.klomfar@broadcom.com> (@broadcom) | supported by Broadcom This plugin has a corresponding action plugin.broadcom.mat.monitor_db2_sqlstmt (2.0.8) — module
Install with ansible-galaxy collection install broadcom.mat:==2.0.8
collections: - name: broadcom.mat version: 2.0.8
Get SQL details for the DB2 statement.
- name: Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1 broadcom.mat.monitor_db2_sqlstmt: mon_num: 5 dbrm: CUPBTSDY stmtnum: 464 totalsamps: 1
- name: Get the DB2 SQL statement details for the latest monitor in the TESTPROF profile, for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1 broadcom.mat.monitor_db2_sqlstmt: profile: TESTPROF dbrm: CUPBTSDY stmtnum: 464 totalsamps: 1
- name: Get the DB2 SQL statement details for monitor number 5 for DBRM CUPBTSDY, statement number 464, with total number of taken samples 1, and with the specific MAT profile details defined broadcom.mat.monitor_db2_sqlstmt: mon_num: 5 dbrm: CUPBTSDY stmtnum: 464 totalsamps: 1 host: example.com port: 12345 user: johndoe password: qwerty
dbrm: description: - Specifies the DBRM/Package name that the requested DB2 statement belongs to (e.g., CUPBTSDY). You get the dbrm value from the 'db2 db2view ' command response. required: false type: str host: description: - Specifies the hostname or IP address defined for the MAT REST API server (e.g. 127.0.0.0 or localhost). required: false type: str port: description: - Specifies the server port (e.g. 8080). required: false type: int user: description: - Your mainframe username. required: false type: str mon_num: description: - Specifies the unique monitor number of the measurement. required: false type: int profile: description: - Specifies the name of the profile that you want to analyze. When you specify the profile name, you get the data for the latest measurement within the specified profile. required: false type: str stmtnum: description: - Specifies the statement number that you request the SQL details for (e.g., 464). You get the stmtnum value from the 'db2 db2view ' command response. required: false type: int password: description: - Your mainframe password. required: false type: str protocol: choices: - http - https default: https description: - Specifies the protocol defined for the MAT REST API server (http or https). required: false type: str base_path: description: - The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to all resources when making REST requests. 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 totalsamps: description: - Specifies the total number of samples taken for the requested statement (e.g., 1). You get the totalsamps value from the 'db2 db2view ' command response. required: false type: int listing_dir: description: - "Specifies the directory where you want to store the registered program listings\ \ (e.g. 'c:\\listings') for your immediate source code inspection. You can use the\ \ advantage of automated listing registration with MAT and listing retrieval through\ \ Endevor\xAE footprints for Cobol, C/C++, and Assembler programs. When a source\ \ program listing is registered with MAT, you can enhance the histogram analysis\ \ data with the program listing details that pertain to the specific CSECT and program\ \ statement. The listing is transfered to the specified directory, which enables\ \ you to navigate directly to the line of the source code in you VS Code IDE and\ \ inspect the program statement. To use the listing retrieval option through Endevor\xAE\ \ footprints, you need to have the Endevor\xAE Web Services installed and configured\ \ and specify the Endevor\xAE web server details in the MAT database configuration." required: false type: str cert_key_file: description: - The file path to a certificate key file to use for authentication. required: false type: path 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