Configuring Notifications

This chapter describes how to configure notifications on Cisco ME 1200 NID.

Prerequisites for Configuring Notifications

  • NID must be added to the controller.
  • NID must be accessible from the controller.
  • NID must have an IP address.
  • Configuring username and enabling password on the UCS controller is a must for HTTP authentication.

Restrictions for Configuring Notifications

  • Only the first three notification lists are supported. They are:
    • Notifications_list 1 for HeartBeat notifications.
    • Notifications_list 2 for Config Change Trap notifications.
    • Notifications_list 3 for Asynchronous failure notifications.

    Note
    In case, the other notification lists are configured, the configuration does not get applied.

Information About Notifications

Notifications are asynchronous messages generated by NID based on the events. The notifications are transported over HTTP POST request. The NID acts as an HTTP client and the controller (ME3600 or any other HTTP server) acts as a server.

Types of Notifications

The Cisco ME 1200 NID supports three types of notifications:
  • HeartBeat Notifications
  • Config Change Trap Notifications
  • Asynchronous Failure Notifications

HeartBeat Notifications

Heartbeat notifications are used to check the liveliness of the NID. This corresponds to the module_id = 1, and the notification_id = 1. You can use the setNotificationReceiver setNotificationReceiver_req heartbeat 30 command to configure the HeartBeat to 30 seconds. If the controller does not receive the heartbeat notification within 30 seconds, the controller waits for an additional 60 seconds before announcing Cisco ME 1200 NID as DOWN. For more information, see .

Config Change Trap Notifications

The registered server receives configuration change notifications when any other controller does prime changes or accesses the NID through XML. This corresponds to the module_id = 2, and the notification_id = 1. For more information, see .

Asynchronous Failure Notifications (ICLI failures)

The controller receives asynchronous failure notifications, when there are ICLI failures. Every commit action (SOAP action) on the controller is translated into multiple ICLI commands on NID, and if there are failures during the ICLI command execution, an asynchronous failure notification is sent to the controller that has registered to receive the asynchronous failure notification. This corresponds to the module_id = 3 , and the notification_id = 1. For more information, see .

How to Configure Notifications

Setting Password on the Controller

     Command or ActionPurpose
    Step 1ConfigureNID


    Example: 
    UCS# Configure NID 1
          		Opens a new session for NID 1.  
    Step 2username user_name


    Example: 
    UCS# username guest123
          		Configures the username.
    • user_name—username.
     
    Step 3enable password password


    Example: 
    UCS# enable password lab123
          		Configures the password.
    • password—password.
     
    Step 4exit


    Example: 
    UCS# exit
          		Exits to the privileged EXEC mode.  

    Configuration Example

    UCS# configureNID
UCS# username guest123
UCS# enable password lab123
UCS# exit

    Viewing Notifications

       Command or ActionPurpose
      Step 1Configure NID


      Example: 
      UCS# Configure NID 1
              		Opens a new session for NID 1.  
      Step 2ProvisionNotifications


      Example: 
      UCS# ProvisionNotifications
              		Enters the Notifications mode.  
      Step 3getNotificationList listAllNotifications_req


      Example: 
      UCS(ProvisionNotifications)# getNotificationList listAllNotifications_req
              		Displays the supported notifications list for that module.  
      Step 4getNotificationList review


      Example: 
      UCS(ProvisionNotifications)# getNotificationList review
              		Displays the configuration.  
      Step 5getNotificationList commit


      Example: 
      UCS(ProvisionNotifications)# getNotificationList commit
              		Sends the configuration to the NID.  
      Step 6exit


      Example: 
      UCS(ProvisionNotifications)# exit
              		Exits the Notifications mode.  

      Configuration Example

      UCS# ProvisionNotifications
UCS(ProvisionNotifications)# getNotificationList  listAllNotifications_req
UCS(ProvisionNotifications)# getNotificationList review

Commands in queue:
    getNotificationList listAllNotifications_req 

