Cisco Cisco Evolved Programmable Network Manager 2.0 Developer's Guide
Cisco Evolved Programmable Network Manager 2.0.1 RESTCONF API Guide
18
within it. Typically, a Module object is contained within an Equipment object and has a Containing equipment
FDN. Equipment containing Physical Connectors (explained below) are often but not always Modules.
Modules are created through discovery on devices whose credentials are entered into the system through
the graphical user interface (GUI). The RESTCONF API for Module is read-only.
Note: Module is sub class of Equipment. This interface retrieves only Module objects along with any
additional attributes defined for Module.
Resource
FDN. Equipment containing Physical Connectors (explained below) are often but not always Modules.
Modules are created through discovery on devices whose credentials are entered into the system through
the graphical user interface (GUI). The RESTCONF API for Module is read-only.
Note: Module is sub class of Equipment. This interface retrieves only Module objects along with any
additional attributes defined for Module.
Resource
Description
Module
Retrieves the Modules in the system.
HTTP Method
Resource Path
GET
/data/v1/cisco-resource-physical:module
Query Parameters
Name
Name
Type
Description
fdn
String
Fully Distinguished Name (FDN) of the Module to retrieve.
name
String
Name of the Module to retrieve (not unique).
description
String
Description of the Module to retrieve (not unique).
<attribute>
varies
Uses any non-collection attribute to retrieve Module object(s).
Response Message
Response Content Type
Response Content Type
application/xml, application/yang.data+xml, application/json,
application/yang.data+json
application/yang.data+json
Response Data
0 or more Modules of type module – see yang model for the data details.
HTTP Status Code
200 OK - Success with response message-body
401, 403 – Authentication and Authorization errors.
400 Bad Request - Invalid request message
500 Internal Server Error - operation-failed
Please refer to RESTCONF standard status codes and standard error response
data for further detail.
data for further detail.
4.5.1 Module Data
Name
Type
Description
module
Container element
Holds the data for a Module.
4.6 Physical Connector Retrieval
This interface provides the operations required to retrieve PhysicalConnector details. A Physical Connector
represents a connector capable of transmitting signals or power. Each PhysicalConnector object contains its
own attributes and the Fully Distinguished Names (FDN) of the Equipment instance that contains it.
Equipment containing PhysicalConnectors are often but not always Modules. PhysicalConnectors are created
through discovery on devices whose credentials are entered into the system through the graphical user
interface (GUI). The RESTCONF API for Physical is read-only.
Note: PhysicalConnector is not a subclass of Equipment.
Resource
represents a connector capable of transmitting signals or power. Each PhysicalConnector object contains its
own attributes and the Fully Distinguished Names (FDN) of the Equipment instance that contains it.
Equipment containing PhysicalConnectors are often but not always Modules. PhysicalConnectors are created
through discovery on devices whose credentials are entered into the system through the graphical user
interface (GUI). The RESTCONF API for Physical is read-only.
Note: PhysicalConnector is not a subclass of Equipment.
Resource
Description
PhysicalConnector
Retrieves the PhysicalConnectors in the system.
HTTP Method
Resource Path
GET
/data/v1/cisco-resource-physical:physicalconnector
Query Parameters
Name
Name
Type
Description