CLI Configuration Guide for Cisco Unified SIP Proxy Release 10.2

Simple Network Management Protocol (SNMP)

It is a common network protocol that describes information passed between SNMP-enabled applications.

SNMP Agent

An SNMP Agent acts as a client to an SNMP management application by providing data values for registered OIDs.

Management Information Base (MIB)

MIBs are a defined hierarchy of data values managed by an SNMP Agent application.

SNMP Notification (Trap)/Informs

Information shared by a network entity with the management station to monitor a fault, exception, or an attribute value change. Traps do not need acknowledgment, but informs request acknowledgment. From SNMPv2, traps are known as notifications.

Object Identifiers (OID)

It is a unique string of digits representing the value defined in an MIB.

SNMP GET

SNMP GET is an SNMP message used to fetch the value for a particular OID.

SNMP SET

SNMP SET is an SNMP request used to modify information on the target agent (controlling agent behavior or configuration of agent).

cuspLastCounterResetTime

.1.3.6.1.4.1.9.9.827.1.1.1

Gives the timestamps in date and time when the call counter was last reset. All counters related to calls, Calls Per Second (CPS) and messages are reset when the counter is reset.

cuspSystemState

.1.3.6.1.4.1.9.9.827.1.1.2

Gives the Cisco Unified SIP Proxy system state as UP or DOWN.

cuspSystemUpTime

.1.3.6.1.4.1.9.9.827.1.1.3

Gives information on the active time of the Cisco Unified SIP Proxy system.

cuspLicenseLimit

.1.3.6.1.4.1.9.9.827.1.1.4

Gives the license limit information. Calls are rejected if the license limit is exceeded.

cuspLicenseState

.1.3.6.1.4.1.9.9.827.1.1.5

Gives the current license state of Cisco Unified SIP Proxy.

cuspSmartAgentState

.1.3.6.1.4.1.9.9.827.1.1.6

Gives the current license state of the SmartLicense Agent.

cuspConfiguredMemory

.1.3.6.1.4.1.9.9.827.1.1.7

Gives the total memory (RAM) configured on Cisco Unified SIP Proxy in Megabytes.

cuspMemoryUsed

.1.3.6.1.4.1.9.9.827.1.1.8

Gives the Cisco Unified SIP Proxy current memory (RAM) usage information in Megabytes.

cuspDiskSpaceUsed

.1.3.6.1.4.1.9.9.827.1.1.9

Gives the current disk utilization of CUSP in MB (Mega Byte).

cuspTotalCalls

.1.3.6.1.4.1.9.9.827.1.1.10.1

The total number of calls since the last counter reset.

cuspTotalFailedCalls

.1.3.6.1.4.1.9.9.827.1.1.10.2

The total number of failed calls since last counter reset.

cuspCPS

.1.3.6.1.4.1.9.9.827.1.1.10.3

The current running Calls Per Second (CPS) information.

cuspAvgCPSOneMin

.1.3.6.1.4.1.9.9.827.1.1.10.4

The average CPS in the last one minute.

cuspMaxCPSOneMin

.1.3.6.1.4.1.9.9.827.1.1.10.5

The Maximum value of CPS in the last one minute.

cuspDroppedCallsOneSec

.1.3.6.1.4.1.9.9.827.1.1.10.6

The count on number of calls dropped in the last one second.

cuspAvgDroppedCallsOneMin

.1.3.6.1.4.1.9.9.827.1.1.10.7

The average of 'dropped calls per second' in the last one minute.

cuspMaxDroppedCallsOneMin

.1.3.6.1.4.1.9.9.827.1.1.10.8

The Maximum of 'dropped calls per second' in the last one minute.

cuspCallsRoutedOneSec

.1.3.6.1.4.1.9.9.827.1.1.10.9

The number of calls routed through CUSP in one second.

cuspAvgCallsRoutedOneMin

.1.3.6.1.4.1.9.9.827.1.1.10.10

