Cisco Evolved Programmable Network Manager 2.0 … Module Retrieval ... Northbound Interface for integrating Cisco EPN Manager with a standards-compliant OSS. ... draft-ietf-netconf-restconf-07

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

Cisco Evolved Programmable Network Manager 2.0– RESTCONF NBI Guide

First Published: May 2, 2016 EDCS-1542631

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 NON-INFRINGEMENT 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

Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide

iii

Table of Contents

Table of Contents ................................................................................................................. iii

1 Preface .......................................................................................................................... 5

Conventions.......................................................................................................................5 1.1

Obtaining Documentation, Obtaining Support, and Security Guidelines ...............................5 1.2

2 Northbound RESTCONF/YANG Interface ......................................................................... 7

Web Services Standards .....................................................................................................7 2.1

RESTCONF Standards .........................................................................................................7 2.2

Communication Patterns ....................................................................................................7 2.3Containment Associations ................................................................................................................................... 7

OSS Integration Usage Scenarios ........................................................................................8 2.4Retrieving Inventory ............................................................................................................................................. 8

3 Supported RESTCONF/YANG Interfaces .......................................................................... 9

RESTCONF/YANG Interface Endpoints.................................................................................9 3.1Authentication ................................................................................................................................................... 11 Authorization ..................................................................................................................................................... 11 License ................................................................................................................................................................ 11

4 RESTCONF/YANG Interface Details ............................................................................... 12

Group Retrieval ............................................................................................................... 12 4.1Group Data ......................................................................................................................................................... 12 Operations ......................................................................................................................................................... 12 Sample Response Data ....................................................................................................................................... 13

4.1.1.1 JSON ........................................................................................................................................... 13

ManagedElement Retrieval .............................................................................................. 14 4.2ManagedElement Data ...................................................................................................................................... 14 Operations ......................................................................................................................................................... 16 Sample Response Data ....................................................................................................................................... 16

4.2.1.1 JSON ........................................................................................................................................... 16

Chassis Retrieval .............................................................................................................. 23 4.3Chassis Data ....................................................................................................................................................... 23 Operations ......................................................................................................................................................... 26 Sample Response Data ....................................................................................................................................... 26

4.3.1.1 JSON ........................................................................................................................................... 26

Equipment Retrieval ........................................................................................................ 43 4.4Equipment Data ................................................................................................................................................. 43 Operations ......................................................................................................................................................... 45 Sample Response Data ....................................................................................................................................... 46

4.4.1.1 JSON ........................................................................................................................................... 46

Module Retrieval ............................................................................................................. 51 4.5Module Data ...................................................................................................................................................... 51 Operations ......................................................................................................................................................... 53

Contents

Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide iv

Sample Response Data ....................................................................................................................................... 55 4.5.1.1 JSON ........................................................................................................................................... 55

PhysicalConnector Retrieval ............................................................................................. 64 4.6PhysicalConnector Data ..................................................................................................................................... 64 Operations ......................................................................................................................................................... 64 Sample Response Data ....................................................................................................................................... 65

4.6.1.1 JSON ........................................................................................................................................... 65

Physical Protocol Endpoint Retrieval ................................................................................ 67 4.7PhysicalProtocolEndpoint Data .......................................................................................................................... 67 Operations ......................................................................................................................................................... 69 Sample Response Data ....................................................................................................................................... 70

4.7.1.1 JSON ........................................................................................................................................... 70

InterfaceProtocolEndpoint Retrieval ................................................................................. 72 4.8InterfaceProtocolEndpoint Data ........................................................................................................................ 72 Operations ......................................................................................................................................................... 73 Sample Response Data ....................................................................................................................................... 74

4.8.1.1 JSON ........................................................................................................................................... 74

5 Fully-qualified Domain Names (FDN) ............................................................................ 76

ManagedElement FDN Format ......................................................................................... 76 5.1

Equipment FDN Format .................................................................................................... 77 5.2

ProtocolEndpoint FDN Format .......................................................................................... 78 5.3

6 RESTCONF/YANG Containment Hirarchy ....................................................................... 80

Physical Inventory YANG Containment Hirarchy................................................................ 80 6.1Physical 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

Preface


5

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.

Conventions 1.1

This document uses the following conventions:

Convention Indication

bold font 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.

Obtaining Documentation, Obtaining Support, and Security Guidelines 1.2

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

http://www.cisco.com/en/US/docs/general/whatsnew/whatsnew.html

Preface

Cisco Evolved Programmable Network Manager 2.0 RESTCONF NBI Guide 6

reader application. The RSS feeds are a free service and Cisco currently supports RSS version 2.0.

Northbound RESTCONF/YANG Interface


7

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.

Web Services Standards 2.1

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

RESTCONF Standards 2.2

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.

Communication Patterns 2.3

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

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.

OSS Integration Usage Scenarios 2.4

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.

Supported RESTCONF/YANG Interfaces


9

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 Operation Name

Physical Inventory – API’s

Group Retrieval getAllGroups

getGroup by id

ManagedElement Retrieval getAllManagedElements

getManagedElement by businessKey

Chassis Retrieval getAllChassiss

getChassis by businessKey

getChassis by id

Equipment Retrieval getAllEquipments

getEquipment by businessKey

getEquipment by id

Module Retrieval getAllModules

getModule by businessKey

getModule by id

PhysicalConnector Retrieval getAllPhysicalConnectors

getPhysicalConnector by businessKey

getPhysicalConnector by id

PhysicalProtocolEndpoint Retrieval getAllPhysicalProtocolEndpoints

getPhysicalProtocolEndpoint by businessKey

getPhysicalProtocolEndpoint by id

InterfaceProtocolEndpoint Retrieval getAllInterfaceProtocolEndpoints

getInterfaceProtocolEndpoint by businessKey

getInterfaceProtocolEndpoint by id

RESTCONF/YANG Interface Endpoints 3.1

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 Description

Physical Inventory Interfaces

https://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-group:Group

Retrieve all Group instances

https://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-group:Group/{id}

getGroup by id

https://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-managedelement:ManagedElement

Retrieve all ManagedElement instances

https://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-managedelement:ManagedElement

Retrieve ManagedElement instance by businessKey



https://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis

Retrieve all Chassis instances

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis/{owningEntityId}

Retrieve Chassis instance by businessKey

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis/{id}

getChassis by id

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment

