Cisco Evolved Programmable Network Manager

Host                             : 'CISCO_EPNM_HOSTNAME'
Port                             : 443
Username                         : 'CISCO_EPNM_USERNAME'
Password                         : 'CISCO_EPNM_PASSWORD'
Cookie                           : 'JSESSIONID'
EnableSSL                        : 'true'
KeyStore                         : 'PATH_TO/YOUR_KEYSTORE_FILE.jks'
KeyStorePassword                 : 'YOUR_KEYSTORE_PASSWORD'

MessageLog                       : '$OMNIHOME/log/message_bus_cisco_epnm.log'
RulesFile                        : '$OMNIHOME/probes/<arch>/message_bus_cisco_epnm.rules' 
PropsFile                        : '$OMNIHOME/probes/<arch>/message_bus_cisco_epnm.props'
TransportFile                    : '$OMNIHOME/java/conf/ciscoEpnmTransport.properties'
TransportType                    : 'WebSocket'
TransformerFile                  : '$OMNIHOME/probes/<arch>/cisco_epnm_parser_config.json'

RecordData                       : 'alm.system-update-time,com.iteratorId'
DataBackupFile                   : '$OMNIHOME/probes/<arch>/ciscoEpnmPartialRsync.bak'
ResyncBatchSize                  : 100

InitialResync                    : 'true'
ResyncInterval                   : 300 

Update the properties with the values appropriate for your system.

# Constructs the HTTP request which will be sent after the OAuth
# access token request. 
# A successful login request will return a HTTP Session Cookie JSESSIONID, which will be
# stored in memory and pass to subsequent HTTP requests (configured using Cookie property 
# of Message Bus probe).  
loginRequestURI=/restconf/data/v1/cisco-customer:customer
loginRequestMethod=GET
#loginRequestContent
#loginRequestHeaders=

# Constructs the HTTP request which will be sent periodically.
# The interval is configured by the ResyncInterval probe property.
 
# Retrieve alarms based on system-update-time during resynchronization.
# ++alm.system-update-time++ will be replaced by RecordData.alm.system-update-time in DataBackupFile during runtime.
#resyncRequestURI=/restconf/data/v1/cisco-rtm:alarm?system-update-time=++alm.system-update-time++
 
# Retrieve alarms in batch filtered by severity and a specific date and time
# .startIndex is a start index of the data to be retrieved.
# .maxCount is maximum number of objects to be retrieved.
# ++ResyncBatchSize++ will be replaced by ResyncBatchSize which is defined in message_bus_cisco_epnm.props.
# ++{0,0,++ResyncBatchSize++}++ is representing ++{start,stop,step}++.
# .startIndex is derived by adding start and step for each request during runtime. The stop is set to 0 and not applicable.
#resyncRequestURI=/restconf/data/v1/cisco-rtm:alarm?.startIndex=++{0,0,++ResyncBatchSize++}++&perceived-severity=major,minor,critical&system-update-time=2021-11-16%2006:21:15.268

# Retrieve alarms in batch based on iteratorId during resynchronization.
# ++com.iteratorId++ will be replaced by RecordData.com.iteratorId in DataBackupFile during runtime.
# .startIndex is a start index of the data to be retrieved.
# .maxCount is maximum number of objects to be retrieved.
# ++ResyncBatchSize++ will be replaced by ResyncBatchSize which is defined in message_bus_cisco_epnm.props.
# ++{0,0,++ResyncBatchSize++}++ is representing ++{start,stop,step}++.
# .startIndex is derived by adding start and step for each request during runtime. The stop is set to 0 and not applicable.
#resyncRequestURI=/restconf/data/v1/cisco-rtm:alarm?iteratorId=++com.iteratorId++&.startIndex=++{0,0,++ResyncBatchSize++}++&.maxCount=++ResyncBatchSize++

# Retrieve alarms in batch filtered by severity
# .startIndex is a start index of the data to be retrieved.
# .maxCount is maximum number of objects to be retrieved.
# ++ResyncBatchSize++ will be replaced by ResyncBatchSize which is defined in message_bus_cisco_epnm.props.
# ++{0,0,++ResyncBatchSize++}++ is representing ++{start,stop,step}++.
# .startIndex is derived by adding start and step for each request during runtime. The stop is set to 0 and not applicable.
resyncRequestURI=/restconf/data/v1/cisco-rtm:alarm?.startIndex=++{0,0,++ResyncBatchSize++}++&perceived-severity=major,minor,critical&.maxCount=++ResyncBatchSize++
 
resyncRequestMethod=GET
#resyncRequestContent=
#resyncRequestHeaders=
 
Live events will arrive via websocket, by default this is disabled.  Customer can enable it by uncomment the following URI:
# Specifies the path on the websocket server to connect.
#webSocketURI=/restconf/streams/v1/alarm.json

A successful login request will return an HTTP Session Cookie JSESSIONID which will be stored in memory and passed to subsequent HTTP requests. This is configured using the Cookie property of the Message Bus Probe.

Make sure the cookie setting is correct. For example, there might be settings on the EMS which could specify a cookie name other than JSESSIONID, in which case you will need to modify the value for Cookie property in probe’s .props file accordingly. If the EMS has disabled authentication, then the login request URI and the Cookie property in the probe’s .props file can be commented out.

{
    "endpoint": "/restconf/streams/v1/alarm.json",
    "name": "Alarms",
    "config": {
      "dataToRecord": [ ],
      "messagePayload": "json.push\\.push-change-update",
      "messageHeader": "json.push\\.push-change-update",
      "jsonNestedPayload": "",
      "jsonNestedHeader": "",
      "messageDepth": 10
    }
  },