Logical Interface

45 min

\urls summary\ url get post patch put delete /rest/v1/rpc/clear counters interface n y n n n /rest/v1/rpc/clear counters rif n y n n n /rest/v1/rpc/clear router interface n y n n n /rest/v1/rpc/clear vlan membership n y n n n /rest/v1/running/interfaces/{name} y n y n y /rest/v1/running/interfaces/{name}/ipv4 y y y n y /rest/v1/running/interfaces/{name}/ipv4/address/{ip prefix} y y n n y /rest/v1/running/interfaces/{name}/ipv6 y y y n y /rest/v1/running/interfaces/{name}/ipv6/address/{ip prefix} y y n n y /rest/v1/running/interfaces/{name}/statistics y n n n n /rest/v1/rpc/show counters interface n y n n n /rest/v1/rpc/show counters router interface n y n n n /rest/v1/rpc/show interface n y n n n /rest/v1/rpc/show interface description n y n n n /rest/v1/rpc/show interface errdown n y n n n /rest/v1/rpc/show interface startup delay n y n n n /rest/v1/rpc/show interface summary n y n n n /rest/v1/rpc/show ip interface n y n n n /rest/v1/rpc/show ipv6 interface n y n n n /rest/v1/rpc/show sub interface n y n n n \\ \clear router interface\ post https //{switch ip}/rest/v1/rpc/clear router interface { "interface" "ethernet1" } \clear vlan members for interface\ post https //{switch ip}/rest/v1/rpc/clear vlan membership { "interface" "ethernet1" } \get interface statistics\ get https //{switch ip}/rest/v1/running/interfaces/{name}/statistics \get counters of interface\ post https //{switch ip}/rest/v1/rpc/show counters interface { "name" "ethernet1" } \get counters of router interface\ post https //{switch ip}/rest/v1/rpc/show counters router interface { "name" "vlan200" } \get interface summary\ post https //{switch ip}/rest/v1/rpc/show interface summary \get interface\ post https //{switch ip}/rest/v1/rpc/show interface { "interface" "ethernet1" } \get sub interface\ post https //{switch ip}/rest/v1/rpc/show sub interface { "interface" "ethernet1 100" } \get interface error down\ post https //{switch ip}/rest/v1/rpc/show interface errdown {} \get interface description\ post https //{switch ip}/rest/v1/rpc/show interface description {} \get interface startup delay\ post https //{switch ip}/rest/v1/rpc/show interface startup delay {} \get interface ip address\ post https //{switch ip}/rest/v1/rpc/show ip interface {} \get interface ipv6 address\ post https //{switch ip}/rest/v1/rpc/show ipv6 interface {} \get all interfaces information\ get https //{switch ip}/rest/v1/running/interfaces \modify an ethernet interface\ patch https //{switch ip}/rest/v1/running/interfaces/ethernet1 { "mtu" 1510, "mac address" "00 11 22 33 44 55" } \delete a loopback interface\ delete https //{switch ip}/rest/v1/running/interfaces/loopback100 \create ipv4 address for interface\ post https //{switch ip}/rest/v1/running/interfaces/ethernet1/ipv4 { "address" \[ {"ip prefix" "192 168 100 100/20"} ] } \delete ipv4 address from interface\ detele rest/v1/running/interfaces/ethernet2/ipv4/address/20 1 1 2%2f20 \create an ipv6 address for interface\ post https //{switch ip}/rest/v1/running/interfaces/vlan2345/ipv6/address { "ip prefix" "fec0 1234/64" } \properties descriptions\ \interfaces configurable fields\ tree diagrams + rw interfaces + rw interface \[name] + rw name + rw description? + rw admin status? + rw interface mode? + ro oper status? + rw mac address? + rw mac address learning? + rw mtu? + rw vrf? + rw nat zone? + rw ipv4 \| + rw address \[ip prefix] \| | + rw ip prefix \| | + rw secondary? + rw ipv6 \| + rw address \[ip prefix] \| | + rw ip prefix \| | + rw secondary? + rw ipv6 link local? + rw ndp proxy? + rw pbr policy? table of properties name required type/range description interfaces m path only node, has no configurable value interface parameters name m ethernet name ethernet sub interface name lag1 9999 link aggregation sub interface name loopback0 199 vlan1 4094 (sub property of interfaces) the name of the interface description co string within 255 characters (sub property of interfaces) only applicable when name is a ethernet,ethernet sub interface,portchannel,portchannel sub interface name a textual description of the interface admin status o "true" "false" (sub property of interfaces) this leaf contains the configured, desired state of the interface default value "true" interface mode co "routed" "trunk" "none" (sub property of interfaces) only applicable when name is a ethernet,portchannel,vlan name set the interface to access, trunk, none mode vlan and ip interface configuration may be automatically deleted after changing this field oper status ro "true" "false" (sub property of interfaces) the current operational state of the interface mac address co a\ b c\ d e\ f (sub property of interfaces) only applicable when name is a ethernet,ethernet sub interface,portchannel,portchannel sub interface,vlan name the interface's address at its protocol sub layer for example, for an 802 x interface, this object normally contains a media access control (mac) address the interface's media specific modules must define the bit and byte ordering and the format of the value of this object for interfaces that do not have such an address (e g , a serial line), this node is not present mac address learning co "true" "false" (sub property of interfaces) only applicable when name is a ethernet,portchannel name set interface mac address learning, only support for vlan and its members when an interface is configured as a vlan member, mac address learning is automatically enabled default value "false" mtu co 1312 9216 (sub property of interfaces) only applicable when name is a ethernet,ethernet sub interface,portchannel,portchannel sub interface,vlan name set the max transmission unit size in octets for the physical interface if this is not set, the mtu is set to the operational default default value 9216 vrf o "default" vrf name (sub property of interfaces) set interface vrf nat zone o 0 1 (sub property of interfaces) set interface nat zone (0 1) default value 0 ipv4 m (sub property of interfaces) path only node, has no configurable value parameters for the ipv4 address family address m (sub property of ipv4) path only node, has no configurable value the list of ipv4 addresses on the interface ip prefix m a b c d/m (sub property of address) secondary co "true" "false" (sub property of address) only applicable when name is a ethernet,ethernet sub interface,portchannel,portchannel sub interface,vlan name set secondary ipv6 address for interface must set primary ipv6 address in the same network first default value "false" ipv6 m (sub property of interfaces) path only node, has no configurable value parameters for the ipv6 address family address m (sub property of ipv6) path only node, has no configurable value the list of ipv6 addresses on the interface ip prefix m xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx/m (sub property of address) secondary co "true" "false" (sub property of address) only applicable when name is a ethernet,ethernet sub interface,portchannel,portchannel sub interface,vlan name set secondary ipv6 address for interface must set primary ipv6 address in the same network first default value "false" ipv6 link local co "true" "false" (sub property of interfaces) only applicable when name is a ethernet,ethernet sub interface,portchannel,portchannel sub interface,vlan name set ipv6 use link local when an ipv6 address is configured on the interface, ipv6 link local is automatically enabled default value "false" ndp proxy co "true" "false" (sub property of interfaces) only applicable when name is a ethernet,portchannel,vlan name set interface ndp proxy default value "false" pbr policy co string (sub property of interfaces) only applicable when name is a ethernet,portchannel name name of the pbr map to apply only support in ethernet and portchannel, not support sub interface \interfaces read only fields\ tree diagrams + rw interfaces + rw interface \[name] + rw name + ro statistics + ro in octets? + ro in unicast pkts? + ro in broadcast pkts? + ro in multicast pkts? + ro in discards? + ro in errors? + ro out octets? + ro out unicast pkts? + ro out broadcast pkts? + ro out multicast pkts? + ro out discards? + ro out errors? table of properties name required type/range description interfaces m path only node, has no configurable value interface parameters name m ethernet name ethernet sub interface name portchannel name portchannel sub interface name vlan name loopback name (sub property of interfaces) the name of the interface statistics ro (sub property of interfaces) path only node, has no configurable value a collection of interface related statistics objects in octets ro yang\ counter64 (sub property of interfaces) the total number of octets received on the interface, including framing characters discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" in unicast pkts ro yang\ counter64 (sub property of interfaces) the number of packets, delivered by this sub layer to a higher (sub )layer, that were not addressed to a multicast or broadcast address at this sub layer discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" in broadcast pkts ro yang\ counter64 (sub property of interfaces) the number of packets, delivered by this sub layer to a higher (sub )layer, that were addressed to a broadcast address at this sub layer discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" in multicast pkts ro yang\ counter64 (sub property of interfaces) the number of packets, delivered by this sub layer to a higher (sub )layer, that were addressed to a multicast address at this sub layer for a mac layer protocol, this includes both group and functional addresses discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" in discards ro yang\ counter64 (sub property of interfaces) the number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher layer protocol one possible reason for discarding such a packet could be to free up buffer space discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" in errors ro yang\ counter64 (sub property of interfaces) for packet oriented interfaces, the number of inbound packets that contained errors preventing them from being deliverable to a higher layer protocol for character oriented or fixed length interfaces, the number of inbound transmission units that contained errors preventing them from being deliverable to a higher layer protocol discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" out octets ro yang\ counter64 (sub property of interfaces) the total number of octets transmitted out of the interface, including framing characters discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" out unicast pkts ro yang\ counter64 (sub property of interfaces) the total number of packets that higher level protocols requested be transmitted and that were not addressed to a multicast or broadcast address at this sub layer, including those that were discarded or not sent discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" out broadcast pkts ro yang\ counter64 (sub property of interfaces) the total number of packets that higher level protocols requested be transmitted and that were addressed to a broadcast address at this sub layer, including those that were discarded or not sent discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" out multicast pkts ro yang\ counter64 (sub property of interfaces) the total number of packets that higher level protocols requested be transmitted and that were addressed to a multicast address at this sub layer, including those that were discarded or not sent for a mac layer protocol, this includes both group and functional addresses discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" out discards ro yang\ counter64 (sub property of interfaces) the number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being transmitted one possible reason for discarding such a packet could be to free up buffer space discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" out errors ro yang\ counter64 (sub property of interfaces) for packet oriented interfaces, the number of outbound packets that could not be transmitted because of errors for character oriented or fixed length interfaces, the number of outbound transmission units that could not be transmitted because of errors discontinuities in the value of this counter can occur at re initialization of the management system and at other times as indicated by the value of "discontinuity time" \clear counters interface\ tree diagrams + x clear counters interface \| + ro output \| + ro data? table of properties n \ame\ \required\ \type/range\ \description\ clear counters interface m path only node, has no configurable value rpc for clearing interface counters data ro string (sub property of output) the result of clear counters interface \clear counters router interface\ tree diagrams + x clear counters rif \| + ro output \| + ro data? table of properties name required type/range description clear counters rif m path only node, has no configurable value rpc for clearing router interface counters data ro string (sub property of output) the result of clear counters router interface \show counters interface\ tree diagrams + x show counters interface \| + w input \| | + w name? \| | + w errors only? \| | + w rates only? \| | + w raw stats? \| | + w period? \| | + w all? \| | + w detail? \| | + w json? \| + ro output \| + ro interface \[name] \| | + ro name \| | + ro state? \| | + ro rx ok? \| | + ro rx bps? \| | + ro rx util? \| | + ro rx err? \| | + ro rx drp? \| | + ro rx ovr? \| | + ro tx ok? \| | + ro tx bps? \| | + ro tx util? \| | + ro tx err? \| | + ro tx drp? \| | + ro tx ovr? \| + ro result? table of properties name required type/range description show counters interface m path only node, has no configurable value rpc for showing interface counters name o ethernet name lag name (sub property of input) the name of the interface errors only o "true" "false" (sub property of input) display interface errors rates only o "true" "false" (sub property of input) display interface rates raw stats o "true" "false" (sub property of input) raw stats (unmodified output of netstat) period o 0 100 (sub property of input) display stats over a specified period (in seconds), default=0 all o "true" "false" (sub property of input) display all the stats counters detail o "true" "false" (sub property of input) display detailed statistics json o "true" "false" (sub property of input) display in json format interface ro (sub property of output) path only node, has no configurable value structured interface counter output for rpc clients name ro string (sub property of interface) state ro "up" "down" "not available" (sub property of interface) rx ok ro string (sub property of interface) rx bps ro string (sub property of interface) rx util ro string (sub property of interface) rx err ro string (sub property of interface) rx drp ro string (sub property of interface) rx ovr ro string (sub property of interface) tx ok ro string (sub property of interface) tx bps ro string (sub property of interface) tx util ro string (sub property of interface) tx err ro string (sub property of interface) tx drp ro string (sub property of interface) tx ovr ro string (sub property of interface) result ro (sub property of output) a table that shows counter of router interface \show counters router interface\ tree diagrams + x show counters router interface \| + w input \| | + w name? \| | + w period? \| | + w json? \| + ro output \| + ro interface \[name] \| | + ro name \| | + ro rx ok? \| | + ro rx bps? \| | + ro rx util? \| | + ro rx err? \| | + ro rx drp? \| | + ro rx ovr? \| | + ro tx ok? \| | + ro tx bps? \| | + ro tx util? \| | + ro tx err? \| | + ro tx drp? \| | + ro tx ovr? \| + ro result? table of properties name required type/range description show counters router interface m path only node, has no configurable value rpc for showing router interface counters name o ethernet name ethernet sub interface name lag name lag sub interface name loopback0 199 vlan1 4094 (sub property of input) the name of the router interface period o 0 100 (sub property of input) display stats over a specified period (in seconds), default=0 json o "true" "false" (sub property of input) display in json format interface ro (sub property of output) path only node, has no configurable value structured router interface counter output for rpc clients name ro string (sub property of interface) rx ok ro string (sub property of interface) rx bps ro string (sub property of interface) rx util ro string (sub property of interface) rx err ro string (sub property of interface) rx drp ro string (sub property of interface) rx ovr ro string (sub property of interface) tx ok ro string (sub property of interface) tx bps ro string (sub property of interface) tx util ro string (sub property of interface) tx err ro string (sub property of interface) tx drp ro string (sub property of interface) tx ovr ro string (sub property of interface) result ro (sub property of output) a table that shows counter of router interface \clear vlan membership for interface\ tree diagrams + x clear vlan membership \| + w input \| + w interface table of properties name required type/range description clear vlan membership m path only node, has no configurable value clear vlan membership of an ethernet port or link aggregation group return an error if the interface is a router interface interface m string (sub property of input) the name of the interface \clear router interface\ tree diagrams + x clear router interface \| + w input \| + w interface table of properties name required type/range description clear router interface m path only node, has no configurable value clear router interface of an ethernet port or link aggregation group return an error if the interface is a vlan trunk port interface m string (sub property of input) the name of the interface \show interface summary\ tree diagrams + x show interface summary \| + ro output \| + ro interface \[name] \| + ro name \| + ro lanes? \| + ro speed? \| + ro mtu? \| + ro fec? \| + ro alias? \| + ro interface mode? \| + ro oper status? \| + ro admin status? \| + ro transceiver type? \| + ro asym pfc? table of properties name required type/range description show interface summary m path only node, has no configurable value interface ro (sub property of output) path only node, has no configurable value structured interface summary for ethernet ports and link aggregations name ro ethernet name lag name (sub property of interface) the name of the interface lanes ro string (sub property of interface) comma separated lanes for ethernet ports, or 'n/a' for link aggregations speed ro string (sub property of interface) operational speed formatted for display, such as '100g' or 'n/a' mtu ro 0 65535 (sub property of interface) the mtu of the interface fec ro string (sub property of interface) the fec mode, or 'n/a' alias ro string (sub property of interface) the configured alias, or 'n/a' interface mode ro string (sub property of interface) the derived interface mode, such as 'trunk', 'routed', a parent link aggregation, or 'n/a' oper status ro "up" "down" (sub property of interface) the operational status of the interface admin status ro "up" "down" (sub property of interface) the administrative status of the interface transceiver type ro string (sub property of interface) the transceiver type, or 'n/a' asym pfc ro string (sub property of interface) the asymmetric pfc state, or 'n/a' \show interface detail information\ tree diagrams + x show interface \| + w input \| | + w interface \| + ro output \| + ro name? \| + ro admin status? \| + ro line protocol status? \| + ro hardware? \| + ro mac address? \| + ro interface index? \| + ro description? \| + ro ipv4 address? \| + ro ipv4 assignment mode? \| + ro ipv6 assignment mode? \| + ro mtu? \| + ro line speed? \| + ro current speed? \| + ro auto negotiation? \| + ro input statistics \| | + ro packets? \| | + ro octets? \| | + ro multicasts? \| | + ro broadcasts? \| | + ro unicasts? \| | + ro errors? \| | + ro discards? \| | + ro crc errors? \| + ro output statistics \| + ro packets? \| + ro octets? \| + ro multicasts? \| + ro broadcasts? \| + ro unicasts? \| + ro errors? \| + ro discards? table of properties name required type/range description show interface m path only node, has no configurable value interface m ethernet name lag name (sub property of input) the name of the ethernet or link aggregation interface name ro string (sub property of output) the interface name admin status ro "up" "down" (sub property of output) the administrative status of the interface line protocol status ro "up" "down" (sub property of output) the operational line protocol status of the interface hardware ro string (sub property of output) the interface hardware type mac address ro string (sub property of output) the interface mac address, or n/a interface index ro string (sub property of output) the interface index description ro string (sub property of output) the interface description, or n/a ipv4 address ro string (sub property of output) the primary ipv4 address if configured ipv4 assignment mode ro string (sub property of output) the ipv4 address assignment mode ipv6 assignment mode ro string (sub property of output) the ipv6 address assignment mode mtu ro 0 65535 (sub property of output) the ip mtu in bytes line speed ro string (sub property of output) the configured interface speed current speed ro string (sub property of output) the current interface speed for link aggregation interfaces auto negotiation ro "true" "false" (sub property of output) whether auto negotiation is enabled input statistics ro (sub property of output) path only node, has no configurable value input packet statistics packets ro uint64 (sub property of input statistics) octets ro uint64 (sub property of input statistics) multicasts ro uint64 (sub property of input statistics) broadcasts ro uint64 (sub property of input statistics) unicasts ro uint64 (sub property of input statistics) errors ro uint64 (sub property of input statistics) discards ro uint64 (sub property of input statistics) crc errors ro uint64 (sub property of input statistics) output statistics ro (sub property of output) path only node, has no configurable value output packet statistics packets ro uint64 (sub property of output statistics) octets ro uint64 (sub property of output statistics) multicasts ro uint64 (sub property of output statistics) broadcasts ro uint64 (sub property of output statistics) unicasts ro uint64 (sub property of output statistics) errors ro uint64 (sub property of output statistics) discards ro uint64 (sub property of output statistics) \show sub interface\ tree diagrams + x show sub interface \| + w input \| | + w interface? \| + ro output \| + ro interface \[name] \| | + ro name \| | + ro speed? \| | + ro mtu? \| | + ro vlan id? \| | + ro admin status? \| | + ro type? \| + ro result? table of properties name required type/range description show sub interface m path only node, has no configurable value interface o ethernet sub interface name lag sub interface name (sub property of input) the name of the ethernet or link aggregation sub interface interface ro (sub property of output) path only node, has no configurable value name ro string (sub property of interface) speed ro string (sub property of interface) mtu ro 0 65535 (sub property of interface) vlan id ro 1 4094 (sub property of interface) admin status ro "up" "down" (sub property of interface) type ro string (sub property of interface) result ro (sub property of output) a table that shows sub interface \show interface error down\ tree diagrams + x show interface errdown \| + ro output \| + ro interface \[name] \| + ro name \| + ro status? table of properties name required type/range description show interface errdown m path only node, has no configurable value interface ro (sub property of output) path only node, has no configurable value name ro string (sub property of interface) status ro "up" "errdown" (sub property of interface) \show interface description\ tree diagrams + x show interface description \| + ro output \| + ro interface \[name] \| + ro name \| + ro oper status? \| + ro admin status? \| + ro alias? \| + ro description? table of properties name required type/range description show interface description m path only node, has no configurable value interface ro (sub property of output) path only node, has no configurable value name ro string (sub property of interface) oper status ro "up" "down" (sub property of interface) admin status ro "up" "down" (sub property of interface) alias ro string (sub property of interface) description ro string (sub property of interface) \show interface startup delay\ tree diagrams + x show interface startup delay \| + ro output \| + ro interface \[name] \| + ro name \| + ro startup delay? table of properties name required type/range description show interface startup delay m path only node, has no configurable value interface ro (sub property of output) path only node, has no configurable value name ro ethernet name (sub property of interface) startup delay ro 0 65535 (sub property of interface) \show interface ipv4 address\ tree diagrams + x show ip interface \| + ro output \| + ro interface \[name] \| + ro name \| + ro master? \| + ro ip prefix \| + ro admin status? \| + ro oper status? \| + ro bgp neighbor? \| + ro neighbor ip? table of properties name required type/range description show ip interface m path only node, has no configurable value interface ro (sub property of output) path only node, has no configurable value name ro string (sub property of interface) master ro string (sub property of interface) ip prefix ro string (sub property of interface) ipv4 prefixes configured on the interface admin status ro "up" "down" (sub property of interface) oper status ro "up" "down" (sub property of interface) bgp neighbor ro string (sub property of interface) neighbor ip ro string (sub property of interface) \show interface ipv6 address\ tree diagrams + x show ipv6 interface + ro output + ro interface \[name] + ro name + ro master? + ro ip prefix + ro admin status? + ro oper status? + ro bgp neighbor? + ro neighbor ip? table of properties name required type/range description show ipv6 interface m path only node, has no configurable value interface ro (sub property of output) path only node, has no configurable value name ro string (sub property of interface) master ro string (sub property of interface) ip prefix ro string (sub property of interface) ipv6 prefixes configured on the interface admin status ro "up" "down" (sub property of interface) oper status ro "up" "down" (sub property of interface) bgp neighbor ro string (sub property of interface) neighbor ip ro string (sub property of interface)