Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide

Page of 204
  
 
 
 
Cisco Evolved Programmable Network Manager 2.0.1 RESTCONF API Guide 
 
 
195 
      
mandatory
 true; 
      
description
 
        
"This references the subscription topic for which the
 
         notification is sent."
    } 
    
leaf
 creation-time { 
      
type
 yang:date-and-time; 
      
description
 
       
"This leaf contains the time of the creation, i.e. the
 
         time at which the change was observed."
    } 
    
leaf
 time-of-update { 
      
type
 yang:date-and-time; 
      
description
 
       
"This leaf contains the time of the update, i.e. the
 
         time at which the change was observed."
    } 
  } 
 
8.3  Connection-oriented Notifications 
The following is the workflow in the case of "connection-oriented" inventory notifications: 
 
 
The client subscribes to a predefined URL using a websocket client using basic 
authentication through a secure HTTPS channel.  
o  URL
https://<epnm-server-fully-qualified-domain-
name>/restconf/streams/v1/{notification-type}{.xml | .json}
 
  where {notification-type} can be either "inventory" or "service-
activation" 
  and appending the url with ".xml" will result in notifications 
serialized to xml format and ".json" will result in notifications 
serialized to json 
o  Authentication: Basic auth 
 
If the client has provided all required information and if the provided user passes 
the authorization phase, a secure connection channel is established between the 
EPN-M server and the client.  
 
Once the connection is established, the same connection will be kept alive 
throughout the lifecycle of the application. 
o  the lifecycle here is governed by the following cases: 
  until the client disconnects from the server 
  until the server goes down either for maintenance or during a 
failover. 
 
As long as the connection is kept alive, a notification of type push-change-update is 
sent from the EPN-M server to all clients that are listening for notifications. 
 
The yang schema for the cisco-yang-push has been included above. 
 
A sample client for subscribing and listening to connection-oriented notifications is 
provided in the next section. Connectionless notifications can be received by any REST 
service accepting an XML or JSON payload via a POST request.