Retrieve all Equipment instances

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment/{owningEntityId}/{entPhysicalIndex}

Retrieve Equipment instance by businessKey

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment/{id}

getEquipment by id

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module

Retrieve all Module instances

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module/{owningEntityId}/{entPhysicalIndex}

Retrieve Module instance by businessKey

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module/{id}

getModule by id

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-physicalconnector:PhysicalConnector

Retrieve all PhysicalConnector instances

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-physicalconnector:PhysicalConnector/{owningEntityId}/{entPhysicalIndex}

Retrieve PhysicalConnector instance by businessKey

https://<host>/restconf/data/v1/xmp-im-physical-resource-module-physicalconnector:PhysicalConnector/{id}

getPhysicalConnector by id

https://<host>/restconf/data/v1/xmp-im-connectivity-module-physicalprotocolendpoint:PhysicalProtocolEndpoint

Retrieve all PhysicalProtocolEndpoint instances

https://<host>/restconf/data/v1/xmp-im-connectivity-module-physicalprotocolendpoint:PhysicalProtocolEndpoint/{entPhysicalContainedIn}/{name}/{owningEntityId}

Retrieve PhysicalProtocolEndpoint instance by businessKey

https://<host>/restconf/data/v1/xmp-im-connectivity-module-physicalprotocolendpoint:PhysicalProtocolEndpoint/{id}

getPhysicalProtocolEndpoint by id

https://<host>/restconf/data/v1/xmp-im-connectivity-module-interfaceprotocolendpoint:InterfaceProtocolE

Retrieve all InterfaceProtocolEndpoint instances



11

ndpoint

https://<host>/restconf/data/v1/xmp-im-connectivity-module-interfaceprotocolendpoint:InterfaceProtocolEndpoint/{owningEntityId}/{entPhysicalIndex}

Retrieve InterfaceProtocolEndpoint instance by businessKey

https://<host>/restconf/data/v1/xmp-im-connectivity-module-interfaceprotocolendpoint:InterfaceProtocolEndpoint/{id}

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.

RESTCONF/YANG Interface Details


4 RESTCONF/YANG Interface Details

This section provides details about the supported RESTCONF/YANG interfaces.

Group Retrieval 4.1

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 Data Type Description

instanceId int Instance identifier of entity in the database.

description String Description of the group.

name String Name of the group.

managedElements Set<ManagedElement> ManagedElements within the group.

Operations

The following table lists the operations available to retrieve Group data from RESTCONF via the http protocol:

URL Description

https://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-group:Group

Retrieve all Group entities in the database.

https://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-group:Group/{id}

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



13

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-PAN-

5.cisco.com','businessKey':'bda9d49e[207210_192.168.23.58]'}],

