NETCONF Configuration Guide
YANG API Reference
interfaces
29 min
asternos yang model for interfaces yang tree diagram yang tree diagram module asternos interfaces + rw interfaces + rw interface \[name] + rw name union + rw description? cmn\ description type + rw admin status? boolean + rw interface mode? enumeration + ro oper status? boolean + ro error down status? boolean + ro error down reason? string + rw mac address? yang\ mac address + rw mtu? if\ mtu type + rw vrf? vrf\ vrf ref + rw tpid? string + rw urpf mode? enumeration + rw pbr policy? string + ro statistics + ro in octets? yang\ counter64 + ro in unicast pkts? yang\ counter64 + ro in broadcast pkts? yang\ counter64 + ro in multicast pkts? yang\ counter64 + ro in discards? yang\ counter64 + ro in errors? yang\ counter64 + ro in ipv4 pkts? yang\ counter64 + ro in ipv4 octets? yang\ counter64 + ro in ipv6 pkts? yang\ counter64 + ro in ipv6 octets? yang\ counter64 + ro out octets? yang\ counter64 + ro out unicast pkts? yang\ counter64 + ro out broadcast pkts? yang\ counter64 + ro out multicast pkts? yang\ counter64 + ro out discards? yang\ counter64 + ro out errors? yang\ counter64 + ro out ipv4 octets? yang\ counter64 + ro out ipv6 octets? yang\ counter64 rpcs + x clear counters interface \| + ro output \| + ro data? string + x show counters interface \| + w input \| | + w name? string \| | + w errors only? boolean \| | + w rates only? boolean \| | + w raw stats? boolean \| | + w period? uint8 \| | + w all? boolean \| | + w detail? boolean \| | + w json? boolean \| + ro output \| + ro data? \<anydata> + x clear vlan membership \| + w input \| + w interface string + x clear router interface \| + w input \| + w interface string + x show interface summary \| + ro output \| + ro data? \<anydata> + x show ip interface \| + ro output \| + ro data? \<anydata> + x show ipv6 interface \| + ro output \| + ro data? \<anydata> + x show interface urpf \| + ro output \| + ro data? \<anydata> + x config port group \| + w input \| + w interfaces interface ids \| + w operation? rpc operation type \| + w admin status? boolean \| + w ethernet config \| | + w startup delay? uint16 \| | + w port speed? identityref \| | + w auto negotiate? boolean \| + w vlan group config \| | + w vlan ranges? vlan range \| | + w tagging mode? enumeration \| + w lldp \| | + w vid? uint32 \| | + w vlan type? enumeration \| | + w priority? uint32 \| | + w dscp? uint32 \| + w monitor link \| | + w name? string \| | + w mode enumeration \| + w poe \| | + w enable mode? enumeration \| | + w delay? uint16 \| | + w priority? enumeration \| | + w max power? enumeration \| | + w legacy detect? boolean \| | + w power off time range? > /time range\ time ranges/time range/name \| + w qos map \| + w dscp tc map name? string \| + w dot1p tc map name? string \| + w mpls exp tc map name? string \| + w tc dscp map name? string \| + w tc dot1p map name? string \| + w tc mpls exp map name? string + x config lag group \| + w input \| + w lags? interface ids \| + w operation? rpc operation type \| + w vlan group config \| + w vlan ranges? vlan range \| + w tagging mode? enumeration + x show interface errdown \| + ro output \| + ro data \| + ro errdown info \[interface] \| + ro interface string \| + ro state? string + x show interface port \| + w input \| | + w port union \| + ro output \| + ro data? \<anydata> + x show sub interface + w input \| + w interface? string + ro output + ro data? \<anydata> resources resources resource list resource list path access /interfaces read write /interfaces/interface read write /interfaces/interface/name read write /interfaces/interface/description read write /interfaces/interface/admin status read write /interfaces/interface/interface mode read write /interfaces/interface/oper status read only /interfaces/interface/error down status read only /interfaces/interface/error down reason read only /interfaces/interface/mac address read write /interfaces/interface/mtu read write /interfaces/interface/vrf read write /interfaces/interface/tpid read write /interfaces/interface/urpf mode read write /interfaces/interface/pbr policy read write /interfaces/interface/statistics read only /interfaces/interface/statistics/in octets read only /interfaces/interface/statistics/in unicast pkts read only /interfaces/interface/statistics/in broadcast pkts read only /interfaces/interface/statistics/in multicast pkts read only /interfaces/interface/statistics/in discards read only /interfaces/interface/statistics/in errors read only /interfaces/interface/statistics/in ipv4 pkts read only /interfaces/interface/statistics/in ipv4 octets read only /interfaces/interface/statistics/in ipv6 pkts read only /interfaces/interface/statistics/in ipv6 octets read only /interfaces/interface/statistics/out octets read only /interfaces/interface/statistics/out unicast pkts read only /interfaces/interface/statistics/out broadcast pkts read only /interfaces/interface/statistics/out multicast pkts read only /interfaces/interface/statistics/out discards read only /interfaces/interface/statistics/out errors read only /interfaces/interface/statistics/out ipv4 octets read only /interfaces/interface/statistics/out ipv6 octets read only detailed nodes detailed nodes /interfaces /interfaces path /interfaces node type container description interface parameters access read write /interfaces/interface /interfaces/interface path /interfaces/interface node type list description the list of interfaces on the device access read write /interfaces/interface/name /interfaces/interface/name path /interfaces/interface/name node type leaf description the name of the interface access read write data type \<yang type union> /interfaces/interface/description /interfaces/interface/description path /interfaces/interface/description node type leaf description a textual description of the interface access read write data type \<yang type description type> constraints multiple constraints when condition /name\[starts with(text(), 'ethernet')] or /name\[starts with(text(), 'eth')] or /name\[starts with(text(), 'po')] or /name\[starts with(text(), 'portchannel')] string with length 0 to 255 /interfaces/interface/admin status /interfaces/interface/admin status path /interfaces/interface/admin status node type leaf description this leaf contains the configured, desired state of the interface access read write data type \<yang type boolean> constraints valid in \[true, false] /interfaces/interface/interface mode /interfaces/interface/interface mode path /interfaces/interface/interface mode node type leaf description set the interface to access, trunk, none mode vlan and ip interface configuration may be automatically deleted after changing this field access read write data type \<yang type enumeration> constraints multiple constraints when condition /name\[starts with(text(), 'ethernet')] or /name\[starts with(text(), 'portchannel')] or /name\[starts with(text(), 'vlan')] enumeration with options routed trunk none /interfaces/interface/oper status /interfaces/interface/oper status path /interfaces/interface/oper status node type leaf description the current operational state of the interface access read only data type \<yang type boolean> constraints valid in \[true, false] /interfaces/interface/error down status /interfaces/interface/error down status path /interfaces/interface/error down status node type leaf description the current error down state of the interface access read only data type \<yang type boolean> constraints valid in \[true, false] /interfaces/interface/error down reason /interfaces/interface/error down reason path /interfaces/interface/error down reason node type leaf description the current reason for error down state of the interface access read only data type \<yang type string> /interfaces/interface/mac address /interfaces/interface/mac address path /interfaces/interface/mac address node type leaf description 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 access read write data type \<yang type mac address> constraints multiple constraints when condition /name\[starts with(text(), 'eth')] or /name\[starts with(text(), 'po')] or /name\[starts with(text(), 'vlan')] the mac address type represents an ieee 802 mac address the canonical representation uses lowercase characters in the value set and its semantics, this type is equivalent to the macaddress textual convention of the smiv2 /interfaces/interface/mtu /interfaces/interface/mtu path /interfaces/interface/mtu node type leaf description 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 access read write data type \<yang type mtu type> constraints multiple constraints when condition /name\[starts with(text(), 'eth')] or /name\[starts with(text(), 'po')] or /name\[starts with(text(), 'vlan')] valid range 1312 to 10218 /interfaces/interface/vrf /interfaces/interface/vrf path /interfaces/interface/vrf node type leaf description set interface vrf access read write data type \<yang type vrf ref> constraints leafref pointing to asternos vrf\ vrf ref /interfaces/interface/tpid /interfaces/interface/tpid path /interfaces/interface/tpid node type leaf description set the tpid value for the interface the default is 0x8100 access read write data type \<yang type string> constraints when condition /name\[starts with(text(), 'ethernet')] /interfaces/interface/urpf mode /interfaces/interface/urpf mode path /interfaces/interface/urpf mode node type leaf description the urpf in strict mode requires packet source address to lpm some route in fib, and next hop of this route must be interface packet was received on the urpf in loose mode requires packet source address to lpm some route in fib this leaf is irrelevalnt and should be ignored if urpf is not enabled access read write data type \<yang type enumeration> constraints multiple constraints when condition /name\[starts with(text(), 'ethernet')] or /name\[starts with(text(), 'portchannel')] or /name\[starts with(text(), 'vlan')] enumeration with options disable loose strict /interfaces/interface/pbr policy /interfaces/interface/pbr policy path /interfaces/interface/pbr policy node type leaf description name of the pbr map to apply only support in ethernet and portchannel, not support sub interface access read write data type \<yang type string> /interfaces/interface/statistics /interfaces/interface/statistics path /interfaces/interface/statistics node type container description a collection of interface related statistics objects access read only /interfaces/interface/statistics/in octets /interfaces/interface/statistics/in octets path /interfaces/interface/statistics/in octets node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in unicast pkts /interfaces/interface/statistics/in unicast pkts path /interfaces/interface/statistics/in unicast pkts node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in broadcast pkts /interfaces/interface/statistics/in broadcast pkts path /interfaces/interface/statistics/in broadcast pkts node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in multicast pkts /interfaces/interface/statistics/in multicast pkts path /interfaces/interface/statistics/in multicast pkts node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in discards /interfaces/interface/statistics/in discards path /interfaces/interface/statistics/in discards node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in errors /interfaces/interface/statistics/in errors path /interfaces/interface/statistics/in errors node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in ipv4 pkts /interfaces/interface/statistics/in ipv4 pkts path /interfaces/interface/statistics/in ipv4 pkts node type leaf description the total number of input ipv4 datagrams received 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in ipv4 octets /interfaces/interface/statistics/in ipv4 octets path /interfaces/interface/statistics/in ipv4 octets node type leaf description the total number of octets received in input ipv4 datagrams 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in ipv6 pkts /interfaces/interface/statistics/in ipv6 pkts path /interfaces/interface/statistics/in ipv6 pkts node type leaf description the total number of input ipv6 datagrams received 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/in ipv6 octets /interfaces/interface/statistics/in ipv6 octets path /interfaces/interface/statistics/in ipv6 octets node type leaf description the total number of octets received in input ipv6 datagrams 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out octets /interfaces/interface/statistics/out octets path /interfaces/interface/statistics/out octets node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out unicast pkts /interfaces/interface/statistics/out unicast pkts path /interfaces/interface/statistics/out unicast pkts node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out broadcast pkts /interfaces/interface/statistics/out broadcast pkts path /interfaces/interface/statistics/out broadcast pkts node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out multicast pkts /interfaces/interface/statistics/out multicast pkts path /interfaces/interface/statistics/out multicast pkts node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out discards /interfaces/interface/statistics/out discards path /interfaces/interface/statistics/out discards node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out errors /interfaces/interface/statistics/out errors path /interfaces/interface/statistics/out errors node type leaf description 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out ipv4 octets /interfaces/interface/statistics/out ipv4 octets path /interfaces/interface/statistics/out ipv4 octets node type leaf description the total number of octets in output ipv4 datagrams 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' access read only data type \<yang type counter64> /interfaces/interface/statistics/out ipv6 octets /interfaces/interface/statistics/out ipv6 octets path /interfaces/interface/statistics/out ipv6 octets node type leaf description the total number of octets in output ipv6 datagrams 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' access read only data type \<yang type counter64>
