Module to extend OpenConfig terminal device's operational modes' data. It supports operational modes for one Optical Channel, with a single OTSi. The operational mode includes key attributes such modulation format, symbol rate, nominal central frequency (NFC) tunability constraints (grid, min/max NCF), FEC gain, minimum and maximum output power of the transmitter or minimum OSNR at the receiver as well as the spectrum width of the OTSi (OTSiMC). It also includes (optional) aspects such as filter characterization, CD and DGD tolerance.
openconfig-extensions
openconfig-transport-types
openconfig-terminal-device-property-types
description:
Indicates the terminal-device's list of compatible transceiver
component and its associated modes and mode descriptors compatibility
matrix.
nodetype: container (ro)
description:
List of transceiver components supported by the terminal-device.
The operational mode provides a platform-defined summary
of information such as symbol rate, modulation, pulse
shaping, etc.
nodetype: list (ro)
list keys: [component-descriptor-id]
description:
Reference to component-descriptor-id
nodetype: leaf (list key) (ro)
type: leafref
description:
Static features or properties which characterize the
component descriptor.
nodetype: container (ro)
description:
Unique identifier assigned by the system vendor for the
component descriptor.
nodetype: leaf (ro)
type: string
description:
System vendor company name
nodetype: leaf (ro)
type: string
description:
System-vendor assigned part number for the component. This should
be present in particular if the component is also an FRU
(field replaceable unit)
nodetype: leaf (ro)
type: string
description:
System-supplied identifier for the manufacturer of the
component. This data is particularly useful when a
component manufacturer is different than the overall
device vendor.
nodetype: leaf (ro)
type: string
description:
Transceiver manufacturer assigned part number for the component.
nodetype: leaf (ro)
type: string
description:
For hardware components, this is the hardware revision of
the component.
nodetype: leaf (ro)
type: string
description:
For hardware components, this is the version of associated
firmware that is running on the component, if applicable.
nodetype: leaf (ro)
type: string
description:
For software components such as operating system or other
software module, this is the version of the currently
running software.
nodetype: leaf (ro)
type: string
description:
Common Language Equipment Identifier (CLEI) code of the
component. This should be present in particular if the
component is also an FRU (field replaceable unit)
nodetype: leaf (ro)
type: string
description:
Indicates the set of operatational-modes, present in the terminal-
device manifest, which are compatible with the described transceiver
component.
nodetype: container (ro)
description:
List of operational modes supported by the target transceiver.
nodetype: list (ro)
list keys: [mode-id]
description:
Reference to a ../state/mode-id.
nodetype: leaf (list key) (ro)
type: leafref
description:
State container of transciever compatible modes.
nodetype: container (ro)
description:
Two-octet encoding of the vendor-defined operational mode.
Each value shall reference a valid mode-id included in the
operational-mode-descriptors list.
nodetype: leaf (ro)
type: uint16
description:
Reference to the associated mode-descriptor-id which describes
the specific design properties of the mode once it is being transmitted
by the parent transceiver component.
nodetype: leaf (ro)
type: leafref
description:
Indicates the terminal-device's list of compatible linecard
component and its associated modes and mode descriptors compatibility
matrix.
nodetype: container (ro)
description:
List of linecard components supported by the terminal-device.
The operational mode provides a platform-defined summary
of information such as symbol rate, modulation, pulse
shaping, etc.
nodetype: list (ro)
list keys: [component-descriptor-id]
description:
Reference to component-descriptor-id
nodetype: leaf (list key) (ro)
type: leafref
description:
Static features or properties which characterize the
component descriptor.
nodetype: container (ro)
description:
Unique identifier assigned by the system vendor for the
component descriptor.
nodetype: leaf (ro)
type: string
description:
System vendor company name
nodetype: leaf (ro)
type: string
description:
System-vendor assigned part number for the component. This should
be present in particular if the component is also an FRU
(field replaceable unit)
nodetype: leaf (ro)
type: string
description:
System-supplied identifier for the manufacturer of the
component. This data is particularly useful when a
component manufacturer is different than the overall
device vendor.
nodetype: leaf (ro)
type: string
description:
Transceiver manufacturer assigned part number for the component.
nodetype: leaf (ro)
type: string
description:
For hardware components, this is the hardware revision of
the component.
nodetype: leaf (ro)
type: string
description:
For hardware components, this is the version of associated
firmware that is running on the component, if applicable.
nodetype: leaf (ro)
type: string
description:
For software components such as operating system or other
software module, this is the version of the currently
running software.
nodetype: leaf (ro)
type: string
description:
Common Language Equipment Identifier (CLEI) code of the
component. This should be present in particular if the
component is also an FRU (field replaceable unit)
nodetype: leaf (ro)
type: string
description:
Indicates the set of transceiver component which are compatible
with the described linecard component.
nodetype: container (ro)
description:
List of transceiver descriptor ids.
nodetype: list (ro)
list keys: [transceiver-descriptor-id]
description:
Reference to transceiver-descriptor-id
nodetype: leaf (list key) (ro)
type: leafref
description:
Static features or properties which characterize the
component descriptor.
nodetype: container (ro)
description:
String rerference of the system vendor defined transciever
component descriptor id.
nodetype: leaf (ro)
type: string
description:
Indicates the set of operatational-modes, present in the terminal-
device manifest, which are compatible with the described transceiver
component within the linecard component.
nodetype: container (ro)
description:
List of operational modes supported by the target transceiver.
nodetype: list (ro)
list keys: [mode-id]
description:
Reference to linecard-descriptor/constrained-compatible-mode/state/mode-id.
nodetype: leaf (list key) (ro)
type: leafref
description:
State container for linecard constrained compatible modes
nodetype: container (ro)
description:
Absolute reference to an operational-mode-id. Each value shall
reference a valid mode-id included in the operational-mode-descriptors
list.
nodetype: leaf (ro)
type: uint16
description:
Reference to the associated mode-descriptor-id which describes
the specific design properties of the mode once it is being transmitted
by the parent transceiver component.
nodetype: leaf (ro)
type: leafref
description:
Set of constraints of the configuration attributes
of the optical-channel associated to the selected
operational-mode.
nodetype: container (ro)
description:
Operational-mode explicit mode config value constrains state top
container.
nodetype: container (ro)
description:
The lowest configurable central frequency in MHz.
nodetype: leaf (ro)
type: oc-opt-types:frequency-type
description:
The highest configurable central frequency in MHz.
nodetype: leaf (ro)
type: oc-opt-types:frequency-type
description:
Frequency ITU-T G.694.1 (10/2020) grid specification attribute.
nodetype: leaf (ro)
type: oc-opt-term-prop-types:grid-type
description:
Adjustment granularity in Gigahertz. As per ITU-T G.694.1
(10/2020), it is used to calculate nominal central frequency of an
optical channel. It defines the minimum granularity supporting by the
optical channel's central frequency setting.
nodetype: leaf (ro)
type: oc-opt-term-prop-types:adjustment-granularity
description:
Minimum recommended spectrum spacing between the central frequency of two
adjacent optical channels of the same mode. In case of two adjacent optical
channels with different operational-modes, it is up to the path computation
engine to determine the minimum distance between the central frequencies of
these two optical channels.
nodetype: leaf (ro)
type: decimal64
units: GHz
description:
Minimum target output optical power level of the optical channel,
configurable according to the optical transceiver mode properties,
expressed in increments of 0.01 dBm (decibel-milliwats)
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
Maximum target output optical power level of the optical channel,
configurable according to the optical transceiver mode properties,
expressed in increments of 0.01 dBm (decibel-milliwatts)
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
Indicates the transceiver's list of supported operational
modes and its associated transmission features
nodetype: container (ro)
description:
List of operational modes supported by the terminal-device.
The operational mode descriptor list provides a platform-defined
summary of the modes' information such as symbol rate, modulation, pulse
shaping, etc.
nodetype: list (ro)
list keys: [mode-id]
description:
Reference to mode-id
nodetype: leaf (list key) (ro)
type: leafref
description:
Static features or properties which characterize the
operational mode.
nodetype: container (ro)
description:
Two-octet encoding of the vendor-defined operational
mode
nodetype: leaf (ro)
type: uint16
description:
Optical modulation format associated to the mode. The
modulation format associated to the optical signal.
nodetype: leaf (ro)
type: union
type: string
type: oc-opt-term-prop-types:modulation-format
description:
Rounded bit rate of the tributary signal delivered by the
optical channel associated to the specific operational mode.
Exact bit rate will be refined by protocol selection at the
associated tributary logical channel.
nodetype: leaf (ro)
type: oc-opt-term-prop-types:bit-rate
description:
Baud-rate or symbol rate.
nodetype: leaf (ro)
type: decimal64
units: Bd
description:
Spectrum width of the optical channel associated to this
operational mode, calculated as the baud-rate*(1+roll-off).
nodetype: leaf (ro)
type: decimal64
units: GHz
description:
This container includes information which characterises the filter at
transceiver transmission for the given operational-mode.
nodetype: container (ro)
description:
Filter's state attributes top container.
nodetype: container (ro)
description:
Pulse/spectral shaping type such as Raised-cosine (RC),
root-raised-cosine (RRC) and OFF. The attribute allows
other pulse-shaping types to be encoded as strings.
nodetype: leaf (ro)
type: union
type: string
type: oc-opt-term-prop-types:pulse-shaping-type
description:
Decimal fraction between 0 and 1. Roll-off parameter (𝛽) of the
TX pulse shaping filter. This assumes a raised-cosine filter
nodetype: leaf (ro)
type: decimal64
description:
The Forward Error Coding (FEC) coding schema used,
including the name, overhead, pre-fec-ber threshold and
gain properties.
nodetype: container (ro)
description:
FEC state attributes top container.
nodetype: container (ro)
description:
Forward error correction (FEC) coding schema used in the
transmission mode. Type union of string (for proprietary codes)
and a set of standard codes encoded as identity references
nodetype: leaf (ro)
type: union
type: string
type: oc-opt-term-prop-types:fec-coding
description:
Coding overhead rate in %.
nodetype: leaf (ro)
type: decimal64
description:
Net coding gain (NCG) in dB units at 10E-15 bit error rate.
It may vary depending on the modulation format used in the
associated transmission mode (operational-mode).
nodetype: leaf (ro)
type: decimal64
default: 0.00
units: dB
description:
Explicit definition of the operational-mode. Typically this is used
for non-standard/proprietary modes defined by the terminal-device
vendor and it is self-described by the capabilities included in
the subtree underneath.
nodetype: container (ro)
description:
nodetype: list (ro)
list keys: [mode-descriptor-id]
description:
Reference to mode-descriptor-id
nodetype: leaf (list key) (ro)
type: leafref
description:
Mode-descriptor state attributes top container.
nodetype: container (ro)
description:
Two-octet encoding of the vendor-defined operational
mode
nodetype: leaf (ro)
type: uint16
description:
Minimum in-band transmitter OSNR measured at 0.1nm@193.6Thz,
considering the maximum transceiver inserted noise.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
Minimum back-to-back OSNR measured over 0.1nm@193.6Thz or
12.5GHz noise resolution bandwidth at the min-input-power.
If received OSNR at min-input-power is lower than this value,
an increased level of bit-errors post-FEC needs to be
expected.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
Minimum value required input power in dBm of an optical channel
at the receiver (Rx) according to the given min-rx-osnr value. If
the input-power is lower it is expected to introduce an OSNR
penalty.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
Maximum tolerated input power in dBm at the receiver (Rx)
of the coherence transceiver, which if exceeded can cause an
overload.
nodetype: leaf (ro)
type: decimal64
units: dBm
description:
Maximum chromatic-dispersion, accumulated value, supported by the
optical channel associated to the associated transmission mode
(operational model), expressed in picoseconds / nanometer (ps/nm).
nodetype: leaf (ro)
type: decimal64
units: ps-nm
description:
Maximum differential-group-delay, absolute value, supported by the
optical channel associated to the associated tranmission mode
(operational model), expressed in picoseconds (ps).
nodetype: leaf (ro)
type: decimal64
units: ps
description:
Maximum polarization-dependent-loss accumulated value, supported by the
optical channel associated to the associated transmission mode
(operational model), expressed in decibels (dB)
nodetype: leaf (ro)
type: decimal64
units: dB
description:
Threshold on the PRE-FEC-BER, for which FEC code is able to
correct errors.
nodetype: leaf (ro)
type: decimal64
units: bit-errors-per-second
description:
Enconsing list's container.
nodetype: container (ro)
description:
Penalties includes contributions from different impairments including
cd, pmd, low RX Power, pdl,...
- For parameter values below lowest up-to-boundary value, the penalty is 0.
- For parameter values between lowest and highest up-to-boundary
values, penalty could be linearly interpolated.
- For parameter values above highest up-to-boundary value, the penalty is the one
included within penalty-value attribute associated to the highest up-to-boundary
nodetype: list (ro)
list keys: [parameter-and-unit] [up-to-boundary]
description:
Impairment and unit leading to the penalty (i.e., cd-ps)
nodetype: leaf (list key) (ro)
type: leafref
description:
defines the upper (for positive values) and lower (for negative values)
limit for which the penalty value is valid.
nodetype: leaf (list key) (ro)
type: leafref
description:
Penalties list element's state attributes top container.
nodetype: container (ro)
description:
Impairment and unit leading to the penalty (i.e., cd-ps)
nodetype: leaf (ro)
type: oc-opt-term-prop-types:impairment-type
description:
defines the upper (for positive values) and lower (for negative values)
limit for which the penalty value is valid.
nodetype: leaf (ro)
type: decimal64
description:
OSNR penalty associated to the given values, expressed in dB.
nodetype: leaf (ro)
type: decimal64
units: dB
description:
Top level container of interoperable modes.
nodetype: container (ro)
description:
Each interoperable mode is defined by its public name reference
and a set of free form key-value properties which augments with
the required information provided by the system-vendor.
nodetype: list (ro)
list keys: [mode-name]
description:
Reference to mode-name.
nodetype: leaf (list key) (ro)
type: leafref
description:
Operational-mode interoperbale mode state top container.
nodetype: container (ro)
description:
Public well-know free-format name reference to the mode name.
nodetype: leaf (ro)
type: string
description:
Name of the organization, standard body, Multi-Source Agreement, or
open source project, responsible of the definition of the interoperable
mode.
nodetype: leaf (ro)
type: union
type: string
type: oc-opt-term-prop-types:interoperability-modes-organization