RESTConf Interface

Introduction

Cisco EPN Manager implements the RESTCONF API as a standards-based Northbound Interface for integrating Cisco EPN Manager with a standards-compliant OSS. It is a set of RESTFul services confirmed to the RESTCONF/YANG specifications.

The Cisco EPN Manager implementation of the RESTCONF/YANG interface supports the retrieval of device inventory, circuit inventory, circuit provisioning and notifications about respective resource changes and provisioning. This includes:

  • Managed Elements and Equipment Inventory
  • Termination Point and Topological Link Inventory
  • Virtual Connection (RFS) Resource Inventory
  • Service (CFS) Inventory
  • Service Provisioning
  • Inventory Object Create, Delete and Attribute Value Change (AVC) Notifications.

In a Nutshell

  • RESTCONF is an HTTP based protocol for data defined in YANG using the datastore concepts from NETCONF
  • RESTCONF uses HTTP methods to provide CRUD operations on a conceptual datastore containing YANG-defined data

Forming the API URLs - API Endpoints

  • GET is used to retrieve data - https://{{host}}/restconf/data/ https://{{host}}/restconf/data/v1/cisco-resource-ems:termination-point
  • DELETE, PATCH, POST, and PUT methods is used to modify data
  • Data is encoded with XML or JSON
  • Operations (RPC) are under - https://{{host}}/restconf/operations/ https://{{host}}/restconf/operations/v1/cisco-service-activation:provision-service
  • RESTCONF provides event capability similar to the NETCONF event stream