Properties and command line options

You use properties to specify how the probe interacts with the device. You can override the default values by using the properties file or the command line options.

The following table describes the probe specific properties and command line options configured by the juniper_contrail.props file.

For information about default properties and command line options, see the IBM Tivoli Netcool/OMNIbus Probe and Gateway Guide.

Table 1. Properties and command line options

Property name

Command line option

Description

EnableSSL string

-noenablessl (This is equivalent to EnableSSL with a value of false.)

-enablessl (This is equivalent to EnableSSL with a value of true.)

Use this property to specify whether SSL connectivity between the probe and the EMS server is enabled or disabled. This property takes the following values:

false: SSL connectivity between the probe and the EMS server is disabled.

true: SSL connectivity between the probe and the EMS server is enabled.

The default is false.

Host string

-host string

Use this property to specify the host name or IP address of the instance to which the probe connects.

For supported IP environments, see Summary.

The default is "".

InitialResyncWindow string

-initialresyncwindow string

Use this property to offset the initial resynchronization to a specified point in the timeline before the probe starts up, which will be the start time of the first query.

The supported format for this property is:

xd yh zm

Where d is days, h is hours, and m is minutes with x, y, and z being integers. Other supported formats allowed are single day, hour or minute values, or multiple values in sequential order from minutes to days. For example, the following formats are allowed: 59m, 11h 59m, or 13d 11h 59m.

The maximum value is 14d and minimum value is 1m.

The default is 3d.

KeyStore string

-keystore string

Use this property to specify the location of the keystore file that contains the client certificate for the SSL and trusted authority certificate.

The default is "".

KeyStorePassword string

-keystorepassword string

Use this property to specify the password required to access the certificate specified by the KeyStore property.

The default is "".

Note: You can encrypt this password using the nco_aes_crypt utility within Netcool/OMNIbus.

Port

integer

-port

integer

Use this property to specify the host port of the instance of Juniper Contrail to which the probe connects.

The default is 8081.

ResyncBatchTimespan

integer

-resyncbatchtimespan

integer

Use this property to specify the maximum timespan (in minutes) per query over the timeline covered in the initial resynchronization.

You can specify a value between 1 and 15.

The default is 5.

StreamCapture string

-nostreamcapture (This is equivalent to StreamCapture with a value of false.)

-streamcapture (This is equivalent to StreamCapture with a value of true.)

Use this property to specify whether the probe stores the event data received in a stream capture file.

The default is false.

StreamCaptureFile string

-streamcapturefile string

Use this property to specify the location of the stream capture file.

The default is ${OMNIHOME}/var/ juniper_contrail.stream.

On UNIX, if you specify an environment variable (for example, OMNIHOME) you must include it within curly brackets { }.

On Windows operating systems, you must manually change this property value to: %OMNIHOME%\\var\\ juniper_contrail.stream.

TransformerFile string

-transformerfile string

Use this property to specify the location of the transformer file.

The default is ${OMNIHOME}/java/conf/juniper_contrail _transformers.xml.

TransportFile string

-transportfile string

Use this property to specify the location of the transport properties file.

The default is ${OMNIHOME}/java/conf/juniperContrail Transport.properties

On UNIX, if you specify an environment variable (for example, OMNIHOME) you must include it within curly brackets { }.

On Windows operating systems, you must manually change this property value to: %OMNIHOME%\\java\\conf\\ juniperContrailTransport. properties

TransportType string

-transporttype string

Use this property to specify the transport method.

The default is RESTAPI.

Note: Currently RESTAPI is the only supported value for this property.

UseLastResyncTimestamp string

-uselastresynctimestamp string

Use this property to specify whether the probe uses the last resynchronization timestamp as the starting point of the initial resynchronization.

true: If the interval between the last event timestamp and the probe startup time is less than the maximum value allowed for the InitialResyncWindow property (14 days), then the probe will use the last resynchronization timestamp value as the starting point of the initial resynchronization. However, if the last resynchronization timestamp exceeds 14 days from the probe startup time, then the probe will offset the initial resynchronization starting time as specified by the InitialResyncWindow property.

false: The probe will offset the initial resynchronization starting time as specified by the InitialResyncWindow property.

The default is false.