Summary
Send a gNOI clear LLDP message.
Description
Send a clear LLDP interface message over gRPC gNOI.
Route
POST /automationgateway/gnoi/clear_lldp_interface/execute
Roles
admin
Parameters
DetailsExampleSchema
| Name |
Type |
Required |
Description |
| host |
string |
yes |
A host from the gRPC inventory |
| interface |
object |
yes |
All LLDP adjacencies on the provided interface will be cleared. |
Copied to Clipboard
{
"host": "xr9kv-atl",
"interface": {
"origin": "openconfig-interfaces",
"elem": [
{
"name": "[object Object]"
}
]
}
}
Copied to Clipboard
{
"type": "object",
"properties": {
"host": {
"title": "host",
"type": "string",
"$ref": "deviceData#/definitions/deviceName"
},
"interface": {
"title": "interface",
"type": "object",
"properties": {
"origin": {
"type": "string",
"examples": [
"openconfig-interfaces"
]
},
"elem": {
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string",
"examples": [
{
"name": "interfaces"
},
{
"name": "interface",
"key": {
"name": "MgmtEth0/RP0/CPU0/0"
}
}
]
}
}
}
}
}
}
},
"required": [
"host",
"interface"
],
"additionalProperties": false
}
Return
DetailsExampleSchema
| Name |
Type |
Description |
| result |
object |
gNOI response object. |
Copied to Clipboard
{
"key": "stdout",
"status": "200"
}
