protocol/link-oam
Configures, modifies, or retrieves Protocol Link-OAM configuration.
Resource URIs
URI
|
Description
|
<base_URI>/config/running/protocol/link-oam
|
Configures, modifies, or retrieves Protocol Link-OAM configuration.
|
GET URIs
|
Description
|
<base_URI>/config/running/protocol/link-oam
|
Displays the Protocol Loop-Detection Interface Link-OAM configuration.
|
<base_URI>/config/running/protocol/link-oam/shutdown
|
Displays whether protocol link-oam is enabled or disabled.
|
<base_URI>/config/running/protocol/link-oam/pdu-rate
|
Displays pdu-rate value.
|
<base_URI>/config/running/protocol/link-oam/time-out
|
Displays timeout value.
|
PUT URIs
|
Payload
|
Description
|
<base_URI>/config/running/protocol/link-oam
|
<link-oam />
|
Configures Protocol Link-OAM.
|
<base_URI>/config/running/protocol/link-oam/shutdown
|
<shutdown>{enumerate}</shutdown>
|
Disables or enables protocol link-oam
|
<base_URI>/config/running/protocol/link-oam/pdu-rate
|
<pdu-rate>{uint32}</pdu-rate>
|
Configures pdu-rate value.
|
<base_URI>/config/running/protocol/link-oam/time-out
|
<time-out>{uint32}</time-out>
|
Configures timeout value.
|
POST URIs
|
Payload
|
Description
|
<base_URI>/config/running/protocol
|
<link-oam />
|
Configures Protocol Link-OAM.
|
PATCH URIs
|
Payload
|
Description
|
<base_URI>/config/running/protocol/link-oam
|
<link-oam><shutdown>{enumerate}</shutdown></link-oam>
|
Disables or enables protocol link-oam
|
<base_URI>/config/running/protocol/link-oam
|
<link-oam><pdu-rate>{uint32}</pdu-rate></link-oam>
|
Configures pdu-rate value.
|
<base_URI>/config/running/protocol/link-oam
|
<link-oam><time-out>{uint32}</time-out></link-oam>
|
Configures timeout value.
|
DELETE URIs
|
<base_URI>/config/running/protocol/link-oam
|
<base_URI>/config/running/protocol/link-oam/pdu-rate
|
<base_URI>/config/running/protocol/link-oam/time-out
|
Parameters
- shutdown
- Disables or enables protocol link-oam. Boolean value.
- pdu-rate
- Number of OAM PDUs per second. Range 1-10 per second. Default is 1 per second.
- time-ou
- Hold time before Discovery process is restarted. Range 1-10 seconds. Default is 5 seconds.
Usage Guidelines
GET, PUT, PATCH, DELETE, OPTIONS, and HEAD operations are supported.