static-route

AsterNOS Model for static routes

YANG Tree Diagram

module: asternos-static-route
  +--rw static-routes
     +--rw static-route* [vrf prefix]
        +--rw vrf         vrf:vrf-ref
        +--rw prefix      inet:ip-prefix
        +--rw nexthops
           +--rw (nexthop)
              +--:(blackhole)
              |  +--rw blackhole-nexthop
              |     +--rw bh-type     blackhole-type
              |     +--rw distance?   uint8
              |     +--rw tag?        uint32
              +--:(non-blackhole)
                 +--rw ifindex-nexthops* [interface]
                 |  +--rw interface    if:interface-ref
                 |  +--rw bfd
                 |  |  +--rw enable?   boolean
                 |  |  +--rw mhop?     boolean
                 |  |  +--rw local?    inet:ip-address
                 |  +--rw track?       uint32
                 |  +--rw distance?    uint8
                 |  +--rw tag?         uint32
                 +--rw ip-nexthops* [nh-vrf gateway]
                 |  +--rw nh-vrf      vrf:vrf-ref
                 |  +--rw gateway     inet:ip-address-no-zone
                 |  +--rw distance?   uint8
                 |  +--rw tag?        uint32
                 |  +--rw bfd
                 |  |  +--rw enable?   boolean
                 |  |  +--rw mhop?     boolean
                 |  |  +--rw local?    inet:ip-address
                 |  +--rw track?      uint32
                 +--rw ip-ifindex-nexthops* [gateway interface]
                    +--rw gateway      inet:ip-address-no-zone
                    +--rw interface    if:interface-ref
                    +--rw distance?    uint8
                    +--rw tag?         uint32
                    +--rw bfd
                    |  +--rw enable?   boolean
                    |  +--rw mhop?     boolean
                    |  +--rw local?    inet:ip-address
                    +--rw track?       uint32

  rpcs:
    +---x show-ip-route
    |  +--ro output
    |     +--ro data?   <anydata>
    +---x show-ipv6-route
       +--ro output
          +--ro data?   <anydata>

Resources

Resource List

Path	Access
/static-routes	Read-Write
/static-routes/static-route	Read-Write
/static-routes/static-route/vrf	Read-Write
/static-routes/static-route/prefix	Read-Write
/static-routes/static-route/nexthops	Read-Write
/static-routes/static-route/nexthops/nexthop	Read-Write
/static-routes/static-route/nexthops/nexthop/blackhole	Read-Write
/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop	Read-Write
/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/bh-type	Read-Write
/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/distance	Read-Write
/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/tag	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/interface	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/enable	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/mhop	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/local	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/track	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/distance	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/tag	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/nh-vrf	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/gateway	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/distance	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/tag	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/enable	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/mhop	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/local	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/track	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/gateway	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/interface	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/distance	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/tag	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/enable	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/mhop	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/local	Read-Write
/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/track	Read-Write

Detailed Nodes

/static-routes

Path

/static-routes

Node Type

container

Access

Read-Write

/static-routes/static-route

Path

/static-routes/static-route

Node Type

list

Description

List of staticd IP routes.

Access

Read-Write

/static-routes/static-route/vrf

Path

/static-routes/static-route/vrf

Node Type

leaf

Description

VRF of staticd IP route.

Access

Read-Write

Data Type

<YANG type vrf-ref>

Constraints

LeafRef pointing to: asternos-vrf:vrf-ref

/static-routes/static-route/prefix

Path

/static-routes/static-route/prefix

Node Type

leaf

Description

IP prefix.

Access

Read-Write

Data Type

<YANG type ip-prefix>

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.

/static-routes/static-route/nexthops

Path

/static-routes/static-route/nexthops

Node Type

container

Description

FRR nexthop object.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop

Path

/static-routes/static-route/nexthops/nexthop

Node Type

choice

Access

Read-Write

Mandatory

Yes

/static-routes/static-route/nexthops/nexthop/blackhole

Path

/static-routes/static-route/nexthops/nexthop/blackhole

Node Type

choice-case

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop

Path

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop

Node Type

container

Description

For blackhole type nexthops, there is only one configurable.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/bh-type

Path

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/bh-type

Node Type

leaf

Description

A blackhole sub-type, if the nexthop is a blackhole type.

Access

Read-Write

Data Type

<YANG type blackhole-type>

Constraints

Enumeration with options:

• unspec
• null
• reject
• prohibited

Mandatory

Yes

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/distance

Path

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/distance

Node Type

leaf

Description

Admin distance associated with this route.

Access

Read-Write

Data Type

<YANG type uint8>

Constraints

Valid range: 1 to 255

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/tag

Path

/static-routes/static-route/nexthops/nexthop/blackhole/blackhole-nexthop/tag

Node Type

leaf

Description

Route tag

Access

Read-Write

Data Type

<YANG type uint32>

/static-routes/static-route/nexthops/nexthop/non-blackhole

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole

Node Type

choice-case

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops

Node Type

list

Description

A list of nexthop objects.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/interface

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/interface

Node Type

leaf

Description

The nexthop egress interface.

Access

Read-Write

Data Type

<YANG type interface-ref>

Constraints

LeafRef pointing to: asternos-interfaces:interface-ref

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd

Node Type

container

Description

FRR nexthop bfd object.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/enable

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/enable

Node Type

leaf

Description

Nexthop open bfd

Access

Read-Write

Data Type

<YANG type boolean>

Constraints

Valid in [true, false]

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/mhop

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/mhop

Node Type

leaf

Description

Open bfd multihop mode

Access

Read-Write

Data Type

<YANG type boolean>

Constraints

