interfaces

AsterNOS YANG Model for interfaces.

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

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

/interfaces

Path

/interfaces

Node Type

container

Description

Interface parameters.

Access

Read-Write

/interfaces/interface

Path

/interfaces/interface

Node Type

list

Description

The list of interfaces on the device.

Access

Read-Write

/interfaces/interface/name

Path

/interfaces/interface/name

Node Type

leaf

Description

The name of the interface.

Access

Read-Write

Data Type

/interfaces/interface/description

Path

/interfaces/interface/description

Node Type

leaf

Description

A textual description of the interface.

Access

Read-Write

Data 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

Path

/interfaces/interface/admin-status

Node Type

leaf

Description

This leaf contains the configured, desired state of the interface.

Access

Read-Write

Data Type

Constraints

Valid in [true, false]

/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

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

Path

/interfaces/interface/oper-status

Node Type

leaf

Description

The current operational state of the interface.

Access

Read-Only

Data Type

Constraints

Valid in [true, false]

/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

Constraints

Valid in [true, false]

/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

/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

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

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

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

Path

/interfaces/interface/vrf

Node Type

leaf

Description

Set interface VRF.

Access

Read-Write

Data Type

Constraints

LeafRef pointing to: asternos-vrf:vrf-ref

/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

Constraints

When condition: ../name[starts-with(text(), ‘Ethernet’)]

/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

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

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

/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

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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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

/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