The average of 'calls routed per second' in last one minute.

cuspMaxCallsRoutedOneMin

.1.3.6.1.4.1.9.9.827.1.1.10.11

The maximum of 'calls routed per second' in the last one minute.

cuspCallsDroppedExceedingLicense

.1.3.6.1.4.1.9.9.827.1.1.10.12

The total calls dropped due to exceeding license limit.

cuspDiskSpaceThresholdValue

.1.3.6.1.4.1.9.9.827.1.1.12.1

The percentage threshold value configured by the user. If the percentage disk space utilization exceeds this limit, then cuspDiskSpaceThresholdAlert notification is sent.

cuspMemoryThresholdValue

.1.3.6.1.4.1.9.9.827.1.1.12.2

The percentage threshold value configured by the user. If the percentage memory utilization exceeds this limit, then cuspMemoryThresholdAlert notification is sent.

cuspServerGroupEntry

.1.3.6.1.4.1.9.9.827.1.2.1.1

An entry (conceptual row) in the ServerGroup Table.

cuspServerGroupIndex

.1.3.6.1.4.1.9.9.827.1.2.1.1.1

A unique value, greater than zero, for each server group.

cuspServerGroupName

.1.3.6.1.4.1.9.9.827.1.2.1.1.2

The name of the server group.

cuspServerGroupNetwork

.1.3.6.1.4.1.9.9.827.1.2.1.1.3

The network to which the server group belongs.

cuspServerGroupStatus

.1.3.6.1.4.1.9.9.827.1.2.1.1.4

The Server group status is given as up, partial down, and down.

cuspServerGroupPingStatus

.1.3.6.1.4.1.9.9.827.1.2.1.1.5

Server group ping status.

cuspServerGroupLBType

.1.3.6.1.4.1.9.9.827.1.2.1.1.6

The load balancing algorithm for the server group.

cuspElementEntry

.1.3.6.1.4.1.9.9.827.1.2.2.1

An entry (conceptual row) in the cuspElementTable.

cuspElementIndex

.1.3.6.1.4.1.9.9.827.1.2.2.1.1

A unique value, greater than zero, for each element.

cuspElementName

.1.3.6.1.4.1.9.9.827.1.2.2.1.2

The Server group element ID.

cuspElementStatus

.1.3.6.1.4.1.9.9.827.1.2.2.1.3

The server group element status as up or down.

cuspElementQValue

.1.3.6.1.4.1.9.9.827.1.2.2.1.4

The Q value of the server group element. Q value range is 0.0 to 1.0.

cuspElementWeight

.1.3.6.1.4.1.9.9.827.1.2.2.1.5

The weight of the server group element. Weight is used for load balancing between server group elements.

cuspElementPort

.1.3.6.1.4.1.9.9.827.1.2.2.1.6

Gives the port number of the server group element.

cuspElementTransport

.1.3.6.1.4.1.9.9.827.1.2.2.1.7

The transport type of the server group element. Transport type can be udp, tcp, or tls.

cuspElementTotalCalls

.1.3.6.1.4.1.9.9.827.1.2.2.1.8

The total routed calls to the server group element.

cuspElementFailedCalls

.1.3.6.1.4.1.9.9.827.1.2.2.1.9

The total failed calls on the server group element.

cuspNotifSeverity

.1.3.6.1.4.1.9.9.827.1.3.1

The classification on the event severity.

cuspNotifDetail

.1.3.6.1.4.1.9.9.827.1.3.2

The detailed information on error encountered.

cuspSystemStateAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.3

Controls generation of cuspSystemStateAlert, cuspConnectionExceptionAlert.

cuspServerGroupAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.4

Controls the generation of cuspServerGroupElementAlert and cuspServerGroupAlert.

cuspServerGroupElementAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.5

Controls the generation of cuspServerGroupElementAlert.

cuspLicenseExceededAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.6

Controls the generation of cuspLicenseExceededAlert.

cuspLicenseStateAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.7

Controls the generation of cuspLicenseStateAlert.

cuspExtensiveLoggingAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.8

Controls the generation of cuspExtensiveLoggingAlert.

cuspDiskSpaceThresholdAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.9

Controls the generation of cuspDiskSpaceThresholdAlert.

cuspMemoryThresholdAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.10

Controls the generation of cuspMemoryThresholdAlert.

cuspBackupProcessFailAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.11

Controls the generation of cuspBackupProcessFailAlert notification.

cuspConnectionExceptionAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.12

Controls the generation of cuspConnectionExceptionAlert.

cuspSIPMessageQueueOverflowAlertEnable

.1.3.6.1.4.1.9.9.827.1.3.13

Controls the generation of cuspSIPMessageQueueOverflowAlert.

cuspSystemStateAlert

.1.3.6.1.4.1.9.9.827.0.1

Generated when the Cisco Unified SIP Proxy system goes up or down. This notification can be enabled or disabled by setting cuspSystemStateAlertEnable.

CLI command to configure the trap:

snmp-server enable traps System-State

cuspServerGroupElementAlert

.1.3.6.1.4.1.9.9.827.0.2

Generated when the status of server group element changes. This notification can be enabled or disabled by setting cuspServerGroupAlertEnable.

CLI command to configure the trap:

snmp-server enable traps SG-Element

cuspServerGroupAlert

.1.3.6.1.4.1.9.9.827.0.3

Generated when all the elements in the server group go down. Also, it is generated when any one element in the server group comes up after all the elements in the group were down. This notification is enabled or disabled by setting cuspServerGroupAlertEnable.

CLI command to configure the trap:

snmp-server enable traps Server-Group

cuspMemoryThresholdAlert

.1.3.6.1.4.1.9.9.827.0.4

Generated when Cisco Unified SIP Proxy memory usage exceeds the cuspMemoryThresholdValue. This notification can be enabled or disabled by setting cuspThresholdAlertEnable.

cuspLicenseExceededAlert

.1.3.6.1.4.1.9.9.827.0.5

Generated when average CPS exceeds cuspLicenseLimit. This notification can be enabled or disabled by setting cuspLicenseExceededAlertEnable.

CLI command to configure the trap:

snmp-server enable traps License-Exceeded

cuspLicenseStateAlert

.1.3.6.1.4.1.9.9.827.0.6

Generated when Cisco Unified SIP Proxy license state changes. This notification is enabled or disabled by setting cuspLicenseStateAlertEnable

CLI command to configure the trap:

snmp-server enable traps License-State

cuspExtensiveLoggingAlert

.1.3.6.1.4.1.9.9.827.0.7

Generated when extensive debug level logging is enabled in Cisco Unified SIP Proxy. Extensive logging has an impact on performance and system stability. This notification can be enabled or disabled by setting cuspExtensiveLoggingAlertEnable.

CLI Command to configure the trap:

snmp-server enable traps Extensive-Logging

cuspDiskSpaceThresholdAlert

.1.3.6.1.4.1.9.9.827.0.8

Generated when the Cisco Unified SIP Proxy Disk usage exceeds the cuspDiskSpaceThresholdValue. This notification can be enabled or disabled by setting cuspThresholdAlertEnable.

cuspBackupProcessFailAlert

.1.3.6.1.4.1.9.9.827.0.9

Generated when backup process fails. This notification is enabled or disabled by setting cuspBackupProcessFailAlertEnabl.

cuspConnectionExceptionAlert

.1.3.6.1.4.1.9.9.827.0.10

Generated when a connection exception occurs. This notification can be enabled or disabled by setting cuspSystemStateAlertEnable.

cuspSIPMessageQueueOverflowAlert

.1.3.6.1.4.1.9.9.827.0.11

