Cisco Evolved Programmable Network
Manager 1.1– RESTConf NBI Guide
First Published: April, 2015
EDCS-1492121
Americas Headquarters
Cisco Systems, Inc.
170 West Tasman Drive
San Jose, CA 95134-1706
USA
http://www.cisco.com
Tel:
408 526-4000
800 553-NETS (6387)
Fax:
408 527-0883
Abstract
The Cisco NBI OSS Integration Guide for RESTConf/Yang gives information on OSS Integration using
RESTConf/Yang northbound interfaces.
THE SPECIFICATIONS AND INFORMATION REGARDING THE PRODUCTS IN THIS GUIDE ARE SUBJECT
TO CHANGE WITHOUT NOTICE. ALL STATEMENTS, INFORMATION, AND RECOMMENDATIONS IN THIS
GUIDE ARE BELIEVED TO BE ACCURATE BUT ARE PRESENTED WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED. USERS MUST TAKE FULL RESPONSIBILITY FOR THEIR APPLICATION OF ANY
PRODUCTS.
THE SOFTWARE LICENSE AND LIMITED WARRANTY FOR THE ACCOMPANYING PRODUCT ARE SET
FORTH IN THE INFORMATION PACKET THAT SHIPPED WITH THE PRODUCT AND ARE
INCORPORATED HEREIN BY THIS REFERENCE. IF YOU ARE UNABLE TO LOCATE THE SOFTWARE
LICENSE OR LIMITED WARRANTY, CONTACT YOUR CISCO REPRESENTATIVE FOR A COPY.
NOTWITHSTANDING ANY OTHER WARRANTY HEREIN, ALL DOCUMENT FILES AND SOFTWARE OF
THESE SUPPLIERS ARE PROVIDED “AS IS” WITH ALL FAULTS. CISCO AND THE ABOVE-NAMED
SUPPLIERS DISCLAIM ALL WARRANTIES, EXPRESSED OR IMPLIED, INCLUDING, WITHOUT
LIMITATION, THOSE OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OR ARISING FROM A COURSE OF DEALING, USAGE, OR TRADE PRACTICE.
IN NO EVENT SHALL CISCO OR ITS SUPPLIERS BE LIABLE FOR ANY INDIRECT, SPECIAL,
CONSEQUENTIAL, OR INCIDENTAL DAMAGES, INCLUDING, WITHOUT LIMITATION, LOST PROFITS OR
LOSS OR DAMAGE TO DATA ARISING OUT OF THE USE OR INABILITY TO USE THIS GUIDE, EVEN IF
CISCO OR ITS SUPPLIERS HAVE BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
Cisco and the Cisco logo are trademarks or registered trademarks of Cisco and/or its affiliates in the U.S. and
other countries. To view a list of Cisco trademarks, go to this URL:www.cisco.com/go/trademarks. Third-party
trademarks mentioned are the property of their respective owners. The use of the word partner does not
imply a partnership relationship between Cisco and any other company. (1110R)
Any Internet Protocol (IP) addresses and phone numbers used in this document are not intended to be actual
addresses and phone numbers. Any examples, command display output, network topology diagrams, and
other figures included in the document are shown for illustrative purposes only. Any use of actual IP
addresses or phone numbers in illustrative content is unintentional and coincidental.
Cisco EPN Manager 1.1 OSS Integration Guide for RESTConf/Yang
© 1999–2015 Cisco Systems, Inc. All rights reserved.
Contents
Table of Contents
Table of Contents ................................................................................................................. iii
1
2
Preface .......................................................................................................................... 5
1.1
Conventions.......................................................................................................................5
1.2
Additional User Documentation .........................................................................................5
1.3
Obtaining Documentation, Obtaining Support, and Security Guidelines...............................6
Northbound RESTConf/Yang Interface ............................................................................ 7
2.1
Web Services Standards .....................................................................................................7
2.2
RESTConf Standards ...........................................................................................................7
2.3
Communication Patterns....................................................................................................7
2.3.1
2.4
2.4.1
3
OSS Integration Usage Scenarios ........................................................................................8
Retrieving Device Inventory Flow ..........................................................................................................8
Supported RESTConf/Yang Interfaces ........................................................................... 10
3.1
3.1.1
3.1.2
3.1.3
4
Iterator Pattern ......................................................................................................................................8
RESTConf/Yang Interface Endpoints ................................................................................. 10
Authentication .....................................................................................................................................10
Authorization .......................................................................................................................................10
License .................................................................................................................................................10
RESTConf/Yang Interface Details .................................................................................. 11
4.1
ManagedElementRetrieval ............................................................................................... 11
4.1.1
Managed Element Data .......................................................................................................................11
4.1.2
Operations ...........................................................................................................................................12
4.1.2.1
getAllManagedElements ............................................................................................................12
4.1.2.2
getManagedElement ..................................................................................................................13
5
Troubleshooting ........................................................................................................... 14
6
Appendix I – WSDL Document References ..................................................................... 15
6.1
RESTConf/Yang WADL Documents .................................................................................... 15
7
Appendix III – Example Java Client to Retrieve Inventory .............................................. 16
8
Appendix III – Sample RESTFul Request Response ......................................................... 17
8.1
8.1.1
8.1.2
8.2
8.2.1
8.2.2
8.3
getAllManagedElements with XML Response.................................................................... 17
RESTConf Request ................................................................................................................................17
RESTConf Response .............................................................................................................................17
getAllManagedElements with JSON Response .................................................................. 19
RESTConf Request ................................................................................................................................19
RESTConf Response .............................................................................................................................19
getManagedElement with XML Response ......................................................................... 21
Cisco EPNM RESTConf NBI Guide
iii
Contents
8.3.1
8.3.2
8.4
8.4.1
8.4.2
RESTConf Request ................................................................................................................................21
RESTConf Response .............................................................................................................................21
getAllManagedElements with JSON Response .................................................................. 22
RESTConf Request ................................................................................................................................22
RESTConf Response .............................................................................................................................22
Cisco EPN Manager RESTConf NBI Guide
iv
Preface
1 Preface
This guide provides information about the RESTConf/Yang based NBI Northbound APIs
supported by Cisco Evolved Programmable Network (EPN) Manager. OSS operators can
use this document to integrate Cisco EPN Manager with their OSS system.
1.1 Conventions
This document uses the following conventions:
Convention
bold
Indication
Indicates commands, keywords, and user-entered text.
italic
Indicates document titles, new or emphasized terms, and arguments for
which you supply values.
[]
Indicates elements that are optional.
{x|y|z}
Indicates required alternative keywords grouped within brackets and
separated by vertical bars.
[x|y|z]
Indicates optional alternative keywords grouped in brackets and
separated by vertical bars.
String
Indicates a nonsuited set of characters. Do not use quotation marks
around the string or the string will include the quotation marks.
courier
font
Indicates code snippets and XML.
<>
Indicates nonprinting characters such as passwords.
[ ]
Indicates default responses to system prompts.
!,#
Indicates a comment when used at the beginning of a line of code.
Note
Means reader take note. Notes contain helpful suggestions or references to
material not covered in the publication.
1.2 Additional User Documentation
The RESTCong/Yang Specification with its supporting documents (Business Agreement
Interface Specification and System Description) can be obtained at: <Need to Update>.
Cisco EPNM RESTConf NBI Guide
5
Preface
1.3 Obtaining Documentation, Obtaining Support, and Security Guidelines
For information on obtaining documentation, submitting a service request, and
gathering additional information, see the monthly What’s New in Cisco Product
Documentation, which also lists all new and revised Cisco technical documentation, at:
http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html
Subscribe to the What’s New in Cisco Product Documentation as a Really Simple
Syndication (RSS) feed and set content to be delivered directly to your desktop using a
reader application. The RSS feeds are a free service and Cisco currently supports RSS
version 2.0.
Cisco EPN Manager RESTConf NBI Guide
6
Northbound
RESTConf/Yang Interface
2 Northbound RESTConf/Yang Interface
Cisco EPN Manager implements the RESTConf/Yang API as a standards-based Northbound
Interface for integrating EPN Manager with a standards-compliant OSS. It is a set of
RESTFul services confirmed to the RESTConf/Yang specification.
The EPN Manager implementation of the RESTConf/Yang interface supports the retrieval of
device inventory, circuit inventory, and notifications about respective resource changes
and provisioning. This includes:







Managed Elements and Equipment Inventory
Termination Point Inventory
Ethernet Virtual Connection Resource Inventory
Subnetwork Connection and Resource Inventory
Inventory Object Create, Delete and Attribute Value Change (AVC) Notifications
Service Inventory
Service Provisioning
2.1 Web Services Standards
RESTConf implementation of the EPN Manager is based on the following Web Services
specification from W3C standards, as mentioned in the RESTConf/Yang specification.




RESTful Web Services (JAX-RS)
XML Schema version 1.0 (XSD)
RESTConf standard - <Need to Update>
Yang specification - <Need to Update>
2.2 RESTConf Standards
The EPN Manager implementation of the RESTConf/Yang Interface conforms to the
RESTCong/Yang specification (<Need to Update>) information model and operational APIs.
The information model and operations APIs are extended in a standard way to support
Cisco’s vendor extensions to the RESTConf/Yang interface wherever required. These
extensions are added as a set of xml and yang schema definitions for the information
model extensions, and a set of WADL definitions for the operational model extensions.
2.3 Communication Patterns
RESTConf/Yang interfaces supported by EPN Manager use RPC Communication Style and
use the following Communication Patterns as defined in the RESTConf/Yang specification:
Cisco EPNM RESTConf NBI Guide
7
Northbound RESTConf/Yang Interface