UCS(ProvisionNotifications)# getNotificationList commit

	   GetNotificationList_Output.listAllNotifications_resp.notification[0].module_id = 1
    GetNotificationList_Output.listAllNotifications_resp.notification[0].module_description = 'HeartBeat'
    GetNotificationList_Output.listAllNotifications_resp.notification[0].notification_id = 1
    GetNotificationList_Output.listAllNotifications_resp.notification[0].notification_description = 'Heartbeat Notifications'
    GetNotificationList_Output.listAllNotifications_resp.notification[1].module_id = 2
    GetNotificationList_Output.listAllNotifications_resp.notification[1].module_description = 'ConfigChangeTrap'
    GetNotificationList_Output.listAllNotifications_resp.notification[1].notification_id = 1
    GetNotificationList_Output.listAllNotifications_resp.notification[1].notification_description = 'Config Change Notifications'
    GetNotificationList_Output.listAllNotifications_resp.notification[2].module_id = 3
    GetNotificationList_Output.listAllNotifications_resp.notification[2].module_description = 'AsyncNotification'
    GetNotificationList_Output.listAllNotifications_resp.notification[2].notification_id = 1
    GetNotificationList_Output.listAllNotifications_resp.notification[2].notification_description = 'ICLI command failure'

    GetNotificationList Commit Success!!!

UCS(ProvisionNIDMgmtType)# exit

      Configuring Notifications

         Command or ActionPurpose
        Step 1Configure NID


        Example: 
        UCS# Configure NID 1
                  		Opens a new session for NID 1.  
        Step 2ProvisionNotifications


        Example: 
        UCS# ProvisionNotifications
                  		Enters the Notifications mode.  
        Step 3setNotificationReceiver setNotificationReceiver_req {heartbeat heartbeat |http_BA_password WORD | http_BA_user WORD | http_file_path WORD | http_server_address WORD}


        Example: 
        UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req heartbeat 30
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_BA_password lab123 
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_BA_user guest123
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_file_path myfiles/nid_notification
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_server_address 10.20.30.40
                  		Configures the values for receiving the notifications.
        • heartbeat—Specifies the rate at which keepalive packets are expected (in seconds).
        • heartbeat—Heartbeat rate. The range is from 1 to 65535.
        • http_BA_password—Specifies the HTTP basic authentication password.
        • WORD—Password.
        • http_BA_user—Specifies the HTTP basic authentication user.
        • WORD—user.
        • http_file_path—Specifies the name of a document/resource. For example: /nid_notification.
        • WORD—name of a document.
        • http_server_address—Specifies the HTTP server IP address.
        • WORD—HTTP Server IP address.
         
        Step 4setNotificationReceiver review


        Example: 
        UCS(ProvisionNotifications)# setNotificationReceiver review
                  		Displays the configuration.  
        Step 5setNotificationReceiver commit


        Example: 
        UCS(ProvisionNotifications)# setNotificationReceiver commit
                  		Sends the configuration to the NID.  
        Step 6exit


        Example: 
        UCS(ProvisionNotifications)# exit
                  		Exits the Notifications mode.  

        Configuration Example

        UCS# ProvisionNotifications
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req heartbeat 30
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_BA_password lab123 
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_BA_user guest123 
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_file_path myfiles/nid_notification 
UCS(ProvisionNotifications)# setNotificationReceiver setNotificationReceiver_req http_server_address 10.20.30.40
UCS(ProvisionNotifications)# setNotificationReceiver review

Commands in queue:
    setNotificationReceiver setNotificationReceiver_req heartbeat 30
    setNotificationReceiver setNotificationReceiver_req http_BA_password lab123 
    setNotificationReceiver setNotificationReceiver_req http_BA_user guest123 
    setNotificationReceiver setNotificationReceiver_req http_file_path myfiles/nid_notification 
    setNotificationReceiver setNotificationReceiver_req http_server_address 10.20.30.40

UCS(ProvisionNotifications)# setNotificationReceiver commit

	   SetNotificationReceiver_Output.setNotificationReceiver_resp.registerOK = true
    SetNotificationReceiver_Output.setNotificationReceiver_resp.cookie = 5120  

    SetNotificationReceiver Commit Success!!!!

