NETCONF Configuration Guide
YANG API Reference
static-route
52 min
module description 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 description no description available 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 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 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 description no description available access read write mandatory yes /static routes/static route/nexthops/nexthop/blackhole path /static routes/static route/nexthops/nexthop/blackhole node type choice case description no description available 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 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 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 constraints valid range /static routes/static route/nexthops/nexthop/non blackhole path /static routes/static route/nexthops/nexthop/non blackhole node type choice case description no description available 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 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 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 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 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 constraints valid range /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 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 constraints valid range /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 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 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 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 constraints valid range /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 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 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 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 constraints valid range /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 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 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 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 constraints valid range /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 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 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 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 constraints valid range rpcs show ip route path access /show ip route/output read write /show ip route/output/data read write /show ip route/output path /show ip route/output node type container description no description available access read write /show ip route/output/data path /show ip route/output/data node type anydata description show ipv4 routes access read write show ipv6 route path access /show ipv6 route/output read write /show ipv6 route/output/data read write /show ipv6 route/output path /show ipv6 route/output node type container description no description available access read write /show ipv6 route/output/data path /show ipv6 route/output/data node type anydata description show ipv6 routes access read write
