Downloads |
Table Of Contents
Supported Standards, MIBs, and RFCs
CNS Event Agent
Feature History
This feature module describes the CNS Event Agent feature. This feature module includes the following sections:
•
Supported Standards, MIBs, and RFCs
Feature Overview
Cisco Networking Services (CNS) is a foundation technology for linking users to network services. CNS Software Developers Kit (SDK) accomplishes this linking by making applications network-aware and increasing the intelligence of the network elements. CNS SDK provides building blocks to a range of customers in market segments such as enterprise, service provider, independent software vendors, and system integrators.
The CNS Event Agent is part of the Cisco IOS infrastructure that allows Cisco IOS applications to publish and subscribe to events on a CNS Event Bus. CNS Event Agent works in conjunction with the CNS Configuration Agent feature.
Benefits
•
•
Supported Platforms
CNS Event Agent is supported on the following platforms in Cisco IOS Release 12.2(2)T:
•
•
•
•
•
•
•
•
•
•
•
•
•
•
•
*Software images for Access Server platforms have not been released for version 12.2(2)T, but this feature is supported in any release based on 12.2 T that includes software images for Access Servers.
CNS Event Agent is supported on the following platforms in Cisco IOS Release 12.0(18)ST (12.0.18-ST):
•
•
•
•
•
CNS Event Agent is supported on the following platforms in Cisco IOS Release 12.0(22)S
•
•
•
•
•
Supported Standards, MIBs, and RFCs
Standards
None
MIBs
None
For descriptions of supported MIBs and how to use MIBs, see the Cisco MIB web site on CCO at http://www.cisco.com/public/sw-center/netmgmt/cmtk/mibs.shtml.
RFCs
None
Configuration Tasks
To configure the CNS Event Agent, use the following commands beginning in global configuration mode:
Step 1
Router (config)# cns event
Configures the Event Gateway for CNS.
Step 2
Router# show cns event
Displays information about the CNS Event Agent.
Command Reference
This section documents new commands. All other commands used with this feature are documented in the Cisco IOS Release 12.2 command reference publications.
cns event
To configure the Cisco Networking Services (CNS) event gateway, which provides CNS event services to Cisco IOS clients, use the cns event command in global configuration mode. To remove the specified event gateway from the gateway list, use the no form of this command.
cns event {host-name | ip-address} [port-number] [encrypt] [backup] [failover-time seconds] [keepalive seconds retry-count] [source ip-address] [clock-timeout time] [reconnect time]
no cns event {host-name | ip-address} [port-number] [encrypt] [backup] [failover-time seconds] [keepalive seconds retry-count] [source ip-address] [clock-timeout time] [reconnect time]
Syntax Description
Command Default
The event gateway default port number is 11011 with no encryption or 11012 with encryption.
The default number of seconds to wait for a primary gateway route is 3.
The clock timeout default is 10 minutes.
The reconnection time default is 3600 seconds.Command Modes
Global configuration
Command History
Usage Guidelines
The CNS event agent must be enabled before any of the other CNS agents are configured because the CNS event agent provides a transport connection to the CNS Event Bus for all other CNS agents. The other CNS agents use the connection to the CNS Event Bus to send and receive messages. The CNS event agent does not read or modify the messages.
The failover-time keyword is useful if you have a backup CNS event gateway configured. If the CNS event agent is trying to connect to the gateway and it discovers that the route to the backup is available before the route to the primary gateway, the seconds argument specifies how long the CNS event agent will continue to search for a route to the primary gateway before attempting to link to the backup gateway.
Unless you are using a bandwidth-constrained link, you should set a keepalive timeout and retry count. Doing so allows the management network to recover gracefully should a Cisco IE2100 configuration engine fail. Without the keepalive data, such a failure requires manual intervention on every device. The seconds multiplied by the retry-count determines the length of idle time before the CNS event agent will disconnect and attempt to reconnect to the gateway. Cisco recommends a minimum retry-count of 2.
If the optional source keyword is used, the source IP address might be a secondary IP address of a specific interface to allow a management network to run on top of a production network.
If network connectivity between the Cisco IOS router running the CNS Event Agent and the gateway is absent, the Event Agent goes into an exponential backoff retry mode and gets stuck at the maximum limit (which may be hours). The reconnect-time keyword allows a configurable upper limit of the maximum retry timeout.
Examples
The following example shows how to set the address of the primary CNS event gateway to the configuration engine software running on IP address 10.1.2.3, port 11011, with a keepalive of 60 seconds and a retry count of 5:
Router(config)# cns event 10.1.2.3 11011 keepalive 60 5Related Commands
cns id
Sets the unique event ID or config ID router identifier.
show cns event status
Displays status information about the CNS event agent.
debug cns event
To turn on debug messages related to the Cisco Networking Services (CNS) Event Gateway, use the debug cns event command in EXEC mode. To turn off the debug messages related to the Event Gateway, use the no version of this command.
debug cns event {all | subscriber | agent | connection}
no debug cns event {all | subscriber | agent | connection}
Syntax Description
Defaults
No default behavior or values.
Command Modes
EXEC
Command History
Usage Guidelines
Use this command to turn on or turn off debug messages related to the Event Gateway.
Related Commands
cns event
Configures the CNS Event Gateway.
show cns event
Displays information about the CNS Event Agent.
show cns event
To display information about the Cisco Networking Services (CNS) Event Agent, use the show cns event command in EXEC mode.
show cns event {status | subject [name] | gateway | stats}
Syntax Description
Defaults
No default behavior or values.
Command Modes
EXEC
Command History
Usage Guidelines
Use this command to display information about the Event Agent.
Related Commands