UCS(ProvisionNIDMgmtType)# exit

        Note
        Use this procedure to generate multiple cookies. In the above mentioned example, 5120 is the cookie value.

        Registering for HeartBeat Notification

           Command or ActionPurpose
          Step 1Configure NID


          Example: 
          UCS# Configure NID 1
                      		Opens a new session for NID 1.  
          Step 2ProvisionNotifications


          Example: 
          UCS# ProvisionNotifications
                      		Enters the Notifications mode.  
          Step 3registerForNotification regForNotification_req {cookie cookie value | notifications_list List of notifications {enable {enable | disable} | module_id Module ID | notification_id Notification ID }}


          Example: 
          UCS(ProvisionNotifications)# registerForNotification regForNotification_req cookie 5120

UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 1 enable enable

UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 1 module_id 1

UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 1 notification_id 1
          Note    For the Heartbeat notification, the notification_list is 1, the module_id is 1, and the notification_id is 1.
                      		Lists all the registered notifications under the generated cookie.
          • cookie—Specifies the notification cookie with unique cookie value.
          • cookie value—cookie value. The range is from 1 to 65535.
          • notifications_list—Specifies the list of notifications.
          • List of notifications—list of notification ranges from 1 to 10, where, the supported lists are from 1 to 3.
          • enable—Enables or disables the notification.
          • module_id—Specifies the module ID from which notifications are desired.
          • Module ID—Module ID. The range is from 1 to 65536.
          • notification_id—Specifies the notification ID.
          • Notification ID—list of notification ranges from 1 to 10, wherein the supported lists are from 1 to 3.
           
          Step 4registerForNotification review


          Example: 
          UCS(ProvisionNotifications)# registerForNotification review
                      		Displays the configuration.  
          Step 5registerForNotification commit


          Example: 
          UCS(ProvisionNotifications)# registerForNotification commit
                      		Sends the configuration to the NID.  
          Step 6exit


          Example: 
          UCS(ProvisionNotifications)# exit
                      		Exits the Notification mode.  

          Configuration Example

          UCS# ProvisionNotifications
UCS(ProvisionNotifications)# registerForNotification regForNotification_req cookie 5120
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 1 enable enable
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 1 module_id 1
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 1 notification_id 1
UCS(ProvisionNotifications)# registerForNotification review

Commands in queue:
    registerForNotification regForNotification_req cookie 5120
    registerForNotification regForNotification_req notifications_list 1 enable enable
    registerForNotification regForNotification_req notifications_list 1 module_id 1
    registerForNotification regForNotification_req notifications_list 1 notification_id 1

UCS(ProvisionNotifications)# registerForNotification commit

	   RegisterForNotification_Output.regForNotification_resp = 0
    RegisterForNotification Commit Success!!!

UCS(ProvisionNIDMgmtType)# exit

          Registering for Config Change Trap Notification

             Command or ActionPurpose
            Step 1Configure NID


            Example: 
            UCS# Configure NID 1
                          		Opens a new session for NID 1.  
            Step 2ProvisionNotifications


            Example: 
            UCS# ProvisionNotifications
                          		Enters the Notifications mode.  
            Step 3registerForNotification regForNotification_req {cookie cookie value | notifications_list List of notifications {enable {enable | disable} | module_id Module ID | notification_id Notification ID }}


            Example: 
            UCS(ProvisionNotifications)# registerForNotification regForNotification_req cookie 5120
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 2 enable enable
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 2 module_id 2
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 2 notification_id 1
            Note    For the ConfigChangeTrap notification, the notification_list is 2, the module_id is 2, and the notification_id is 1.
                          		Lists all the registered notifications under the generated cookie.
            • cookie—Specifies the notification cookie with unique cookie value.
            • cookie value—cookie value. The range is from 1 to 65535.
            • notifications_list—Specifies the list of notifications.
            • List of notifications—list of notification ranges from 1 to 10, where, the supported lists are from 1 to 3.
            • enable—Enables or disables the notification.
            • module_id—Specifies the module ID from which notifications are desired.
            • Module ID—Module ID. The range is from 1 to 65536.
            • notification_id—Specifies the notification ID.
            • Notification ID—list of notification ranges from 1 to 10, wherein the supported lists are from 1 to 3.
             
            Step 4registerForNotification review


            Example: 
            UCS(ProvisionNotifications)# registerForNotification review
                          		Displays the configuration.  
            Step 5registerForNotification commit


            Example: 
            UCS(ProvisionNotifications)# registerForNotification commit
                          		Sends the configuration to the NID.  
            Step 6exit


            Example: 
            UCS(ProvisionNotifications)# exit
                          		Exits the Notifications mode.  

            Configuration Example

            UCS# ProvisionNotifications