[ManagedElement{'name':'ASR903-PAN-

6.cisco.com','businessKey':'bda9d49e[207212_192.168.23.63]'}],

[ManagedElement{'name':'ASR903-

2','businessKey':'bda9d49e[207225_192.168.222.189]'}]"

},

{


"description": "Optical Networking",

"name": "Optical Networking",

"managedElements":

"[ManagedElement{'name':'SMR20-

78','businessKey':'bda9d49e[1266279_192.168.229.78]'}],

[ManagedElement{'name':'M15_229_79','businessKey':'bda9d49e[1266271_192.168.2

29.79]'}],

[ManagedElement{'name':'454A-236-


[ManagedElement{'name':'454A-236-


[ManagedElement{'name':'SMR9-


[ManagedElement{'name':'NCS2KA-236-


[ManagedElement{'name':'SMR9-




[ManagedElement{'name':'M15_229_77','businessKey':'bda9d49e[1266283_192.168.2

29.77]'}],

[ManagedElement{'name':'NCS2006A-234-

38','businessKey':'bda9d49e[1266273_192.168.234.38]'}]"

}

]

}

}

ManagedElement Retrieval 4.2

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 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.

clusterCount int Cluster count.

collectionStatus String A detailed status of inventory collection - Success or failure.

collectionTime datetime Collection time.

communicationState CommunicationStateEnum

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.

creationTime datetime Creation time.

description String Description of the MNE.

fdn String The fully qualified domain name (FDN) for the equipment (or equipment subclass) instance.

lastBootTime datetime Represents the time the management agent on the



15

managed network element was last rebooted.

lifecycleState LifecycleStateEnum 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.

managementAddress String 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.

name String The name of the MNE.

owningEntityId String Entity ID

productFamily String The contents of the NAME attribute of the outer-most <DEVICEGROUP> element in a Cisco MDF file for this particular instance of ManagedNetworkElement.

productSeries String The contents of the NAME attribute of the second-level <DEVICEGROUP> element in a Cisco MDF file for this particular instance of ManagedNetworkElement.

productType String The contents of the NAME attribute of the <DEVICE> element in a Cisco MDF file for this particular instance of ManagedNetworkElement.

productVendor String product vendor

satelliteCount int Number of satellites.

softwareFamily String software Family

softwareType String A string that identifies the specific type of software that is installed on this ManagedNetworkElement. For example, Cisco IOS or Linux.

softwareVersion String The specific version of the software (see attribute softwareType) that is installed. The value is formatted as a text field.

sysContact String sysContat of the mne

sysLocation String The physical location of this node (for example, 'telephone closet, 3rd floor'). If the location is unknown, the value is the zero-length string.

sysObjectId String The vendor's authoritative identification of the network management subsystem contained in the element.

sysUpTime String Internal use only

uuid String

equipment * Collection<Equipment>

The instances of Equipment (or any of its subclasses) that realize this instance of a NetworkResource subclass.

groups Set<Group> Groups containing the ManagedElement.

protocolEndpoint Set<ProtocolEndpoint>

The set of instances of a ProtocolEndpoint subclasses that support this instance of a NetworkResource subclass.



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/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 Description

http://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-managedelement:ManagedElement

Retrieve all ManagedElement instances

http://<host>/restconf/data/v1/epnm-restconf-xmp-im-ext-managedelement:ManagedElement/{owningEntityId}

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-ext-managedelement: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.



{"ns1.ManagedElementInstances": [

"ManagedElement": {

{


"businessKey": "bda9d49e[207208_192.168.23.26]",

"clusterCount": 0,

"collectionStatus": "SUCCESS",

"collectionTime": "2015-08-24T22:10:52.918-07:00",



17

"communicationState": "REACHABLE",

"creationTime": "2015-08-24T11:40:28.059-07:00",

"description": "Cisco IOS Software, 901 Software (ASR901-

UNIVERSALK9-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",


"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-1-

DOMAIN3.cisco.com\/EQ\/name=A901-12C-F-D Chassis;partnumber=A901-12C-F-

D",

"hardwareVersion": "V03 ",

"isFRUable": "FALSE",

"isReportingAlarmsAllowed": "UNKNOWN",



"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",


"businessKey": "d1d98c1f[207208_192.168.23.26,2]",



"equipmentType": "OTHER",


DOMAIN3.cisco.com\/EQ\/name=Chassis Slot;partnumber=A901-12C-F-D",







"subclassname": "Equipment",

"vendorEquipmentType": "cevContainerSlot",


"description": "A901-12C-F-D Motherboard with Built-in

12GE, 1FE",

"name": "A901-12C-F-D Motherboard ",

"owningEntityId": "207208_192.168.23.26",


"businessKey": "ddf068b3[207208_192.168.23.26,3]",



"equipmentType": "MODULE",


DOMAIN3.cisco.com\/EQ\/name=A901-12C-F-D Motherboard ;partnumber=A901-

12C-F-D",



19







"subclassname": "Module",


"connectors": [

{

"description": "Gigabit Ethernet",

"name": "GigabitEthernet0\/2",

"owningEntityId": "207208_192.168.23.26",


"businessKey":

"e01b1a63[3,GigabitEthernet0\/2,207208_192.168.23.26]",



"subclassname": "PhysicalConnector",

"vendorEquipmentType": "cevPortGEIP",

"equipment": "[Module{'name':'A901-12C-F-D

Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",

"physicalProtocolEndpoint": {


"owningEntityId": "207208_192.168.23.26",


DOMAIN3.cisco.com\/FTP\/GigabitEthernet0\/2",

"isFloatingPep": false,

"subclassname": "PhysicalProtocolEndpoint",


"businessKey": "489e4745[207208_192.168.23.26,10]",

"clocking": "NOTAPPLICABLE",


"isInternalPort": false,

"speed": 0,

"supportsAutoNegotiation": "FALSE",

"supportsAutoSpeed": false,



"physicalConnector":

"[PhysicalConnector{'name':'GigabitEthernet0\/2','businessKey':'e01b1a6

3[3,GigabitEthernet0\/2,207208_192.168.23.26]'}]"

}

},

{



"owningEntityId": "207208_192.168.23.26",


"businessKey":






"equipment": "[Module{'name':'A901-12C-F-D

Motherboard ','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",



"owningEntityId": "207208_192.168.23.26",






"businessKey": "489e4745[207208_192.168.23.26,8]",




"speed": 0,






}

}

],



21

"containedEquipment": [

{

"description": "High Speed Fan2 Module for A901-12C-

F-D",

"name": "Fan2",

"owningEntityId": "207208_192.168.23.26",





"equipmentType": "FAN",


DOMAIN3.cisco.com\/EQ\/name=Fan2;partnumber=FAN",




"partNumber": "FAN",

"serialNumber": "33-0629-01",



"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",




















}

],

"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]'}]"

}

]

}

}



23

Chassis Retrieval 4.3

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 Data Type Description



administrativeStateCode String ** 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.

assemblyNumber String Indicates the manufacturing assembly number, which is the 'hardware' identification.

assemblyRevision String Indicates the revision of the entity within the assemblyNumber.

cleiCode String 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

description String an optional description of the entity.

deviationNumber String 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.

entPhysicalContainedIn String ## Internal use only ##

entPhysicalIndex String ## Internal use only ##

equipmentType EquipmentTypeEnum

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.

fdn String The fully qualified domain name (FDN) for the equipment (or equipment subclass) instance

hardwareVersion String 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.

isFRUable MultiStateEnum Indicates whether this physical entity is considered a 'field replaceable unit' by the vendor.

isRackMountable boolean Indicates whether the Chassis can be mounted in a Rack.

isReportingAlarmsAllowed

MultiStateEnum Indicates whether alarm reporting for this resource is allowed (can be set to Not_applicable).

manufacturedDate datetime Contains the date of manufacturing of the equipment. If the manufacturing date is unknown or not supported, the value of 0 is assigned.

manufacturer String 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.

name String the name of the entity

nrFreeSlots int Indicates the number of free slots the chassis has.

nrSlots int The number of slots in the chassis available for plugin modules.

operationalStateCode String ** 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.

owningEntityId String ## Internal use only ##

partNumber String Manufacturer's part number.

position String ** 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).

productFamily String 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.

productId String 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\\\'.



25

productName String 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.

serialNumber String 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').

serviceState EquipmentServiceStateEnum

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.

slotConfig String ** 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.

subclassname String The name of the object type

udi String Universal Device Identifier. The UDI is composed by concatenating the following values:\r\nPID = Equipment.partNumber\r\nVID = Equipment.hardwareVersion\r\nSN = Equipment.serialNumber

vendorEquipmentType String 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.

connectors * Set<PhysicalConnector>

The set of instances of PhysicalConnectors contained in this piece of Equipment.

containedEquipment * Set<Equipment> A set of instances of Equipment contained in this instance of Equipment.

occupiedHolders Set<EquipmentHolder>

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.

providedHolders Set<EquipmentHolder>

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.



Operations


application/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 Description

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis

Retrieve all Chassis instances

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis/{owningEntityId}/{entPhysicalIndex}

Retrieve Chassis instance by business key

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-chassis:Chassis/{id}

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.



{"ns2.ChassisInstances": [

"Chassis": [

{

"description": "ME-3600X-24CX-M",

"name": 1,

"owningEntityId": "207215_192.168.23.47",






27

"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-

4\/EQ\/name=1;partnumber=ME-3600X-24CX-M",

"hardwareVersion": "V02",



"partNumber": "ME-3600X-24CX-M",

"serialNumber": "FOC1736N1AJ",



"vendorEquipmentType": "cevChassisMe3600x24CxM",


{

"description": "ME-3600X-24CX-M - Container 1",

"name": "Container 1",

"owningEntityId": "207215_192.168.23.47",






"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/EQ\/name=Container

1;partnumber=cevContainerPowerSupplySlot",





"vendorEquipmentType": "cevContainerPowerSupplySlot",


"description": "Switch FRU Fan",

"name": "Fan Tray",

"owningEntityId": "207215_192.168.23.47",






"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/EQ\/name=Fan

Tray;partnumber=ME-FANTRAY ",




"isFRUable": "TRUE",


"operationalStateCode": "normal",

"partNumber": "ME-FANTRAY ",

"serialNumber": "LIT1730052S",



"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",






"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/EQ\/name=ME-3600X-

24CX-M - Fixed Module 0;partnumber=ME-3600X-24CX-M",




"partNumber": "ME-3600X-24CX-M",

"serialNumber": "FOC1736N1AJ",



"vendorEquipmentType": "cevModuleME3600X24FS",

"connectors": [

{

"description": "E1 0\/6",



29

"name": "E1 0\/6",

"owningEntityId": "207215_192.168.23.47",


"businessKey": "e01b1a63[1002,E1

0\/6,207215_192.168.23.47]",




"vendorEquipmentType": "cevPortT1E1",

"equipment": "[Module{'name':'ME-3600X-24CX-M - Fixed

Module 0','businessKey':'ddf068b3[207215_192.168.23.47,1002]'}]",


"name": "E1 0\/6",

"owningEntityId": "207215_192.168.23.47",

"fdn": "MD\/CISCO_EPNM\/ME\/ME3600X-PAN-4\/FTP\/E1

0\/6",




"businessKey": "489e4745[207215_192.168.23.47,1055]",




"speed": 0,



"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",


"businessKey":

"e01b1a63[1002,GigabitEthernet0,207215_192.168.23.47]",






"vendorEquipmentType": "cevPortNIC100",

"equipment": "[Module{'name':'ME-3600X-24CX-M - Fixed

Module 0','businessKey':'ddf068b3[207215_192.168.23.47,1002]'}]",



"owningEntityId": "207215_192.168.23.47",


4\/FTP\/GigabitEthernet0",




"businessKey": "489e4745[207215_192.168.23.47,1045]",




"speed": 0,




"[PhysicalConnector{'name':'GigabitEthernet0','businessKey':'e01b1a63[1

002,GigabitEthernet0,207215_192.168.23.47]'}]"

}

},

],


{

"description": "GigabitEthernet Container",

"name": "GigabitEthernet0\/5 Container",

"owningEntityId": "207215_192.168.23.47",







4\/EQ\/name=GigabitEthernet0\/5 Container;partnumber=cevContainerSFP",





31



"vendorEquipmentType": "cevContainerSFP",

"connectors": {

"description": "GigabitEthernet0\/5",


"owningEntityId": "207215_192.168.23.47",


"businessKey":





"vendorEquipmentType": "cevPortBaseTEther",

"equipment": "[Equipment{'name':'GigabitEthernet0\/5

Container','businessKey':'d1d98c1f[207215_192.168.23.47,1019]'}]",



"owningEntityId": "207215_192.168.23.47",


4\/FTP\/GigabitEthernet0\/5",




"businessKey": "489e4745[207215_192.168.23.47,1070]",




"speed": 0,






}

},

"containingEquipment": "[Module{'name':'ME-3600X-24CX-M -

Fixed Module 0','businessKey':'ddf068b3[207215_192.168.23.47,1002]'}]"

}



],


"[Chassis{'name':'1','businessKey':'859457fb[207215_192.168.23.47,1001]

'}]"

}

],


"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",




"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN-

6.cisco.com\/EQ\/name=Chassis;partnumber=ASR-903",




"manufacturer": "Cisco Systems Inc",

"partNumber": "ASR-903",

"serialNumber": "FOX1723P4XL",



"vendorEquipmentType": "cevChassisCGS252016S8PCC",


{

"description": "RSP Slot",

"name": "slot R0",

"owningEntityId": "207212_192.168.23.63",







33



6.cisco.com\/EQ\/name=slot R0;partnumber=cevContainerASR900RSPSlot",





"vendorEquipmentType": "cevContainerASR900RSPSlot",


"description": "ASR 903 Route Switch Processor 1, Base

Scale, 55Gbps",

"name": "module R0",

"owningEntityId": "207212_192.168.23.63",







6.cisco.com\/EQ\/name=module R0;partnumber=A903-RSP1A-55",





"operationalStateCode": "ok",

"partNumber": "A903-RSP1A-55",

"serialNumber": "FOC1717N4UE",



"vendorEquipmentType": "cevModuleASR903RSP1A",

"connectors": {

"description": "Network Management Ethernet",

"name": "NME R0",

"owningEntityId": "207212_192.168.23.63",


"businessKey": "e01b1a63[100,NME

R0,207212_192.168.23.63]",






"vendorEquipmentType": "cevPortGe",

"equipment": "[Module{'name':'module

R0','businessKey':'ddf068b3[207212_192.168.23.63,100]'}]",



"owningEntityId": "207212_192.168.23.63",


6.cisco.com\/FTP\/GigabitEthernet0",




"businessKey": "489e4745[207212_192.168.23.63,136]",




"speed": 0,



"physicalConnector": "[PhysicalConnector{'name':'NME

R0','businessKey':'e01b1a63[100,NME R0,207212_192.168.23.63]'}]"

}

},


{

"description": "CPU 0 of module R0",

"name": "cpu R0\/0",

"owningEntityId": "207212_192.168.23.63",






6.cisco.com\/EQ\/name=cpu R0\/0;partnumber=cevModuleCpuType",






35


"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",







6.cisco.com\/EQ\/name=usb R0\/1;partnumber=cevContainerUSB",





"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]'}]"

},


"[Chassis{'name':'Chassis','businessKey':'859457fb[207212_192.168.23.63

,1]'}]"

},

{

"description": "IM Bay",

"name": "subslot 0\/2",

"owningEntityId": "207212_192.168.23.63",









6.cisco.com\/EQ\/name=subslot 0\/2;partnumber=cevContainerIMBay",





"vendorEquipmentType": "cevContainerIMBay",


"description": "8-port Gigabit Ethernet Interface Module",

"name": "IM subslot 0\/2",

"owningEntityId": "207212_192.168.23.63",







6.cisco.com\/EQ\/name=IM subslot 0\/2;partnumber=A900-IMA8T",






"partNumber": "A900-IMA8T",

"serialNumber": "FOC1725N41Q",



"vendorEquipmentType": "cevIM8pGeCu",

"connectors": [

{

"description": "A900-IMA8T",

"name": "GigabitEthernet0\/2\/7",

"owningEntityId": "207212_192.168.23.63",


"businessKey":

"e01b1a63[800,GigabitEthernet0\/2\/7,207212_192.168.23.63]",



37





"equipment": "[Module{'name':'IM subslot

0\/2','businessKey':'ddf068b3[207212_192.168.23.63,800]'}]",



"owningEntityId": "207212_192.168.23.63",


6.cisco.com\/FTP\/GigabitEthernet0\/2\/7",




"businessKey": "489e4745[207212_192.168.23.63,808]",




"speed": 0,




"[PhysicalConnector{'name':'GigabitEthernet0\/2\/7','businessKey':'e01b

1a63[800,GigabitEthernet0\/2\/7,207212_192.168.23.63]'}]"

}

},

{

"description": "A900-IMA8T",


"owningEntityId": "207212_192.168.23.63",


"businessKey":






"equipment": "[Module{'name':'IM subslot

0\/2','businessKey':'ddf068b3[207212_192.168.23.63,800]'}]",





"owningEntityId": "207212_192.168.23.63",






"businessKey": "489e4745[207212_192.168.23.63,802]",




"speed": 0,






}

},

],

"containingEquipment": "[Equipment{'name':'subslot

0\/2','businessKey':'d1d98c1f[207212_192.168.23.63,6]'}]"

},



,1]'}]"

},

{



"owningEntityId": "207212_192.168.23.63",








39









"description": "1-port Ten Gigabit Ethernet XFP Interface

Module",


"owningEntityId": "207212_192.168.23.63",







6.cisco.com\/EQ\/name=IM subslot 0\/0;partnumber=A900-IMA1X",






"partNumber": "A900-IMA1X",

"serialNumber": "FOC1721N9U7",



"vendorEquipmentType": "cevIM1p10GeXfp",


"description": "subslot 0\/0 transceiver container 0",

"name": "subslot 0\/0 transceiver container 0",

"owningEntityId": "207212_192.168.23.63",









6.cisco.com\/EQ\/name=subslot 0\/0 transceiver container

0;partnumber=cevContainerSFP",






"containingEquipment": "[Module{'name':'IM subslot

0\/0','businessKey':'ddf068b3[207212_192.168.23.63,300]'}]"

},


0\/0','businessKey':'d1d98c1f[207212_192.168.23.63,4]'}]"

},



,1]'}]"

},

