broadcom.mat.monitor_codeview_histogram (2.0.8) — module

Install collection

Install with ansible-galaxy collection install broadcom.mat:==2.0.8

Add to requirements.yml

  collections:
    - name: broadcom.mat
      version: 2.0.8

Description

Get the Histogram details for the measurement.

Usage examples

Scanned by Steampunk Spotter

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

- name: Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB
  broadcom.mat.monitor_codeview_histogram:
    mon_num: 5
    module: RUNCOB
    csect: TUNCOB01

Scanned by Steampunk Spotter

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

- name: Get the Histogram details for the latest monitor in the TESTPROF profile for CSECT name TUNCOB01, empty module name, limiting the group size to 32 bytes and the number of returned records to 5 top consumers
  broadcom.mat.monitor_codeview_histogram:
    profile: TESTPROF
    module: ""
    csect: TUNCOB01
    group: 32
    top: 5

Scanned by Steampunk Spotter

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

- name: Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, limit the number of returned records to 5 top consumers, and request the listing details
  broadcom.mat.monitor_codeview_histogram:
    mon_num: 5
    module: RUNCOB
    csect: TUNCOB01
    top: 5
    listing: y

Scanned by Steampunk Spotter

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

- name: Get the Histogram details for monitor number 5, CSECT name TUNCOB01, and module name RUNCOB, with the specific MAT profile details defined
  broadcom.mat.monitor_codeview_histogram:
    mon_num: 5
    module: RUNCOB
    csect: TUNCOB01
    host: example.com
    port: 12345
    user: johndoe
    password: qwerty

Inputs

    
top:
    description:
    - 'Specifies the maximum number of the top consuming CSECT activity locations that
      you want to obtain in the response (e.g., 5). If you specify 0, you get the list
      of all CSECT activity locations that MAT has detected during the measurement.The
      parameter is optional. Values: numbers between 0 and 300.'
    required: false
    type: int

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

csect:
    description:
    - Specifies the CSECT name that you request the Histogram data for. You get the csect
      value from the 'codeview csect' command response. The CSECT name can be empty (e.g.,  "TUNCOB01"
      or '""').
    required: false
    type: str

group:
    description:
    - 'Specifies the histogram group size parameter that defines the resolution of the
      histogram (e.g., 32). If you do not specify the group parameter, the group size
      value defaults to 4 bytes. If the source program listing is registered with MAT,
      the group size parameter is ignored. The parameter is optional. Lower values of
      the parameter result in more granular representation of the histogram data. Values:
      numbers between 2 and 999999.'
    required: false
    type: str

module:
    description:
    - Specifies the module name that you request the Histogram data for. You get the module
      value from the 'codeview csect' command response. The module name can be empty (e.g.,
      "IGZCPAC" or '""').
    required: false
    type: str

listing:
    description:
    - "Enables you to retrieve program listing details that pertain to the specific CSECT\
      \ and statement. To use the listing retrieval option, you must install and configure\
      \ the Endevor\xAE Web Services and have the program listing for the specific measurement\
      \ registered with MAT. The source code listing is retrieved through Endevor\xAE\
      \ footprints for Cobol, C/C++, and Assembler programs. The program listing file\
      \ is downloaded to your local directory that you specified with the 'listingDir'\
      \ parameter in your MAT configuration profile. When you request the histogram details\
      \ with the '--listing' option, the 'histogram' command returns the additional 'listing'\
      \ column that contains a reference to the program listing with the specific CSECT\
      \ name, program type, line and column number that pertain to the requested CSECT\
      \ and statement, for example, c:listingsSA420LE.asm:382:51. If you use Visual Studio\
      \ Code (VS Code) IDE, you can click on the reference in the command responce in\
      \ your VS Code terminal to navigate directly to the indicated source program location.The\
      \ parameter is optional."
    required: false
    type: bool

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

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

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