UCS(ProvisionNotifications)# registerForNotification regForNotification_req cookie 5120
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 2 enable enable
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 2 module_id 2
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 2 notification_id 1
UCS(ProvisionNotifications)# registerForNotification review

Commands in queue:
    registerForNotification regForNotification_req cookie 5120
    registerForNotification regForNotification_req notifications_list 2 enable enable
    registerForNotification regForNotification_req notifications_list 2 module_id 2
    registerForNotification regForNotification_req notifications_list 2 notification_id 1

UCS(ProvisionNotifications)# registerForNotification commit

	   RegisterForNotification_Output.regForNotification_resp = 0
    RegisterForNotification Commit Success!!!

UCS(ProvisionNIDMgmtType)# exit

            Registering for Asynchronous Failure Notification

               Command or ActionPurpose
              Step 1Configure NID


              Example: 
              UCS# Configure NID 1
                              		Opens a new session for NID 1.  
              Step 2ProvisionNotifications


              Example: 
              UCS# ProvisionNotifications
                              		Enters the Notifications mode.  
              Step 3registerForNotification regForNotification_req {cookie cookie value | notifications_list List of notifications {enable {enable | disable} | module_id Module ID | notification_id Notification ID }}


              Example: 
              UCS(ProvisionNotifications)# registerForNotification regForNotification_req cookie 5120

UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 3 enable enable

UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 3 module_id 3

UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 3 notification_id 1
              Note    For the Asynchronous failure notification, the notification_list is 3, the module_id is 3, and the notification_id is 1.
                              		Lists all the registered notifications under the generated cookie.
              • cookie—Specifies the notification cookie with unique cookie value.
              • cookie value—cookie value. The range is from 1 to 65535.
              • notifications_list—Specifies the list of notifications.
              • List of notifications—list of notification ranges from 1 to 10, where, the supported lists are from 1 to 3.
              • enable—Enables or disables the notification.
              • module_id—Specifies the module ID from which notifications are desired.
              • Module ID—Module ID. The range is from 1 to 65536.
              • notification_id—Specifies the notification ID.
              • Notification ID—list of notification ranges from 1 to 10, wherein the supported lists are from 1 to 3.
               
              Step 4registerForNotification review


              Example: 
              UCS(ProvisionNotifications)# registerForNotification review
                              		Displays the configuration.  
              Step 5registerForNotification commit


              Example: 
              UCS(ProvisionNotifications)# registerForNotification commit
                              		Sends the configuration to the NID.  
              Step 6exit


              Example: 
              UCS(ProvisionNotifications)# exit
                              		Exits the Notifications mode.  

              Configuration Example

              UCS# ProvisionNotifications
UCS(ProvisionNotifications)# registerForNotification regForNotification_req cookie 5120
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 3 enable enable
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 3 module_id 3
UCS(ProvisionNotifications)# registerForNotification regForNotification_req notifications_list 3 notification_id 1
UCS(ProvisionNotifications)# registerForNotification review

Commands in queue:
    registerForNotification regForNotification_req cookie 5120
    registerForNotification regForNotification_req notifications_list 3 enable enable
    registerForNotification regForNotification_req notifications_list 3 module_id 3
    registerForNotification regForNotification_req notifications_list 3 notification_id 1

UCS(ProvisionNotifications)# registerForNotification commit

	   RegisterForNotification_Output.regForNotification_resp = 0
    RegisterForNotification Commit Success!!!

