Cisco Cisco Evolved Programmable Network Manager 1.2 Developer's Guide
RESTCONF/YANG
Interface Details
Cisco EPNM RESTConf NBI Guide
331
OpticalPathSettingsCFS Retrieval
4.58
This interface provides the operations to retrieve OpticalPathSettingsCFS entities. This
object represents the configuration settings to detect optical impairment and trigger
restoration when impairment is detected. This object represents the service as
provisioned.
object represents the configuration settings to detect optical impairment and trigger
restoration when impairment is detected. This object represents the service as
provisioned.
OpticalPathSettingsCFS Data
The table below lists the attributes in the OpticalPathSettingsCFS 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.
OpticalPathSettingsCFS
Data
Data
Data Type
Description
instanceId
int
Instance identifier of entity in the database.
routeType
OpticalPathTypeEnum
Primary or secondary route plus whether restored
or not.
or not.
subclassname
String
The name of the object type.
validationMode
OpticalValidationModeEnum Optical validation required upon circuit setup.
validationZoneThreshold
OpticalValidationZoneEnum
Optical quality level on the circuit path.
Operations
The table below lists the operations available to retrieve OpticalPathSettingsCFS data from
RESTCONF via the http protocol.
All URLs require basic authentication and can produce:
RESTCONF via the http protocol.
All URLs require basic authentication and can produce:
application/xml
application/yang.data+xml
application/json
application/yang.data+json
The first URL retrieves all the OpticalPathSettingsCFS entities in the database. The final URL
retrieves a specific OpticalPathSettingsCFS by its database instance id. Enter the instance
id, but do not include the braces.