zowe › znetview-base › list › canzlog🖨️

List a message or a set of messages from Canzlog.

Usage

zowe znetview-base list canzlog <requestType> [options]

Positional Arguments

• requestType (string)

  • Specifies the type of request to be used to retrieve Canzlog messages.
    The following values are valid:

    czid

    timestamp

    timerange

    recent

Options

• --begin | --beg (string)

  • The specific time for the request type 'timestamp' or the start time for the request type 'timerange', in format of "mm/dd/yy hh:mm:ss".

    Note: It is required for the request types 'timerange' and 'timestamp'.

• --direction | --dir (string)

  • Specifies which direction, backward or forward, for which to retrieve additional Canzlog messages.

    Note: This is valid for request types 'czid', 'timestamp'.

    Default value: fwd
    Allowed values: fwd, bwd

• --domain | -D (string)

  • The NetView domain to which the request will be sent.

    The default is the NetView domain to which the NetView REST Server is connected.

• --end (string)

  • The end time for the request type time range, in format of "mm/dd/yy hh:mm:ss".

    Note: It is required for the request type 'timerange'.

• --id (number)

  • The CZID of the message you’re retrieving.

    Note: It is required for the request type 'CZID'.

• --number | --num (string)

  • Specifies the number of messages to retrieve.

    Note: This is valid for request types 'czid', 'timestamp' and 'recent'.

    Default value: 1

• --show-details | --sd (boolean)

  • Specifies if you want to display all attribute data of the Canzlog messages.

    Default value: false

NetView Connection Options

• --host | -H (string)

  • The host name of your NetView REST Server.

• --port | -P (number)

  • The port number of your NetView REST Server.

• --user | -u (string)

  • The user name to authenticate to your NetView REST Server.

• --password | --pw (string)

  • The password to authenticate to your NetView REST Server.

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

  • The type of the token to authenticate to your NetView REST Server. The only token type that is valid when using NetView REST Server authentication is JSESSIONID.

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

  • The value of the token to authenticate to your NetView REST Server.

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

  • The base path for your Zowe API Mediation Layer instance. Specify this option to prepend the base path to NetView REST service when making REST requests to the Zowe API Mediation Layer.

    Note: Do not specify this option if you are not using the Zowe API Mediation Layer.

Profile Options

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

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

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

  • Reject self-signed certificates.

    Default value: true

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

• List 3 Canzlog messages starting with the message specified by czid and retrieving the next 2 messages for domain CNM01:

  • zowe znetview-base list canzlog czid --id 237766 --direction fwd --number 3 --domain CNM01 Copy

• List 4 Canzlog messages starting with the message specified by the timestamp and retrieving the previous 3 messages for domain CNM01:

  • zowe znetview-base list canzlog timestamp --begin "09/10/20 00:00:00" --direction bwd --number 4 --domain CNM01 Copy

• List Canzlog messages specified by the timerange for domain CNM01:

  • zowe znetview-base list canzlog timerange –-begin "09/10/20 00:00:00" --end "09/10/20 00:10:00" --domain CNM01 Copy

• List the 2 most recent Canzlog messages for domain CNM01:

  • zowe znetview-base list canzlog recent --number 2 --domain CNM01 Copy