{



"owningEntityId": "207212_192.168.23.63",















,1]'}]"

},

{

"description": "Power Supply Bay",



41

"name": "Power Supply Bay 1",

"owningEntityId": "207212_192.168.23.63",







6.cisco.com\/EQ\/name=Power Supply Bay

1;partnumber=cevContainerASR900PowerSupplyBay",





"vendorEquipmentType": "cevContainerASR900PowerSupplyBay",



,1]'}]"

},

{

"description": "Power Supply Bay",

"name": "Power Supply Bay 0",

"owningEntityId": "207212_192.168.23.63",







6.cisco.com\/EQ\/name=Power Supply Bay

0;partnumber=cevContainerASR900PowerSupplyBay",





"vendorEquipmentType": "cevContainerASR900PowerSupplyBay",


"description": "ASR 900 550W AC Power Supply",

"name": "Power Supply Module 0",



"owningEntityId": "207212_192.168.23.63",





"equipmentType": "POWERSUPPLY",


6.cisco.com\/EQ\/name=Power Supply Module 0;partnumber=A900-PWR550-A",





"operationalStateCode": "on",

"partNumber": "A900-PWR550-A",

"serialNumber": "GES17162596",



"vendorEquipmentType": "cevPowerSupplyASR900AC500W",

"containingEquipment": "[Equipment{'name':'Power Supply Bay


},