UCS(ProvisionNIDMgmtType)# exit

              Listing Notifications

                 Command or ActionPurpose
                Step 1Configure NID


                Example: 
                UCS# Configure NID 1
                                  		Opens a new session for NID 1.  
                Step 2ProvisionNotifications


                Example: 
                UCS# ProvisionNotifications
                                  		Enters the Notifications mode.  
                Step 3listRegisteredNotification listNotificationsRegistered {cookie cookie value}


                Example: 
                UCS(ProvisionNotifications)# listRegisteredNotification listNotificationsRegistered cookie 5120
                                  		Lists all the registered notifications under the generated cookie.
                • cookie—Specifies the notification cookie with unique cookie value.
                • cookie value—cookie value. The range is from 1 to 65535.
                 
                Step 4listRegisteredNotification review


                Example: 
                UCS(ProvisionNotifications)# listRegisteredNotification review
                                  		Displays the configuration.  
                Step 5listRegisteredNotification commit


                Example: 
                UCS(ProvisionNotifications)# listRegisteredNotification commit
                                  		Sends the configuration to the NID.  
                Step 6exit


                Example: 
                UCS(ProvisionNotifications)# exit
                                  		Exits the Notifications mode.  

                Configuration Example

                UCS# ProvisionNotifications
UCS(ProvisionNotifications)# listRegisteredNotification listNotificationsRegistered cookie 5120
UCS(ProvisionNotifications)# listRegisteredNotification review

Commands in queue:
    listRegisteredNotification listNotificationsRegistered cookie 5120

UCS(ProvisionNotifications)# listRegisteredNotification commit

    ListRegisteredNotification_Output.regForNotification_req.notifications_list[0].module_id = 1
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[0].notification_id = 1
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[0].enable = true
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[1].module_id = 2
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[1].notification_id = 1
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[1].enable = true
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[2].module_id = 3
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[2].notification_id = 1
    ListRegisteredNotification_Output.regForNotification_req.notifications_list[2].enable = true
    ListRegisteredNotification_Output.regForNotification_req.cookie = 5120

    ListRegisteredNotification Commit Success!!!

UCS(ProvisionNIDMgmtType)# exit

                Deleting Notifications

                   Command or ActionPurpose
                  Step 1Configure NID


                  Example: 
                  UCS# Configure NID 1
                                      		Opens a new session for NID 1.  
                  Step 2ProvisionNotifications


                  Example: 
                  UCS# ProvisionNotifications
                                      		Enters the Notifications mode.  
                  Step 3delNotificationReceiver delNotifReceiver_req {cookie cookie value}


                  Example: 
                  UCS(ProvisionNotifications)# delNotificationReceiver delNotifReceiver_req cookie 5120
                                      		Deletes the notifications under the cookie.
                  • cookie—Specifies the notification cookie with unique cookie value.
                  • cookie value—cookie value.
                   
                  Step 4delNotificationReceiver review


                  Example: 
                  UCS(ProvisionNotifications)# delNotificationReceiver review
                                      		Displays the configuration.  
                  Step 5delNotificationReceiver commit


                  Example: 
                  UCS(ProvisionNotifications)# delNotificationReceiver commit
                                      		Sends the configuration to the NID.  
                  Step 6exit


                  Example: 
                  UCS(ProvisionNotifications)# exit
                                      		Exits the Notifications mode.  

                  Configuration Example

                  UCS# ProvisionNotifications
UCS(ProvisionNotifications)# delNotificationReceiver delNotifReceiver_req cookie 5120
UCS(ProvisionNotifications)# delNotificationReceiver review

Commands in queue:
    delNotificationReceiver delNotifReceiver_req cookie 5120

UCS(ProvisionNotifications)# delNotificationReceiver commit

	   DelNotificationReceiver_Output.delNotifReceiver_resp = false

    DelNotificationReceiver Commit Success!!!

UCS(ProvisionNIDMgmtType)# exit
                  What to Do Next

                  After deleting the notification, use the listRegisteredNotification listNotificationsRegistered {cookie cookie value} command to verify if the delete operation is successful. 

                  UCS(ProvisionNotifications)# listRegisteredNotification listNotificationsRegistered cookie cookie value
UCS(ProvisionNotifications)# listRegisteredNotification review
UCS(ProvisionNotifications)# listRegisteredNotification commit