Cisco Evolved Programmable Network
Manager 2.0– RESTCONF NBI Guide
First Published: May 2, 2016
EDCS-1542631
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 2.0 OSS Integration Guide for RESTCONF/YANG
© 1999–2016 Cisco Systems, Inc. All rights reserved.
Contents
Table of Contents
Table of Contents ................................................................................................................. iii
1
2
Preface .......................................................................................................................... 5
1.1
Conventions.......................................................................................................................5
1.2
Obtaining Documentation, Obtaining Support, and Security Guidelines...............................5
Northbound RESTCONF/YANG Interface ......................................................................... 7
2.1
Web Services Standards .....................................................................................................7
2.2
RESTCONF Standards .........................................................................................................7
2.3
Communication Patterns....................................................................................................7
Containment Associations ...................................................................................................................................7
2.4
OSS Integration Usage Scenarios ........................................................................................8
Retrieving Inventory .............................................................................................................................................8
3
Supported RESTCONF/YANG Interfaces .......................................................................... 9
3.1
RESTCONF/YANG Interface Endpoints.................................................................................9
Authentication ...................................................................................................................................................11
Authorization .....................................................................................................................................................11
License................................................................................................................................................................11
4
RESTCONF/YANG Interface Details ............................................................................... 12
4.1
Group Retrieval ............................................................................................................... 12
Group Data .........................................................................................................................................................12
Operations .........................................................................................................................................................12
Sample Response Data .......................................................................................................................................13
4.1.1.1
JSON ...........................................................................................................................................13
4.2
ManagedElement Retrieval .............................................................................................. 14
ManagedElement Data ......................................................................................................................................14
Operations .........................................................................................................................................................16
Sample Response Data .......................................................................................................................................16
4.2.1.1
JSON ...........................................................................................................................................16
4.3
Chassis Retrieval .............................................................................................................. 23
Chassis Data .......................................................................................................................................................23
Operations .........................................................................................................................................................26
Sample Response Data .......................................................................................................................................26
4.3.1.1
JSON ...........................................................................................................................................26
4.4
Equipment Retrieval ........................................................................................................ 43
Equipment Data .................................................................................................................................................43
Operations .........................................................................................................................................................45
Sample Response Data .......................................................................................................................................46
4.4.1.1
JSON ...........................................................................................................................................46
4.5
Module Retrieval ............................................................................................................. 51
Module Data ......................................................................................................................................................51
Operations .........................................................................................................................................................53
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
iii
Contents
Sample Response Data .......................................................................................................................................55
4.5.1.1
JSON ...........................................................................................................................................55
4.6
PhysicalConnector Retrieval ............................................................................................. 64
PhysicalConnector Data .....................................................................................................................................64
Operations .........................................................................................................................................................64
Sample Response Data .......................................................................................................................................65
4.6.1.1
JSON ...........................................................................................................................................65
4.7
Physical Protocol Endpoint Retrieval ................................................................................ 67
PhysicalProtocolEndpoint Data ..........................................................................................................................67
Operations .........................................................................................................................................................69
Sample Response Data .......................................................................................................................................70
4.7.1.1
JSON ...........................................................................................................................................70
4.8
InterfaceProtocolEndpoint Retrieval................................................................................. 72
InterfaceProtocolEndpoint Data ........................................................................................................................72
Operations .........................................................................................................................................................73
Sample Response Data .......................................................................................................................................74
4.8.1.1
JSON ...........................................................................................................................................74
5
6
Fully-qualified Domain Names (FDN) ............................................................................ 76
5.1
ManagedElement FDN Format ......................................................................................... 76
5.2
Equipment FDN Format .................................................................................................... 77
5.3
ProtocolEndpoint FDN Format .......................................................................................... 78
RESTCONF/YANG Containment Hirarchy ....................................................................... 80
6.1
Physical Inventory YANG Containment Hirarchy................................................................ 80
Physical Inventory YANG Containment Hierarchy - High Level Class Diagram ..................................................80
Physical Inventory YANG Containment Hierarchy – Detailed Class Diagram .....................................................80
7
Additional REST API:..................................................................................................... 81
8
Using Filtering.............................................................................................................. 82
Filtering Syntax ............................................................................................................................ 82
URL encoding ............................................................................................................................... 82
Advanced Filtering ....................................................................................................................... 82
9
Using Sorting ............................................................................................................... 84
Ascending vs. Descending............................................................................................................. 84
10 Using Paging ................................................................................................................ 85
11 Combination of filtering, sorting and paging ................................................................ 86
12 Troubleshooting ........................................................................................................... 87
13 Appendix II – REST Clients............................................................................................. 88
Cisco Evolved Programmable Network Manager 2.0 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 font
Indication
Commands and keywords and user-entered text appear in bold font.
italic font
Document titles, new or emphasized terms, and arguments for which
you supply values are in italic font.
[]
Elements in square brackets are optional.
{x|y|z}
Required alternative keywords are grouped in braces and separated by
vertical bars.
[x|y|z]
Optional alternative keywords are grouped in brackets and separated
by vertical bars.
String
A nonsuited set of characters. Do not use quotation marks around the
string or the string will include the quotation marks.
courier
font
For code snippets and XML.
<>
Nonprinting characters such as passwords are in angle brackets.
[ ]
Default responses to system prompts are in square brackets.
!,#
An exclamation point (!) or a pound sign (#) at the beginning of a line of
code indicates a comment line.
Note
Notes contain helpful suggestions or references to material not covered
in the publication.
1.2 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 lists of all the new and revised Cisco technical documentation
(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
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
5
Preface
reader application. The RSS feeds are a free service and Cisco currently supports RSS
version 2.0.
Cisco Evolved Programmable Network Manager 2.0 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 Cisco EPN Manager with a standards-compliant OSS.
It is a set of RESTFul services confirmed to the RESTCONF/YANG specification.
The Cisco EPN Manager implementation of the RESTCONF/YANG interface supports the
retrieval of device inventory, circuit inventory, notifications about respective resource
changes, and provisioning which includes Managed Elements and Equipment Inventory.
2.1 Web Services Standards
The RESTCONF implementation of the Cisco 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 Protocol (draft 07) draft-ietf-netconf-restconf-07
YANG – A Data Modeling Language for the Network Configuration Protocol
(NETCONF) – RFC-6020
 Hypertext Transfer Protocol HTTP 1.1 - RFCs 7230-7237
2.2 RESTCONF Standards
The Cisco EPN Manager implementation of the RESTCONF/YANG Interface exposes EPN-M
management information as specified by the RESTCONF/YANG protocol and data modeling
language.
While no standard exists for information model exposed by this interface, the model is
based on TeleManagement Forum (TMF) standards governing the modeling of physical and
service inventory.
2.3 Communication Patterns
RESTCONF/YANG interfaces supported by Cisco EPN Manager use REST (Representational
State Transfer) techniques. REST is stateless and uses a client-server protocol (HTTP 1.1).
The client issues HTTP GET requests to retrieve objects using the URLs and query
parameters described in this document.
Containment Associations
The operations on supported RESTCONF/YANG interfaces return a single object or multiple
objects, depending how many objects match the URL and whether the object supports
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
7
Northbound RESTCONF/YANG Interface
containment associates. For example, when the client retrieves a managed element object,
the associated chassis, equipment, models, and physical connectors are returned as well.
Such requests can return large amounts of data in response to a single GET request.
2.4 OSS Integration Usage Scenarios
In a typical scenario, OSS clients integrating with Cisco EPN Manager may use the
RESTCONF/YANG Interfaces supported by Cisco EPN Manager to retrieve the device
inventory and then export the inventory to other systems or use it to generate reports.
Retrieving Inventory
The RESTCONF/YANG interface supports standard HTTP 1.1 GET requests. The information
is returned in the format specified by the accept header of the request. The client may
retrieve the physical information about a device through the Physical Inventory API. Logical
resource and service information are available through the other APIs.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
8
Supported RESTCONF/YANG
Interfaces
3 Supported RESTCONF/YANG Interfaces
The following table lists the RESTCONF/YANG interfaces and associated operations
supported in the Cisco EPN Manager implementation.
Table 2: Supported RESTCONF/YANG Interfaces
Interface Name
Physical Inventory – API’s
Group Retrieval
Operation Name
getAllGroups
getGroup by id
getAllManagedElements
getManagedElement by businessKey
getAllChassiss
getChassis by businessKey
getChassis by id
getAllEquipments
getEquipment by businessKey
getEquipment by id
getAllModules
getModule by businessKey
getModule by id
getAllPhysicalConnectors
getPhysicalConnector by businessKey
getPhysicalConnector by id
getAllPhysicalProtocolEndpoints
getPhysicalProtocolEndpoint by businessKey
getPhysicalProtocolEndpoint by id
getAllInterfaceProtocolEndpoints
getInterfaceProtocolEndpoint by businessKey
getInterfaceProtocolEndpoint by id
ManagedElement Retrieval
Chassis Retrieval
Equipment Retrieval
Module Retrieval
PhysicalConnector Retrieval
PhysicalProtocolEndpoint Retrieval
InterfaceProtocolEndpoint Retrieval
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 Cisco EPN Manager:
RESTCONF/YANG Web Service Endpoint URL
Physical Inventory Interfaces
https://<host>/restconf/data/v1/epnmrestconf-xmp-im-ext-group:Group
https://<host>/restconf/data/v1/epnmrestconf-xmp-im-ext-group:Group/{id}
https://<host>/restconf/data/v1/epnmrestconf-xmp-im-extmanagedelement:ManagedElement
https://<host>/restconf/data/v1/epnmrestconf-xmp-im-extmanagedelement:ManagedElement
Description
Retrieve all Group instances
getGroup by id
Retrieve all ManagedElement instances
Retrieve ManagedElement instance by businessKey
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
9
Supported RESTCONF/YANG Interfaces
https://<host>/restconf/data/v1/xmp-imphysical-resource-module-chassis:Chassis
https://<host>/restconf/data/v1/xmp-imphysical-resource-modulechassis:Chassis/{owningEntityId}
https://<host>/restconf/data/v1/xmp-imphysical-resource-module-chassis:Chassis/{id}
https://<host>/restconf/data/v1/xmp-imphysical-resource-moduleequipment:Equipment
https://<host>/restconf/data/v1/xmp-imphysical-resource-moduleequipment:Equipment/{owningEntityId}/{ent
PhysicalIndex}
https://<host>/restconf/data/v1/xmp-imphysical-resource-moduleequipment:Equipment/{id}
https://<host>/restconf/data/v1/xmp-imphysical-resource-module-module:Module
https://<host>/restconf/data/v1/xmp-imphysical-resource-modulemodule:Module/{owningEntityId}/{entPhysic
alIndex}
https://<host>/restconf/data/v1/xmp-imphysical-resource-modulemodule:Module/{id}
https://<host>/restconf/data/v1/xmp-imphysical-resource-modulephysicalconnector:PhysicalConnector
https://<host>/restconf/data/v1/xmp-imphysical-resource-modulephysicalconnector:PhysicalConnector/{ownin
gEntityId}/{entPhysicalIndex}
https://<host>/restconf/data/v1/xmp-imphysical-resource-modulephysicalconnector:PhysicalConnector/{id}
https://<host>/restconf/data/v1/xmp-imconnectivity-modulephysicalprotocolendpoint:PhysicalProtocolEn
dpoint
https://<host>/restconf/data/v1/xmp-imconnectivity-modulephysicalprotocolendpoint:PhysicalProtocolEn
dpoint/{entPhysicalContainedIn}/{name}/{ow
ningEntityId}
https://<host>/restconf/data/v1/xmp-imconnectivity-modulephysicalprotocolendpoint:PhysicalProtocolEn
dpoint/{id}
https://<host>/restconf/data/v1/xmp-imconnectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolE
Retrieve all Chassis instances
Retrieve Chassis instance by businessKey
getChassis by id
Retrieve all Equipment instances
Retrieve Equipment instance by businessKey
getEquipment by id
Retrieve all Module instances
Retrieve Module instance by businessKey
getModule by id
Retrieve all PhysicalConnector instances
Retrieve PhysicalConnector instance by businessKey
getPhysicalConnector by id
Retrieve all PhysicalProtocolEndpoint instances
Retrieve PhysicalProtocolEndpoint instance by
businessKey
getPhysicalProtocolEndpoint by id
Retrieve all InterfaceProtocolEndpoint instances
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
10
Supported RESTCONF/YANG
Interfaces
ndpoint
https://<host>/restconf/data/v1/xmp-imconnectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolE
ndpoint/{owningEntityId}/{entPhysicalIndex}
https://<host>/restconf/data/v1/xmp-imconnectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolE
ndpoint/{id}
Retrieve InterfaceProtocolEndpoint instance by
businessKey
getInterfaceProtocolEndpoint by id
Note: Do not use braces for the <id>
Authentication
The RESTCONF/YANG endpoints in Cisco EPN Manager are secured. To access these
endpoints, use HTTP basic authentication.
Authorization
User credentials passed for accessing the RESTCONF/YANG endpoints require the proper
authorization to use the API. This authorization can be configured using Cisco EPN
Manager security management interface. In Cisco EPN Manager, NBI Read privileges are
required to access all retrieval RESTCONF/YANG interfaces, and NBI Write privileges are
required to use the provisioning RESTCONF/YANG interface.
License
A Cisco EPN Manager RESTCONF/YANG license is required to use RESTCONF/YANG
interface endpoints.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
11
RESTCONF/YANG Interface Details
4 RESTCONF/YANG Interface Details
This section provides details about the supported RESTCONF/YANG interfaces.
4.1 Group Retrieval
This interface provides the operations to retrieve Group entities. This object represent
automatic and user defined groups to which ManagedElements may belong.
Group Data
Associated objects are represented by a collection, for one-to-many associations, or an
attribute of the object type for one-to-one or many-to-one associates.
The role of the object(s) in the association provides the name for association attributes.
The API traverses selected associations, usually of one-to-many cardinality, to allow
retrieval of a hierarchy of objects in a single request. Attribute names of such associations
are followed by an asterisk (*). To prevent cycles in the retrieval or divide the hierarchy
into manageable pieces, other associations are summarized as a string with an entry giving
the object type, name, and business key for each object in the collection. Some attributes
may not be displayed since null values and empty associations are not included in the
response.
The following table lists the attributes in the Group object:
Group Data
instanceId
description
name
managedElements
Data Type
int
String
String
Set<ManagedElement>
Description
Instance identifier of entity in the database.
Description of the group.
Name of the group.
ManagedElements within the group.
Operations
The following table lists the operations available to retrieve Group data from RESTCONF via
the http protocol:
URL
https://<host>/restconf/data/v1/epnm-restconf-xmp-imext-group:Group
https://<host>/restconf/data/v1/epnm-restconf-xmp-imext-group:Group/{id}
Description
Retrieve all Group entities in the database.
Retrieve Group instance by database instance
id
Note: Do not use braces for the <id>.
All URLs require basic authentication and can produce:
 application/xml
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
12
RESTCONF/YANG Interface Details