,1]'}]"

}

],


"businessKey": "859457fb[207212_192.168.23.63,1]",

"nrSlots": 0,

"slotConfig": 0

}

]

}

}



43

Equipment Retrieval 4.4

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 Data Type Description







description String An optional description of the entity.





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.



isFRUable MultiStateEnum Indicates whether this physical entity is considered a 'field replaceable unit' by the vendor.

isReportingAlarmsAllowed

MultiStateEnum Indicates whether alarm reporting for this resource is allowed (can be set to Not_applicable).



name String The name of the entity.






productId String 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\\\'.

productName String The official name given to a product. For example, Cisco 10720 Router or Cisco 10720, Cisco 12000 Series Six-Port



45

DS3 Line Card or 6-Port DS3.




subclassname String The name of the object type.

udi String Universal Device Identifier. The UDI is composed by concatenating the following values:\r\nPID = Equipment.partNumber\r\nVID = Equipment.hardwareVersion\r\nSN = Equipment.serialNumber.




containedEquipment * Set<Equipment> A set of instances of Equipment contained in this instance of Equipment.



Operations


application/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



http://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment

Retrieve all Equipment instances

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment/{owningEntityId}/{entPhysicalIndex}

Retrieve Equipment instance by business key

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-equipment:Equipment/{id}

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>




{"ns2.EquipmentInstances": [

"Equipment": [

{

"description": "A901-12C-F-D Motherboard with Built-in 12GE,

1FE",


"owningEntityId": "207208_192.168.23.26",






12C-F-D",









47



"connectors": [

{



"owningEntityId": "207208_192.168.23.26",


"businessKey":






"equipment": "[Module{'name':'A901-12C-F-D Motherboard

','businessKey':'ddf068b3[207208_192.168.23.26,3]'}]",



"owningEntityId": "207208_192.168.23.26",






"businessKey": "489e4745[207208_192.168.23.26,10]",




"speed": 0,






}

},

{

"description": "eTSEC 1",

"name": "FastEthernet0\/0",



"owningEntityId": "207208_192.168.23.26",


"businessKey":

"e01b1a63[3,FastEthernet0\/0,207208_192.168.23.26]",




"vendorEquipmentType": "cevPortFEIP",





"owningEntityId": "207208_192.168.23.26",


DOMAIN3.cisco.com\/FTP\/FastEthernet0\/0",




"businessKey": "489e4745[207208_192.168.23.26,16]",




"speed": 0,




"[PhysicalConnector{'name':'FastEthernet0\/0','businessKey':'e01b1a63[3

,FastEthernet0\/0,207208_192.168.23.26]'}]"

}

}

],


{

"description": "High Speed Fan2 Module for A901-12C-F-D",

"name": "Fan2",

"owningEntityId": "207208_192.168.23.26",






49















},

{


"name": "Fan1",

"owningEntityId": "207208_192.168.23.26",


















}

],




