1 Cardinal: OpenDaylight Monitoring as a Service
2 ==============================================
4 This section describes how to use the Cardinal feature in OpenDaylight
5 and contains configuration, administration, and management sections for
11 Cardinal (OpenDaylight Monitoring as a Service) enables OpenDaylight and
12 the underlying software defined network to be remotely monitored by
13 deployed Network Management Systems (NMS) or Analytics suite. In the
14 Boron release, Cardinal will add:
18 2. Enable ODL diagnostics/monitoring to be exposed across SNMP (v2c, v3)
21 3. Extend ODL System health, Karaf parameter and feature info, ODL
22 plugin scalability and network parameters.
24 4. Support autonomous notifications (SNMP Traps).
29 The Cardinal architecture can be found at the below link:
31 https://wiki.opendaylight.org/images/8/89/Cardinal-ODL_Monitoring_as_a_Service_V2.pdf
33 Configuring Cardinal feature
34 ----------------------------
36 To start Cardinal feature, start karaf and type the following command:
40 feature:install odl-cardinal
42 After this Cardinal should be up and working with SNMP daemon running on
48 Below are tutorials for Cardinal.
53 These tutorials are intended for any user who wants to monitor three
54 basic component in OpenDaylight
56 1. System Info in which controller is running.
60 3. Project Specific Information.
65 There is no as such specific prerequisite. Cardinal can work without
66 installing any third party software. However If one wants to see the
67 output of a snmpget/snmpwalk on the CLI prompt, than one can install the
68 SNMP using the below link:
70 https://www.digitalocean.com/community/tutorials/how-to-install-and-configure-an-snmp-daemon-and-client-on-ubuntu-14-04
72 Using the above command line utility one can get the same result as the
73 cardinal APIs will give for the snmpget/snmpwalk request.
78 This tutorial is developed considering the following environment:
80 controller-Linux(Ubuntu 14.02).
85 Install Cardinal feature
86 ''''''''''''''''''''''''
88 Open karaf and install the cardinal feature using the following command:
92 feature:install odl-cardinal
94 Please verify that SNMP daemon is up on port 161 using the following
95 command on the terminal window of Linux machine:
99 netstat -anp | grep "161"
100 netstat -anp | grep "2001"
101 netstat -anp | grep "2003"
103 If the grep on the \`\`snmpd\`\` port is successful than SNMP daemon is
109 Please see Developer guide for usage of Cardinal APIs.
111 CLI commands to do snmpget/walk
112 '''''''''''''''''''''''''''''''
114 One can do snmpget/walk on the ODL-CARDINAL-MIB. Open the linux terminal
115 and type the below command:
119 snmpget -v2c -c public localhost Oid_Of_the_mib_variable
125 snmpget -v2c -c public localhost ODL-CARDINAL-MIB::mib_variable_name
127 For snmpwalk use the below command:
131 snmpwalk -v2c -c public localhost SNMPv2-SMI::experimental
133 For tabular data (netconf devices), snmpwalk use the
138 snmpwalk -v2c -c public localhost:2001 SNMPv2-SMI::experimental
140 For tabular data (openflow devices), snmpwalk use the
145 snmpwalk -v2c -c public localhost:2003 SNMPv2-SMI::experimental