application/yang.data+xml
application/json
application/yang.data+json
Sample Response Data
4.1.1.1 JSON
This sample is formatted and edited for clarity and length.
{"ns2.GroupInstances": [
"Group": [
{
"instanceId": 124221,
"description": "Cisco ASR 900 Series Aggregation Services Routers",
"name": "Cisco ASR 900 Series Aggregation Services Routers",
"managedElements":
"[ManagedElement{'name':'ASR903-PAN5.cisco.com','businessKey':'bda9d49e[207210_192.168.23.58]'}],
[ManagedElement{'name':'ASR903-PAN6.cisco.com','businessKey':'bda9d49e[207212_192.168.23.63]'}],
[ManagedElement{'name':'ASR9032','businessKey':'bda9d49e[207225_192.168.222.189]'}]"
},
{
"instanceId": 1297296,
"description": "Optical Networking",
"name": "Optical Networking",
"managedElements":
"[ManagedElement{'name':'SMR2078','businessKey':'bda9d49e[1266279_192.168.229.78]'}],
[ManagedElement{'name':'M15_229_79','businessKey':'bda9d49e[1266271_192.168.2
29.79]'}],
[ManagedElement{'name':'454A-236108','businessKey':'bda9d49e[1581584_192.168.236.108]'}],
[ManagedElement{'name':'454A-236109','businessKey':'bda9d49e[1581582_192.168.236.109]'}],
[ManagedElement{'name':'SMR973','businessKey':'bda9d49e[1266272_192.168.229.73]'}],
[ManagedElement{'name':'NCS2KA-236123','businessKey':'bda9d49e[1266270_192.168.236.123]'}],
[ManagedElement{'name':'SMR972','businessKey':'bda9d49e[1266282_192.168.229.72]'}],
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
13
RESTCONF/YANG Interface Details
[ManagedElement{'name':'M15_229_77','businessKey':'bda9d49e[1266283_192.168.2
29.77]'}],
[ManagedElement{'name':'NCS2006A-23438','businessKey':'bda9d49e[1266273_192.168.234.38]'}]"
}
]
}
}
4.2 ManagedElement Retrieval
This interface provides the operations to retrieve ManagedElement entities. This object
represents a device managed by Cisco EPN Manager.
ManagedElement Data
The table below lists the attributes in the ManagedElement object. Associated objects are
represented by a collection, for one-to-many associations, or an attribute of the object
type for one-to-one or many-to-one associates. The role of the object(s) in the association
provides the name for association attributes. The API traverses selected associations,
usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects in a single
request. Attribute names of such associations are followed by an asterisk (*). To prevent
cycles in the retrieval or divide the hierarchy into manageable pieces, other associations
are summarized as a string with an entry giving the object type, name, and business key for
each object in the collection. Some attributes may not be displayed since null values and
empty associations are not included in the response.
ManagedElement Data
Data Type
Description
instanceId
businessKey
int
String
clusterCount
collectionStatus
int
String
collectionTime
communicationState
datetime
CommunicationState
Enum
creationTime
description
fdn
datetime
String
String
lastBootTime
datetime
Instance identifier of entity in the database.
String representation of attribute value(s) that
uniquely identify the entity or instanceId if no
business key defined.
Cluster count.
A detailed status of inventory collection - Success or
failure.
Collection time.
Indicates management availability or reachability of
the managed network element. It can indicate the
availability or reachability of the management agent
serving as a proxy for the network element.
Creation time.
Description of the MNE.
The fully qualified domain name (FDN) for the
equipment (or equipment subclass) instance.
Represents the time the management agent on the
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
14
RESTCONF/YANG Interface Details
lifecycleState
LifecycleStateEnum
managementAddress
String
name
owningEntityId
productFamily
String
String
String
productSeries
String
productType
String
productVendor
satelliteCount
softwareFamily
softwareType
String
int
String
String
softwareVersion
String
sysContact
sysLocation
String
String
sysObjectId
String
sysUpTime
uuid
equipment *
String
String
Collection<Equipmen
t>
groups
protocolEndpoint
Set<Group>
Set<ProtocolEndpoin
t>
managed network element was last rebooted.
Represents the current management state of the
network element: managed, unmanaged, under
maintenance, and so on. This state is modified by
events in the network and network management
system, and also by user request.
The 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.
The name of the MNE.
Entity ID
The contents of the NAME attribute of the outermost <DEVICEGROUP> element in a Cisco MDF file
for this particular instance of
ManagedNetworkElement.
The contents of the NAME attribute of the secondlevel <DEVICEGROUP> element in a Cisco MDF file
for this particular instance of
ManagedNetworkElement.
The contents of the NAME attribute of the <DEVICE>
element in a Cisco MDF file for this particular
instance of ManagedNetworkElement.
product vendor
Number of satellites.
software Family
A string that identifies the specific type of software
that is installed on this ManagedNetworkElement.
For example, Cisco IOS or Linux.
The specific version of the software (see attribute
softwareType) that is installed. The value is
formatted as a text field.
sysContat of the mne
The physical location of this node (for example,
'telephone closet, 3rd floor'). If the location is
unknown, the value is the zero-length string.
The vendor's authoritative identification of the
network management subsystem contained in the
element.
Internal use only
The instances of Equipment (or any of its subclasses)
that realize this instance of a NetworkResource
subclass.
Groups containing the ManagedElement.
The set of instances of a ProtocolEndpoint
subclasses that support this instance of a
NetworkResource subclass.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
15
RESTCONF/YANG Interface Details
Operations
The table below lists the operations available to retrieve ManagedElement data from
RESTCONF via the http protocol.
All URLs require basic authentication and can produce:
 application/xml
 application/yang.data+xml
 application/json
 application/yang.data+json
The first URL retrieves all the ManagedElement entities in the database. The next URL
returns a specific ManagedElement entity by its business key. Enter the values of the
attributes shown in the braces, but do not include the braces.
URL
http://<host>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement
http://<host>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement/{owningEntityId}
Description
Retrieve all ManagedElement
instances
Retrieve ManagedElement
instance by business key
This object supports the fully-qualified domain name (FDN) attribute, which is unique for
all ManagedElement objects. You may use the FDN as a query parameter to retrieve a
specific ManagedElement object as follows:
http://<host>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?fdn=<value>
Where <host> is the host name or IP address of the Cisco EPN Manager Server and <value>
is the value of the FDN attribute for the object to retrieve.
Sample Response Data
4.2.1.1 JSON
This sample is formatted and edited for clarity and length.
{"ns1.ManagedElementInstances": [
"ManagedElement": {
{
"instanceId": 214215,
"businessKey": "bda9d49e[207208_192.168.23.26]",
"clusterCount": 0,
"collectionStatus": "SUCCESS",
"collectionTime": "2015-08-24T22:10:52.918-07:00",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
16
RESTCONF/YANG Interface Details
"communicationState": "REACHABLE",
"creationTime": "2015-08-24T11:40:28.059-07:00",
"description": "Cisco IOS Software, 901 Software (ASR901UNIVERSALK9-M), Version 15.4(3)S, RELEASE SOFTWARE (fc3)\r\nTechnical
Support: http:\/\/www.cisco.com\/techsupport\r\nCopyright (c) 1986-2014
by Cisco Systems, Inc.\r\nCompiled Sun 27-Jul-14 12:26 by
prod_rel_team",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1-DOMAIN3.cisco.com",
"lastBootTime": "2015-08-09T07:59:48.571-07:00",
"lifecycleState": "MANAGED_AND_SYNCHRONIZED",
"managementAddress": "192.168.23.26",
"name": "ASR901-CSG-1-DOMAIN3.cisco.com",
"owningEntityId": "207208_192.168.23.26",
"productFamily": "Routers",
"productSeries": "Cisco ASR 901 Series Aggregation Services
Routers",
"productType": "Cisco ASR 901-E Router",
"satelliteCount": 0,
"softwareType": "IOS",
"softwareVersion": "15.4(3)S",
"sysObjectId": "1.3.6.1.4.1.9.1.1522",
"sysUpTime": "15 days, 14:00:19.86",
"equipment": [
{
"description": "A901-12C-F-D Chassis",
"name": "A901-12C-F-D Chassis",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235295,
"businessKey": "859457fb[207208_192.168.23.26,1]",
"assemblyNumber": "A901-12C-F-D",
"entPhysicalContainedIn": 0,
"entPhysicalIndex": 1,
"equipmentType": "CHASSIS",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=A901-12C-F-D Chassis;partnumber=A901-12C-FD",
"hardwareVersion": "V03 ",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
17
RESTCONF/YANG Interface Details
"manufacturer": "Cisco",
"partNumber": "A901-12C-F-D",
"serialNumber": "CAT1722U1K4",
"serviceState": "UNKNOWN",
"subclassname": "Chassis",
"vendorEquipmentType": "cevChassisASR901E",
"containedEquipment": {
"description": "A901-12C-F-D Chassis Slot ",
"name": "Chassis Slot",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235281,
"businessKey": "d1d98c1f[207208_192.168.23.26,2]",
"entPhysicalContainedIn": 1,
"entPhysicalIndex": 2,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=Chassis Slot;partnumber=A901-12C-F-D",
"hardwareVersion": "V03 ",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "A901-12C-F-D",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerSlot",
"containedEquipment": {
"description": "A901-12C-F-D Motherboard with Built-in
12GE, 1FE",
"name": "A901-12C-F-D Motherboard ",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235282,
"businessKey": "ddf068b3[207208_192.168.23.26,3]",
"entPhysicalContainedIn": 2,
"entPhysicalIndex": 3,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=A901-12C-F-D Motherboard ;partnumber=A90112C-F-D",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
18
RESTCONF/YANG Interface Details
"hardwareVersion": "V03 ",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "A901-12C-F-D",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevChassisASR901E",
"connectors": [
{
"description": "Gigabit Ethernet",
"name": "GigabitEthernet0\/2",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 241255,
"businessKey":
"e01b1a63[3,GigabitEthernet0\/2,207208_192.168.23.26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 10,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGEIP",
"equipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/2",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/2",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220543,
"businessKey": "489e4745[207208_192.168.23.26,10]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 10,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
19
RESTCONF/YANG Interface Details
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/2','businessKey':'e01b1a6
3[3,GigabitEthernet0\/2,207208_192.168.23.26]'}]"
}
},
{
"description": "Gigabit Ethernet",
"name": "GigabitEthernet0\/0",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 241253,
"businessKey":
"e01b1a63[3,GigabitEthernet0\/0,207208_192.168.23.26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 8,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGEIP",
"equipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/0",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220480,
"businessKey": "489e4745[207208_192.168.23.26,8]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 8,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/0','businessKey':'e01b1a6
3[3,GigabitEthernet0\/0,207208_192.168.23.26]'}]"
}
}
],
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
20
RESTCONF/YANG Interface Details
"containedEquipment": [
{
"description": "High Speed Fan2 Module for A901-12CF-D",
"name": "Fan2",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235286,
"businessKey": "d1d98c1f[207208_192.168.23.26,28]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 28,
"equipmentType": "FAN",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=Fan2;partnumber=FAN",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "FAN",
"serialNumber": "33-0629-01",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevFanSinglePulse",
"containingEquipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]"
},
{
"description": "High Speed Fan1 Module for A901-12CF-D",
"name": "Fan1",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235285,
"businessKey": "d1d98c1f[207208_192.168.23.26,27]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 27,
"equipmentType": "FAN",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=Fan1;partnumber=FAN",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
21
RESTCONF/YANG Interface Details
"partNumber": "FAN",
"serialNumber": "33-0629-01",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevFanSinglePulse",
"containingEquipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]"
}
],
"containingEquipment": "[Equipment{'name':'Chassis
Slot','businessKey':'d1d98c1f[207208_192.168.23.26,2]'}]"
},
"containingEquipment": "[Chassis{'name':'A901-12C-F-D
Chassis','businessKey':'859457fb[207208_192.168.23.26,1]'}]"
}
}
],
"protocolEndpoint":
"[PhysicalProtocolEndpoint{'name':'GigabitEthernet0\/7','businessKey':'
489e4745[207208_192.168.23.26,15]'}],
[LoopbackInterface{'name':'Loopback26','businessKey':'220505'}],
[PhysicalProtocolEndpoint{'name':'FastEthernet0\/0','businessKey':'489e
4745[207208_192.168.23.26,16]'}]
[PwProtocolEndpoint{'name':'AccessEPL_690','businessKey':'926c5675[2072
08_192.168.23.26,81,13.13.13.13]'}]"
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
22
RESTCONF/YANG Interface Details
4.3 Chassis Retrieval
This interface provides the operations to retrieve Chassis entities. This object is a
specialization of Equipment that can contain other pieces of Equipment (such as enclosure,
frame, and so on).
Chassis Data
The table below lists the attributes in the Chassis object. Associated objects are
represented by a collection, for one-to-many associations, or an attribute of the object
type for one-to-one or many-to-one associates. The role of the object(s) in the association
provides the name for association attributes. The API traverses selected associations,
usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects in a single
request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
Chassis Data
instanceId
businessKey
Data Type
int
String
administrativeStateCode
String
assemblyNumber
String
assemblyRevision
String
cleiCode
String
description
deviationNumber
String
String
entPhysicalContainedIn
entPhysicalIndex
equipmentType
String
String
EquipmentTypeE
num
Description
Instance identifier of entity in the database.
String representation of attribute value(s) that uniquely
identify the entity or instanceId if no business key defined.
** Deprecated. Will be replaced by an enumerated attribute
(possibly a lookup table) after a proper model review
**\r\nThe administrative state (locked, unlocked, and so
on). The administrative state is the result of an
administrative action performed by administrator and/or
EMS/NMS SW.
Indicates the manufacturing assembly number, which is the
'hardware' identification.
Indicates the revision of the entity within the
assemblyNumber.
This object represents the CLEI (Common Language
Equipment Identifier) code for the physical entity. If the
physical entity is not present in the system, or does not have
an associated CLEI code, the value of this object will be
null.\r\n\r\nFrom-CISCO-ENTITY-ASSET-MIB : ceAsset.cleI
an optional description of the entity.
Revision number (signifying a minor deviation) of a module,
port adapter, and so on. Typically this number is required in
FN (Field Notice) reports provided to customers by a HW
vendor.
## Internal use only ##
## Internal use only ##
An indication of the general hardware type of the physical
entity. This should be set to the standard enumeration value
that most accurately indicates the general class of the
physical entity or the primary class if there is more than one.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
23
RESTCONF/YANG Interface Details
fdn
String
hardwareVersion
String
isFRUable
MultiStateEnum
isRackMountable
isReportingAlarmsAllow
ed
manufacturedDate
boolean
MultiStateEnum
manufacturer
String
name
nrFreeSlots
nrSlots
String
int
int
operationalStateCode
String
owningEntityId
partNumber
position
String
String
String
productFamily
String
productId
String
datetime
If no appropriate standard registration identifier exists for
this physical entity, the value 'other' is returned.
The fully qualified domain name (FDN) for the equipment
(or equipment subclass) instance
The vendor-specific hardware revision string for the physical
entity. The preferred value is the hardware revision
identifier actually printed on the component itself (if
present). If no specific hardware revision string is associated
with the physical component, or if this information is
unknown, this will contain a zero-length string.
Indicates whether this physical entity is considered a 'field
replaceable unit' by the vendor.
Indicates whether the Chassis can be mounted in a Rack.
Indicates whether alarm reporting for this resource is
allowed (can be set to Not_applicable).
Contains the date of manufacturing of the equipment. If the
manufacturing date is unknown or not supported, the value
of 0 is assigned.
The name of the manufacturer of this physical component.
The preferred value is the manufacturer name string
actually printed on the component itself (if present). If the
manufacturer name string associated with the physical
component is unknown to the agent, this object will contain
a zero-length string.
the name of the entity
Indicates the number of free slots the chassis has.
The number of slots in the chassis available for plugin
modules.
** Deprecated. Will be replaced by an enumerated attribute
(possibly a lookup table) after a proper model review
**\r\nThe operational state (operable or inoperable) of the
equipment.
## Internal use only ##
Manufacturer's part number.
** Deprecated. Will be removed after EquipmentHolder is
put back in the model **\r\nThe name of the container(s)
that the Equipment is in, or null if is not contained (for
example, chassis).
The name of a group of products derived from a common
product platform. For example, Catalyst 4000, MDS 900.
Product family can be uniquely determined via the
productId in Cisco's products databases that contain the
product, product series, product families, and their
relationship.
The vendor-specific model name identifier string associated
with this physical component. The preferred value is the
customer-visible part number, which might be printed on
the component itself. The productId generated by the
device is often referred to as the \\\'base PID\\\'.\r\n\r\nFor
some applications, PIDs must go through a validation
process; the resulting PID is referred to as a \\\'validated
PID\\\'.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
24
RESTCONF/YANG Interface Details
productName
String
serialNumber
String
serviceState
EquipmentServic
eStateEnum
slotConfig
String
subclassname
udi
String
String
vendorEquipmentType
String
connectors *
Set<PhysicalCon
nector>
Set<Equipment>
containedEquipment *
occupiedHolders
Set<EquipmentH
older>
providedHolders
Set<EquipmentH
older>
The official name given to a product. For example, Cisco
10720 Router or Cisco 10720, Cisco 12000 Series Six-Port
DS3 Line Card or 6-Port DS3.
The vendor-specific serial number string for the physical
entity. The preferred value is the serial number string
actually printed on the component itself (if present). If a
serial number is unknown or nonexistent, the SerialNumber
will be left null. Note that not every physical component has
(or needs) a serial number. Physical entities, which are not
FRU (field replaceable) do not need their own unique serial
number. This item is used for composing the UDI SID (see
attribute 'udi').
Denotes the service state of a physical entity from the point
of view of the management application. It indicates whether
the entity is in service, out of service, under maintenance,
and so on.
** Deprecated. Will be removed after EquipmentHolder is
put back in the model **\r\nAn indication of which slots in
the chassis have modules inserted. This is an integer value
with bits set to indicate configured modules. It can be
interpreted as a sum of f(x) as x goes from 1 to the number
of slots, where f(x) = 0 for no module inserted and f(x) =
exp(2, x-1) for a module inserted. Based on the MIB
definition, it can only represent (the first) 16 slots in a
Chassis.
The name of the object type
Universal Device Identifier. The UDI is composed by
concatenating the following values:\r\nPID =
Equipment.partNumber\r\nVID =
Equipment.hardwareVersion\r\nSN =
Equipment.serialNumber
An indication of the vendor-specific hardware type of the
physical entity. Represents an independently extensible type
identification value. It can, for example, indicate a particular
subtree with further MIB definitions, or define a particular
type of protocol or hardware (for example,
1.3.6.1.4.1.9.12.3.1.9.3.131).\r\nSee CISCO-ENTITYVENDORTYPE-OID-MIB.
The set of instances of PhysicalConnectors contained in this
piece of Equipment.
A set of instances of Equipment contained in this instance of
Equipment.
The EquipmentHolders occupied by this piece of
Equipment.\nOther pieces of Equipment provide these
Holders. For example: A Module can occupy one or two
Slots provided by a Chassis.
A collection of the EquipmentHolders provided by this
Chassis. Other pieces of Equipment can occupy these
Holders. For example: A Chassis can provide many Slots, and
Modules can occupy the Slots.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
25
RESTCONF/YANG Interface Details
Operations
All URLs require basic authentication and can produce:
 application/xml
 application/yang.data+xml
 application/json
 application/yang.data+json
The following table lists the operations available to retrieve Chassis data from RESTCONF
via the http protocol:
URL
http://<host>/restconf/data/v1/xmp-im-physical-resource-modulechassis:Chassis
http://<host>/restconf/data/v1/xmp-im-physical-resource-modulechassis:Chassis/{owningEntityId}/{entPhysicalIndex}
http://<host>/restconf/data/v1/xmp-im-physical-resource-modulechassis:Chassis/{id}
Description
Retrieve all Chassis instances
Retrieve Chassis instance by
business key
Retrieve Chassis instance by
database instance id
Note: Do not use braces for the
<id>.
This object supports the fully-qualified domain name (FDN) attribute, which is unique for
all Chassis objects. You may use the FDN as a query parameter to retrieve a specific Chassis
object as follows:
http://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis?fdn=<value>
Where <host> is the host name or IP address of the Cisco EPN Manager server and <value>
is the value of the FDN attribute for the object to retrieve.
Sample Response Data
4.3.1.1 JSON
This sample is formatted and edited for clarity and length.
{"ns2.ChassisInstances": [
"Chassis": [
{
"description": "ME-3600X-24CX-M",
"name": 1,
"owningEntityId": "207215_192.168.23.47",
"entPhysicalContainedIn": 0,
"entPhysicalIndex": 1001,
"equipmentType": "CHASSIS",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
26
RESTCONF/YANG Interface Details
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN4\/EQ\/name=1;partnumber=ME-3600X-24CX-M",
"hardwareVersion": "V02",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"partNumber": "ME-3600X-24CX-M",
"serialNumber": "FOC1736N1AJ",
"serviceState": "UNKNOWN",
"subclassname": "Chassis",
"vendorEquipmentType": "cevChassisMe3600x24CxM",
"containedEquipment": [
{
"description": "ME-3600X-24CX-M - Container 1",
"name": "Container 1",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 235362,
"businessKey": "d1d98c1f[207215_192.168.23.47,1004]",
"entPhysicalContainedIn": 1001,
"entPhysicalIndex": 1004,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/EQ\/name=Container
1;partnumber=cevContainerPowerSupplySlot",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerPowerSupplySlot",
"containedEquipment": {
"description": "Switch FRU Fan",
"name": "Fan Tray",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 235357,
"businessKey": "d1d98c1f[207215_192.168.23.47,1048]",
"entPhysicalContainedIn": 1004,
"entPhysicalIndex": 1048,
"equipmentType": "FAN",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/EQ\/name=Fan
Tray;partnumber=ME-FANTRAY
",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
27
RESTCONF/YANG Interface Details
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"operationalStateCode": "normal",
"partNumber": "ME-FANTRAY
",
"serialNumber": "LIT1730052S",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevFanMEFanTray",
"containingEquipment": "[Equipment{'name':'Container
1','businessKey':'d1d98c1f[207215_192.168.23.47,1004]'}]"
},
"containingEquipment":
"[Chassis{'name':'1','businessKey':'859457fb[207215_192.168.23.47,1001]
'}]"
},
{
"description": "ME-3600X-24CX-M - Fixed Module 0",
"name": "ME-3600X-24CX-M - Fixed Module 0",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 235330,
"businessKey": "ddf068b3[207215_192.168.23.47,1002]",
"entPhysicalContainedIn": 1001,
"entPhysicalIndex": 1002,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/EQ\/name=ME-3600X24CX-M - Fixed Module 0;partnumber=ME-3600X-24CX-M",
"hardwareVersion": "V02",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"partNumber": "ME-3600X-24CX-M",
"serialNumber": "FOC1736N1AJ",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevModuleME3600X24FS",
"connectors": [
{
"description": "E1 0\/6",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
28
RESTCONF/YANG Interface Details
"name": "E1 0\/6",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 241313,
"businessKey": "e01b1a63[1002,E1
0\/6,207215_192.168.23.47]",
"entPhysicalContainedIn": 1002,
"entPhysicalIndex": 1055,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortT1E1",
"equipment": "[Module{'name':'ME-3600X-24CX-M - Fixed
Module 0','businessKey':'ddf068b3[207215_192.168.23.47,1002]'}]",
"physicalProtocolEndpoint": {
"name": "E1 0\/6",
"owningEntityId": "207215_192.168.23.47",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/FTP\/E1
0\/6",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220911,
"businessKey": "489e4745[207215_192.168.23.47,1055]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 1055,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector": "[PhysicalConnector{'name':'E1
0\/6','businessKey':'e01b1a63[1002,E1 0\/6,207215_192.168.23.47]'}]"
}
},
{
"description": "GigabitEthernet0",
"name": "GigabitEthernet0",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 241318,
"businessKey":
"e01b1a63[1002,GigabitEthernet0,207215_192.168.23.47]",
"entPhysicalContainedIn": 1002,
"entPhysicalIndex": 1045,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
29
RESTCONF/YANG Interface Details
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortNIC100",
"equipment": "[Module{'name':'ME-3600X-24CX-M - Fixed
Module 0','businessKey':'ddf068b3[207215_192.168.23.47,1002]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0",
"owningEntityId": "207215_192.168.23.47",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN4\/FTP\/GigabitEthernet0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220922,
"businessKey": "489e4745[207215_192.168.23.47,1045]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 1045,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0','businessKey':'e01b1a63[1
002,GigabitEthernet0,207215_192.168.23.47]'}]"
}
},
],
"containedEquipment": [
{
"description": "GigabitEthernet Container",
"name": "GigabitEthernet0\/5 Container",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 235335,
"businessKey": "d1d98c1f[207215_192.168.23.47,1019]",
"entPhysicalContainedIn": 1002,
"entPhysicalIndex": 1019,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN4\/EQ\/name=GigabitEthernet0\/5 Container;partnumber=cevContainerSFP",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
30
RESTCONF/YANG Interface Details
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerSFP",
"connectors": {
"description": "GigabitEthernet0\/5",
"name": "GigabitEthernet0\/5",
"owningEntityId": "207215_192.168.23.47",
"instanceId": 241304,
"businessKey":
"e01b1a63[1019,GigabitEthernet0\/5,207215_192.168.23.47]",
"entPhysicalContainedIn": 1019,
"entPhysicalIndex": 1070,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortBaseTEther",
"equipment": "[Equipment{'name':'GigabitEthernet0\/5
Container','businessKey':'d1d98c1f[207215_192.168.23.47,1019]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/5",
"owningEntityId": "207215_192.168.23.47",
"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN4\/FTP\/GigabitEthernet0\/5",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220894,
"businessKey": "489e4745[207215_192.168.23.47,1070]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 1070,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/5','businessKey':'e01b1a6
3[1019,GigabitEthernet0\/5,207215_192.168.23.47]'}]"
}
},
"containingEquipment": "[Module{'name':'ME-3600X-24CX-M Fixed Module 0','businessKey':'ddf068b3[207215_192.168.23.47,1002]'}]"
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
31
RESTCONF/YANG Interface Details
],
"containingEquipment":
"[Chassis{'name':'1','businessKey':'859457fb[207215_192.168.23.47,1001]
'}]"
}
],
"instanceId": 235369,
"businessKey": "859457fb[207215_192.168.23.47,1001]",
"nrSlots": 0,
"slotConfig": 0
},
{
"description": "ASR 903 Series Router Chassis",
"name": "Chassis",
"owningEntityId": "207212_192.168.23.63",
"entPhysicalContainedIn": 0,
"entPhysicalIndex": 1,
"equipmentType": "CHASSIS",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=Chassis;partnumber=ASR-903",
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco Systems Inc",
"partNumber": "ASR-903",
"serialNumber": "FOX1723P4XL",
"serviceState": "UNKNOWN",
"subclassname": "Chassis",
"vendorEquipmentType": "cevChassisCGS252016S8PCC",
"containedEquipment": [
{
"description": "RSP Slot",
"name": "slot R0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235379,
"businessKey": "d1d98c1f[207212_192.168.23.63,2]",
"entPhysicalContainedIn": 1,
"entPhysicalIndex": 2,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
32
RESTCONF/YANG Interface Details
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=slot R0;partnumber=cevContainerASR900RSPSlot",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerASR900RSPSlot",
"containedEquipment": {
"description": "ASR 903 Route Switch Processor 1, Base
Scale, 55Gbps",
"name": "module R0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235380,
"businessKey": "ddf068b3[207212_192.168.23.63,100]",
"entPhysicalContainedIn": 2,
"entPhysicalIndex": 100,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=module R0;partnumber=A903-RSP1A-55",
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco Systems Inc",
"operationalStateCode": "ok",
"partNumber": "A903-RSP1A-55",
"serialNumber": "FOC1717N4UE",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevModuleASR903RSP1A",
"connectors": {
"description": "Network Management Ethernet",
"name": "NME R0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 241322,
"businessKey": "e01b1a63[100,NME
R0,207212_192.168.23.63]",
"entPhysicalContainedIn": 100,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
33
RESTCONF/YANG Interface Details
"entPhysicalIndex": 136,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'module
R0','businessKey':'ddf068b3[207212_192.168.23.63,100]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0",
"owningEntityId": "207212_192.168.23.63",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/FTP\/GigabitEthernet0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 221015,
"businessKey": "489e4745[207212_192.168.23.63,136]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 136,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector": "[PhysicalConnector{'name':'NME
R0','businessKey':'e01b1a63[100,NME R0,207212_192.168.23.63]'}]"
}
},
"containedEquipment": [
{
"description": "CPU 0 of module R0",
"name": "cpu R0\/0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235370,
"businessKey": "d1d98c1f[207212_192.168.23.63,131]",
"entPhysicalContainedIn": 100,
"entPhysicalIndex": 131,
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=cpu R0\/0;partnumber=cevModuleCpuType",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
34
RESTCONF/YANG Interface Details
"subclassname": "Equipment",
"vendorEquipmentType": "cevModuleCpuType",
"containingEquipment": "[Module{'name':'module
R0','businessKey':'ddf068b3[207212_192.168.23.63,100]'}]"
},
{
"description": "USB Port",
"name": "usb R0\/1",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235371,
"businessKey": "d1d98c1f[207212_192.168.23.63,134]",
"entPhysicalContainedIn": 100,
"entPhysicalIndex": 134,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=usb R0\/1;partnumber=cevContainerUSB",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerUSB",
"containingEquipment": "[Module{'name':'module
R0','businessKey':'ddf068b3[207212_192.168.23.63,100]'}]"
}
],
"containingEquipment": "[Equipment{'name':'slot
R0','businessKey':'d1d98c1f[207212_192.168.23.63,2]'}]"
},
"containingEquipment":
"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63
,1]'}]"
},
{
"description": "IM Bay",
"name": "subslot 0\/2",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235385,
"businessKey": "d1d98c1f[207212_192.168.23.63,6]",
"entPhysicalContainedIn": 1,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
35
RESTCONF/YANG Interface Details
"entPhysicalIndex": 6,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=subslot 0\/2;partnumber=cevContainerIMBay",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerIMBay",
"containedEquipment": {
"description": "8-port Gigabit Ethernet Interface Module",
"name": "IM subslot 0\/2",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235374,
"businessKey": "ddf068b3[207212_192.168.23.63,800]",
"entPhysicalContainedIn": 6,
"entPhysicalIndex": 800,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=IM subslot 0\/2;partnumber=A900-IMA8T",
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco Systems Inc",
"operationalStateCode": "ok",
"partNumber": "A900-IMA8T",
"serialNumber": "FOC1725N41Q",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevIM8pGeCu",
"connectors": [
{
"description": "A900-IMA8T",
"name": "GigabitEthernet0\/2\/7",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 241330,
"businessKey":
"e01b1a63[800,GigabitEthernet0\/2\/7,207212_192.168.23.63]",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
36
RESTCONF/YANG Interface Details
"entPhysicalContainedIn": 800,
"entPhysicalIndex": 808,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'IM subslot
0\/2','businessKey':'ddf068b3[207212_192.168.23.63,800]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/2\/7",
"owningEntityId": "207212_192.168.23.63",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/FTP\/GigabitEthernet0\/2\/7",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 221025,
"businessKey": "489e4745[207212_192.168.23.63,808]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 808,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/2\/7','businessKey':'e01b
1a63[800,GigabitEthernet0\/2\/7,207212_192.168.23.63]'}]"
}
},
{
"description": "A900-IMA8T",
"name": "GigabitEthernet0\/2\/1",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 241324,
"businessKey":
"e01b1a63[800,GigabitEthernet0\/2\/1,207212_192.168.23.63]",
"entPhysicalContainedIn": 800,
"entPhysicalIndex": 802,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'IM subslot
0\/2','businessKey':'ddf068b3[207212_192.168.23.63,800]'}]",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
37
RESTCONF/YANG Interface Details
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/2\/1",
"owningEntityId": "207212_192.168.23.63",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/FTP\/GigabitEthernet0\/2\/1",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 221022,
"businessKey": "489e4745[207212_192.168.23.63,802]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 802,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/2\/1','businessKey':'e01b
1a63[800,GigabitEthernet0\/2\/1,207212_192.168.23.63]'}]"
}
},
],
"containingEquipment": "[Equipment{'name':'subslot
0\/2','businessKey':'d1d98c1f[207212_192.168.23.63,6]'}]"
},
"containingEquipment":
"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63
,1]'}]"
},
{
"description": "IM Bay",
"name": "subslot 0\/0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235383,
"businessKey": "d1d98c1f[207212_192.168.23.63,4]",
"entPhysicalContainedIn": 1,
"entPhysicalIndex": 4,
"equipmentType": "OTHER",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
38
RESTCONF/YANG Interface Details
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=subslot 0\/0;partnumber=cevContainerIMBay",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerIMBay",
"containedEquipment": {
"description": "1-port Ten Gigabit Ethernet XFP Interface
Module",
"name": "IM subslot 0\/0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235375,
"businessKey": "ddf068b3[207212_192.168.23.63,300]",
"entPhysicalContainedIn": 4,
"entPhysicalIndex": 300,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=IM subslot 0\/0;partnumber=A900-IMA1X",
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco Systems Inc",
"operationalStateCode": "ok",
"partNumber": "A900-IMA1X",
"serialNumber": "FOC1721N9U7",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevIM1p10GeXfp",
"containedEquipment": {
"description": "subslot 0\/0 transceiver container 0",
"name": "subslot 0\/0 transceiver container 0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235373,
"businessKey": "d1d98c1f[207212_192.168.23.63,343]",
"entPhysicalContainedIn": 300,
"entPhysicalIndex": 343,
"equipmentType": "OTHER",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
39
RESTCONF/YANG Interface Details
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=subslot 0\/0 transceiver container
0;partnumber=cevContainerSFP",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerSFP",
"containingEquipment": "[Module{'name':'IM subslot
0\/0','businessKey':'ddf068b3[207212_192.168.23.63,300]'}]"
},
"containingEquipment": "[Equipment{'name':'subslot
0\/0','businessKey':'d1d98c1f[207212_192.168.23.63,4]'}]"
},
"containingEquipment":
"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63
,1]'}]"
},
{
"description": "IM Bay",
"name": "subslot 0\/1",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235384,
"businessKey": "d1d98c1f[207212_192.168.23.63,5]",
"entPhysicalContainedIn": 1,
"entPhysicalIndex": 5,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=subslot 0\/1;partnumber=cevContainerIMBay",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerIMBay",
"containingEquipment":
"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63
,1]'}]"
},
{
"description": "Power Supply Bay",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
40
RESTCONF/YANG Interface Details
"name": "Power Supply Bay 1",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235389,
"businessKey": "d1d98c1f[207212_192.168.23.63,30]",
"entPhysicalContainedIn": 1,
"entPhysicalIndex": 30,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=Power Supply Bay
1;partnumber=cevContainerASR900PowerSupplyBay",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerASR900PowerSupplyBay",
"containingEquipment":
"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63
,1]'}]"
},
{
"description": "Power Supply Bay",
"name": "Power Supply Bay 0",
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235376,
"businessKey": "d1d98c1f[207212_192.168.23.63,10]",
"entPhysicalContainedIn": 1,
"entPhysicalIndex": 10,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=Power Supply Bay
0;partnumber=cevContainerASR900PowerSupplyBay",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerASR900PowerSupplyBay",
"containedEquipment": {
"description": "ASR 900 550W AC Power Supply",
"name": "Power Supply Module 0",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
41
RESTCONF/YANG Interface Details
"owningEntityId": "207212_192.168.23.63",
"instanceId": 235377,
"businessKey": "d1d98c1f[207212_192.168.23.63,11]",
"entPhysicalContainedIn": 10,
"entPhysicalIndex": 11,
"equipmentType": "POWERSUPPLY",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN6.cisco.com\/EQ\/name=Power Supply Module 0;partnumber=A900-PWR550-A",
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco Systems Inc",
"operationalStateCode": "on",
"partNumber": "A900-PWR550-A",
"serialNumber": "GES17162596",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevPowerSupplyASR900AC500W",
"containingEquipment": "[Equipment{'name':'Power Supply Bay
0','businessKey':'d1d98c1f[207212_192.168.23.63,10]'}]"
},
"containingEquipment":
"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63
,1]'}]"
}
],
"instanceId": 235378,
"businessKey": "859457fb[207212_192.168.23.63,1]",
"nrSlots": 0,
"slotConfig": 0
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
42
RESTCONF/YANG Interface Details
4.4 Equipment Retrieval
This interface provides the operations to retrieve Equipment entities. The object
represents a piece of hardware that has some well specified function (for example, a line
card, memory board, or power supply).
Equipment Data
The table below lists the attributes in the Equipment object. Associated objects are
represented by a collection, for one-to-many associations, or an attribute of the object
type for one-to-one or many-to-one associates. The role of the object(s) in the association
provides the name for association attributes. The API traverses selected associations,
usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects in a single
request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
Equipment Data
instanceId
businessKey
Data Type
int
String
administrativeStateCode
String
assemblyNumber
String
assemblyRevision
String
cleiCode
String
description
deviationNumber
String
String
entPhysicalContainedIn
entPhysicalIndex
equipmentType
String
String
EquipmentTypeEn
um
Description
Instance identifier of entity in the database.
String representation of attribute value(s) that uniquely
identify the entity or instanceId if no business key defined.
** Deprecated. Will be replaced by an enumerated
attribute (possibly a lookup table) after a proper model
review **\r\nThe administrative state (locked, unlocked,
and so on). The administrative state is the result of an
administrative action performed by administrator and/or
EMS/NMS SW.
Indicates the manufacturing assembly number, which is the
'hardware' identification.
Indicates the revision of the entity within the
assemblyNumber.
This object represents the CLEI (Common Language
Equipment Identifier) code for the physical entity. If the
physical entity is not present in the system, or does not
have an associated CLEI code, the value of this object will
be null.\r\n\r\nFrom-CISCO-ENTITY-ASSET-MIB :
ceAsset.cleI
An optional description of the entity.
Revision number (signifying a minor deviation) of a
module, port adapter, and so on. Typically this number is
required in FN (Field Notice) reports provided to customers
by a HW vendor.
## Internal use only ##
## Internal use only ##
An indication of the general hardware type of the physical
entity. This should be set to the standard enumeration
value that most accurately indicates the general class of
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
43
RESTCONF/YANG Interface Details
fdn
String
hardwareVersion
String
isFRUable
MultiStateEnum
isReportingAlarmsAllow
ed
manufacturedDate
MultiStateEnum
manufacturer
String
name
operationalStateCode
String
String
owningEntityId
partNumber
position
String
String
String
productFamily
String
productId
String
productName
String
datetime
the physical entity or the primary class if there is more than
one. If no appropriate standard registration identifier exists
for this physical entity, the value 'other' is returned.
The fully qualified domain name (FDN) for the equipment
(or equipment subclass) instance.
The vendor-specific hardware revision string for the
physical entity. The preferred value is the hardware
revision identifier actually printed on the component itself
(if present). If no specific hardware revision string is
associated with the physical component, or if this
information is unknown, this will contain a zero-length
string.
Indicates whether this physical entity is considered a 'field
replaceable unit' by the vendor.
Indicates whether alarm reporting for this resource is
allowed (can be set to Not_applicable).
Contains the date of manufacturing of the equipment. If
the manufacturing date is unknown or not supported, the
value of 0 is assigned.
The name of the manufacturer of this physical component.
The preferred value is the manufacturer name string
actually printed on the component itself (if present). If the
manufacturer name string associated with the physical
component is unknown to the agent, this object will
contain a zero-length string.
The name of the entity.
** Deprecated. Will be replaced by an enumerated
attribute (possibly a lookup table) after a proper model
review **\r\nThe operational state (operable or
inoperable) of the equipment.
## Internal use only ##
Manufacturer's part number.
** Deprecated. Will be removed after EquipmentHolder is
put back in the model **\r\nThe name of the container(s)
that the Equipment is in, or null if is not contained (for
example, chassis).
The name of a group of products derived from a common
product platform. For example, Catalyst 4000, MDS 900.
Product family can be uniquely determined via the
productId in Cisco's products databases that contain the
product, product series, product families, and their
relationship.
The vendor-specific model name identifier string
associated with this physical component. The preferred
value is the customer-visible part number, which might be
printed on the component itself. The productId generated
by the device is often referred to as the \\\'base
PID\\\'.\r\n\r\nFor some applications, PIDs must go
through a validation process; the resulting PID is referred
to as a \\\'validated PID\\\'.
The official name given to a product. For example, Cisco
10720 Router or Cisco 10720, Cisco 12000 Series Six-Port
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
44
RESTCONF/YANG Interface Details
serialNumber
String
serviceState
EquipmentService
StateEnum
subclassname
udi
String
String
vendorEquipmentType
String
connectors *
Set<PhysicalConn
ector>
Set<Equipment>
containedEquipment *
occupiedHolders
Set<EquipmentHo
lder>
DS3 Line Card or 6-Port DS3.
The vendor-specific serial number string for the physical
entity. The preferred value is the serial number string
actually printed on the component itself (if present). If a
serial number is unknown or nonexistent, the
SerialNumber will be left null. Note that not every physical
component has (or needs) a serial number. Physical
entities, which are not FRU (field replaceable) do not need
their own unique serial number. This item is used for
composing the UDI SID (see attribute 'udi').
Denotes the service state of a physical entity from the
point of view of the management application. It indicates
whether the entity is in service, out of service, under
maintenance, and so on.
The name of the object type.
Universal Device Identifier. The UDI is composed by
concatenating the following values:\r\nPID =
Equipment.partNumber\r\nVID =
Equipment.hardwareVersion\r\nSN =
Equipment.serialNumber.
An indication of the vendor-specific hardware type of the
physical entity. Represents an independently extensible
type identification value. It can, for example, indicate a
particular subtree with further MIB definitions, or define a
particular type of protocol or hardware (for example,
1.3.6.1.4.1.9.12.3.1.9.3.131).\r\nSee CISCO-ENTITYVENDORTYPE-OID-MIB.
The set of instances of PhysicalConnectors contained in this
piece of Equipment.
A set of instances of Equipment contained in this instance
of Equipment.
The EquipmentHolders occupied by this piece of
Equipment.\nOther pieces of Equipment provide these
Holders. For example: A Module can occupy one or two
Slots provided by a Chassis.
Operations
All URLs require basic authentication and can produce:
 application/xml
 application/yang.data+xml
 application/json
 application/yang.data+json
