zowe › jclcheck › check › local-file🖨️

Reads the contents of the local file specified and invokes the JCLCheck service with the JCL contents.

Usage

zowe jclcheck check local-file <localFile> [options]

Positional Arguments

• localFile (string)

  • The local file containing the JCL to check. The local JCL file can contain a single job or multiple jobs (specified one after another without blank lines or line breaks). The JCL lines in the file must not exceed 80 characters.

Options

• --max-return-code | --mrc (number)

  • Specifies the maximum acceptable return code from the JCLCheck service. If the JCLCheck overall return code exceeds the value specified on this option, the command will exit with a failure status code of 1.

• --raw-output | --ro (boolean)

  • Causes the command to print the unformatted JCLCheck report (raw report) instead of the formatted error table. Use this option if you intend to change the format of the JCLCheck report via runtime options. Changing the format may affect the ability to produce a structured API response.

    Default value: false

JCLCheck Connection Options

• --host | -H (string)

  • Host name of the JCLCheck API service that is running on the mainframe system.

• --port | -P (number)

  • Port for the JCLCheck API service that is running on the mainframe system.

• --user | -u (string)

  • User name for authenticating connections to the JCLCheck API service that is running on the mainframe system.

• --password | --pass | --pw (string)

  • Password for authenticating connections to the JCLCheck API service that is running on the mainframe system.

• --base-path | --bp (string)

  • The base path for your 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 API mediation layer.

• --reject-unauthorized | --ru (boolean)

  • Reject self-signed certificates.

    Default value: true

• --protocol | -o (string)

  • Specifies protocol to use for JCLCheck connection (http or https).

    Default value: https
    Allowed values: http, https

• --jclcheck-options | --jo (string)

  • The desired set of JCLCheck runtime options. Specify the options exactly as you would on the PARM= or OPTIONS DD on a batch run of JCLCheck. See the JCLCheck runtime options documentation for details on available runtime options. If you specify options that change the format of the JCLCheck reports, you should request '--raw-output'. Changing the format of the report will affect the ability to produce a structured API response.

Profile Options

• --jclcheck-profile | --jclcheck-p (string)

  • The name of a (jclcheck) profile to load for this command execution.

• --base-profile | --base-p (string)

  • The name of a (base) profile to load for this command execution.

Base Connection Options

• --token-type | --tt (string)

  • The type of token to get and use for the API. Omit this option to use the default token type, which is provided by 'zowe auth login'.

• --token-value | --tv (string)

  • The value of the token to pass to the API.

• --cert-file (local file path)

  • The file path to a certificate file to use for authentication

• --cert-key-file (local file path)

  • The file path to a certificate key file to use for authentication

Examples

• Check the JCL contained in the file "jcl.txt" and print a table of statements in error:

  • zowe jclcheck check local-file jcl.txt --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN" Copy

• Check the JCL contained in the file "jcl.txt" and print the raw JCLCheck report:

  • zowe jclcheck check local-file jcl.txt --host hostname --port 1234 --jclcheck-options "NOAS NOAU NOHCD NOJCL NORES NOSIGN" --raw-output Copy