Skip to content
AsterNOS
Ask AI

ip

AsterNOS YANG Model for IP.

module: asternos-ip


  augment /if:interfaces/if:interface:
    +--rw ipv4
    |  +--rw address* [ip-prefix]
    |  |  +--rw ip-prefix    inet:ip-prefix
    |  +--rw neighbor* [ip]
    |     +--rw ip             inet:ipv4-address-no-zone
    |     +--rw mac-address    yang:mac-address
    |     +--ro origin?        neighbor-origin
    +--rw ipv6
       +--rw address* [ip-prefix]
       |  +--rw ip-prefix    inet:ip-prefix
       +--rw neighbor* [ip]
       |  +--rw ip             inet:ipv6-address-no-zone
       |  +--rw mac-address    yang:mac-address
       |  +--ro origin?        neighbor-origin
       |  +--ro is-router?     empty
       |  +--ro state?         enumeration
       +--rw router-advertisement
          +--rw managed-flag?        boolean
          +--rw other-config-flag?   boolean
          +--rw link-mtu?            cmn:mtu-type
          +--rw on-link-flag?        boolean
          +--rw autonomous-flag?     boolean
          +--rw prefixes* [prefix]
          |  +--rw prefix    inet:ipv6-prefix
          +--rw rdnsses* [rdnss]
          |  +--rw rdnss    inet:ipv6-address-no-zone
          +--rw routes* [route]
             +--rw route        inet:ipv6-prefix
             +--rw preferred?   enumeration


  rpcs:
    +---x show-ipv4-neighbor-summary
    |  +--ro output
    |     +--ro data?   <anydata>
    +---x show-ipv6-neighbor-summary
       +---w input
       |  +---w ip?          inet:ipv6-address-no-zone
       |  +---w interface?   union
       +--ro output
          +--ro data?   <anydata>

Resources

Section titled “Resources”

Resource List

Section titled “Resource List”
PathAccess
/?/interfaces/interface/ipv4Read-Write
/?/interfaces/interface/ipv4/addressRead-Write
/?/interfaces/interface/ipv4/address/ip-prefixRead-Write
/?/interfaces/interface/ipv4/neighborRead-Write
/?/interfaces/interface/ipv4/neighbor/ipRead-Write
/?/interfaces/interface/ipv4/neighbor/mac-addressRead-Write
/?/interfaces/interface/ipv4/neighbor/originRead-Only
/?/interfaces/interface/ipv6Read-Write
/?/interfaces/interface/ipv6/addressRead-Write
/?/interfaces/interface/ipv6/address/ip-prefixRead-Write
/?/interfaces/interface/ipv6/neighborRead-Write
/?/interfaces/interface/ipv6/neighbor/ipRead-Write
/?/interfaces/interface/ipv6/neighbor/mac-addressRead-Write
/?/interfaces/interface/ipv6/neighbor/originRead-Only
/?/interfaces/interface/ipv6/neighbor/is-routerRead-Only
/?/interfaces/interface/ipv6/neighbor/stateRead-Only
/?/interfaces/interface/ipv6/router-advertisementRead-Write
/?/interfaces/interface/ipv6/router-advertisement/managed-flagRead-Write
/?/interfaces/interface/ipv6/router-advertisement/other-config-flagRead-Write
/?/interfaces/interface/ipv6/router-advertisement/link-mtuRead-Write
/?/interfaces/interface/ipv6/router-advertisement/on-link-flagRead-Write
/?/interfaces/interface/ipv6/router-advertisement/autonomous-flagRead-Write
/?/interfaces/interface/ipv6/router-advertisement/prefixesRead-Write
/?/interfaces/interface/ipv6/router-advertisement/prefixes/prefixRead-Write
/?/interfaces/interface/ipv6/router-advertisement/rdnssesRead-Write
/?/interfaces/interface/ipv6/router-advertisement/rdnsses/rdnssRead-Write
/?/interfaces/interface/ipv6/router-advertisement/routesRead-Write
/?/interfaces/interface/ipv6/router-advertisement/routes/routeRead-Write
/?/interfaces/interface/ipv6/router-advertisement/routes/preferredRead-Write

Detailed Nodes

Section titled “Detailed Nodes”

/?/interfaces/interface/ipv4

Section titled “/?/interfaces/interface/ipv4”

Path

/?/interfaces/interface/ipv4

Node Type

container

Description

Parameters for the IPv4 address family.

Access

Read-Write

/?/interfaces/interface/ipv4/address

Section titled “/?/interfaces/interface/ipv4/address”

Path

/?/interfaces/interface/ipv4/address

Node Type

list

Description

The list of IPv4 addresses on the interface.

Access

Read-Write

/?/interfaces/interface/ipv4/address/ip-prefix

Section titled “/?/interfaces/interface/ipv4/address/ip-prefix”

Path

/?/interfaces/interface/ipv4/address/ip-prefix

Node Type

leaf

Access

Read-Write

Data Type

Constraints

Multiple constraints:

  • The ipv6-prefix type represents an IPv6 prefix.

The prefix length is given by the number following the slash character and must be less than or equal to 128.

A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

The canonical format of an IPv6 prefix has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Furthermore, the IPv6 address is represented as defined in Section 4 of RFC 5952.

The definition of ipv6-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 2001:db8::1/64 must be accepted as a valid value but it will be converted into the canonical format 2001:db8::/64.

  • The ipv4-prefix type represents an IPv4 prefix.

The prefix length is given by the number following the slash character and must be less than or equal to 32.

A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

The canonical format of an IPv4 prefix has all bits of the IPv4 address set to zero that are not part of the

IPv4 prefix.

The definition of ipv4-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 192.0.2.1/24 must be accepted as a valid value but it will be converted into the canonical format 192.0.2.0/24.

  • Must condition: contains(current(), ’.’)

/?/interfaces/interface/ipv4/neighbor

Section titled “/?/interfaces/interface/ipv4/neighbor”

Path

/?/interfaces/interface/ipv4/neighbor

Node Type

list

Description

A list of mappings from IPv4 addresses to link-layer addresses.

Entries in this list in the intended configuration are used as static entries in the ARP Cache.

In the operational state, this list represents the ARP

Cache.

Access

Read-Write

/?/interfaces/interface/ipv4/neighbor/ip

Section titled “/?/interfaces/interface/ipv4/neighbor/ip”

Path

/?/interfaces/interface/ipv4/neighbor/ip

Node Type

leaf

Description

The IPv4 address of the neighbor node.

Access

Read-Write

Data Type

Constraints

An IPv4 address without a zone index. This type, derived from the type ipv4-address, may be used in situations where the zone is known from the context and no zone index is needed.

/?/interfaces/interface/ipv4/neighbor/mac-address

Section titled “/?/interfaces/interface/ipv4/neighbor/mac-address”

Path

/?/interfaces/interface/ipv4/neighbor/mac-address

Node Type

leaf

Description

The link-layer address of the neighbor node.

Access

Read-Write

Data Type

Constraints

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.

Mandatory

Yes

/?/interfaces/interface/ipv4/neighbor/origin

Section titled “/?/interfaces/interface/ipv4/neighbor/origin”

Path

/?/interfaces/interface/ipv4/neighbor/origin

Node Type

leaf

Description

The origin of this neighbor entry.

Access

Read-Only

Data Type

Constraints

Enumeration with options:

  • other
  • static
  • dynamic

/?/interfaces/interface/ipv6

Section titled “/?/interfaces/interface/ipv6”

Path

/?/interfaces/interface/ipv6

Node Type

container

Description

Parameters for the IPv6 address family.

Access

Read-Write

/?/interfaces/interface/ipv6/address

Section titled “/?/interfaces/interface/ipv6/address”

Path

/?/interfaces/interface/ipv6/address

Node Type

list

Description

The list of IPv6 addresses on the interface.

Access

Read-Write

/?/interfaces/interface/ipv6/address/ip-prefix

Section titled “/?/interfaces/interface/ipv6/address/ip-prefix”

Path

/?/interfaces/interface/ipv6/address/ip-prefix

Node Type

leaf

Access

Read-Write

Data Type

Constraints

Multiple constraints:

  • The ipv6-prefix type represents an IPv6 prefix.

The prefix length is given by the number following the slash character and must be less than or equal to 128.

A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

The canonical format of an IPv6 prefix has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Furthermore, the IPv6 address is represented as defined in Section 4 of RFC 5952.

The definition of ipv6-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 2001:db8::1/64 must be accepted as a valid value but it will be converted into the canonical format 2001:db8::/64.

  • Must condition: contains(current(), ’:’)
  • The ipv4-prefix type represents an IPv4 prefix.

The prefix length is given by the number following the slash character and must be less than or equal to 32.

A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

The canonical format of an IPv4 prefix has all bits of the IPv4 address set to zero that are not part of the

IPv4 prefix.

The definition of ipv4-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 192.0.2.1/24 must be accepted as a valid value but it will be converted into the canonical format 192.0.2.0/24.

/?/interfaces/interface/ipv6/neighbor

Section titled “/?/interfaces/interface/ipv6/neighbor”

Path

/?/interfaces/interface/ipv6/neighbor

Node Type

list

Description

A list of mappings from IPv6 addresses to link-layer addresses.

Entries in this list in the intended configuration are used as static entries in the Neighbor Cache.

In the operational state, this list represents the

Neighbor Cache.

Access

Read-Write

/?/interfaces/interface/ipv6/neighbor/ip

Section titled “/?/interfaces/interface/ipv6/neighbor/ip”

Path

/?/interfaces/interface/ipv6/neighbor/ip

Node Type

leaf

Description

The IPv6 address of the neighbor node.

Access

Read-Write

Data Type

Constraints

An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.

/?/interfaces/interface/ipv6/neighbor/mac-address

Section titled “/?/interfaces/interface/ipv6/neighbor/mac-address”

Path

/?/interfaces/interface/ipv6/neighbor/mac-address

Node Type

leaf

Description

The link-layer address of the neighbor node.

In the operational state, if the neighbor’s ‘state’ leaf is ‘incomplete’, this leaf is not instantiated.

Access

Read-Write

Data Type

Constraints

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.

Mandatory

Yes

/?/interfaces/interface/ipv6/neighbor/origin

Section titled “/?/interfaces/interface/ipv6/neighbor/origin”

Path

/?/interfaces/interface/ipv6/neighbor/origin

Node Type

leaf

Description

The origin of this neighbor entry.

Access

Read-Only

Data Type

Constraints

Enumeration with options:

  • other
  • static
  • dynamic

/?/interfaces/interface/ipv6/neighbor/is-router

Section titled “/?/interfaces/interface/ipv6/neighbor/is-router”

Path

/?/interfaces/interface/ipv6/neighbor/is-router

Node Type

leaf

Description

Indicates that the neighbor node acts as a router.

Access

Read-Only

Data Type

Constraints

Empty type

/?/interfaces/interface/ipv6/neighbor/state

Section titled “/?/interfaces/interface/ipv6/neighbor/state”

Path

/?/interfaces/interface/ipv6/neighbor/state

Node Type

leaf

Description

The Neighbor Unreachability Detection state of this entry.

Access

Read-Only

Data Type

Constraints

Enumeration with options:

  • incomplete
  • reachable
  • stale
  • delay
  • probe

/?/interfaces/interface/ipv6/router-advertisement

Section titled “/?/interfaces/interface/ipv6/router-advertisement”

Path

/?/interfaces/interface/ipv6/router-advertisement

Node Type

container

Description

Support for IPv6 Router Advertisements.

Access

Read-Write

Constraints

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

/?/interfaces/interface/ipv6/router-advertisement/managed-flag

Section titled “/?/interfaces/interface/ipv6/router-advertisement/managed-flag”

Path

/?/interfaces/interface/ipv6/router-advertisement/managed-flag

Node Type

leaf

Description

The value to be placed in the ‘Managed address configuration’ flag field in the Router

Advertisement.

Access

Read-Write

Data Type

Constraints

Valid in [true, false]

/?/interfaces/interface/ipv6/router-advertisement/other-config-flag

Section titled “/?/interfaces/interface/ipv6/router-advertisement/other-config-flag”

Path

/?/interfaces/interface/ipv6/router-advertisement/other-config-flag

Node Type

leaf

Description

The value to be placed in the ‘Other configuration’ flag field in the Router Advertisement.

Access

Read-Write

Data Type

Constraints

Valid in [true, false]

Section titled “/?/interfaces/interface/ipv6/router-advertisement/link-mtu”

Path

/?/interfaces/interface/ipv6/router-advertisement/link-mtu

Node Type

leaf

Description

The value to be placed in MTU options sent by the router. A value of zero indicates that no MTU options are sent.

Access

Read-Write

Data Type

Constraints

Valid range: 1312 to 9216

Section titled “/?/interfaces/interface/ipv6/router-advertisement/on-link-flag”

Path

/?/interfaces/interface/ipv6/router-advertisement/on-link-flag

Node Type

leaf

Description

