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 properties and command line options specific to this probe. For information about common 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:

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

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

The default is false.

EncodingStandard string

-encodingstandard string

Use this property to specify the character encoding standard that the probe uses. Possible values for this property are:

ISO-8859-1: This sets the encoding standard to Latin Alphabet 1.

UTF-8: This sets the encoding standard to UTF-8.

The default is: ISO-8859-1

IORFile string

-iorfile string

Use this property to specify the path of the Interoperable Object Reference (IOR) file used to connect to the target through the CORBA interface. If you do not provide a value for this property, use the NamingContextPath with the NamingServiceHost and NamingServicePort properties or the NamingServiceIORFile property to define the Naming Service to use instead.

The default is "".

KeyStore string

-keystore string

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

The default is "".

KeyStorePassword string

-keystorepasswordstring

Use this property to specify the password required to access the certificate defined in the Keystore property.

The default is "".

NamingContextPath string

-nspath string

Use this property to specify the location of the object in the Naming Service. If using a Naming Service to connect to the CORBA interface, always set this property.

The default is "".

NamingServiceHost string

-nshost string

Use this property to specify the name of the host that runs the Naming Service. If you do not use the IORFile property define the location of the Naming Service using this property, together with the NamingServicePort and NamingContextPathproperties, or the NamingServiceIORFile and NamingContextPath properties.

The default is: "".

NamingServiceIORFile string

-nsiorfile string

Use this property to specify the location of the IOR file that contains the root context of the Naming Service. If you do not provide a value for the IORFile property, use this property and the NamingContextPath property or the NamingServiceHost, NamingServicePort, and NamingContextPath properties to define the Naming Service to use to obtain the reference to the EmsFactorySession_I object.

The default is: "".

NamingServicePort integer

-nsport integer

Use this property to specify the port on the host defined by NamingServiceHost through which to connect to the Naming Service. If you do not use the IORFile property, use this property, together with the NamingServiceHost property and NamingContextPath property, or the NamingServiceIORFile and NamingContextPath properties.

The default is: 0.

NotificationClientType string

-notificationclienttype string

Use this property to define the probe subscription for notification service.

SEQUENCE_EVENT: The probe will receive a sequence of StructuredEvent.

STRUCTURED_EVENT: The probe will receive a single StructuredEvent during every notification cycle.

The default is: SEQUENCE_EVENT.

ORBCharEncoding string

-orncharencoding string

Use this property to specify the native character encoding set that the Oject Request Broker (ORB) uses for character data. Possible values for this property are:

  • ISO8859_1
  • UTF8

The default is: ISO8859_1.

ORBDebug string

-orbdebug string

Use this property to enable ORB debugging.

true: ORB debugging is enabled.

false: ORB debugging is disabled.

The default is false.

ORBDebugFile string

-orbdebugfile string

Use this property to specify the ORB debugging log file.

The default is "".

ORBLocalHost string

-orblocalhost string

Use this property to specify the local host used by the server-side ORB to place the server's host name or IP address into the IOR of a remote object.

The default is: "".

ORBLocalPort integer

-orblocalport integer

Use this property to specify the local port that the ORB listens on for connections from the probe.

The default is: 0 (the ORB selects a port at random).

ORBWCharDefault string

-orbwchardefault string

Use this property to specify the wide character (wchar) set that the IBM® ORB uses when communicating with other ORBs that do not publish a wchar set. Possible values for this property are:

  • UCS2
  • UTF16

The default is: UTF16.

Password string

-password string

Use this property to specify the password of the account to use when logging in to the target system. The password can be in plain text or encrypted using the AES algorithm. Always define a value for this property and the Username property.

The default is: "".

ReleaseTMF814 string

-releasetmf814 string

Use this property to specify the version of TMF that the probe should implement. Possible values for this property are:

  • V2.1
  • V3.0
  • V3.5

The default is: V3.0.

ResyncAlarmObject string

-resyncalarmobject string

Use this property to specify the objects against which the alarms retrieved during resynchronization are raised.

Possible values for this property are:

AllEMSAndME : All active alarms for EMS itself and all network elements under the control of this EMS are retrieved. This makes the probe request all of the active alarms and threshold crossing alerts (TCAs) that are under the control of the EMS (both those raised by the network elements and those raised by the EMS itself).

AllEMSSystem: All active alarms for EMS itself only are retrieved, excluding alarms for all network elements managed by this EMS. This makes the probe request all of the active alarms and TCAs for the EMS itself.

AllEMSAndME,AllEMSSystem: All active alarms for EMS itself and all network elements under the control of this EMS are retrieved, but in a non-TMF-standard way. In contrast to the AllEMSAndME property value which is to retrieve the same set of alarms, this property makes probe override the default standard-compliant way.
Note: This property value caters for whichever EMS implementing getAllEMSAndMEActiveAlarms() operation in a non-TMF-standard way which returns no alarms for EMS itself, but only alarms for network elements being managed.

The default is: AllEMSAndME.

ResyncBatchSize integer

-resyncbatchsize integer

Use this property to specify the maximum number of alarms contained in each batch that the probe receives during a resynchronization operation. The minimum value of this property is 1.

The default is: 100.

ResyncProbableCause Filter string

-resyncpbcausefilter string

Use this property to specify a list of probable causes to exclude when the probe resynchronizes with the CORBA interface. Separate each entry in the list with a semicolon. For example:

pbCause1;pbCause2;pbCause3

The default is: "".

ResyncSeverityFilter string

-resyncseverityfilter string

Use this property to specify a list of severities that the probe excludes when resynchronizing with the CORBA interface. Separate each entry in the list with a semicolon. The severity values you can include are:

  • PS_INDETERMINATE
  • PS_CRITICAL
  • PS_MAJOR
  • PS_MINOR
  • PS_WARNING
  • PS_CLEARED

The default is: "".

Note: If the AlarmResyncObject property is set to AllEMSSystem, the ResyncSeverityFilter property is not used by the probe.
SecurityProtocol string

-securityprotocol string

Use this property to specify the security protocol used.

The default is TLSv1.2.

StreamCapture integer

-streamcapture integer

Use this property to specify whether the stream capture feature is enabled. The values this property can have are:

1: The probe uses the stream capture feature.

0: The probe does not use the stream capture feature.

The default is: 0.

Note: If you set the value of this property to 1, define a value for the StreamCaptureFilePath property as well.

StreamCaptureFilePath string

-streamcapturefilepath string

Use this property to specify the directory where the probe stores the input data stream.

The default is: "".

See Data stream capture for more information on how to use this property.

Username string

-username string

Use this property to specify the account to use when logging in to the target system. Always define a value for this property and the Password property.

The default is: "".