Management Interface
URLs Summary
URL | GET | POST | PATCH | PUT | DELETE |
|---|---|---|---|---|---|
/rest/v1/running/mgmt-interfaces/{name} | Y | N | Y | N | N |
/rest/v1/running/mgmt-interfaces/{name}/address/{ip-prefix} | Y | Y | Y | N | Y |
/rest/v1/rpc/show-interface-mgmt | N | Y | N | N | N |
Examples
Modify mgmt interface
PATCH HTTPS://{switch IP}/rest/v1/running/mgmt-interfaces/Mgmt0
{"vrf-enable": "false"}Modify ip address for mgmt interface
POST HTTPS://{switch IP}/rest/v1/running/mgmt-interfaces/Mgmt0/address
{
"ip-prefix": "172.16.8.10/24",
"gwaddr": "172.16.8.1"
}Properties Descriptions
Management Interface
Tree Diagrams
+--rw mgmt-interfaces
+--rw mgmt-interface* [name]
+--rw name
+--rw address* [ip-prefix]
| +--rw ip-prefix
| +--rw gwaddr?
+--rw vrf-enable?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
mgmt-interfaces | M | | Path-only node, has no configurable value. The mgmt-interfaces struct containing all attributes of mgmt-interfaces data set. |
name | M | string | (sub-property of mgmt-interfaces) |
address | M | | (sub-property of mgmt-interfaces) Path-only node, has no configurable value. The type of ip-prefix must be same as the type of gw. |
ip-prefix | M | A.B.C.D/M or XX:XX:XX:XX:XX:XX:XX:XX/M | (sub-property of address) IP address family must be same as gwaddr. |
gwaddr | O | A.B.C.D or XX:XX:XX:XX:XX:XX:XX:XX | (sub-property of address) IP address family must be same as ip-prefix |
vrf-enable | O | "true" "false" | (sub-property of mgmt-interfaces) Default value: "false" |
Show Management Interface
Tree Diagrams
+---x show-interface-mgmt
+---w input
| +---w vrf?
+--ro output
+--ro result?Table of Properties
Name | Required | Type/Range | Description |
|---|---|---|---|
show-interface-mgmt | M | | Path-only node, has no configurable value. Show mgmt interface |
vrf | O | "true" "false" | (sub-property of input) If true, show mgmt interface in VRF mode. |
result | RO | string | (sub-property of output) A text that shows information of mgmt interface |