Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTCONF/YANG Interface Details
Cisco EPN Manager RESTConf NBI Guide
328
328
OpticalTransportSettings Retrieval
4.57
This interface provides the operations to retrieve OpticalTransportSettings entities.
OpticalTransportSettings Data
The table below lists the attributes in the OpticalTransportSettings 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.
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.
OpticalTransportSettin
gs Data
gs 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.
uniquely identify the entity or instanceId if no
business key defined.
name
String
The name of the settings
owningEntityId
String
## Internal use only ##
portType
String
-
protectionRole
OpticalProtectionRoleEnum
Identifies the port role in a protection scheme.
protectionStatus
OpticalProtectionPortStatusEn
um
um
Port is active, standby, or not in a protection scheme.
secondaryState
OpticalSecondaryStateEnum
Used to extend the behavor of the primary admin
state, which supports only UP/DOWN states.
state, which supports only UP/DOWN states.
serviceState
String
The secondary services state (SST) primary state (PST)
and primary state qualifier (PSTQ) as defined for
SONET.
and primary state qualifier (PSTQ) as defined for
SONET.
soak
int
Period before failure is communicated to higher level
protocols.
protocols.
squelchMode
OtnSquelchModeEnum
Shuts down the far-end laser in response to certain
defects.
defects.
subclassname
String
The name of the object type.
transportAdminState
String
Transport admin state is a PST-SST.
interfaceProtocolEndpo
int
int
InterfaceProtocolEndpoint
-
Operations
The table below lists the operations available to retrieve OpticalTransportSettings data
from RESTCONF via the http protocol.
from RESTCONF via the http protocol.
All URLs require basic authentication and can produce: