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 cisco_apic.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

Cookie string

-cookie string

Use this property to specify the HTTP cookie name to be retrieved from the probe store. The probe uses the value retrieved from the cookie to replace the ++property_setting++ token in the ciscoApicTransport.properties file.

The default is APIC-cookie.

Cisco APIC sends the APIC-cookie cookie in response to the probe's login request. The default setting for this property instructs the probe to replace the ++APIC-cookie++ token in the ciscoApicTransport.properties file with the APIC-cookie value.

Note: You can specify multiple values for this property by separating each string with a comma (,).

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 of APIC to which the probe connects.

The default is "".

Note: The probe also uses this value to replace the ++Host++ token in the ciscoApicTransport.properties file.
JsonNestedPayload string

-jsonnestedpayload string

Use this property to specify whether nested parsing on JSON data is enabled. To enable, specify either XML or JSON tree structure to the nested message payload in the JSON string values in the JSON array as specified by the MessagePayload property. This property has the same semantics as MessagePayload except that the default value is blank (an empty string), which turns off nested parsing.

The default is "".

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.

MessagePayload string

-messagepayload string

Use this property to specify the JSON tree structure to the message payload.

A probe event is derived from a JSON object pointed by message payload. The message payload object consists of name-value data pairs. The probe processes the message payload object to generate probe name-value pair elements.

For example, the Cisco APIC message tree structure when retrieving the faultInst object class is defined as: json.imdata.faultInst. attributes.(%message_payload%)

So using this example, you should set this property to json.imdata.faultInst. attributes (which is the default value).

Note: The tree structure must start with json to indicate that the message is a JSON object.

Password string

-password string

Use this property to specify the password associated with the Username property for logging into Cisco APIC.

The default is "".

Note: The probe uses this value to replace the ++Password++ token in the ciscoApicTransport.properties file.

Port

integer

-port

integer

Use this property to specify the host port of the instance of Cisco APIC to which the probe connects.

The default is 0.

Note: The probe also uses this value to replace the ++Port++ token in the ciscoApicTransport.properties file.

StreamCapture string

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

-streamcapturefile (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/cisco_apic.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: %OMNIBUS%\\var\\cisco_apic.stream.

TransformerFile string

-transformerfile

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

The default is is'${OMNIHOME}/java/conf/transformers.xml' .

On UNIX, if you specify an environment variable (for example, OMNIHOME) you must include it within curly brackets { }. '${OMNIHOME}/java/conf/transformers.xml'.

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

TransportFile string

-transportfile string

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

The default is ${OMNIHOME}/java/conf/ciscoApicTransport.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: %OMNIBUS%\\java\\conf\\ciscoApicTransport.properties'

TransportType string

-transporttype string

Use this property to either specify the transport method to be used, or to define the name of the transport module class to use.

The default is WebSocket.

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

Username string

-username string

Use this property to specify the user account for logging into Cisco APIC.

The default is "".

Note: The probe uses this value to replace the ++Username++ token in the ciscoApicTransport.properties file.

WebSocketID string

-websocketid string

Use this property to specify the JSON field name where the WebSocket subscription ID is stored as a field value in the response message during a subscription request.

The probe uses the WebSocket subscription ID to replace the ++property_setting++ token in the ciscoApicTransport.properties file.

The default is subscriptionId.