openconfig-optical-attenuator

openconfig-version: 0.2.0

Description

This model describes configuration and operational state data for variable optical attenuators, deployed as part of a transport line system.

Imports

openconfig-platform
openconfig-types
openconfig-extensions

Identities

base: OPTICAL_ATTENUATOR_MODE

description:
Type definition for different types of optical attenuator operating modes

CONSTANT_POWER

description:
Constant power mode

base identity: OPTICAL_ATTENUATOR_MODE

CONSTANT_ATTENUATION

description:
Constant attenuation mode

base identity: OPTICAL_ATTENUATOR_MODE

SYSTEM_CONTROLLED

description:
System controls the attenuation value.

base identity: OPTICAL_ATTENUATOR_MODE

Data elements

/
optical-attenuator

description:
Enclosing container for attenuators

nodetype: container (rw)

/optical-attenuator/
attenuators

description:
Enclosing container for list of attenuators

nodetype: container (rw)

/optical-attenuator/attenuators/
attenuator

description:
List of variable optical attenuators present in the device

nodetype: list (rw)

list keys: [name]

/optical-attenuator/attenuators/attenuator/
name

description:
Reference to the name of the attenuator

nodetype: leaf (list key) (rw)

type: leafref

  • path reference: ../config/name

/optical-attenuator/attenuators/attenuator/
config

description:
Configuration data for the attenuator

nodetype: container (rw)

/optical-attenuator/attenuators/attenuator/config/
name

description:
User-defined name assigned to identify a specific attenuator in the device

nodetype: leaf (rw)

type: string

/optical-attenuator/attenuators/attenuator/config/
attenuation-mode

description:
The operating mode of the attenuator

nodetype: leaf (rw)

type: identityref

  • base: OPTICAL_ATTENUATOR_MODE

/optical-attenuator/attenuators/attenuator/config/
target-output-power

description:
Power level set on the output of attenuator. This leaf is only relevant when in CONSTANT_POWER mode.

nodetype: leaf (rw)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/config/
attenuation

description:
Attenuation applied by the attenuator. This leaf is only relevant when in CONSTANT_ATTENUATION mode.

nodetype: leaf (rw)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/config/
enabled

description:
When true, attenuator is set to specified attenuation or varies to maintain constant output power. When false, the attenuator is set max attenuation or blocked.

nodetype: leaf (rw)

type: boolean

/optical-attenuator/attenuators/attenuator/config/
max-output-power

description:
The max power level allowed on the output of attenuator. This leaf is optional when in SYSTEM_CONTROLLED mode.

nodetype: leaf (rw)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/config/
max-output-power-threshold

description:
If the system-derived-target-output-power is equal to or greater than 'max-output-power + max-output-power-threshold', a device alarm will be raised within /system/alarms. This leaf is only relevant when in SYSTEM_CONTROLLED mode.

nodetype: leaf (rw)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/
state

description:
Operational state data for the attenuator

nodetype: container (ro)

/optical-attenuator/attenuators/attenuator/state/
name

description:
User-defined name assigned to identify a specific attenuator in the device

nodetype: leaf (ro)

type: string

/optical-attenuator/attenuators/attenuator/state/
attenuation-mode

description:
The operating mode of the attenuator

nodetype: leaf (ro)

type: identityref

  • base: OPTICAL_ATTENUATOR_MODE

/optical-attenuator/attenuators/attenuator/state/
target-output-power

description:
Power level set on the output of attenuator. This leaf is only relevant when in CONSTANT_POWER mode.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/
attenuation

description:
Attenuation applied by the attenuator. This leaf is only relevant when in CONSTANT_ATTENUATION mode.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/
enabled

description:
When true, attenuator is set to specified attenuation or varies to maintain constant output power. When false, the attenuator is set max attenuation or blocked.

nodetype: leaf (ro)

type: boolean

/optical-attenuator/attenuators/attenuator/state/
max-output-power

description:
The max power level allowed on the output of attenuator. This leaf is optional when in SYSTEM_CONTROLLED mode.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/
max-output-power-threshold

description:
If the system-derived-target-output-power is equal to or greater than 'max-output-power + max-output-power-threshold', a device alarm will be raised within /system/alarms. This leaf is only relevant when in SYSTEM_CONTROLLED mode.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/
component

description:
Reference to the system-supplied physical component that the attenuator block is contained within. Multiple attenuator blocks may be contained within the same physical component.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/optical-attenuator/attenuators/attenuator/state/
ingress-port

description:
Reference to system-supplied name of the attenuator ingress port. This leaf is only valid for ports of type INGRESS.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/optical-attenuator/attenuators/attenuator/state/
egress-port

description:
Reference to system-supplied name of the attenuator egress port. This leaf is only valid for ports of type EGRESS.

nodetype: leaf (ro)

type: leafref

  • path reference: /components/component/name

/optical-attenuator/attenuators/attenuator/state/
system-derived-target-output-power

description:
The target output power as determined by the device. This leaf is only relevant when in SYSTEM_CONTROLLED mode.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/
actual-attenuation

description:
The actual attenuation applied by the attenuator in units of 0.01dB. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dB

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/optical-attenuator/attenuators/attenuator/state/actual-attenuation/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/optical-attenuator/attenuators/attenuator/state/
output-power-total

description:
The total output optical power of this port in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value

nodetype: container (ro)

/optical-attenuator/attenuators/attenuator/state/output-power-total/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/output-power-total/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/output-power-total/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/output-power-total/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/output-power-total/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/optical-attenuator/attenuators/attenuator/state/output-power-total/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/optical-attenuator/attenuators/attenuator/state/output-power-total/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/optical-attenuator/attenuators/attenuator/state/
optical-return-loss

description:
The optical return loss (ORL) is the ratio of the light reflected back into the port to the light launched out of the port. ORL is in units of 0.01dBm. If avg/min/max statistics are not supported, just supply the instant value.

nodetype: container (ro)

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
instant

description:
The instantaneous value of the statistic.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
avg

description:
The arithmetic mean value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
min

description:
The minimum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
max

description:
The maximum value of the statistic over the time interval.

nodetype: leaf (ro)

type: decimal64

units: dBm

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
interval

description:
If supported by the system, this reports the time interval over which the min/max/average statistics are computed by the system.

nodetype: leaf (ro)

type: oc-types:stat-interval

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
min-time

description:
The absolute time at which the minimum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64

/optical-attenuator/attenuators/attenuator/state/optical-return-loss/
max-time

description:
The absolute time at which the maximum value occurred. The value is the timestamp in nanoseconds relative to the Unix Epoch (Jan 1, 1970 00:00:00 UTC).

nodetype: leaf (ro)

type: oc-types:timeticks64