The value to be placed in the on-link flag (‘L-bit’) field in the Prefix Information option.

Access

Read-Write

Data Type

Constraints

Valid in [true, false]

/?/interfaces/interface/ipv6/router-advertisement/autonomous-flag

Section titled “/?/interfaces/interface/ipv6/router-advertisement/autonomous-flag”

Path

/?/interfaces/interface/ipv6/router-advertisement/autonomous-flag

Node Type

leaf

Description

The value to be placed in the Autonomous Flag field in the Prefix Information option.

Access

Read-Write

Data Type

Constraints

Valid in [true, false]

/?/interfaces/interface/ipv6/router-advertisement/prefixes

Section titled “/?/interfaces/interface/ipv6/router-advertisement/prefixes”

Path

/?/interfaces/interface/ipv6/router-advertisement/prefixes

Node Type

list

Description

Support for an advertised prefix entry.

Access

Read-Write

/?/interfaces/interface/ipv6/router-advertisement/prefixes/prefix

Section titled “/?/interfaces/interface/ipv6/router-advertisement/prefixes/prefix”

Path

/?/interfaces/interface/ipv6/router-advertisement/prefixes/prefix

Node Type

leaf

Description

IPv6 address prefix.

Access

Read-Write

Data Type

Constraints

The ipv6-prefix type represents an IPv6 prefix.

The prefix length is given by the number following the slash character and must be less than or equal to 128.

A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

The canonical format of an IPv6 prefix has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Furthermore, the IPv6 address is represented as defined in Section 4 of RFC 5952.

The definition of ipv6-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 2001:db8::1/64 must be accepted as a valid value but it will be converted into the canonical format 2001:db8::/64.

/?/interfaces/interface/ipv6/router-advertisement/rdnsses

Section titled “/?/interfaces/interface/ipv6/router-advertisement/rdnsses”

Path

/?/interfaces/interface/ipv6/router-advertisement/rdnsses

Node Type

list

Description

Support for an advertised prefix entry.

Access

Read-Write

/?/interfaces/interface/ipv6/router-advertisement/rdnsses/rdnss

Section titled “/?/interfaces/interface/ipv6/router-advertisement/rdnsses/rdnss”

Path

/?/interfaces/interface/ipv6/router-advertisement/rdnsses/rdnss

Node Type

leaf

Description

IPv6 address.

Access

Read-Write

Data Type

Constraints

An IPv6 address without a zone index. This type, derived from the type ipv6-address, may be used in situations where the zone is known from the context and no zone index is needed.

/?/interfaces/interface/ipv6/router-advertisement/routes

Section titled “/?/interfaces/interface/ipv6/router-advertisement/routes”

Path

/?/interfaces/interface/ipv6/router-advertisement/routes

Node Type

list

Description

Support for an advertised prefix entry.

Access

Read-Write

/?/interfaces/interface/ipv6/router-advertisement/routes/route

Section titled “/?/interfaces/interface/ipv6/router-advertisement/routes/route”

Path

/?/interfaces/interface/ipv6/router-advertisement/routes/route

Node Type

leaf

Description

IPv6 address prefix.

Access

Read-Write

Data Type

Constraints

The ipv6-prefix type represents an IPv6 prefix.

The prefix length is given by the number following the slash character and must be less than or equal to 128.

A prefix length value of n corresponds to an IP address mask that has n contiguous 1-bits from the most significant bit (MSB) and all other bits set to 0.

The canonical format of an IPv6 prefix has all bits of the IPv6 address set to zero that are not part of the IPv6 prefix. Furthermore, the IPv6 address is represented as defined in Section 4 of RFC 5952.

The definition of ipv6-prefix does not require that bits, which are not part of the prefix, are set to zero. However, implementations have to return values in canonical format, which requires non-prefix bits to be set to zero. This means that 2001:db8::1/64 must be accepted as a valid value but it will be converted into the canonical format 2001:db8::/64.

/?/interfaces/interface/ipv6/router-advertisement/routes/preferred

Section titled “/?/interfaces/interface/ipv6/router-advertisement/routes/preferred”

Path

/?/interfaces/interface/ipv6/router-advertisement/routes/preferred

Node Type

leaf

Description

The value to be placed in the Route Preference in the Route Information option.

The preference associated with the default router, as either ‘low’, ‘medium’, or ‘high’.

Access

Read-Write

Data Type

Constraints

Enumeration with options:

  • low
  • medium
  • high