Try SpotterInvoke a MAT monitor profile
| "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.
Install with ansible-galaxy collection install broadcom.mat:==2.0.8
collections:
- name: broadcom.mat
version: 2.0.8Invoke a MAT monitor profile to start measurement.
- name: Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system
broadcom.mat.profile_invoke:
profile: PROFILE1
jobname: JOB1
targsys: AA31
- name: Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and save the measurement result in the DEMO.MAT.MONITOR.PROFILE1 data set
broadcom.mat.profile_invoke:
profile: PROFILE1
jobname: JOB1
mondsn: DEMO.MAT.MONITOR.PROFILE1
targsys: AA31
- name: Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system and register the program listing
broadcom.mat.profile_invoke:
profile: PROFILE1
jobname: JOB1
targsys: AA31
listing: y
- name: Invoke the PROFILE1 monitor profile to measure job JOB1 that runs on the AA31 system with the specific MAT profile details defined
broadcom.mat.profile_invoke:
profile: PROFILE1
jobname: JOB1
targsys: AA31
host: example.com
port: 12345
user: johndoe
password: qwerty
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
mondsn:
description:
- 'Specifies the monitor data set name where MAT saves the measurement (e.g. DEMO.MAT.MONITOR).
Values: data set name pattern, maximum 46 characters. If not specified, your default
MAT monitor DSN pattern is applied.'
required: false
type: str
jobname:
description:
- 'Specifies the name of the job to be measured (e.g. JOB1). Values: 1 to 8 characters,
alphanumeric (A-Z capitals only and 0-9), national (#, $, @), and wildcards (* or
%).'
required: true
type: str
listing:
description:
- "Activates automated registration of Cobol, C/C++, and Assembler program listings\
\ through Endevor\xAE footprints. After completion of the measurement that you invoke\
\ with the parameter, the MAT Analyze plug-in for Zowe CLI automatically retrieves\
\ the program listing that is associated with the monitored job and registers the\
\ listing with MAT. A registered program listing enhances the analysis possibilities\
\ of the 'codeview histogram' command the 'codeview histogram' command and enables\
\ you to inspect the source code statements that are associated with specific modules\
\ and CSECTs."
required: false
type: bool
moiuuid:
description:
- 'Specifies the MOI UUID. Values: maximum 61 characters, alphanumeric (A-Z and 0-9).
If you use this parameter for command execution, the value cannot be blank.'
required: false
type: str
profile:
description:
- 'Specifies the name of the profile in MAT that you invoke (e.g. PROFILE1). Values:
1 to 8 characters, a combination of alphanumeric and national characters (A-Z, 0-9,
and @), the first character must be an alphabetic or @. The profile name must not
contain characters # and $.'
required: true
type: str
targsys:
description:
- 'Specifies the target system in SYSPLEX. Values: a comma separated list of up to
4 values is allowed, maximum 8 characters each, a combination of alphanumeric (A-Z
and 0-9) and national (@,#,$), the first character must be an alphabetic (A-Z) or
a national (@, #, $) (e.g. AA31,AA32).'
required: true
type: str
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
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
moitimestamp:
description:
- 'Specifies the MOI timestamp. Values: maximum 12 characters, numbers only (0-9).
If you use this parameter for command execution, the value cannot be blank.'
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