Configuring the transport module

The transport properties file defines how the probe receives events from the transport module.

Cisco APIC transport properties file

The probe is packaged with the ciscoApicTransport.properties file which is a pre-configured transport properties file for the probe to retrieve faultInst objects from Cisco APIC. This configuration file does not require customization, unless you have special requirements; for example, to define the scope of filters or refresh intervals.

The configuration of the ciscoApicTransport.properties file supplied with the probe is based on the Cisco APIC REST API specifications.

The following table describes the properties used to configure the ciscoApicTransport.properties file.

Table 1. Cisco APIC transport properties
Property name	Description
httpVersion	Use this property to specify the version of the HTTP protocol that the target system supports. For Cisco APIC, this property must be set to 1.1.
loginRequestURI	Use this property to specify the URI that the probe uses to request a login to the target system. Cisco APIC requires the probe to send the `aaaLogin` API to login and open a session.
loginRequestMethod	Use this property to specify the message type that the probe sends to request a login to the target system. Cisco APIC requires the `aaaLogin` API to be sent as a `POST` message.
loginRequestContent	Use this property to specify any additional information that the probe sends with the login request. Cisco APIC requires the `aaaLogin` API message body to contain an `aaa:User` object with the name and password attributes.
loginRefreshURI	Use this property to specify the URI that the probe uses to request a login refresh. Cisco APIC requires the probe to send the `aaaRefresh` API to reset the session timer.
loginRefreshMethod	Use this property to specify the message type that the probe sends to request a login refresh. Cisco APIC requires the `aaaRefresh` API to be sent as a `GET` message.
loginRefreshContent	Use this property to specify any additional information that the probe sends with the login refresh request. Cisco APIC requires no values for this property.
loginRefreshInterval	Use this property to specify the interval (in seconds) that the probe leaves between successive login refresh requests. The Cisco APIC session timeout period is 300 seconds (or 5 minutes), so the probe must be refreshed within that timeout period.
logoutRequestURI	Use this property to specify the URI that the probe uses to request a logout for the target system. Cisco APIC requires the probe to send the `aaaLogout` API to log out the user and close the session.
logoutRequestMethod	Use this property to specify the message type that the probe sends to request a logout to the target system. Cisco APIC requires the `aaaLogout` API to be sent as a `POST` message.
logoutRequestContent	Use this property to specify any additional information that the probe sends with the logout request. Cisco APIC requires the `aaaLogin` API message body to contain an `aaa:User` object with the name attribute.
refreshRetryCount `integer`	Use this property to specify how many times the probe attempts to refresh a subscription before attempting to restart/shutdown the probe. Note: When RetryCount is set to 0, the probe shuts down after refreshRetryCount completes. When RetryCount is set to a value greater than 0, the probe will attempt to restart to the set number of times indicated by RetryCount before it shuts down and returns to the command prompt.
responseTimeout	Use this property to specify how long (in seconds) that the probe waits for a response from the target system before timing out.
resyncRequestURI	Use this property to specify the URI that the probe uses to request a resynchronization with the target system at startup. To retrieve all `faults:Inst` objects from Cisco APIC, the probe can invoke a query with the URI in the following form: `{http\|https}://host[:port]/api/class/faultInst.json`. Note: You can append the URI that you specify with this property with a query filter that limits the scope of the events that are returned by the request. For details of the format of the query request, see Specifying a query filter to send to the target system.
resyncRequestMethod	Use this property to specify the message type that the probe sends to request a resynchronization with the target system. Cisco APIC requires the query to retrieve the `fault:Inst` objects to be sent as a `GET` message.
resyncRequestContent	Use this property to specify any additional information that the probe sends with the resynchronization request. Cisco APIC requires no values for this property.
securityProtocol `string`	Use this property to specify the security protocol used. The probe takes the following values: TLSv1.1. TLSv1.2. The default is TLSv1.2.
subscribeRequestURI	Use this property to specify the URI that the probe uses to request a subscription to new alarms as they are created in the target system. For Cisco APIC, to create a subscription to a query the probe must send a query with the option `'?subscription=yes'`. To subscribe to all `fault:Inst` objects the query URI must be in the form: `{http\|https}://host[:port]/api/class/faultInst.json?subscription=yes`. Note: You can append the URI that you specify with this property with a query filter that limits the scope of the events that are returned by the request. For details of the format of the query request, see Specifying a query filter to send to the target system.
subscribeRequestMethod	Use this property to specify the message type that the probe sends to request a subscription to new alarms. Cisco APIC requires the query to retrieve `fault:Inst` objects to be set as a `GET` message.
subscribeRequestContent	Use this property to specify any additional information that the probe sends with the subscription request. Cisco APIC requires no values for this property.
subscribeRefreshURI	Use this property to specify the URI that the probe uses to request a subscription refresh. Cisco APIC requires the probe to send the `subscriptionRefresh` API with the `id` parameter equal to the `subscriptionId` value to refresh each subscription.
subscribeRefreshMethod	Use this property to specify the message type that the probe sends to request a subscription refresh. Cisco APIC requires the `subscriptionRefresh` API to be sent as `GET` message.
subscribeRefreshContent	Use this property to specify any additional information that the probe sends with the subscription refresh request.
subscribeRefreshInterval	Use this property to specify the interval (in seconds) that the probe leaves between successive subscription refresh requests. The Cisco APIC timeout period for a subscription is 60 seconds (or one minute). To prevent lost notifications, the probe must send a subscription refresh message within that timeout period.
webSocketURI	Use this property to specify the URI that the probe uses to request a WebSocket connection with the Cisco APIC REST API. Cisco APIC requires the WebSocket for notifications to have a URI in the following form: `{http\|https}://host[:port]/socket%TOKEN%` where `%TOKEN%` is the current API session token (cookie).