broadcom.mat_pma_util.get_perf (2.0.5) — module

Install collection

Install with ansible-galaxy collection install broadcom.mat_pma_util:==2.0.5

Add to requirements.yml

  collections:
    - name: broadcom.mat_pma_util
      version: 2.0.5

Description

Get the current performance data of a specific job using PMA. If the current measurement results for any of the measured parameters are higher than average values, an alert message is displayed.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get the current performance data of the TESTPMA8 job using the default profile
  broadcom.mat_pma_util.get_perf:
    jobname: TESTPMA8

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: Get the current performance data of the TESTPMA8 job using specific PMA profile details
  broadcom.mat_pma_util.get_perf:
    jobname: TESTPMA8
    job_acct: 123456789
    job_class: A
    job_mclass: A
    job_load: HLQ.CEETLOAD
    job_pmahlq: PMAHLQ

Inputs

    
host:
    description:
    - Host name of service on the mainframe.
    required: false
    type: str

port:
    description:
    - Port number of service on the mainframe.
    required: false
    type: int

user:
    description:
    - User name to authenticate to service on the mainframe.
    required: false
    type: str

jobname:
    description:
    - Specifies the name of the job that is being tested (e.g. TESTPMA8).
    required: true
    type: str

job_acct:
    description:
    - 'Specifies z/OS TSO/E accounting information. Values: numeric characters (0-9).'
    required: true
    type: str

job_load:
    description:
    - Specifies the PMA loadlib data set name that you defined during the PMA customization
      (&HLQ.CEETLOAD) .
    required: true
    type: str

password:
    description:
    - Password to authenticate to service on the mainframe.
    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

job_class:
    description:
    - 'Your z/OS class information. Values: alphanumeric characters (A-Z, 0-9) .'
    required: true
    type: str

job_mclass:
    default: A
    description:
    - 'Specifies the MSGCLASS parameter value and assigns the job log to the specified
      output class. The specified MSGCLASS value is used in all JCLs that PMA runs while
      you execute the commands. If you do not provide the job_mclass parameter, the default
      MSGCLASS value is used. Values: alphanumeric characters (A-Z, 0-9) .'
    required: false
    type: str

job_pmahlq:
    description:
    - Specifies your PMA HLQ to access the KSDSALT, KSDSJOB, and KSDSEXC VSAM files that
      ensure the collection of the necessary data.
    required: true
    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

Outputs

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