Slot','businessKey':'d1d98c1f[207208_192.168.23.26,2]'}]"

}

]

}

}



51

Module Retrieval 4.5

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 Data Type Description


businessKey String String representation of attribute value(s) that uniquely identify the entity or instanceId if no business key defined





description String an optional description of the entity.





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.





isFRUable MultiStateEnum

Indicates whether this physical entity is considered a 'field replaceable unit' by the vendor.

isInlinePowercapable boolean Indicates whether a module is capable of providing inline power through its ports. Populated based on the module type: \\\'wsx6348rj45\\\', \\\'wsx4148rj45v\\\', \\\'cevCat6kWsx6348Rj45\\\', \\\'wsf6kvpwr\\\', and \\\'cpu-3845-2ge\\\' are inline power capable. Others are not capable.

isReportingAlarmsAllowed MultiStateEnum

Indicates whether alarm reporting for this resource is allowed (can be set to Not_applicable).



moduleIndex int ## Internal use only ##


nrFreeSlots int Indicates the number of free slots the chassis has.

nrPorts int Specifies the number of ports that are supported by the module.

nrSlots int The number of slots in the chassis available for plugin modules.






productId String 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



53

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\\\'.

productName String 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.

resetReason ModuleResetReasonTypeEnum

Identifies the reason for the last reset performed on the module.

resetReasonDescription String A description qualifying the module reset reason specified in resetReason. Examples: command xyz, missing task, switch over, watchdog timeout, and so on.




subclassname String The name of the object type

udi String Universal Device Identifier. The UDI is composed by concatenating the following values:\r\nPID = Equipment.partNumber\r\nVID = Equipment.hardwareVersion\r\nSN = Equipment.serialNumber




containedEquipment * Set<Equipment>

A set of instances of Equipment contained in this instance of Equipment.



Operations




application/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 Description

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module

Retrieve all Module instances

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module/{owningEntityId}/{entPhysicalIndex}

Retrieve Module instance by business key

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-module:Module/{id}

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.



55


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",


"owningEntityId": "207208_192.168.23.26",






12C-F-D",









"connectors": [

{



"owningEntityId": "207208_192.168.23.26",


"businessKey":












"owningEntityId": "207208_192.168.23.26",






"businessKey": "489e4745[207208_192.168.23.26,10]",




"speed": 0,






}

},

{

"description": "eTSEC 1",


"owningEntityId": "207208_192.168.23.26",


"businessKey":

"e01b1a63[3,FastEthernet0\/0,207208_192.168.23.26]",




"vendorEquipmentType": "cevPortFEIP",





"owningEntityId": "207208_192.168.23.26",



57


DOMAIN3.cisco.com\/FTP\/FastEthernet0\/0",




"businessKey": "489e4745[207208_192.168.23.26,16]",




"speed": 0,




"[PhysicalConnector{'name':'FastEthernet0\/0','businessKey':'e01b1a63[3

,FastEthernet0\/0,207208_192.168.23.26]'}]"

}

}

],


{


"name": "Fan1",

"owningEntityId": "207208_192.168.23.26",




















},

{

"description": "DC Power Supply 2 (12B V)",

"name": "DC Redundant Power supply",

"owningEntityId": "207208_192.168.23.26",





"equipmentType": "POWERSUPPLY",


DOMAIN3.cisco.com\/EQ\/name=DC Redundant Power supply;partnumber=POWER

SUPPLY",




"partNumber": "POWER SUPPLY",




"vendorEquipmentType": "cevPowerSupplyDc150W",



}

],


Slot','businessKey':'d1d98c1f[207208_192.168.23.26,2]'}]",



"moduleIndex": 0

},

{

"description": "8-port Gigabit Ethernet Interface Module",


"owningEntityId": "207210_192.168.23.58",





59


"fdn": "MD\/CISCO_EPNM\/ME\/ASR903-PAN-5.cisco.com\/EQ\/name=IM

subslot 0\/1;partnumber=A900-IMA8S",






"partNumber": "A900-IMA8S",

"serialNumber": "FOC1725N2NN",



"vendorEquipmentType": "cevIM8pGeSFP",


{



"owningEntityId": "207210_192.168.23.58",















"description": "GE SX",

"name": "subslot 0\/1 transceiver 2",

"owningEntityId": "207210_192.168.23.58",









5.cisco.com\/EQ\/name=subslot 0\/1 transceiver 2;partnumber=QFBR-5766LP

",

"hardwareVersion": " ",



"manufacturer": "CISCO-AGILENT ",

"partNumber": "QFBR-5766LP ",

"serialNumber": "AGS090854D0 ",



"vendorEquipmentType": "cevSFP1000BaseSx",

"connectors": {

"description": "A900-IMA8S",


"owningEntityId": "207210_192.168.23.58",


"businessKey":






"equipment": "[Module{'name':'subslot 0\/1 transceiver

2','businessKey':'ddf068b3[207210_192.168.23.58,622]'}]",



"owningEntityId": "207210_192.168.23.58",






"businessKey": "489e4745[207210_192.168.23.58,623]",






61

"speed": 0,






}

},

"containingEquipment": "[Equipment{'name':'subslot 0\/1

transceiver container


},



},

{



"owningEntityId": "207210_192.168.23.58",















"description": "GE SX",

"name": "subslot 0\/1 transceiver 3",

"owningEntityId": "207210_192.168.23.58",









5.cisco.com\/EQ\/name=subslot 0\/1 transceiver 3;partnumber=SFP-GE-S

",

"hardwareVersion": "B ",



"manufacturer": "CISCO-FINISAR ",

"partNumber": "SFP-GE-S ",

"serialNumber": "FNS124413EA ",



"vendorEquipmentType": "cevSFP1000BaseSx",

"connectors": {

"description": "A900-IMA8S",


"owningEntityId": "207210_192.168.23.58",


"businessKey":






"equipment": "[Module{'name':'subslot 0\/1 transceiver

3','businessKey':'ddf068b3[207210_192.168.23.58,636]'}]",



"owningEntityId": "207210_192.168.23.58",






"businessKey": "489e4745[207210_192.168.23.58,637]",






63

"speed": 0,






}

},

