zowe › caview › download › report🖨️

Download report data.
Optionally convert text report to PDF.

Usage

zowe caview download report <repositoryId> <reportHandle> [fileTarget] [options]

Positional Arguments

• repositoryId (number)

  • Repository identifier.

• reportHandle (string)

  • Report handle.

• fileTarget (string)

  • Local file path.
    If the path represents a directory location, the report will be downloaded into that directory using a default file name.
    If the path does not represent a directory location, the report will be downloaded into the specified path.
    If the path is not specified, the file will be saved to the current working directory using the default file name.
    Any missing directories will be created. If the target file already exists, the file will be overwritten.

Options

• --convert-to-pdf | --to-pdf (boolean)

  • Converts text report to PDF.

    Default value: false

• --page-orientation | --orientation (string)

  • Page orientation for converted PDF.

    Default value: PORTRAIT
    Allowed values: ^PORTRAIT$, ^LANDSCAPE$

• --font-size | --font (number)

  • Font size for converted PDF.

    Default value: 12

• --green-bar (boolean)

  • Include green-bar background in converted PDF.

    Default value: false

• --pages (string)

  • Include the specified page numbers (or page ranges). Separate page numbers (or page ranges) with commas.
    Separate boundaries of a page range with a dash (-). If you do not specify this option, all the pages of the report are downloaded.

    Allowed values: ^(\d+(-\d+)?)(,(\d+(-\d+)?))*$

• --content-filter | --filter (string)

  • Filter text report content using a permanent filter definition.
    If the product instance does not support this feature, this option is ignored.

Profile Options

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

  • The name of a (caview) 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

• --host | -H (string)

  • Host name of service on the mainframe.

• --port | -P (number)

  • Port number of service on the mainframe.

• --user | -u (string)

  • User name to authenticate to service on the mainframe.

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

  • Password to authenticate to service on the mainframe.

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

  • Reject self-signed certificates.

    Default value: true

• --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