Generated when the Cisco Unified SIP Proxy system queue is full. Queue full indicates that either Cisco Unified SIP Proxy is overloaded or encountering network issues. The time interval between two successive notifications is 5 minutes. Notification is not sent within this time frame even if the queue is full. This back-off timer of 5 minutes prevents the Cisco Unified SIP Proxy overload. This notification can be enabled or disabled by setting cuspSIPMessageQueueOverflowAlertEnable.

CLI command to configure the trap:

snmp-server enable traps SIP-Message-Queue-Overflow

cpmCPURisingThreshold

.1.3.6.1.4.1.9.9.109.2.0.1

Sent when configured rising CPU utilization threshold is reached and CPU utilization remains above the threshold for configured interval, and such a notification is requested.

CLI command to configure the trap:

snmp-server enable traps CPU-Rising

cpmCPUFallingThreshold

.1.3.6.1.4.1.9.9.109.2.0.2

Sent when the configured falling threshold is reached and CPU utilization remains under threshold for configured interval, and such a notification is requested.

CLI command to configure the trap:

snmp-server enable traps CPU-Falling

Step 1

config

se-10-1-0-0# config terminal

Enables privileged EXEC mode.

Step 2

snmp-server community community string {RO| RW}

se-10-1-0-0(config)# snmp-server community public RW

Configures the community string. The access could be read-only or read-write based on the selected configuration.

Step 3

end

se-10-1-0-0(config)# end

Exits the privileged EXEC mode.

Step 4

write memory

se-10-1-0-0# write memory

Stores the configuration in the startup configuration file.

Step 1

config

se-10-1-0-0# config terminal

Enables privileged EXEC mode.

Step 2

snmp-server host IP Address community string

se-10-1-0-0(config)# snmp-server host 10.104.54.108

public

Specifies the host that receives SNMP notifications.

Step 3

snmp-server enable traps [ All | System-State | Server-Group | SG-Element | CPU-Rising | CPU-Falling | License-State | License-Exceeded | Extensive-Logging | SIP-Message-Queue-Overflow ]

se-10-1-0-0(config)# snmp-server enable traps SG-Element

Activates the traps selected. The command snmp-server enable traps all activates all traps.

To activate a specific trap, follow snmp-server enable traps with the subcommand specific to that trap.

Step 4

snmp-server enable traps

se-10-1-0-0(config)# snmp-server enable traps

Enables trap generation from Cisco Unified SIP Proxy to the configured hosts.

Traps are sent to the host only when this global command is enabled.

Step 5

end

se-10-1-0-0(config)# end

Exits the privileged EXEC mode.

Step 6

write memory

se-10-1-0-0# write memory

Stores the configuration in the startup configuration file.

Step 1

config

se-10-1-0-0# config terminal

Enables privileged EXEC mode.

Step 2

process cpu threshold type {total} rising percentage interval seconds falling percentage interval seconds

se-10-1-0-0(config)# process cpu threshold type {total} rising 80 interval 300 falling 5 interval 300

Sets the CPU thresholding notifications types and values.

• In this example, the CPU utilization threshold is set to 80 percent for a rising threshold notification and 5 percent for a falling threshold notification. The polling interval is set as 300 seconds.

Step 1

enable

se-10-1-0-0# enable

Enables privileged EXEC mode.

• Enter your password if prompted.

Step 2

license smart destinationAddr https://tools.cisco.com/its/service/oddce/services/DDCEService

se-10-1-0-0# license smart destinationAddr https://tools.cisco.com/its/service/oddce/services/DDCEService

Connects to the central licensing server.

Step 3

license smart httpProxyAddr 10.1.1.1

se-10-1-0-0# license smart httpProxyAddr 10.1.1.1

Sets the HTTP(S) proxy server address for smart licensing.

Step 4

license smart activate cusp count

se-10-1-0-0# license smart activate cusp 100

Activates the request number of licenses. The count must be multiple of 5.

Step 5

license smart register token_id token

