interface/{interface-type}/{interface-name}/link-oam

Configures, modifies, or retrieves Interface Link-OAM configuration.

Resource URIs

URI Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam Configures, modifies, or retrieves Interface Link-OAM configuration. Valid interface type: Ethernet.
GET URIs Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam Displays the interface-level Loop-Detection Interface Link-OAM configuration. Valid interface type: Ethernet.
PUT URIs Payload Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/enable <enable>{enumeration}</enable> Enables Link-OAM. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/allow-loopback <allow-loopback>{enumeration}</allow-loopback> Enables / Disables loopback. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/dying-gasp/action <action>{action-type}</action> Sets action that will happen in a Dying Gasp event (Receiver going down). Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/link-fault/action <action>{action-type}</action> Sets action that will happen in a Link Fault event(Receiver losing signal). Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/critical-event/action <action>{action-type}</action> Sets action that will happen in a Critical Event (malfunction). Valid interface type: Ethernet.
PATCH URIs Payload Description
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam <link-oam><enable>{enumeration}</enable></link-oam> Enables / Disables Link-OAM. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam <link-oam><allow-loopback>true</allow-loopback></link-oam> Enables / Disables loopback. Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/remote-failure/dying-gasp <dying-gasp><action>{action-type}</action></dying-gasp> Sets action that will happen in a Dying Gasp (Receiver going down). Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/remote-failure/link-fault <link-fault><action>{action-type}</action></link-fault> Sets action that will happen in a Link Fault (Receiver losing signal). Valid interface type: Ethernet.
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/remote-failure/critical-event <critical-event><action>{action-type}</action></critical-event> Sets action that will happen in a Critical Event (malfunction). Valid interface type: Ethernet.
DELETE URIs
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/enable
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/allow-loopback
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/remote-failure
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/dying-gasp
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/remote-failure/link-fault
<base_URI>/config/running/interface/{interface-type}/{interface-name}/link-oam/remote-failure/critical-event

Parameters

action
Action that will happen on receipt of a remote failure message. Default is event logging theough syslog. Allowed values: block-interface
enable
Indicates whether Link OAM is enabled or disabled. Boolean value.
allow-loopback
Indicates whether remote loopback is enabled or disabled. Boolean value.

Usage Guidelines

GET, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.