"containingEquipment": "[Equipment{'name':'subslot 0\/1

transceiver container


},



}

],


0\/1','businessKey':'d1d98c1f[207210_192.168.23.58,5]'}]",



"moduleIndex": 0

}

]

}

}



PhysicalConnector Retrieval 4.6

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:

PhysicalConnector Data

Data Type Description


businessKey String String representation of attribute value(s) that uniquely identify the entity or instanceId if no business key defined

description String an optional description of the entity

entAliasLogicalIndexOrZero

String ## Internal use only ##

entPhysicalContainedIn


entPhysicalIndex



owningEntityId



vendorEquipmentType

String 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


application/xml


application/json



65

application/yang.data+json The table below lists the operations available to retrieve PhysicalConnector data from RESTCONF via the http protocol.

URL Description

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-physicalconnector:PhysicalConnector

Retrieve all PhysicalConnector instances

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-physicalconnector:PhysicalConnector/{entPhysicalContainedIn}/{name}/{owningEntityId}

Retrieve PhysicalConnector instance by business key

http://<host>/restconf/data/v1/xmp-im-physical-resource-module-physicalconnector:PhysicalConnector/{id}

Retrieve PhysicalConnector instance by database instance id



{"ns2.PhysicalConnectorInstances": [

"PhysicalConnector": [

{

"description": "RSP Management Ethernet Port",

"name": "MgmtEth0\/RSP0\/CPU0\/1",

"owningEntityId": "207223_192.168.23.54",


"businessKey":

"e01b1a63[38645760,MgmtEth0\/RSP0\/CPU0\/1,207223_192.168.23.54]",






0\/RSP0\/CPU0','businessKey':'ddf068b3[207223_192.168.23.54,38645760]'}

]",

},

{

"description": "RSP Management Ethernet Port",




"owningEntityId": "207223_192.168.23.54",


"businessKey":

"e01b1a63[38645760,MgmtEth0\/RSP0\/CPU0\/0,207223_192.168.23.54]",






0\/RSP0\/CPU0','businessKey':'ddf068b3[207223_192.168.23.54,38645760]'}

]",



"owningEntityId": "207223_192.168.23.54",

"fdn": "MD\/CISCO_EPNM\/ME\/ASR9K-

MTG\/FTP\/MgmtEth0\/RSP0\/CPU0\/0",




"businessKey": "489e4745[207223_192.168.23.54,61759766]",




"speed": 0,




"[PhysicalConnector{'name':'MgmtEth0\/RSP0\/CPU0\/0','businessKey':'e01

b1a63[38645760,MgmtEth0\/RSP0\/CPU0\/0,207223_192.168.23.54]'}]"

}

}

]

}

}



67

Physical Protocol Endpoint Retrieval 4.7

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



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.


doAutoNegotiation boolean Indicates whether the element should negotiate speed,

duplex, and/or link characteristics (such as flow

control).




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 !!!



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.


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)



69

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


application/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-connectivity-

module-physicalprotocolendpoint:PhysicalProtocolEndpoint

Retrieve all PhysicalProtocolEndpoint

instances


module-

physicalprotocolendpoint:PhysicalProtocolEndpoint/{ownin

gEntityId}/{entPhysicalIndex}

Retrieve PhysicalProtocolEndpoint

instance by business key


module-

physicalprotocolendpoint:PhysicalProtocolEndpoint/{id}

Retrieve PhysicalProtocolEndpoint

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 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-connectivity-modulephysicalprotocolendpoint:PhysicalProtocolEndpoint?fdn=<value>



4.7.1.1 JSON Following is the sample code formatted and edited for clarity and length.

{"ns2.PhysicalProtocolEndpoint": [

"PhysicalProtocolEndpoint": [

{


"owningEntityId": "207208_192.168.23.26",






"businessKey": "489e4745[207208_192.168.23.26,9]",




"speed": 0,






},

{



71


"owningEntityId": "207208_192.168.23.26",






"businessKey": "489e4745[207208_192.168.23.26,8]",




"speed": 0,






}

]

}

}



InterfaceProtocolEndpoint Retrieval 4.8

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.

InterfaceProtocolEndpoint Data




adminStatus IfAdminStatusEnum Represents the desired state of the interface.

alarmStatus AlarmSeverityEnum ## Internal use only ##\r\nRaw MIB data - parsed into supportedSpeeds and supportsAutoSpeed

comments String Contains comments added to a subclass of ProtocolEndpoint.


entAliasMappingIdentifier


fdn String The fully qualified domain name (FDN) for the equipment (or equipment subclass) instance

ifIndex String ## Internal use only ##

ifSpeed LongQuantity 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.

isConnectorPresent MultiStateEnum Indicates whether the interface sublayer has a physical connector.

isFloatingPep boolean Indicates whether a ProtocolEndpoint is related to a ResourceAccessPoint. If not, this ProtocolEndpoint is known as a floating PEP.

isPromiscuous boolean 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



73

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.

isSpanMonitored boolean 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

isTrapEnabled boolean False if the interface is confured to not send the traps.

lagEndName String ## Internal use only ##

layerRate LayerRateEnum

locationIndex unsignedInt ## Internal use only ##

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 !!!

mtu int 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.


operStatus IfOperStatusEnum Represent the current operational state of the interface.



supportedMTUs NumericRange Indicates the MTU range supported by the Ethernet interface.

type IFTypeEnum The type of endpoint, as defined by IANA. Reference: IF-MIB : ifType

forwardingRelationshipEnd

ForwardingRelationshipEnd

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.

Operations


application/xml


application/json

application/yang.data+json



The following table lists the operations available to retrieve InterfaceProtocolEndpoint data from RESTCONF via the http protocol.

URL Description

http://<host>/restconf/data/vi/xmp-im-connectivity-module-interfaceprotocolendpoint:InterfaceProtocolEndpoint

Retrieve all InterfaceProtocolEndpoint instances

http://<host>/restconf/data/vi/xmp-im-connectivity-module-interfaceprotocolendpoint:InterfaceProtocolEndpoint/{owningEntityId}/{name}

Retrieve InterfaceProtocolEndpoint instance by business key