Valid in [true, false]

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/local

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/bfd/local

Node Type

leaf

Description

The bfd local-address.

Access

Read-Write

Data Type

<YANG type ip-address>

Constraints

Multiple constraints:

• The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign.

If a system uses zone names that are not represented in UTF-8, then an implementation needs to use some mechanism to transform the local name into UTF-8. The definition of such a mechanism is outside the scope of this document. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

• The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. If a system uses zone names that are not represented in UTF-8, then an implementation needs to use some mechanism to transform the local name into UTF-8. The definition of such a mechanism is outside the scope of this document.

The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/track

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/track

Node Type

leaf

Description

Route track

Access

Read-Write

Data Type

<YANG type uint32>

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/distance

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/distance

Node Type

leaf

Description

Admin distance associated with this route.

Access

Read-Write

Data Type

<YANG type uint8>

Constraints

Valid range: 1 to 255

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/tag

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ifindex-nexthops/tag

Node Type

leaf

Description

Route tag

Access

Read-Write

Data Type

<YANG type uint32>

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops

Node Type

list

Description

A list of nexthop objects of type ip4 or ip6.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/nh-vrf

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/nh-vrf

Node Type

leaf

Description

The nexthop vrf name, if different from the route.

Access

Read-Write

Data Type

<YANG type vrf-ref>

Constraints

LeafRef pointing to: asternos-vrf:vrf-ref

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/gateway

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/gateway

Node Type

leaf

Description

The nexthop gateway address.

Access

Read-Write

Data Type

<YANG type ip-address-no-zone>

Constraints

Multiple 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.
• 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.

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/distance

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/distance

Node Type

leaf

Description

Admin distance associated with this route.

Access

Read-Write

Data Type

<YANG type uint8>

Constraints

Valid range: 1 to 255

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/tag

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/tag

Node Type

leaf

Description

Route tag

Access

Read-Write

Data Type

<YANG type uint32>

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd

Node Type

container

Description

FRR nexthop bfd object.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/enable

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/enable

Node Type

leaf

Description

Nexthop open bfd

Access

Read-Write

Data Type

<YANG type boolean>

Constraints

Valid in [true, false]

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/mhop

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/mhop

Node Type

leaf

Description

Open bfd multihop mode

Access

Read-Write

Data Type

<YANG type boolean>

Constraints

Valid in [true, false]

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/local

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/bfd/local

Node Type

leaf

Description

The bfd local-address.

Access

Read-Write

Data Type

<YANG type ip-address>

Constraints

Multiple constraints:

• The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign.

If a system uses zone names that are not represented in UTF-8, then an implementation needs to use some mechanism to transform the local name into UTF-8. The definition of such a mechanism is outside the scope of this document. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

• The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. If a system uses zone names that are not represented in UTF-8, then an implementation needs to use some mechanism to transform the local name into UTF-8. The definition of such a mechanism is outside the scope of this document.

The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/track

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-nexthops/track

Node Type

leaf

Description

Route track

Access

Read-Write

Data Type

<YANG type uint32>

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops

Node Type

list

Description

A list of nexthop objects of type ip4-ifindex or ip6-ifindex.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/gateway

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/gateway

Node Type

leaf

Description

The nexthop gateway address.

Access

Read-Write

Data Type

<YANG type ip-address-no-zone>

Constraints

Multiple 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.
• 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.

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/interface

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/interface

Node Type

leaf

Description

The nexthop egress interface.

Access

Read-Write

Data Type

<YANG type interface-ref>

Constraints

LeafRef pointing to: asternos-interfaces:interface-ref

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/distance

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/distance

Node Type

leaf

Description

Admin distance associated with this route.

Access

Read-Write

Data Type

<YANG type uint8>

Constraints

Valid range: 1 to 255

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/tag

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/tag

Node Type

leaf

Description

Route tag

Access

Read-Write

Data Type

<YANG type uint32>

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd

Node Type

container

Description

FRR nexthop bfd object.

Access

Read-Write

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/enable

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/enable

Node Type

leaf

Description

Nexthop open bfd

Access

Read-Write

Data Type

<YANG type boolean>

Constraints

Valid in [true, false]

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/mhop

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/mhop

Node Type

leaf

Description

Open bfd multihop mode

Access

Read-Write

Data Type

<YANG type boolean>

Constraints

Valid in [true, false]

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/local

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/bfd/local

Node Type

leaf

Description

The bfd local-address.

Access

Read-Write

Data Type

<YANG type ip-address>

Constraints

Multiple constraints:

• The ipv6-address type represents an IPv6 address in full, mixed, shortened, and shortened-mixed notation. The IPv6 address may include a zone index, separated by a % sign.

If a system uses zone names that are not represented in UTF-8, then an implementation needs to use some mechanism to transform the local name into UTF-8. The definition of such a mechanism is outside the scope of this document. The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format of IPv6 addresses uses the textual representation defined in Section 4 of RFC 5952. The canonical format for the zone index is the numerical format as described in Section 11.2 of RFC 4007.

• The ipv4-address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. If a system uses zone names that are not represented in UTF-8, then an implementation needs to use some mechanism to transform the local name into UTF-8. The definition of such a mechanism is outside the scope of this document.

The zone index is used to disambiguate identical address values. For link-local addresses, the zone index will typically be the interface index number or the name of an interface. If the zone index is not present, the default zone of the device will be used. The canonical format for the zone index is the numerical format

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/track

Path

/static-routes/static-route/nexthops/nexthop/non-blackhole/ip-ifindex-nexthops/track

Node Type

leaf

Description

Route track

Access

Read-Write

Data Type

<YANG type uint32>