se-10-1-0-0# license smart register token_id MjgxZjdkY2RtMWY5Ny00YTk4LOI2N2MtNjcxNmYaMTkzZGFhLHE0MjA3MjY0%0AMjI5N34Z8OVAOdmNzSjdIeG4MMHIzTmZubNFzMHhKOTYyeHlUZWQzQzVIM3Jk%0AHVk3MD0A3D%0N

Registers the device instance with the Cisco licensing cloud. This step is performed only once per device instance.

The license agent registers the product with Cisco and receives back an identity certificate. This certificate is saved and automatically used for all future communications with Cisco. The license agent automatically renews the registration information with Cisco after one year.

Step 1

configure terminal

se-10-1-0-0# config terminal

Enters configuration mode.

Step 2

backup server url sftp-url username sftp-username password sftp-password }

se-10-1-0-0(config)> backup server url sftp://main/backups username “admin” password “wxyz”

se-10-1-0-0(config)> backup server url sftp://192.0.2.15/backups username “admin” password “wxyz”

Sets the backup parameters.

Note You must configure the backup server before you can configure the backup revisions.

• server url —The sftp-url value is the URL to the network SFTP server where the backup files will be stored.
• The sftp-username and sftp-password values are the username and password for the network SFTP server.

In the example, main is the hostname of the SFTP server and backups is the directory where backup files are stored.

Note /backups is an absolute path to the backups directory.

Step 3

backup revisions number

se-10-1-0-0(config)> backup revisions 5

Sets the number of backup files that will be stored. When the system reaches this number of backups, it deletes the oldest stored file.

Step 4

end

se-10-0-0-0(config)> end

Exits configuration mode.

Step 5

show backup

se-10-1-0-0> show backup

Displays the backup server configuration information, including the SFTP server URL and the maximum number of backup files available.

Step 1

configure terminal

se-10-1-0-0# config terminal

Enters configuration mode.

Step 2

ntp server { hostname | ip-address } [ prefer ]

se-10-1-0-0(config)> ntp server 192.0.2.14

se-10-1-0-0(config)> ntp server 192.0.2.17 prefer

Specifies the hostname or IP address of the NTP server.

If more than one server is configured, the server with the prefer attribute is used before the others.

Step 3

end

se-10-1-0-0(config)> exit

Exits configuration mode.

Step 4

show ntp status

se-10-1-0-0> show ntp status

Displays statistics about the NTP server.

Step 5

show ntp configuration

se-10-1-0-0> show ntp configuration

Displays the configured NTP servers.

Step 6

copy running-config startup-config

se-10-1-0-0> copy running-config startup-config

Copies the configuration changes to the startup configuration.

Step 1

configure terminal

se-10-1-0-0# configure terminal

Enters configuration mode.

Step 2

no ntp server { hostname | ip-address }

se-10-1-0-0(config)> no ntp server 192.0.2.14

se-10-1-0-0(config)> no ntp server myhost

Specifies the hostname or IP address of the NTP server to remove.

Step 3

exit

se-10-1-0-0(config)> exit

Exits configuration mode.

Step 4

show ntp status

se-10-1-0-0> show ntp status

Displays statistics about the NTP server.

Step 5

show ntp configuration

se-10-1-0-0> show ntp status

Displays the configured NTP servers.

Step 6

copy running-config startup-config

se-10-1-0-0> copy running-config startup-config

Copies the configuration changes to the startup configuration.

Step 1

configure

se-10-64-86-166# > conf t

Enters Cisco Unified SIP Proxy configuration mode.

Step 2

interface FastEthernet

se-10-64-86-166(config)# interface FastEthernet 0.11

Enters interface FastEthernet.

Step 3

ip address

se-10-64-86-166(config-subif)# ip address 10.64.86.159 255.255.255.0

Configures subinterface for Fastethernet 0.11 under

configuration mode.

Step 4

end

se-10-64-86-166(config-subif)# end

Exits network command mode.