Management Interface

7 min

urls summary 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 examples modify mgmt interface modify mgmt interface patch https //{switch ip}/rest/v1/running/mgmt interfaces/eth0 {"vrf enable" "false"} modify ip address for mgmt interface modify ip address for mgmt interface post https //{switch ip}/rest/v1/running/mgmt interfaces/eth0/address { "ip prefix" "172 16 8 10/24", "gwaddr" "172 16 8 1" } properties descriptions properties descriptions management interface management interface tree diagrams 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 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 show management interface tree diagrams tree diagrams + x show interface mgmt + w input \| + w vrf? + ro output + ro result? table of properties 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