Synchronous Request/Reply (SRR) – used for Simple Response
Synchronous Iterator (SIT) – used for Multiple Batched Responses
2.3.1 Iterator Pattern
The operations performed on supported RESTConf/Yang interfaces return a single object or
multiple objects. In case of operations that return multiple objects, a corresponding
synchronous iterator (SIT) operation is defined in RESTConf/Yang which manages the
responses in multiple batch responses. For example, to retrieve multiple objects of a
specific object type, you can use two operations, getAll<Object> and get<Object>Iterator
defined to retrieve objects in multiple batched responses.
2.4 OSS Integration Usage Scenarios
In a typical scenario, OSS clients integrating with EPN Manager may use the
RESTConf/Yanfg Interfaces supported by EPN Manager to retrieve the device inventory and
then export the inventory to other systems or use it to generate reports.
2.4.1 Retrieving Device Inventory Flow
The following sequence flow illustrates how RESTConf/Yang Web services operations may
be invoked to retrieve the device inventory from EPN Manager for integration purposes.
Cisco EPN Manager RESTConf NBI Guide
8
Northbound
RESTConf/Yang Interface
Cisco EPNM RESTConf NBI Guide
9
Supported RESTConf/Yang Interfaces
3 Supported RESTConf/Yang Interfaces
The following table lists the RESTConf/Yang interfaces and associated operations supported in
the EPN Manager implementation.
Table 2- Supported RESTConf/Yang Interfaces
Interface Name
Operation Name
ManagedElementRetrieval
getAllManagedElements
getManagedElement
Cisco
Extension
Y
Y
3.1 RESTConf/Yang Interface Endpoints
The following table lists the endpoint URLs that can be used to access the supported
RESTConf/Yang Web Services in EPN Manager.
RESTConf/Yang Web Service Endpoint URL
https://<host>/restconf/v1/data/mri-mer:ManagedElement/
https://<host>/restconf/v1/data/mrimer:ManagedElement/<instanceId>
Description
Provide operations to retrieve all
ManagedElements.
Provide operations to retrieve
ManagedElement.
3.1.1 Authentication
The RESTConf/Yang endpoints in EPN Manager are secured. To access these endpoints, use
basic HTTP authentication.
3.1.2 Authorization
User credentials passed for accessing the RESTConf/Yang endpoints require the proper
authorization to use the API. This authorization can be configured using EPN Manager’s
Security Management interface. In EPN Manager, NBI read privileges are required to
access all retrieval RESTConf/Yang interfaces, whereas to use the provisioning
RESTConf/Yang interface, you require NBI Write privileges.
3.1.3 License
An EPN Manager RESTConf/Yang license is required to use RESTConf/Yang interface
endpoints.
Cisco EPN Manager RESTConf NBI Guide
10
RESTConf/Yang Interface
Details
4 RESTConf/Yang Interface Details
This section provides details about the supported RESTConf/Yang interfaces.
4.1 ManagedElementRetrieval
This interface provides the operations required to retrieve Managed Element details.
These operations return the Managed Element details in the form of a single Managed
Element or in the form of batches (list) of Managed Elements.
4.1.1 Managed Element Data
The following table lists the Managed Element data that can be retrieved by the interface.
Managed Element
Data
Data Type
Description
me
ManagedElementT
ype
String
String
NamingAttributeTy
pe
String
String
Holder element that contains the data given below for the
managed element.
instanceId of the Network Element
ID of the Network Element
List of RDNs containing the MD and ME.
instanceId
networkElementId
name (Object Id)
description
managementAddress
communicationState
collectionStatus
collectionTime
lastBootTime
creationTime
CommunicationSta
teType
String
DateTime
DateTime
DateTime
Description.
IP address of the device. This is the preferred management
access address for the device. This is typically an address at
which SNMP, Telnet, and SSH agents are available.
Communication state of Managed Element.
Status of the inventory collection.
Time of inventory collection.
Last boot time.
Timestamp when the instance of the device was created
Cisco EPNM RESTConf NBI Guide
11
RESTConf/Yang Interface Details
lifecycleState
ResourceStateType
Lifecycle state of Managed Element. Value is a
“VENDOR_EXT” with the attribute “extension”.
Represents the current management state of the network
element: managed, unmanaged, under maintenance, and
so forth. This state is modified by events in the network,
network management system, and user request.
Value is set to “VENDOR_EXT” with the attribute
“extension” values set to one of the following:
clusterCount
int
softwareType
String
softwareVersion
productVendor
productSeries
productFamily
discoveredName
sysObjectId
location
sysUpTime
sysContact
satelliteCount
String
String
String
String
String
String
String
String
String
int
UNKNOWN
ADDED_INITIALSTATE
MANAGED_BUT_NEVERSYNCHRONIZED
MANAGED_AND_SYNCHRONIZED
MANAGED_BUT_OUTOFSYNC
MANAGED_BUT_LOSSOFCONNECTIVITY
PREPROVISIONED
UNMANAGED
INSERVICE_MAINTENANCE
MANAGED_BUT_INCOMPLETE
MANAGED_BUT_AGENTSHUTTINGDOWN
MANAGED_PREPARINGFORMAINTENANCE
MANAGED_BUT_DUPLICATE
MANAGED_BUT_CONFLICTINGCREDENTIALS
MANAGED_BUT_SYNCHRONIZING
UNMANAGED_UNLICENSED
Set to number of cluster nodes this managed element
manages.
A string that identifies the specific type of software that is
installed. For example, Cisco IOS or Linux.
Software Version of Managed Element.
Vendor.
Product series.
Product family of this device.
Managed Element Name.
System object ID of the ME.
Syslocation of Managed Element.
Up time.
System Contact.
Set to the number of satellites that this managed element
manages.
4.1.2 Operations
4.1.2.1 getAllManagedElements
This operation retrieves all Managed Element instances present in the network.
Input
Request Parameter
Authorization
Data Type
Basic
Cisco EPN Manager RESTConf NBI Guide
12
Description
Username and Password.
RESTConf/Yang Interface
Details
Request Parameter
Accept
https://<host>/restconf/v
1/data/mrimer:ManagedElement/
Data Type
XML or JSON
ManagedElement
Description
application/xml and application/json
Empty Request Element representing the request.
Output
Response data
managedElements
Data Type
managedElements
Description
List of Managed Elements. See Managed
Element Data above for details.
Exceptions
internalError: Indicates that an internal error or exception is occurring as part of this call.
invalidInput: Indicates that an invalid input is given to the operation.
notImplemented: Indicates that the operation is not implemented by the management
system.
4.1.2.2 getManagedElement
This operation retrieves details about a specified Managed Element instance.
Input
Request Parameter
Authorization
Accept
https://<host>/restco
nf/v1/data/mrimer:ManagedElement
/<instanceId>
Data Type
Basic
XML or JSON
ManagedElement
Description
Username and Password.
application/xml and application/json
Empty Request Element representing the request.
Output
Response Data
getManagedElementRe
sponse
Data Type
SingleMeObjectRespons
eType
Description
Holder for response that contains the single Managed
Element details.
managedElement
ManagedElement
Managed Element details. See Managed Element Data
for details of the data returned.
Exceptions
internalError: Indicates that an internal error or exception is occurring as part of this call.
invalidInput: Indicates that the input given to the operation is invalid.
Cisco EPNM RESTConf NBI Guide
13
Troubleshooting
5 Troubleshooting
The following table provides a list of problems that you may encounter when setting up
the OSS integration layer, along with the probable cause and troubleshooting steps for
each problem.
Problem
Description
Web Services
Security
Exception
getManagedEle
ment returns
an Exception
Indication
Probable Cause
Troubleshooting Procedure
Web Service call to any of the
Interfaces throws a WS
Security exception with
authentication failure
message
A call to getManagedElement
returns a Web Services
exception stating that the
device is not in up-state
though it is actually up.
The user ID /
password provided
for the web service
call might not be
correct
The device name
specified in request is
incorrect
Use a proper User ID /
password for the web services
call
Cisco EPN Manager RESTConf NBI Guide
14
Cross-check the device name in
getManagedElements response
and check if device is in up
state
Appendix I – WSDL
Document References
6 Appendix I – WSDL Document References
6.1 RESTConf/Yang WADL Documents
WSDL Documents are part of the RESTConf/Yang Specification. They can be obtained from the
TMF Forum: <Need to Update>.
Cisco EPNM RESTConf NBI Guide
15
Appendix III – Example Java Client to Retrieve Inventory
7 Appendix III – Example Java Client to Retrieve Inventory
This section provides a Java code snippet that can be used by Java-based OSS clients to
invoke a RESTConf/Yang web service for retrieving a Managed Element’s inventory.
Need to Update the Java Client Code Example.
Cisco EPN Manager RESTConf NBI Guide
16
Appendix III – Sample
RESTFul Request Response
8 Appendix III – Sample RESTFul Request Response
This appendix provides sample RESTful Requests and Responses for some of the operations
provided by the RESTConf NBI.
8.1 getAllManagedElements with XML Response
8.1.1 RESTConf Request
http://<host>/epnm-restconf/v1/data/mri-mer:ManagedElement/
Authorization: Basic
Accept: application/xml
8.1.2 RESTConf Response
<managedElements>
<managedElement
xmlns="http://cisco.com/epnm/restconf/module/mri/mer">
<instanceId>6137131</instanceId>
<networkElementId>6141135</networkElementId>
<name>ASR9K-AGG3</name>
<description>Cisco IOS XR Software (Cisco ASR9K Series), Version
5.1.1[Default]&#xD;
Copyright (c) 2014 by Cisco Systems, Inc.</description>
<managementAddress>172.20.109.16</managementAddress>
<communicationState>REACHABLE</communicationState>
<collectionStatus>&lt;status&gt;&lt;general
code=&quot;SUCCESS&quot;/&gt;&lt;/status&gt;</collectionStatus>
<collectionTime>2015-04-16T22:25:34.038-07:00</collectionTime>
<lastBootTime>2015-04-05T14:38:00.277-07:00</lastBootTime>
<creationTime>2015-04-07T22:22:56.797-07:00</creationTime>
<lifecycleState>MANAGED_AND_SYNCHRONIZED</lifecycleState>
<clusterCount>0</clusterCount>
<softwareType>IOS XR</softwareType>
<softwareVersion>5.1.1[Default]</softwareVersion>
<productType>Cisco ASR 9006 Router</productType>
<productFamily>Routers</productFamily>
<productSeries>Cisco ASR 9000 Series Aggregation Services
Routers</productSeries>
<sysObjectId>1.3.6.1.4.1.9.1.1018</sysObjectId>
<sysLocation>WestCore</sysLocation>
<sysUpTime>11 days, 7:22:05.51</sysUpTime>
<sysContact>NULL</sysContact>
<satelliteCount>1</satelliteCount>
</managedElement>
<managedElement
xmlns="http://cisco.com/epnm/restconf/module/mri/mer">
<instanceId>545545</instanceId>
<networkElementId>6887881</networkElementId>
<name>cvg-scapa-222.cisco.com</name>
<description>Cisco IOS XR Software (NCS-4000), Version 5.2.4.12I&#xD;
Copyright (c) 2013-2014 by Cisco Systems, Inc.</description>
<managementAddress>10.58.235.122</managementAddress>
<communicationState>REACHABLE</communicationState>
<collectionStatus>&lt;status&gt;&lt;general
code=&quot;FAILED_FEAT&quot;/&gt;&lt;failed_features
names=&quot;feature_MedianetCapabilityDetector,feature_config_interface,ifm-imconnectivity-dialer-extmodule,feature_DefaultGateway,feature_memorypool,feature_powerSupplyFanStatusNCS4k,feature_rip,feature_static,feature_eigrp,ifm-aclapp,ifmaclapp,pkgs_image,optics_interface,odu_interface,otu_interface,port_mode,otu_link,
optical_feature_iosxr_lmp,stm_interface,optical_feature_iosxr_gcc,optical_feature_
Cisco EPNM RESTConf NBI Guide
17
Appendix III – Sample RESTFul Request Response
iosxr_odu_tunnel,optical_feature_iosxr_odu_cross_connections,optical_feature_iosxr
_otn_protn&quot; code=&quot;CLI_AUTH_ERROR&quot;/&gt;&lt;failed_features
names=&quot;feature_flashdevice&quot;
code=&quot;SNMP_TIMEOUT&quot;/&gt;&lt;failed_features
names=&quot;IPVersionDetectorFeature,feature_config_controllers,featureRouterCluster,oc_interface,optical_feature_iosxr_stacking,ethernet_interface,featu
re_image&quot;
code=&quot;ERROR_TIMEOUT&quot;/&gt;&lt;/status&gt;</collectionStatus>
<collectionTime>2015-04-16T22:22:53.101-07:00</collectionTime>
<lastBootTime>2015-04-15T06:31:01.089-07:00</lastBootTime>
<creationTime>2015-03-09T16:36:27.047-07:00</creationTime>
<lifecycleState>MANAGED_BUT_OUTOFSYNC</lifecycleState>
<clusterCount>0</clusterCount>
<productType>Cisco NCS 4016</productType>
<productFamily>Optical Networking</productFamily>
<productSeries>Cisco Network Convergence System 4000
Series</productSeries>
<sysObjectId>1.3.6.1.4.1.9.1.1939</sysObjectId>
<sysUpTime>1 day, 15:29:09.10</sysUpTime>
<satelliteCount>0</satelliteCount>
</managedElement>
<managedElement
xmlns="http://cisco.com/epnm/restconf/module/mri/mer">
<instanceId>545548</instanceId>
<networkElementId>547548</networkElementId>
<name>ASR903-AC-2</name>
<description>Cisco IOS Software, ASR903 Software (PPC_LINUX_IOSDUNIVERSAL-M), Version 15.4(2)S1, RELEASE SOFTWARE (fc4)&#xD;
Technical Support: http://www.cisco.com/techsupport&#xD;
Copyright (c) 1986-2014 by Cisco Systems, Inc.&#xD;
Compiled Mon 30-Jun-14 07:16 by mcpre</description>
<managementAddress>172.20.109.25</managementAddress>
<communicationState>REACHABLE</communicationState>
<collectionStatus>&lt;status&gt;&lt;general
code=&quot;SUCCESS&quot;/&gt;&lt;/status&gt;</collectionStatus>
<collectionTime>2015-04-16T22:00:22.326-07:00</collectionTime>
<lastBootTime>2015-03-24T00:11:45.269-07:00</lastBootTime>
<creationTime>2015-03-16T17:29:17.720-07:00</creationTime>
<lifecycleState>MANAGED_AND_SYNCHRONIZED</lifecycleState>
<clusterCount>0</clusterCount>
<softwareType>IOS-XE</softwareType>
<softwareVersion>15.4(2)S1</softwareVersion>
<productType>Cisco ASR 903 Router</productType>
<productFamily>Routers</productFamily>
<productSeries>Cisco ASR 900 Series Aggregation Services
Routers</productSeries>
<sysObjectId>1.3.6.1.4.1.9.1.1441</sysObjectId>
<sysUpTime>23 days, 21:48:14.01</sysUpTime>
<satelliteCount>0</satelliteCount>
</managedElement>
<managedElement
xmlns="http://cisco.com/epnm/restconf/module/mri/mer">
<instanceId>545546</instanceId>
<networkElementId>547547</networkElementId>
<name>nmtg-tme-test-2K-184</name>
<description>IPADDR=172.23.222.184,IPMASK=255.255.255.0,DEFRTR=172.23.222.1,IPV6EN
ABLE=N,IIOPPORT=57790,NAME=\&quot;nmtg-tme-test-2K184\&quot;,SWVER=10.01.01,LOAD=10.101-014-K0716-FSPA,PROTSWVER=10.00.20,PROTLOAD=10.02-014I-05.19-F-SPA,DEFDESC=\&quot;Factory
Defaults\&quot;,PLATFORM=NCS2KFLEXM6,SECUMODE=NORMAL,SUPPRESSIP=NO,MODE=MULTISHELFETH,MSPUBVLANID=1,MSINTLVLANID=2,A
UTOPM=NO,SERIALPORTECHO=Y,OSIROUTINGMODE=IS1,OSIL1BUFSIZE=512,NET=39840F8000000000
0000000000D867D96D886000,SYSTEMMODE=SONET,ALARMSUPPRESS=N,SOFTWARE=ONS</descriptio
n>
<managementAddress>172.23.222.184</managementAddress>
<communicationState>REACHABLE</communicationState>
<collectionStatus>&lt;status&gt;&lt;general
code=&quot;SUCCESS&quot;/&gt;&lt;/status&gt;</collectionStatus>
<collectionTime>2015-04-16T22:00:54.830-07:00</collectionTime>
<lastBootTime>2015-04-16T22:00:00.399-07:00</lastBootTime>
Cisco EPN Manager RESTConf NBI Guide
18
Appendix III – Sample
RESTFul Request Response
<creationTime>2015-03-09T16:37:03.411-07:00</creationTime>
<lifecycleState>MANAGED_AND_SYNCHRONIZED</lifecycleState>
<clusterCount>0</clusterCount>
<softwareType>NCS SONET</softwareType>
<softwareVersion>10.101.01</softwareVersion>
<productType>Cisco NCS 2006</productType>
<productFamily>Optical Networking</productFamily>
<productSeries>Cisco Network Convergence System 2000
Series</productSeries>
<sysObjectId>1.3.6.1.4.1.3607.1.20.10.70</sysObjectId>
<satelliteCount>0</satelliteCount>
</managedElement>
</managedElements>
8.2 getAllManagedElements with JSON Response
8.2.1 RESTConf Request
http://<host>/restconf/v1/data/mri-mer:ManagedElement/
Authorization: Basic
Accept: application/json
8.2.2 RESTConf Response
[
{
"instanceId": 6137131,
"networkElementId": 6141135,
"name": "ASR9K-AGG3",
"description": "Cisco IOS XR Software (Cisco ASR9K Series), Version
5.1.1[Default]\r\nCopyright (c) 2014 by Cisco Systems, Inc.",
"managementAddress": "172.20.109.16",
"communicationState": "REACHABLE",
"collectionStatus": "<status><general code=\"SUCCESS\"/></status>",
"collectionTime": 1429248334038,
"lastBootTime": 1428269880277,
"creationTime": 1428470576797,
"lifecycleState": "MANAGED_AND_SYNCHRONIZED",
"clusterCount": 0,
"softwareType": "IOS XR",
"softwareVersion": "5.1.1[Default]",
"softwareFamily": null,
"productType": "Cisco ASR 9006 Router",
"productFamily": "Routers",
"productSeries": "Cisco ASR 9000 Series Aggregation Services Routers",
"productVendor": null,
"sysObjectId": "1.3.6.1.4.1.9.1.1018",
"sysLocation": "WestCore",
"sysUpTime": "11 days, 7:22:05.51",
"sysContact": "NULL",
"satelliteCount": 1,
"entityTag": null
},
{
"instanceId": 545545,
"networkElementId": 6887881,
"name": "cvg-scapa-222.cisco.com",
"description": "Cisco IOS XR Software (NCS-4000), Version
5.2.4.12I\r\nCopyright (c) 2013-2014 by Cisco Systems, Inc.",
"managementAddress": "10.58.235.122",
"communicationState": "REACHABLE",
"collectionStatus": "<status><general
code=\"FAILED_FEAT\"/><failed_features
Cisco EPNM RESTConf NBI Guide
19
Appendix III – Sample RESTFul Request Response
names=\"feature_MedianetCapabilityDetector,feature_config_interface,ifm-imconnectivity-dialer-extmodule,feature_DefaultGateway,feature_memorypool,feature_powerSupplyFanStatusNCS4k,feature_rip,feature_static,feature_eigrp,ifm-aclapp,ifmaclapp,pkgs_image,optics_interface,odu_interface,otu_interface,port_mode,otu_link,
optical_feature_iosxr_lmp,stm_interface,optical_feature_iosxr_gcc,optical_feature_
iosxr_odu_tunnel,optical_feature_iosxr_odu_cross_connections,optical_feature_iosxr
_otn_protn\" code=\"CLI_AUTH_ERROR\"/><failed_features
names=\"feature_flashdevice\" code=\"SNMP_TIMEOUT\"/><failed_features
names=\"IPVersionDetectorFeature,feature_config_controllers,featureRouterCluster,oc_interface,optical_feature_iosxr_stacking,ethernet_interface,featu
re_image\" code=\"ERROR_TIMEOUT\"/></status>",
"collectionTime": 1429248173101,
"lastBootTime": 1429104661089,
"creationTime": 1425944187047,
"lifecycleState": "MANAGED_BUT_OUTOFSYNC",
"clusterCount": 0,
"softwareType": null,
"softwareVersion": null,
"softwareFamily": null,
"productType": "Cisco NCS 4016",
"productFamily": "Optical Networking",
"productSeries": "Cisco Network Convergence System 4000 Series",
"productVendor": null,
"sysObjectId": "1.3.6.1.4.1.9.1.1939",
"sysLocation": null,
"sysUpTime": "1 day, 15:29:09.10",
"sysContact": null,
"satelliteCount": 0,
"entityTag": null
},
{
"instanceId": 545548,
"networkElementId": 547548,
"name": "ASR903-AC-2",
"description": "Cisco IOS Software, ASR903 Software (PPC_LINUX_IOSDUNIVERSAL-M), Version 15.4(2)S1, RELEASE SOFTWARE (fc4)\r\nTechnical Support:
http://www.cisco.com/techsupport\r\nCopyright (c) 1986-2014 by Cisco Systems,
Inc.\r\nCompiled Mon 30-Jun-14 07:16 by mcpre",
"managementAddress": "172.20.109.25",
"communicationState": "REACHABLE",
"collectionStatus": "<status><general code=\"SUCCESS\"/></status>",
"collectionTime": 1429246822326,
"lastBootTime": 1427181105269,
"creationTime": 1426552157720,
"lifecycleState": "MANAGED_AND_SYNCHRONIZED",
"clusterCount": 0,
"softwareType": "IOS-XE",
"softwareVersion": "15.4(2)S1",
"softwareFamily": null,
"productType": "Cisco ASR 903 Router",
"productFamily": "Routers",
"productSeries": "Cisco ASR 900 Series Aggregation Services Routers",
"productVendor": null,
"sysObjectId": "1.3.6.1.4.1.9.1.1441",
"sysLocation": null,
"sysUpTime": "23 days, 21:48:14.01",
"sysContact": null,
"satelliteCount": 0,
"entityTag": null
},
{
"instanceId": 545546,
"networkElementId": 547547,
"name": "nmtg-tme-test-2K-184",
"description":
"IPADDR=172.23.222.184,IPMASK=255.255.255.0,DEFRTR=172.23.222.1,IPV6ENABLE=N,IIOPP
ORT=57790,NAME=\\\"nmtg-tme-test-2K-184\\\",SWVER=10.01.01,LOAD=10.101-014-K0716F-SPA,PROTSWVER=10.00.20,PROTLOAD=10.02-014I-05.19-F-SPA,DEFDESC=\\\"Factory
Defaults\\\",PLATFORM=NCS2KFLEXM6,SECUMODE=NORMAL,SUPPRESSIP=NO,MODE=MULTISHELFETH,MSPUBVLANID=1,MSINTLVLANID=2,A
Cisco EPN Manager RESTConf NBI Guide
20
Appendix III – Sample
RESTFul Request Response
UTOPM=NO,SERIALPORTECHO=Y,OSIROUTINGMODE=IS1,OSIL1BUFSIZE=512,NET=39840F8000000000
0000000000D867D96D886000,SYSTEMMODE=SONET,ALARMSUPPRESS=N,SOFTWARE=ONS",
"managementAddress": "172.23.222.184",
"communicationState": "REACHABLE",
"collectionStatus": "<status><general code=\"SUCCESS\"/></status>",
"collectionTime": 1429246854830,
"lastBootTime": 1429246800399,
"creationTime": 1425944223411,
"lifecycleState": "MANAGED_AND_SYNCHRONIZED",
"clusterCount": 0,
"softwareType": "NCS SONET",
"softwareVersion": "10.101.01",
"softwareFamily": null,
"productType": "Cisco NCS 2006",
"productFamily": "Optical Networking",
"productSeries": "Cisco Network Convergence System 2000 Series",
"productVendor": null,
"sysObjectId": "1.3.6.1.4.1.3607.1.20.10.70",
"sysLocation": null,
"sysUpTime": null,
"sysContact": null,
"satelliteCount": 0,
"entityTag": null
}
]
8.3 getManagedElement with XML Response
8.3.1 RESTConf Request
http://<host>/epnm-restconf/v1/data/mri-mer:ManagedElement/6137131
Authorization: Basic
Accept: application/xml
8.3.2 RESTConf Response
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<managedElement
xmlns="http://cisco.com/epnm/restconf/module/mri/mer">
<instanceId>6137131</instanceId>
<networkElementId>6141135</networkElementId>
<name>ASR9K-AGG3</name>
<description>Cisco IOS XR Software (Cisco ASR9K Series), Version
5.1.1[Default]&#xD;
Copyright (c) 2014 by Cisco Systems, Inc.</description>
<managementAddress>172.20.109.16</managementAddress>
<communicationState>REACHABLE</communicationState>
<collectionStatus>&lt;status&gt;&lt;general
code=&quot;SUCCESS&quot;/&gt;&lt;/status&gt;</collectionStatus>
<collectionTime>2015-04-16T22:25:34.038-07:00</collectionTime>
<lastBootTime>2015-04-05T14:38:00.277-07:00</lastBootTime>
<creationTime>2015-04-07T22:22:56.797-07:00</creationTime>
<lifecycleState>MANAGED_AND_SYNCHRONIZED</lifecycleState>
<clusterCount>0</clusterCount>
<softwareType>IOS XR</softwareType>
<softwareVersion>5.1.1[Default]</softwareVersion>
<productType>Cisco ASR 9006 Router</productType>
<productFamily>Routers</productFamily>
<productSeries>Cisco ASR 9000 Series Aggregation Services
Routers</productSeries>
<sysObjectId>1.3.6.1.4.1.9.1.1018</sysObjectId>
<sysLocation>WestCore</sysLocation>
<sysUpTime>11 days, 7:22:05.51</sysUpTime>
Cisco EPNM RESTConf NBI Guide
21
Appendix III – Sample RESTFul Request Response
<sysContact>NULL</sysContact>
<satelliteCount>1</satelliteCount>
</managedElement>
8.4 getAllManagedElements with JSON Response
8.4.1 RESTConf Request
http://<host>/epnm-restconf/v1/data/mri-mer:ManagedElement/6137131
Authorization: Basic
Accept: application/json
8.4.2 RESTConf Response
{
"instanceId": 6137131,
"networkElementId": 6141135,
"name": "ASR9K-AGG3",
"description": "Cisco IOS XR Software (Cisco ASR9K Series), Version
5.1.1[Default]\r\nCopyright (c) 2014 by Cisco Systems, Inc.",
"managementAddress": "172.20.109.16",
"communicationState": "REACHABLE",
"collectionStatus": "<status><general code=\"SUCCESS\"/></status>",
"collectionTime": 1429248334038,
"lastBootTime": 1428269880277,
"creationTime": 1428470576797,
"lifecycleState": "MANAGED_AND_SYNCHRONIZED",
"clusterCount": 0,
"softwareType": "IOS XR",
"softwareVersion": "5.1.1[Default]",
"softwareFamily": null,
"productType": "Cisco ASR 9006 Router",
"productFamily": "Routers",
"productSeries": "Cisco ASR 9000 Series Aggregation Services Routers",
"productVendor": null,
"sysObjectId": "1.3.6.1.4.1.9.1.1018",
"sysLocation": "WestCore",
"sysUpTime": "11 days, 7:22:05.51",
"sysContact": "NULL",
"satelliteCount": 1,
"entityTag": null
}
Cisco EPN Manager RESTConf NBI Guide
22