CISCODEV Configuration Syntax

The CISCODEV Configuration is used to set up Cisco Network Device, this includes the monitoring of Cisco® PSTN (standalone) Gateways, Cisco IOS routers and Cisco Expressway™, and Cisco Unified SIP Proxy device monitoring.

SUBSYS CISCODEV

ADD DEVICE (<device-name>, ip=<ip-address>, type=<type>)[, customer=<customer-name>][, site=<site-name>][, pwkey=<pwkey>][, mode={http|https}][, port=<port-number>])
DEFINE SNMP_PROFILE (<device-name>[, port=<port>][, version={2c|3}][, authentication={YES|NO}][, authProtocol={MD5|SHA}][, encryption={YES|NO}][, encryptionProtocol={DES|3DES|AES|AES128|AES192|AES256}])

ADD CUSP (<device-name>, ip=<ip-address>)[, customer=<customer-name>][, site=<site-name>])
DEFINE CUSP_CLI_PROFILE (<device-name>, mode=ssh, port=<port>)
DEFINE CUSP_SNMP_PROFILE (<device-name>, version=2c)

Syntax Elements

ADD DEVICE

A separate ADD DEVICE statement is required for each device to be monitored.

<device-name>

Name of the Cisco device.

ip=<ip-address>

Contactable IPv4 address for the device.

type=<type>

Device type, i.e. expressway, sipgateway, h323gateway or router.

customer=<customer-name>

(Optional) - User-defined customer name for data filtering and Role Based Security.

site=<site-name>

(Optional) - User defined site name for data filtering.

The following parameters are used for Cisco Expressway only.

pwkey=<pwkey>

(Optional) -  Password key for access to the device. This is used to group multiple devices together that share the same password configuration entry.

The second part of the 'Entry Key' from the applicable Prognosis PASSWORDS Configuration entry is used. That is, the text after the colon ':', e.g. for the Entry Name 'EXPRESSWAY:\ExpresswayE' the <pwkey> would be '\ExpresswayE'.

mode={http|https}

(Optional) - Protocol used to connect to the device, either HTTP or HTTPS.

port=<port-number>

(Optional) - Port number used to connect to the device.

DEFINE SNMP PROFILE (Optional)

SNMP Connection details are used by Prognosis to collect CPU, memory, disk and network metrics. If required, add details of the SNMP connection that is to be used by Prognosis to connect to the Cisco device. If this statement is not included these metrics will not be collected.

<device-name>

Name of the Cisco device.

port=<port>

SNMP port on the device (default=161).

Version={2c|3}

SNMP version available on the device, either 2c or 3.

authentication={YES|NO}

Indicates whether SNMP authentication is required (default=NO).

authProtocol={MD5|SHA}

SNMP authentication protocol. Options are; MD5 or SHA.

encryption={YES|NO}

Indicates whether SNMP encryption is required (default=NO). Encryption is not available without authentication.

encryptionProtocol=

SNMP encryption protocol. Options are; DES, 3DES, AES, AES128, AES192, AES256. This only applies if the encryption statement has been enabled.

ADD CUSP

A separate ADD CUSP statement is required for each Cisco Unified SIP Proxy device to be monitored.

<device-name>

Name of the Cisco Unified SIP Proxy server.

ip=<ip-address>

Contactable IPv4 address for the Unified SIP Proxy server.

customer=<customer-name>

(Optional) - User-defined customer name for data filtering and Role Based Security.

site=<site-name>

(Optional) - User defined site name for data filtering.

DEFINE CUSP_CLI_PROFILE (Optional)

CLI Connection details are used by Prognosis to collect most metrics. 

If required, add details of the SNMP connection that is to be used by Prognosis to connect to the Unified SIP Proxy device. If this statement is not included these metrics will not be collected.

<device-name>

Name of the Cisco Expressway server.

mode

CLI mode to connect to the device, only ssh is supported.

portThe ssh port to use.  Default is 22.

DEFINE CUSP_SNMP_PROFILE (Optional)

SNMP Connection details are used by Prognosis to collect Call metrics. SNMP may be disabled on the Cisco Expressway device, to enable SNMP please see the 

If required, add details of the SNMP connection that is to be used by Prognosis to connect to the Unified SIP Proxy device. If this statement is not included these metrics will not be collected.

<device-name>

Name of the Cisco Expressway server.

Version=2c

SNMP version available on the device, only 2c is supported.

Example:

SUBSYS CISCODEV

ADD DEVICE (Dev1, ip=10.118.19.7, type=sipgateway)
DEFINE SNMP_PROFILE (Dev1, port=161, version=3, authentication=YES, authProtocol=MD5, encryption=YES, encryptionProtocol=DES)

ADD DEVICE (SIPGW1-PRI, ip=10.116.107.61, type=sipgateway)
ADD DEVICE (SIPGW2-CAS, ip=10.116.107.21, type=sipgateway)
ADD DEVICE (SIPGW3-FXO-FXS, ip=10.116.102.2, type=sipgateway)
ADD DEVICE (SIPGW4-BRI, ip=10.116.102.10, type=sipgateway)

ADD CUSP(CUSP1, ip=10.116.123.218, "Customer=IR", Site=Sydney)
DEFINE CUSP_CLI_PROFILE(CUSP1, mode=ssh, port=22)
DEFINE CUSP_SNMP_PROFILE(CUSP1, Version=2c)

ADD CUSP(CUSP2, ip=10.116.122.218, "Customer=IR", Site=Sydney)
DEFINE CUSP_CLI_PROFILE(CUSP2, mode=ssh, port=22)
Provide feedback on this article