http://<host>/restconf/data/vi/xmp-im-connectivity-module-interfaceprotocolendpoint:InterfaceProtocolEndpoint/{id}

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-module-interfaceprotocolendpoint:InterfaceProtocolEndpoint?fdn=<value>




{"ns2.InterfaceProtocolEndpointInstances": {

"InterfaceProtocolEndpoint": [

{

"name": "Null0",

"owningEntityId": "207208_192.168.23.26",


DOMAIN3.cisco.com\/FTP\/Null0",


"subclassname": "IntrfcPrtclEndpnt",


"businessKey": "1e6fb6f7[207208_192.168.23.26,Null0]",

"adminStatus": "UP",

"ifIndex": 16,

"ifSpeed": "",



75

"isConnectorPresent": "FALSE",

"isPromiscuous": false,

"isSpanMonitored": false,

"locationIndex": 0,

"mtu": 1500,

"operStatus": "UP",

"type": "OTHER"

},

{

"name": "Vlan20-mpls layer",

"owningEntityId": "207208_192.168.23.26",


DOMAIN3.cisco.com\/FTP\/Vlan20-mpls layer",


"subclassname": "IntrfcPrtclEndpnt",


"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"

}

]

}

}

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 Superclass FDN Format

Group - N/A

ManagedElement - See ManagedElement FDN Format

Chassis Equipment See Equipment FDN Format

Equipment - See Equipment FDN Format

Module Equipment See Equipment FDN Format

PhysicalConnector - N/A

PhysicalProtocolEndpoint ProtocolEndpoint See ProtocolEndpoint FDN Format

InterfaceProtocolEndpoint ProtocolEndpoint See ProtocolEndpoint FDN Format

ManagedElement FDN Format 5.1

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



77

Equipment FDN Format 5.2

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 ComputedName

<e.partnumber> is null and <e.entphysicalindex> is numeric

name=<e.name>;partnumber=<e.vendorequipmenttype>

<e.partnumber> is null and <e.entphysicalindex> is non-numeric

name=<e.entphysicalindex>;partnumber=<e.vendorequipmenttype>

<e.partnumber> is not null and <e.entphysicalindex> is numeric

name=<e.name>;partnumber=<e.partnumber>

<e.partnumber> is not null and <e.entphysicalindex> is non-numeric

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)



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)

ProtocolEndpoint FDN Format 5.3

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 Name Description

CTP Connection Termination Point Termination for links and subnetwork connections.

FTP Floating Termination Point Termination point not associated with a physical port, such as an Ethernet Flow Point.

PTP Physical Termination Point Termination point supported by a port, but not the physical connector itself, which is a separate object.



79

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

RESTCONF/YANG Containment Hirarchy


6 RESTCONF/YANG Containment Hirarchy

This section provides details about the supported RESTCONF Containment Hierarchy for RESTCONF/YANG interfaces.

Physical Inventory YANG Containment Hirarchy 6.1

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.

Additional REST API


81

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.

http://www.cisco.com/c/dam/en/us/td/docs/net_mgmt/prime/infrastructure/3-0/api_reference/guide/cpi_apiref30.zip

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-ext-managedelement: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-ext-managedelement: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-ext-managedelement: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-ext-managedelement: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.

Filtering


83

CRITERION MEANING APPLIES TO USAGE

_COND=and Match all criteria N/A _COND=add&…

_COND=or 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 String, Integers, Date

<attribute>.NE=<value>

.GE Greater Than Or Equals To

String, Integers, Date

<attribute>.GE=<value>

.GT Greater Than String, Integers, Date

<attribute>.GT=<value>

.LE Lesser Than Or Equals To

String, Integers, Date

<attribute>.LE=<value>

.LT Lesser Than String, Integers, Date

<attribute>.LT=<value>

* Wildcard match 0 or more characters

String <attribute>=*<value> <attribute>=<value>* <attribute>=*<value>*

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-ext-managedelement: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-ext-

managedelement:ManagedElement?.sort(+collectionTime)

To sort based on collectionTime in descending order, use the – sign:


managedelement:ManagedElement?.sort(-collectionTime)

Paging


85

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:


managedelement:ManagedElement?.firstIndex=0&.maxCount=4

or


managedelement:ManagedElement?.maxCount=4

b. To get the next four results (results 4 to 7), you can use:


managedelement:ManagedElement?.firstIndex=4&.maxCount=4

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-ext-

managedelement:ManagedElement?name=ASR*&.maxCount=9&.sort(-productFamily)

2. http://<server_name>/restconf/data/v1/epnm-restconf-xmp-im-ext-managedelement:ManagedElement?name=ASR*&.maxCount=5&.sort(+collectionStatus)

Troubleshooting


87

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

Indication Probable Cause Troubleshooting Procedure

No response to HTTP GET request

Client reports it could not get any response to the query (server is not listening at port).

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.

404 Not Found

Server returns 404 Not Found and “No service was found.”

The credentials are incorrect.

Verify that a basic Authorization header with valid user/password is included in the request

Module not found

Server returns 500 Internal Server Error and an error message stating that the module was not found.

The URL is incorrect. Issue a ../restconf/vi/modules request to get a list of supported URLs and correct the URL in the request.

Invalid column Server returns 500 Internal Server Error and an error message stating that “x is not a valid column in the database”

The query arguments contain an invalid column name, pagination directive, or sorting directive

Correct the column or directive in the query parameters

No content Server returns 204 No Content and no message body

The query arguments or the URL do not match any objects.

Alter the URL or the query parameters to match one or more objects.

Data are returned in the wrong format

Expected XML format and retrieved JSON. Expected JSON format and retrieved XML.

Accept header missing or incorrect in the request.

Specify application/<desired format> in the Accept header.

Server error with no error message

Sent a valid URL and server returns a 500 Internal Server Error with no error message field.

Unsupported format in Accept header.

Specify supported format in the Accept header.

Server returns an array with no records

Server returns 200 OK and a body with an empty of the requested object type.

No objects of the requested type in the database.

Verify that services that generate this type of object are provisioned in the EPN-Manager.

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 EPN-Manager 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.

Documents

Cisco Evolved Programmable Network Manager 2.0 … Module Retrieval ... Northbound Interface for integrating Cisco EPN Manager with a standards-compliant OSS. ... draft-ietf-netconf-restconf-07