The following table lists the operations available to retrieve Equipment data from
RESTCONF via the http protocol:
URL
Description
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
45
RESTCONF/YANG Interface Details
http://<host>/restconf/data/v1/xmp-im-physical-resource-moduleequipment:Equipment
http://<host>/restconf/data/v1/xmp-im-physical-resource-moduleequipment:Equipment/{owningEntityId}/{entPhysicalIndex}
http://<host>/restconf/data/v1/xmp-im-physical-resource-moduleequipment:Equipment/{id}
Retrieve all Equipment instances
Retrieve Equipment instance by
business key
Retrieve Equipment instance by
database instance id.
Note: Do not use braces for the
<id>.
This object supports the fully-qualified domain name (FDN) attribute, which is unique for
all Equipment objects. You may use the FDN as a query parameter to retrieve a specific
Equipment object as follows:
http://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment?fdn=<value>
Where <host> is the host name or IP address of the Cisco EPN Manager server and <value>
is the value of the FDN attribute for the object to retrieve.
Sample Response Data
4.4.1.1 JSON
This sample is formatted and edited for clarity and length.
{"ns2.EquipmentInstances": [
"Equipment": [
{
"description": "A901-12C-F-D Motherboard with Built-in 12GE,
1FE",
"name": "A901-12C-F-D Motherboard ",
"owningEntityId": "207208_192.168.23.26",
"entPhysicalContainedIn": 2,
"entPhysicalIndex": 3,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=A901-12C-F-D Motherboard ;partnumber=A90112C-F-D",
"hardwareVersion": "V03 ",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "A901-12C-F-D",
"serviceState": "UNKNOWN",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
46
RESTCONF/YANG Interface Details
"subclassname": "Module",
"vendorEquipmentType": "cevChassisASR901E",
"connectors": [
{
"description": "Gigabit Ethernet",
"name": "GigabitEthernet0\/2",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 241255,
"businessKey":
"e01b1a63[3,GigabitEthernet0\/2,207208_192.168.23.26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 10,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGEIP",
"equipment": "[Module{'name':'A901-12C-F-D Motherboard
','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/2",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/2",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220543,
"businessKey": "489e4745[207208_192.168.23.26,10]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 10,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/2','businessKey':'e01b1a6
3[3,GigabitEthernet0\/2,207208_192.168.23.26]'}]"
}
},
{
"description": "eTSEC 1",
"name": "FastEthernet0\/0",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
47
RESTCONF/YANG Interface Details
"owningEntityId": "207208_192.168.23.26",
"instanceId": 241265,
"businessKey":
"e01b1a63[3,FastEthernet0\/0,207208_192.168.23.26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 16,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortFEIP",
"equipment": "[Module{'name':'A901-12C-F-D Motherboard
','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",
"physicalProtocolEndpoint": {
"name": "FastEthernet0\/0",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/FastEthernet0\/0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220533,
"businessKey": "489e4745[207208_192.168.23.26,16]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 16,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'FastEthernet0\/0','businessKey':'e01b1a63[3
,FastEthernet0\/0,207208_192.168.23.26]'}]"
}
}
],
"containedEquipment": [
{
"description": "High Speed Fan2 Module for A901-12C-F-D",
"name": "Fan2",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235286,
"businessKey": "d1d98c1f[207208_192.168.23.26,28]",
"entPhysicalContainedIn": 3,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
48
RESTCONF/YANG Interface Details
"entPhysicalIndex": 28,
"equipmentType": "FAN",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=Fan2;partnumber=FAN",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "FAN",
"serialNumber": "33-0629-01",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevFanSinglePulse",
"containingEquipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]"
},
{
"description": "High Speed Fan1 Module for A901-12C-F-D",
"name": "Fan1",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235285,
"businessKey": "d1d98c1f[207208_192.168.23.26,27]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 27,
"equipmentType": "FAN",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=Fan1;partnumber=FAN",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "FAN",
"serialNumber": "33-0629-01",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevFanSinglePulse",
"containingEquipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]"
}
],
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
49
RESTCONF/YANG Interface Details
"containingEquipment": "[Equipment{'name':'Chassis
Slot','businessKey':'d1d98c1f[207208_192.168.23.26,2]'}]"
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
50
RESTCONF/YANG Interface Details
4.5 Module Retrieval
This interface provides the operations to retrieve Module entities. The object represents a
physical module or adapter card.
Module Data
The following table lists the attributes in the Module object. Associated objects are
represented by a collection, for one-to-many associations, or an attribute of the object
type for one-to-one or many-to-one associates. The role of the object(s) in the association
provides the name for association attributes. The API traverses selected associations,
usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects in a single
request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
Module Data
instanceId
businessKey
Data Type
int
String
administrativeStateCode
String
assemblyNumber
String
assemblyRevision
String
cleiCode
String
description
deviationNumber
String
String
entPhysicalContainedIn
entPhysicalIndex
equipmentType
String
String
Equipmen
tTypeEnu
m
Description
Instance identifier of entity in the database.
String representation of attribute value(s) that uniquely
identify the entity or instanceId if no business key defined
** Deprecated. Will be replaced by an enumerated attribute
(possibly a lookup table) after a proper model review
**\r\nThe administrative state (locked, unlocked, and so on).
The administrative state is the result of an administrative
action performed by administrator and/or EMS/NMS SW.
Indicates the manufacturing assembly number, which is the
'hardware' identification.
Indicates the revision of the entity within the
assemblyNumber.
This object represents the CLEI (Common Language
Equipment Identifier) code for the physical entity. If the
physical entity is not present in the system, or does not have
an associated CLEI code, the value of this object will be
null.\r\n\r\nFrom-CISCO-ENTITY-ASSET-MIB : ceAsset.cleI
an optional description of the entity.
Revision number (signifying a minor deviation) of a module,
port adapter, and so on. Typically this number is required in
FN (Field Notice) reports provided to customers by a HW
vendor.
## Internal use only ##
## Internal use only ##
An indication of the general hardware type of the physical
entity. This should be set to the standard enumeration value
that most accurately indicates the general class of the physical
entity or the primary class if there is more than one. If no
appropriate standard registration identifier exists for this
physical entity, the value 'other' is returned.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
51
RESTCONF/YANG Interface Details
fdn
String
hardwareVersion
String
isFRUable
MultiState
Enum
boolean
isInlinePowercapable
isReportingAlarmsAllowed
manufacturedDate
MultiState
Enum
datetime
manufacturer
String
moduleIndex
name
nrFreeSlots
nrPorts
int
String
int
int
nrSlots
int
operationalStateCode
String
owningEntityId
partNumber
position
String
String
String
productFamily
String
productId
String
The fully qualified domain name (FDN) for the equipment (or
equipment subclass) instance.
The vendor-specific hardware revision string for the physical
entity. The preferred value is the hardware revision identifier
actually printed on the component itself (if present). If no
specific hardware revision string is associated with the
physical component, or if this information is unknown, this
will contain a zero-length string.
Indicates whether this physical entity is considered a 'field
replaceable unit' by the vendor.
Indicates whether a module is capable of providing inline
power through its ports. Populated based on the module type:
\\\'wsx6348rj45\\\', \\\'wsx4148rj45v\\\',
\\\'cevCat6kWsx6348Rj45\\\', \\\'wsf6kvpwr\\\', and \\\'cpu3845-2ge\\\' are inline power capable. Others are not capable.
Indicates whether alarm reporting for this resource is allowed
(can be set to Not_applicable).
Contains the date of manufacturing of the equipment. If the
manufacturing date is unknown or not supported, the value of
0 is assigned.
The name of the manufacturer of this physical component.
The preferred value is the manufacturer name string actually
printed on the component itself (if present). If the
manufacturer name string associated with the physical
component is unknown to the agent, this object will contain a
zero-length string.
## Internal use only ##
The name of the entity.
Indicates the number of free slots the chassis has.
Specifies the number of ports that are supported by the
module.
The number of slots in the chassis available for plugin
modules.
** Deprecated. Will be replaced by an enumerated attribute
(possibly a lookup table) after a proper model review
**\r\nThe operational state (operable or inoperable) of the
equipment.
## Internal use only ##
Manufacturer's part number.
** Deprecated. Will be removed after EquipmentHolder is put
back in the model **\r\nThe name of the container(s) that the
Equipment is in, or null if is not contained (for example,
chassis).
The name of a group of products derived from a common
product platform. For example, Catalyst 4000, MDS 900.
Product family can be uniquely determined via the productId
in Cisco's products databases that contain the product,
product series, product families, and their relationship.
The vendor-specific model name identifier string associated
with this physical component. The preferred value is the
customer-visible part number, which might be printed on the
component itself. The productId generated by the device is
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
52
RESTCONF/YANG Interface Details
productName
String
resetReason
resetReasonDescription
ModuleRe
setReason
TypeEnum
String
serialNumber
String
serviceState
Equipmen
tServiceSt
ateEnum
subclassname
udi
String
String
vendorEquipmentType
String
connectors *
Set<Physi
calConnec
tor>
Set<Equip
ment>
Set<Equip
mentHold
er>
containedEquipment *
occupiedHolders
often referred to as the \\\'base PID\\\'.\r\n\r\nFor some
applications, PIDs must go through a validation process; the
resulting PID is referred to as a \\\'validated PID\\\'.
The official name given to a product. For example, Cisco 10720
Router or Cisco 10720, Cisco 12000 Series Six-Port DS3 Line
Card or 6-Port DS3.
Identifies the reason for the last reset performed on the
module.
A description qualifying the module reset reason specified in
resetReason. Examples: command xyz, missing task, switch
over, watchdog timeout, and so on.
The vendor-specific serial number string for the physical
entity. The preferred value is the serial number string actually
printed on the component itself (if present). If a serial number
is unknown or nonexistent, the SerialNumber will be left null.
Note that not every physical component has (or needs) a
serial number. Physical entities, which are not FRU (field
replaceable) do not need their own unique serial number. This
item is used for composing the UDI SID (see attribute 'udi').
Denotes the service state of a physical entity from the point of
view of the management application. It indicates whether the
entity is in service, out of service, under maintenance, and so
on.
The name of the object type
Universal Device Identifier. The UDI is composed by
concatenating the following values:\r\nPID =
Equipment.partNumber\r\nVID =
Equipment.hardwareVersion\r\nSN =
Equipment.serialNumber
An indication of the vendor-specific hardware type of the
physical entity. Represents an independently extensible type
identification value. It can, for example, indicate a particular
subtree with further MIB definitions, or define a particular
type of protocol or hardware (for example,
1.3.6.1.4.1.9.12.3.1.9.3.131).\r\nSee CISCO-ENTITYVENDORTYPE-OID-MIB.
The set of instances of PhysicalConnectors contained in this
piece of Equipment.
A set of instances of Equipment contained in this instance of
Equipment.
The EquipmentHolders occupied by this piece of
Equipment.\nOther pieces of Equipment provide these
Holders. For example: A Module can occupy one or two Slots
provided by a Chassis.
Operations
All URLs require basic authentication and can produce:
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
53
RESTCONF/YANG Interface Details




application/xml
application/yang.data+xml
application/json
application/yang.data+json
The following table lists the operations available to retrieve Module data from RESTCONF
via the http protocol.
URL
http://<host>/restconf/data/v1/xmp-im-physical-resourcemodule-module:Module
http://<host>/restconf/data/v1/xmp-im-physical-resourcemodule-module:Module/{owningEntityId}/{entPhysicalIndex}
http://<host>/restconf/data/v1/xmp-im-physical-resourcemodule-module:Module/{id}
Description
Retrieve all Module instances
Retrieve Module instance by business key
Retrieve Module instance by database
instance id
Note: Do not use braces for the <id>.
This object supports the fully-qualified domain name (FDN) attribute, which is unique for
all Module objects. You may use the FDN as a query parameter to retrieve a specific
Module object as follows:
http://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module?fdn=<value>
Where <host> is the host name or IP address of the Cisco EPN Manager Server and <value>
is the value of the FDN attribute for the object to retrieve.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
54
RESTCONF/YANG Interface Details
Sample Response Data
4.5.1.1 JSON
The following sample is formatted and edited for clarity and length:
{"ns1.ModuleInstances": [
"Module": [
{
"description": "A901-12C-F-D Motherboard with Built-in 12GE,
1FE",
"name": "A901-12C-F-D Motherboard ",
"owningEntityId": "207208_192.168.23.26",
"entPhysicalContainedIn": 2,
"entPhysicalIndex": 3,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=A901-12C-F-D Motherboard ;partnumber=A90112C-F-D",
"hardwareVersion": "V03 ",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "A901-12C-F-D",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevChassisASR901E",
"connectors": [
{
"description": "Gigabit Ethernet",
"name": "GigabitEthernet0\/2",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 241255,
"businessKey":
"e01b1a63[3,GigabitEthernet0\/2,207208_192.168.23.26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 10,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGEIP",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
55
RESTCONF/YANG Interface Details
"equipment": "[Module{'name':'A901-12C-F-D Motherboard
','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/2",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/2",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220543,
"businessKey": "489e4745[207208_192.168.23.26,10]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 10,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/2','businessKey':'e01b1a6
3[3,GigabitEthernet0\/2,207208_192.168.23.26]'}]"
}
},
{
"description": "eTSEC 1",
"name": "FastEthernet0\/0",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 241265,
"businessKey":
"e01b1a63[3,FastEthernet0\/0,207208_192.168.23.26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 16,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortFEIP",
"equipment": "[Module{'name':'A901-12C-F-D Motherboard
','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",
"physicalProtocolEndpoint": {
"name": "FastEthernet0\/0",
"owningEntityId": "207208_192.168.23.26",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
56
RESTCONF/YANG Interface Details
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/FastEthernet0\/0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220533,
"businessKey": "489e4745[207208_192.168.23.26,16]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 16,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'FastEthernet0\/0','businessKey':'e01b1a63[3
,FastEthernet0\/0,207208_192.168.23.26]'}]"
}
}
],
"containedEquipment": [
{
"description": "High Speed Fan1 Module for A901-12C-F-D",
"name": "Fan1",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235285,
"businessKey": "d1d98c1f[207208_192.168.23.26,27]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 27,
"equipmentType": "FAN",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=Fan1;partnumber=FAN",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "FAN",
"serialNumber": "33-0629-01",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevFanSinglePulse",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
57
RESTCONF/YANG Interface Details
"containingEquipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]"
},
{
"description": "DC Power Supply 2 (12B V)",
"name": "DC Redundant Power supply",
"owningEntityId": "207208_192.168.23.26",
"instanceId": 235284,
"businessKey": "d1d98c1f[207208_192.168.23.26,26]",
"entPhysicalContainedIn": 3,
"entPhysicalIndex": 26,
"equipmentType": "POWERSUPPLY",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/EQ\/name=DC Redundant Power supply;partnumber=POWER
SUPPLY",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco",
"partNumber": "POWER SUPPLY",
"serialNumber": "34-2593-01",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevPowerSupplyDc150W",
"containingEquipment": "[Module{'name':'A901-12C-F-D
Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]"
}
],
"containingEquipment": "[Equipment{'name':'Chassis
Slot','businessKey':'d1d98c1f[207208_192.168.23.26,2]'}]",
"instanceId": 235282,
"businessKey": "ddf068b3[207208_192.168.23.26,3]",
"moduleIndex": 0
},
{
"description": "8-port Gigabit Ethernet Interface Module",
"name": "IM subslot 0\/1",
"owningEntityId": "207210_192.168.23.58",
"entPhysicalContainedIn": 5,
"entPhysicalIndex": 550,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
58
RESTCONF/YANG Interface Details
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN-5.cisco.com\/EQ\/name=IM
subslot 0\/1;partnumber=A900-IMA8S",
"hardwareVersion": "V01",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "Cisco Systems Inc",
"operationalStateCode": "ok",
"partNumber": "A900-IMA8S",
"serialNumber": "FOC1725N2NN",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevIM8pGeSFP",
"containedEquipment": [
{
"description": "subslot 0\/1 transceiver container 2",
"name": "subslot 0\/1 transceiver container 2",
"owningEntityId": "207210_192.168.23.58",
"instanceId": 235238,
"businessKey": "d1d98c1f[207210_192.168.23.58,621]",
"entPhysicalContainedIn": 550,
"entPhysicalIndex": 621,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN5.cisco.com\/EQ\/name=subslot 0\/1 transceiver container
2;partnumber=cevContainerSFP",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerSFP",
"containedEquipment": {
"description": "GE SX",
"name": "subslot 0\/1 transceiver 2",
"owningEntityId": "207210_192.168.23.58",
"instanceId": 235239,
"businessKey": "ddf068b3[207210_192.168.23.58,622]",
"entPhysicalContainedIn": 621,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
59
RESTCONF/YANG Interface Details
"entPhysicalIndex": 622,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN5.cisco.com\/EQ\/name=subslot 0\/1 transceiver 2;partnumber=QFBR-5766LP
",
"hardwareVersion": "
",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "CISCO-AGILENT
"partNumber": "QFBR-5766LP
",
",
"serialNumber": "AGS090854D0
",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevSFP1000BaseSx",
"connectors": {
"description": "A900-IMA8S",
"name": "GigabitEthernet0\/1\/2",
"owningEntityId": "207210_192.168.23.58",
"instanceId": 241241,
"businessKey":
"e01b1a63[622,GigabitEthernet0\/1\/2,207210_192.168.23.58]",
"entPhysicalContainedIn": 622,
"entPhysicalIndex": 623,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'subslot 0\/1 transceiver
2','businessKey':'ddf068b3[207210_192.168.23.58,622]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/1\/2",
"owningEntityId": "207210_192.168.23.58",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN5.cisco.com\/FTP\/GigabitEthernet0\/1\/2",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220340,
"businessKey": "489e4745[207210_192.168.23.58,623]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 623,
"isInternalPort": false,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
60
RESTCONF/YANG Interface Details
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/1\/2','businessKey':'e01b
1a63[622,GigabitEthernet0\/1\/2,207210_192.168.23.58]'}]"
}
},
"containingEquipment": "[Equipment{'name':'subslot 0\/1
transceiver container
2','businessKey':'d1d98c1f[207210_192.168.23.58,621]'}]"
},
"containingEquipment": "[Module{'name':'IM subslot
0\/1','businessKey':'ddf068b3[207210_192.168.23.58,550]'}]"
},
{
"description": "subslot 0\/1 transceiver container 3",
"name": "subslot 0\/1 transceiver container 3",
"owningEntityId": "207210_192.168.23.58",
"instanceId": 235240,
"businessKey": "d1d98c1f[207210_192.168.23.58,635]",
"entPhysicalContainedIn": 550,
"entPhysicalIndex": 635,
"equipmentType": "OTHER",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN5.cisco.com\/EQ\/name=subslot 0\/1 transceiver container
3;partnumber=cevContainerSFP",
"isFRUable": "FALSE",
"isReportingAlarmsAllowed": "UNKNOWN",
"serviceState": "UNKNOWN",
"subclassname": "Equipment",
"vendorEquipmentType": "cevContainerSFP",
"containedEquipment": {
"description": "GE SX",
"name": "subslot 0\/1 transceiver 3",
"owningEntityId": "207210_192.168.23.58",
"instanceId": 235241,
"businessKey": "ddf068b3[207210_192.168.23.58,636]",
"entPhysicalContainedIn": 635,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
61
RESTCONF/YANG Interface Details
"entPhysicalIndex": 636,
"equipmentType": "MODULE",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN5.cisco.com\/EQ\/name=subslot 0\/1 transceiver 3;partnumber=SFP-GE-S
",
"hardwareVersion": "B
",
"isFRUable": "TRUE",
"isReportingAlarmsAllowed": "UNKNOWN",
"manufacturer": "CISCO-FINISAR
",
"partNumber": "SFP-GE-S
"serialNumber": "FNS124413EA
",
",
"serviceState": "UNKNOWN",
"subclassname": "Module",
"vendorEquipmentType": "cevSFP1000BaseSx",
"connectors": {
"description": "A900-IMA8S",
"name": "GigabitEthernet0\/1\/3",
"owningEntityId": "207210_192.168.23.58",
"instanceId": 241244,
"businessKey":
"e01b1a63[636,GigabitEthernet0\/1\/3,207210_192.168.23.58]",
"entPhysicalContainedIn": 636,
"entPhysicalIndex": 637,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'subslot 0\/1 transceiver
3','businessKey':'ddf068b3[207210_192.168.23.58,636]'}]",
"physicalProtocolEndpoint": {
"name": "GigabitEthernet0\/1\/3",
"owningEntityId": "207210_192.168.23.58",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN5.cisco.com\/FTP\/GigabitEthernet0\/1\/3",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220398,
"businessKey": "489e4745[207210_192.168.23.58,637]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 637,
"isInternalPort": false,
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
62
RESTCONF/YANG Interface Details
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/1\/3','businessKey':'e01b
1a63[636,GigabitEthernet0\/1\/3,207210_192.168.23.58]'}]"
}
},
"containingEquipment": "[Equipment{'name':'subslot 0\/1
transceiver container
3','businessKey':'d1d98c1f[207210_192.168.23.58,635]'}]"
},
"containingEquipment": "[Module{'name':'IM subslot
0\/1','businessKey':'ddf068b3[207210_192.168.23.58,550]'}]"
}
],
"containingEquipment": "[Equipment{'name':'subslot
0\/1','businessKey':'d1d98c1f[207210_192.168.23.58,5]'}]",
"instanceId": 235235,
"businessKey": "ddf068b3[207210_192.168.23.58,550]",
"moduleIndex": 0
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
63
RESTCONF/YANG Interface Details
4.6 PhysicalConnector Retrieval
This interface provides the operations to retrieve PhysicalConnector entities. Represents a
connector that can transmit signals or power when in a connection.
PhysicalConnector Data
Associated objects are represented by a collection, for one-to-many associations, or an
attribute of the object type for one-to-one or many-to-one associates. The role of the
object(s) in the association provides the name for association attributes. The API traverses
selected associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy
of objects in a single request. Attribute names of such associations are followed by an
asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
The following table lists the attributes in the PhysicalConnector object:
PhysicalConne
ctor Data
instanceId
businessKey
Data Type
Description
int
String
description
entAliasLogical
IndexOrZero
entPhysicalCo
ntainedIn
entPhysicalInd
ex
name
owningEntityI
d
subclassname
vendorEquipm
entType
String
String
Instance identifier of entity in the database.
String representation of attribute value(s) that uniquely identify the entity
or instanceId if no business key defined
an optional description of the entity
## Internal use only ##
String
## Internal use only ##
String
## Internal use only ##
String
String
the name of the entity
## Internal use only ##
String
String
The name of the object type.
An indication of the vendor-specific hardware type of the physical entity.
Represents an independently extensible type identification value. It can, for
example, indicate a particular subtree with further MIB definitions, or
define a particular type of protocol or hardware (for example,
1.3.6.1.4.1.9.12.3.1.9.3.131).\r\nSee CISCO-ENTITY-VENDORTYPE-OID-MIB.
Operations
All URLs require basic authentication and can produce:
 application/xml
 application/yang.data+xml
 application/json
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
64
RESTCONF/YANG Interface Details

application/yang.data+json
The table below lists the operations available to retrieve PhysicalConnector data from
RESTCONF via the http protocol.
URL
http://<host>/restconf/data/v1/xmp-im-physical-resourcemodule-physicalconnector:PhysicalConnector
http://<host>/restconf/data/v1/xmp-im-physical-resourcemodulephysicalconnector:PhysicalConnector/{entPhysicalContainedIn}/
{name}/{owningEntityId}
http://<host>/restconf/data/v1/xmp-im-physical-resourcemodule-physicalconnector:PhysicalConnector/{id}
Description
Retrieve all PhysicalConnector
instances
Retrieve PhysicalConnector instance
by business key
Retrieve PhysicalConnector instance
by database instance id
Sample Response Data
4.6.1.1 JSON
This sample is formatted and edited for clarity and length.
{"ns2.PhysicalConnectorInstances": [
"PhysicalConnector": [
{
"description": "RSP Management Ethernet Port",
"name": "MgmtEth0\/RSP0\/CPU0\/1",
"owningEntityId": "207223_192.168.23.54",
"instanceId": 241378,
"businessKey":
"e01b1a63[38645760,MgmtEth0\/RSP0\/CPU0\/1,207223_192.168.23.54]",
"entPhysicalContainedIn": 38645760,
"entPhysicalIndex": 44982153,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'module
0\/RSP0\/CPU0','businessKey':'ddf068b3[207223_192.168.23.54,38645760]'}
]",
},
{
"description": "RSP Management Ethernet Port",
"name": "MgmtEth0\/RSP0\/CPU0\/0",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
65
RESTCONF/YANG Interface Details
"owningEntityId": "207223_192.168.23.54",
"instanceId": 241379,
"businessKey":
"e01b1a63[38645760,MgmtEth0\/RSP0\/CPU0\/0,207223_192.168.23.54]",
"entPhysicalContainedIn": 38645760,
"entPhysicalIndex": 61759766,
"subclassname": "PhysicalConnector",
"vendorEquipmentType": "cevPortGe",
"equipment": "[Module{'name':'module
0\/RSP0\/CPU0','businessKey':'ddf068b3[207223_192.168.23.54,38645760]'}
]",
"physicalProtocolEndpoint": {
"name": "MgmtEth0\/RSP0\/CPU0\/0",
"owningEntityId": "207223_192.168.23.54",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR9KMTG\/FTP\/MgmtEth0\/RSP0\/CPU0\/0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 403492,
"businessKey": "489e4745[207223_192.168.23.54,61759766]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 61759766,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'MgmtEth0\/RSP0\/CPU0\/0','businessKey':'e01
b1a63[38645760,MgmtEth0\/RSP0\/CPU0\/0,207223_192.168.23.54]'}]"
}
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
66
RESTCONF/YANG Interface Details
4.7 Physical Protocol Endpoint Retrieval
This interface provides the operations to retrieve PhysicalProtocolEndpoint entities. This
object represents the end point related to a physical protocol. Note that this is NOT a
physical entity, but a logical entity that represents media information. In contrast, the
associated physical entity, such as a USB connector, is represented by the
PhysicalConnector class or one of its subclasses.
PhysicalProtocolEndpoint Data
The table below lists the attributes in the PhysicalProtocolEndpoint object. Associated
objects are represented by a collection, for one-to-many associations, or an attribute of
the object type for one-to-one or many-to-one associates. The role of the object(s) in the
association provides the name for association attributes. The API traverses selected
associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects
in a single request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
PhysicalProtocolEn
dpoint Data
Data Type
Description
instanceId
int
Instance identifier of entity in the database.
businessKey
String
String representation of attribute value(s) that uniquely
identify the entity or instanceId if no business key
defined.
alarmStatus
AlarmSeverityEnum
## Internal use only ##\r\nRaw MIB data - parsed into
supportedSpeeds and supportsAutoSpeed
clocking
PhysicalLayerClockingE
num
Indicates the clocking mechanism that is being used.
comments
String
Contains comments added to a subclass of
ProtocolEndpoint.
description
String
An optional description of the entity.
doAutoNegotiation
boolean
Indicates whether the element should negotiate speed,
duplex, and/or link characteristics (such as flow
control).
entPhysicalIndex
String
## Internal use only ##
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
67
RESTCONF/YANG Interface Details
fdn
String
The fully qualified domain name (FDN) for the
equipment (or equipment subclass) instance
isFloatingPep
boolean
Indicates whether a ProtocolEndpoint is related to a
ResourceAccessPoint. If not, this ProtocolEndpoint is
known as a floating PEP.
isInternalPort
boolean
Indicates whether this is a device internal port (for
example, used for internal communication only).
layerRate
LayerRateEnum
mtosiLabel
String
!!! this attribute is only to be used by the MTOSI NBI.
It's format and population cannot be relied upon and
may change without notice !!!
name
String
the name of the entity
owningEntityId
String
## Internal use only ##
portIdentifier
String
## Internal Use Only ##\r\nIf present can uniquely
identify a physical protocol endpoint. For ether port it
can be MAC address for FC port it can be WWPN etc.
portStatus
PhysicalStatusEnum
Provides additional detail related to the
OperationalStatuse of the termination point; for
example, whether it is jabbering or negotiating.
subclassname
String
The name of the object type.
speed
unsignedLong
An estimate of the interface's current bandwidth in bits
per second. For interfaces that do not vary in
bandwidth or for those where no accurate estimation
can be made, this setting should contain the nominal
bandwidth. For a sublayer, which has no concept of
bandwidth, this setting should be assigned the value
zero.
supportedSpeedStri
ng
String
## Internal Use Only ##\r\nRaw MIB data - parsed into
supportedSpeeds and supportsAutoSpeed
supportsAutoNegoti
ation
MultiStateEnum
Indicates whether the port supports auto-negotiation. If
auto-negotiation is supported, then doAutoNegotiation
must be set.
supportsAutoSpeed
boolean
Defines if auto speed is supported or not.\r\n(parsed
from supportedSpeedString)
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
68
RESTCONF/YANG Interface Details
containedPEPs *
Collection<ProtocolEnd
point>
The set of instances of ProtocolEndpoint subclasses that
are part of a protocol stack (ISO), of which this instance
of PhysicalProtocolEndpoint is the lowest layer (is said
to \'contain the endpoints in the stack\').
forwardingRelations
hipEnd
ForwardingRelationship
End
The set of instances of ForwardingRelationship for this
instance of FREnd (it is one side of the association
class).
lowerLayerPEP
Set<ProtocolEndpoint>
The set of instances of ProtocolEndpoint subclasses that
serve as a lower layer in a protocol stack for this
instance of a ProtocolEndpoint subclass. The lower layer
PEPs are said to provide connectivity to the upper layer
PEPs.
upperLayerPEP
Set<ProtocolEndpoint>
The set of instances of ProtocolEndpoint subclasses that
serve as upper layers in a protocol stack for this
instance of a ProtocolEndpoint subclass. This instance
(and possibly others) are said to provide connectivity to
the upper layer PEPs.
Operation
All URLs require basic authentication and can produce:
 application/xml
 application/yang.data+xml
 application/json
 application/yang.data+json
The table below lists the operations available to retrieve PhysicalProtocolEndpoint data
from RESTCONF via the HTTP protocol.
URL
Description
http://<host>/restconf/data/v1/xmp-im-connectivitymodule-physicalprotocolendpoint:PhysicalProtocolEndpoint
Retrieve all PhysicalProtocolEndpoint
instances
http://<host>/restconf/data/v1/xmp-im-connectivitymodulephysicalprotocolendpoint:PhysicalProtocolEndpoint/{ownin
gEntityId}/{entPhysicalIndex}
Retrieve PhysicalProtocolEndpoint
instance by business key
http://<host>/restconf/data/v1/xmp-im-connectivitymodulephysicalprotocolendpoint:PhysicalProtocolEndpoint/{id}
Retrieve PhysicalProtocolEndpoint
instance by database instance id
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
69
RESTCONF/YANG Interface Details
Note: Do not use braces for the <id>.
This object supports the fully-qualified domain name (FDN) attribute, which is unique for
all PhysicalProtocolEndpoint objects. You may use the FDN as a query parameter to
retrieve a specific PhysicalProtocolEndpoint object as follows:
http://<host>/restconf/data/v1/xmp-im-connectivitymodulephysicalprotocolendpoint:PhysicalProtocolEndpoint?fdn=<value>
Where <host> is the host name or IP address of the Cisco EPN Manager server and <value>
is the value of the FDN attribute for the object to retrieve.
Sample Response Data
4.7.1.1 JSON
Following is the sample code formatted and edited for clarity and length.
{"ns2.PhysicalProtocolEndpoint": [
"PhysicalProtocolEndpoint": [
{
"name": "GigabitEthernet0\/1",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/1",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220479,
"businessKey": "489e4745[207208_192.168.23.26,9]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 9,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/1','businessKey':'e01b1a6
3[3,GigabitEthernet0\/1,207208_192.168.23.26]'}]"
},
{
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
70
RESTCONF/YANG Interface Details
"name": "GigabitEthernet0\/0",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/0",
"isFloatingPep": false,
"subclassname": "PhysicalProtocolEndpoint",
"instanceId": 220480,
"businessKey": "489e4745[207208_192.168.23.26,8]",
"clocking": "NOTAPPLICABLE",
"entPhysicalIndex": 8,
"isInternalPort": false,
"speed": 0,
"supportsAutoNegotiation": "FALSE",
"supportsAutoSpeed": false,
"physicalConnector":
"[PhysicalConnector{'name':'GigabitEthernet0\/0','businessKey':'e01b1a6
3[3,GigabitEthernet0\/0,207208_192.168.23.26]'}]"
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
71
RESTCONF/YANG Interface Details
4.8 InterfaceProtocolEndpoint Retrieval
This interface provides the operations to retrieve InterfaceProtocolEndpoint entities. This
object represents entries in the IF-MIB IfTable or their equivalent in IOS or config-file.
InterfaceProtocolEndpoint Data
The table below lists the attributes in the InterfaceProtocolEndpoint object. Associated
objects are represented by a collection, for one-to-many associations, or an attribute of
the object type for one-to-one or many-to-one associates. The role of the object(s) in the
association provides the name for association attributes. The API traverses selected
associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy of objects
in a single request. Attribute names of such associations are followed by an asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
InterfaceProtocolEnd
point Data
instanceId
businessKey
Data Type
Description
int
String
adminStatus
alarmStatus
IfAdminStatusEnum
AlarmSeverityEnum
comments
String
description
entAliasMappingIden
tifier
fdn
String
String
Instance identifier of entity in the database.
String representation of attribute value(s) that uniquely
identify the entity or instanceId if no business key defined.
Represents the desired state of the interface.
## Internal use only ##\r\nRaw MIB data - parsed into
supportedSpeeds and supportsAutoSpeed
Contains comments added to a subclass of
ProtocolEndpoint.
An optional description of the entity.
## Internal use only ##
ifIndex
ifSpeed
String
LongQuantity
isConnectorPresent
MultiStateEnum
isFloatingPep
boolean
isPromiscuous
boolean
String
The fully qualified domain name (FDN) for the equipment
(or equipment subclass) instance
## Internal use only ##
Specifies an estimate of the interface's current bandwidth
in bits per second. For interfaces that do not vary in
bandwidth or for those where no accurate estimation can
be made, this should contain the nominal bandwidth. For a
sublayer that has no concept of bandwidth, this object
should be zero.
Indicates whether the interface sublayer has a physical
connector.
Indicates whether a ProtocolEndpoint is related to a
ResourceAccessPoint. If not, this ProtocolEndpoint is
known as a floating PEP.
Indicates whether this interface only accepts
packets/frames that are addressed to its hosting network
element. This object has a value of true when the station
accepts all packets/frames transmitted on the media. The
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
72
RESTCONF/YANG Interface Details
isSpanMonitored
boolean
isTrapEnabled
lagEndName
layerRate
locationIndex
mtosiLabel
boolean
String
LayerRateEnum
unsignedInt
String
mtu
int
name
operStatus
owningEntityId
subclassname
supportedMTUs
String
IfOperStatusEnum
String
String
NumericRange
type
IFTypeEnum
forwardingRelationsh
ipEnd
lowerLayerPEP
ForwardingRelation
shipEnd
Set<ProtocolEndpoi
nt>
upperLayerPEP
Set<ProtocolEndpoi
nt>
value true is only legal on certain types of media;
otherwise the attribute is set to false. This value does not
affect the reception of broadcast and multicast
packets/frames by the interface.
The related IOS commands are\r\n\r\nRouter(config)#
monitor session 1 destination interface fastEthernet
2/0\r\n\r\nMy_Switch(config)# monitor session 1 source
vlan 33 rx\r\n\r\nRouter# show monitor session
2\r\nSession 2\r\n------------\r\nType : Remote Source
Session\r\nSource Ports:\r\nRX Only: Fa1/1-3\r\nDest
RSPAN VLAN: 901
False if the interface is confured to not send the traps.
## Internal use only ##
## Internal use only ##
!!! this attribute is only to be used by the MTOSI NBI. It's
format and population cannot be relied upon and may
change without notice !!!
Represents the size in octets of the largest packet that can
be sent/received on the interface. For interfaces that are
used for transmitting network datagrams, this is the size of
the largest network datagram that can be sent on the
interface.
The name of the entity.
Represent the current operational state of the interface.
## Internal use only ##
The name of the object type.
Indicates the MTU range supported by the Ethernet
interface.
The type of endpoint, as defined by IANA. Reference: IFMIB : ifType
The set of instances of ForwardingRelationship for this
instance of FREnd (it is one side of the association class).
The set of instances of ProtocolEndpoint subclasses that
serve as a lower layer in a protocol stack for this instance
of a ProtocolEndpoint subclass. The lower layer PEPs are
said to provide connectivity to the upper layer PEPs.
The set of instances of ProtocolEndpoint subclasses that
serve as upper layers in a protocol stack for this instance of
a ProtocolEndpoint subclass. This instance (and possibly
others) are said to provide connectivity to the upper layer
PEPs.
Operations
All URLs require basic authentication and can produce:
 application/xml
 application/yang.data+xml
 application/json
 application/yang.data+json
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
73
RESTCONF/YANG Interface Details
The following table lists the operations available to retrieve InterfaceProtocolEndpoint
data from RESTCONF via the http protocol.
URL
http://<host>/restconf/data/vi/xmp-im-connectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolEndpoint
http://<host>/restconf/data/vi/xmp-im-connectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolEndpoint/{ownin
gEntityId}/{name}
http://<host>/restconf/data/vi/xmp-im-connectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolEndpoint/{id}
Description
Retrieve all InterfaceProtocolEndpoint
instances
Retrieve InterfaceProtocolEndpoint
instance by business key
Retrieve InterfaceProtocolEndpoint
instance by database instance id
Note: Do not use braces for the <id>.
This object supports the fully-qualified domain name (FDN) attribute, which is unique for
all InterfaceProtocolEndpoint objects. You may use the FDN as a query parameter to
retrieve a specific InterfaceProtocolEndpoint object as follows:
http://<host>/restconf/data/v1/xmp-im-connectivity-moduleinterfaceprotocolendpoint:InterfaceProtocolEndpoint?fdn=<value>
Where <host> is the host name or IP address of the Cisco EPN Manager server and <value>
is the value of the FDN attribute for the object to retrieve.
Sample Response Data
4.8.1.1 JSON
This sample is formatted and edited for clarity and length.
{"ns2.InterfaceProtocolEndpointInstances": {
"InterfaceProtocolEndpoint": [
{
"name": "Null0",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/Null0",
"isFloatingPep": false,
"subclassname": "IntrfcPrtclEndpnt",
"instanceId": 220491,
"businessKey": "1e6fb6f7[207208_192.168.23.26,Null0]",
"adminStatus": "UP",
"ifIndex": 16,
"ifSpeed": "",
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
74
RESTCONF/YANG Interface Details
"isConnectorPresent": "FALSE",
"isPromiscuous": false,
"isSpanMonitored": false,
"locationIndex": 0,
"mtu": 1500,
"operStatus": "UP",
"type": "OTHER"
},
{
"name": "Vlan20-mpls layer",
"owningEntityId": "207208_192.168.23.26",
"fdn": "MD\/CISCO_EPNM\/ME\/ASR901-CSG-1DOMAIN3.cisco.com\/FTP\/Vlan20-mpls layer",
"isFloatingPep": false,
"subclassname": "IntrfcPrtclEndpnt",
"instanceId": 220492,
"businessKey": "1e6fb6f7[207208_192.168.23.26,Vlan20-mpls
layer]",
"adminStatus": "UP",
"ifIndex": 46,
"ifSpeed": "",
"isConnectorPresent": "FALSE",
"isPromiscuous": false,
"isSpanMonitored": false,
"locationIndex": 0,
"mtu": 1500,
"operStatus": "UP",
"type": "MPLS"
}
]
}
}
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
75
Fully-qualified Domain Names (FDN)
5 Fully-qualified Domain Names (FDN)
This section describes the format of the fully-qualified domain name (FDN) attribute. FDN
attribute is unique for each object that supports it.
You may use the FDN as a query parameter to retrieve a specific object appending the
following query to the URL that retrieves all objects of a particular type:
?fdn=<value>
Where:
<value> is the value of the FDN attribute listed in the table below.
The following table list the object classes, inherited superclass, and FDN computation
format.
Object Class
Group
ManagedElement
Chassis
Equipment
Module
PhysicalConnector
PhysicalProtocolEndpoint
InterfaceProtocolEndpoint
Superclass
Equipment
Equipment
ProtocolEndpoint
ProtocolEndpoint
FDN Format
N/A
See ManagedElement FDN Format
See Equipment FDN Format
See Equipment FDN Format
See Equipment FDN Format
N/A
See ProtocolEndpoint FDN Format
See ProtocolEndpoint FDN Format
5.1 ManagedElement FDN Format
A ManagedElement object represents a device managed by the Cisco EPN Manager. The
FDN for managed elements contains the management domain (currently a fixed value,
‘CISCO_EPNM’, but this may change in future releases) and the name attribute of the
device.
Note: The device name must be globally unique to ensure that the ManagedElement FDN
is unique.
The format is as follows:
MD/CISCO_EPNM/ME/<me.name>
Where:
<me.name> is the value of the ManagedElement’s name attribute.
For example:
MD/CISCO_EPNM/ME/cvg.cisco.com
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
76
Fully-qualified Domain Names (FDN)
5.2 Equipment FDN Format
An Equipment object represents a piece of hardware that has some well-specified function
(for example, a line card, memory board, or power supply).This object class has several
subclasses, as shown in the table above.
The FDN for equipment objects starts with the management domain (currently a fixed
value, ‘CISCO_EPNM’, but this may change in future releases) and the name of the device
that contains it. The rest of this FDN is calculated based on which attributes of the
Equipment object are populated to ensure that the FDN is unique.
The format is as follows:
MD/CISCO_EPNM/ME/<me.name>/EQ/<ComputedName>
Where:
<me.name> is the value of the containing ManagedElement’s name attribute
<ComputedName > is as calculated below to ensure a unique value for the equipment
object’s name.
Equipment Attributes
<e.partnumber> is null and
<e.entphysicalindex> is numeric
<e.partnumber> is null and
<e.entphysicalindex> is nonnumeric
<e.partnumber> is not null and
<e.entphysicalindex> is numeric
<e.partnumber> is not null and
<e.entphysicalindex> is nonnumeric
ComputedName
name=<e.name>;partnumber=<e.vendorequipmenttype>
name=<e.entphysicalindex>;partnumber=<e.vendorequip
menttype>
name=<e.name>;partnumber=<e.partnumber>
name=<e.entphysicalindex>;partnumber=<e.partnumber
>
To summarize, <e.entphysicalIndex> contains the name if its value is non-numeric,
otherwise the name in is the <e.name> attribute. If the <e.partnumber> value is defined, it
is supplied as the part number value, otherwise <e.vendorequipmenttype> is substituted
for it.
For example:
Case 1:
MD/CISCO_EPNM/ME/ME3600X-PAN-3/EQ/name=GigabitEthernet0/19
Container;
partnumber=cevContainerSFP
Where:
e.partnumber = (null)
e.entphysicalIndex = 1037 (numeric)
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
77
Fully-qualified Domain Names (FDN)
e.name= GigabitEthernet0/19 Container
e.vendorEquipmentType= cevContainerSFP
Case 2:
MD/CISCO_EPNM/ME/ONS15454-42/EQ/name=SLOT-1-17;partnumber=
WMOMA22BAB
Where:
e.partnumber = (null)
e.entphysicalIndex = SLOT-1-17 (non-numeric)
e.vendorEquipmentType= WMOMA22BAB
Case 3:
MD/CISCO_EPNM/ME/ME3600X-PAN-3/EQ/name=ME-3600X-24CX-M Fixed Module 0;
partnumber=ME-3600X-24CX-M
Where:
e.partnumber = ME-3600X-24CX-MC (not null)
e.entphysicalIndex = 1002 (numeric)
e.name= ME-3600X-24CX-M - Fixed Module 0
Case 4:
MD/CISCO_EPNM/ME/SMR9-73/EQ/name=PWR-B;partnumber=NCS2006-DC
Where:
e.partnumber = NCS2006-DC (not null)
e.entphysicalIndex = PWR-B (non-numeric)
5.3 ProtocolEndpoint FDN Format
An object type that is of a subclass of ProtocolEndpoint represents a potential or actual
start, end, or intermediate point of connectivity. For example, IP and Ethernet interfaces
are represented by subclasses of the ProtocolEndpoint.
The table, below, defines the types of end points.
Acronym
CTP
FTP
Name
Connection Termination Point
Floating Termination Point
PTP
Physical Termination Point
Description
Termination for links and subnetwork connections.
Termination point not associated with a physical port,
such as an Ethernet Flow Point.
Termination point supported by a port, but not the
physical connector itself, which is a separate object.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
78
Fully-qualified Domain Names (FDN)
The format is as follows:
MD/CISCO_EPNM/ME/<me.name>/[CFP]TP/<pe.name>
Where:
<me.name> is the value of the containing ManagedElement’s name attribute
<pe.name> is the value of the protocol endpoint’s name attribute.
For example:
MD/CISCO_EPNM/ME/NCS2KE-235-160/CTP/PCHAN-2-19-TX
MD/CISCO_EPNM/ME/ONS15454-86/FTP/PLINE-4-15-TX
MD/CISCO_EPNM/ME/NCS2KE-235-160/PTP/FAC-4-5-3-1
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
79
RESTCONF/YANG Containment Hirarchy
6 RESTCONF/YANG Containment Hirarchy
This section provides details about the supported RESTCONF Containment Hierarchy for
RESTCONF/YANG interfaces.
6.1 Physical Inventory YANG Containment Hirarchy
The Class Diagram below shows the YANG Containment Hierarchy for Physical Inventory
objects. Associated objects are represented by a collection, for one-to-many associations,
or an attribute of the object type for one-to-one or many-to-one associates. The role of the
object(s) in the association provides the name for association attributes. The API traverses
selected associations, usually of one-to-many cardinality, to allow retrieval of a hierarchy
of objects in a single request. Attribute names of such associations are followed by an
asterisk (*).
To prevent cycles in the retrieval or divide the hierarchy into manageable pieces, other
associations are summarized as a string with an entry giving the object type, name, and
business key for each object in the collection. Some attributes may not be displayed since
null values and empty associations are not included in the response.
Physical Inventory YANG Containment Hierarchy - High Level Class Diagram
To be provided.
Physical Inventory YANG Containment Hierarchy – Detailed Class Diagram
To be provided.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
80
Additional REST API
7 Additional REST API
Additional REST APIs details can be accessed this link. Although these documents refer to
Cisco Prime Infrastructure, the content is also applicable to Cisco EPN Manager.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
81
Filtering
8 Filtering
Filtering lets you limit the results of a request based on the value of specific Resource
attributes. Filtering is supported for all request types
Filtering Syntax
Filtering on a given attribute of a resource is simple. The documentation gives a list of all
attributes for a given resource. For example, to get a device with a given name, you may
use the following:
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?name=ASR9K
A set of operators allows you to refine the filter in many ways. For example, to get the
list of all devices that start with a pattern, you may use wildcards on the <name>:
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?name=ASR*
The results of a query can be filtered using the value of one or a combination of multiple
attributes.
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?name=ASR*&communicationState=REACHABLE
URL encoding
When forming a filter URL it must comply with URL encoding rules and only contain
characters from the ASCII character-set.
Filter values may frequently contain characters from outside the ASCII set, e.g. space:
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?description=sample description
These must be converted into a valid ASCII format. URL encoding replaces unsafe ASCII
characters with a "%" followed by two hexadecimal digits.
A web browser will automatically encode the entered URL before sending it. However, if
for example you are using a client coded with cURL you will need to do the encoding
yourself. For example space character should be encoded as "%20".
Advanced Filtering
Advanced filtering can be applied to attributes if the criteria conforms to the following
table. The first two rows show how to control how the filter combines multiple criteria
parameters (separated the ampersand ‘&’ as usual). The “and” (conjunction) and “or”
(disjunction) operators are supported, although it is not necessary to use “or” since it is
the default. Note that “and” and “or” cannot combined: the selected operator applies to
all the criteria.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
82
Filtering
CRITERION
MEANING
APPLIES TO
USAGE
_COND=and Match all criteria
N/A
_COND=add&…
Match any of the
criteria (default)
N/A
_COND=or&…
.CO
Contains
String
<attribute>.CO=<value>
..^
Does not contain
String
<attribute>..^=<value>
.EQ
Equals
String, Integers,
Date
<attribute>.EQ=<value>
.^*
Starts With
String
<attribute>.^*=<value>
.*$
Ends With
String
<attribute>.*$=<value>
.NE
Not Equal To
.GE
Greater Than Or
Equals To
.GT
Greater Than
.LE
Lesser Than Or
Equals To
.LT
Lesser Than
_COND=or
*
Wildcard match 0 or
more characters
String, Integers,
Date
String, Integers,
Date
String, Integers,
Date
String, Integers,
Date
String, Integers,
Date
String
<attribute>.NE=<value>
<attribute>.GE=<value>
<attribute>.GT=<value>
<attribute>.LE=<value>
<attribute>.LT=<value>
<attribute>=*<value>
<attribute>=<value>*
<attribute>=*<value>*
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
83
Sorting
9 Sorting
Sorting lets you control the order in which resources are returned. They can be sorted in
Ascending or Descending order based on user preference.
Sorting is enabled using the .sort (attribute_name) query parameter. Sorting is
supported for all request types.
For example, to sort a list of Devices by their latest collection times, you may use the
following URL:
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?.sort(+collectionTime)
Ascending vs. Descending
Ascending or Descending order is controlled by adding a "+" or "-" in front of the
attribute name.


To sort based on collectionTime in ascending order, use the + sign (the default):
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?.sort(+collectionTime)
To sort based on collectionTime in descending order, use the – sign:
https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?.sort(-collectionTime)
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
84
Paging
10
Paging
Paging lets you control the number of records returned by a request and page through
the results. Paging is supported for all request types.
To page results, use the .maxCount and .firstIndex parameters.
Examples:
a. To get the first four results (results 0 to 3), you can use:
 https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?.firstIndex=0&.maxCount=4
or
 https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?.maxCount=4
b. To get the next four results (results 4 to 7), you can use:
 https://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?.firstIndex=4&.maxCount=4
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
85
Combination of filtering, sorting, and paging
11
Combination of filtering, sorting, and paging
Filtering, Sorting and Paging can be combined as long as the combination adheres to the
rules of each of the features.
Examples:
1. http://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?name=ASR*&.maxCount=9&.sort(productFamily)
2. http://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-extmanagedelement:ManagedElement?name=ASR*&.maxCount=5&.sort(+collectionSt
atus)
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
86
Troubleshooting
12
Troubleshooting
The following table provides some issues you might encounter when setting up the OSS
integration layer, along with steps to troubleshoot each issue.
Problem
Description
No response to
HTTP GET
request
404 Not Found
Module not
found
Invalid column
No content
Data are
returned in the
wrong format
Server error
with no error
message
Server returns
an array with
no records
Indication
Probable Cause
Troubleshooting Procedure
Client reports it could not get
any response to the query
(server is not listening at
port).
Server returns 404 Not Found
and “No service was found.”
Server is down.
SSL certificate not
installed.
Verify that server is up by
logging through GUI. Install SSL
certificate on server. Examine
logs/console.log for errors.
Verify that a basic
Authorization header with valid
user/password is included in
the request
Server returns 500 Internal
Server Error and an error
message stating that the
module was not found.
Server returns 500 Internal
Server Error and an error
message stating that “x is not
a valid column in the
database”
Server returns 204 No
Content and no message
body
Expected XML format and
retrieved JSON. Expected
JSON format and retrieved
XML.
Sent a valid URL and server
returns a 500 Internal Server
Error with no error message
field.
Server returns 200 OK and a
body with an empty of the
requested object type.
The URL is incorrect.
The credentials are
incorrect.
The query arguments
contain an invalid
column name,
pagination directive,
or sorting directive
The query arguments
or the URL do not
match any objects.
Accept header
missing or incorrect
in the request.
Issue a ../restconf/vi/modules
request to get a list of
supported URLs and correct
the URL in the request.
Correct the column or directive
in the query parameters
Alter the URL or the query
parameters to match one or
more objects.
Specify application/<desired
format> in the Accept header.
Unsupported format
in Accept header.
Specify supported format in
the Accept header.
No objects of the
requested type in the
database.
Verify that services that
generate this type of object are
provisioned in the EPNManager.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
87
Appendix II – REST Clients
13
Appendix II – REST Clients
Several commercially available clients are available to exercise the RESTCONF/YANG
interface. Use the API specification to create HTTP GET requests to send through these
clients. Such tools allow the customer to explore the interface and troubleshoot problems.
Two examples are:
 Postman–A Google Chrome App which sends HTTP requests specified by the user
and displays the response in raw or pretty format.
 SoapUI by SMARTBEAR–This application also sends and receives HTTP information. It
provides support for automated tests.
In production, the customer’s bespoke software will communicate with the Cisco EPNManager using the RESTCONF/YANG API over HTTP. The exact sequence of the requests
depends on the customer application. Packet tracing tools, such as Wireshark, can be used
to identify problems.
Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide
88