Skip to content

Routemap-Netconf

Routemap

Resources Summary

YANG Path	get/get-config	edit-config	rpc
/route-maps/{name}/{sequence-id}	Y	merge, replace, create, delete	—
/show-route-map-json	—	—	Y

Examples

Get Route-map on device

Request example via rpc get-config

<filter type="subtree">
  <top>
    <route-maps>
      <route-map/>
    </route-maps>
  </filter>

Reply example via rpc get-config

<data xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
  <top>
    <route-maps xmlns="http://asterfusion.com/ns/yang/asternos-route-map">
      <route-map>
        <name>test</name>
        <sequence-id>11</sequence-id>
        <action>permit</action>
        <match-condition>
          <as-path>65000:100</as-path>
          <alias>EXAMPLE_ALIAS</alias>
          <community>65000:100</community>
          <extended-community>RT:65000:100</extended-community>
          <large-community>65000:100:200</large-community>
          <local-preference>100</local-preference>
          <origin>igp</origin>
          <interface>Ethernet1</interface>
          <ipv4-prefix-list>EXAMPLE_IPV4_PREFIX_LIST</ipv4-prefix-list>
          <ipv4-prefix-len>24</ipv4-prefix-len>
          <ipv4-next-hop-address>192.168.1.1</ipv4-next-hop-address>
          <ipv4-next-hop-prefix-list>EXAMPLE_NEXT_HOP_PREFIX_LIST</ipv4-next-hop-prefix-list>
          <ipv4-next-hop-type>blackhole</ipv4-next-hop-type>
          <ipv4-next-hop-prefix-len>24</ipv4-next-hop-prefix-len>
          <ipv4-route-source-prefix-list>EXAMPLE_ROUTE_SOURCE_PREFIX_LIST</ipv4-route-source-prefix-list>
          <ipv6-prefix-list>EXAMPLE_IPV6_PREFIX_LIST</ipv6-prefix-list>
          <ipv6-prefix-len>64</ipv6-prefix-len>
          <ipv6-next-hop-address>2001:db8::1</ipv6-next-hop-address>
          <ipv6-next-hop-prefix-list>EXAMPLE_IPV6_NEXT_HOP_PREFIX_LIST</ipv6-next-hop-prefix-list>
          <ipv6-next-hop-type>blackhole</ipv6-next-hop-type>
          <peer-ipv4-address>192.168.1.2</peer-ipv4-address>
          <metric>100</metric>
          <tag>200</tag>
          <source-instance>1</source-instance>
          <source-protocol>bgp</source-protocol>
        </match-condition>
        <set-action>
          <aggregator-as-number>65000</aggregator-as-number>
          <aggregator-ip-address>192.168.1.1</aggregator-ip-address>
          <exclude-as>65001</exclude-as>
          <prepend-as>65000</prepend-as>
          <atomic-aggregate>true</atomic-aggregate>
          <community>65000:100</community>
          <delete-community-list>EXAMPLE_DELETE_COMMUNITY_LIST</delete-community-list>
          <distance>200</distance>
          <local-preference>150</local-preference>
          <origin>igp</origin>
          <originator-id>192.168.1.1</originator-id>
          <weight>100</weight>
          <bandwidth-value>1000</bandwidth-value>
          <bandwidth-non-transitive>true</bandwidth-non-transitive>
          <ipv4-next-hop-address>192.168.1.1</ipv4-next-hop-address>
          <ipv4-vpn-next-hop-address>192.168.1.1</ipv4-vpn-next-hop-address>
          <ipv6-forwarding-address>2001:db8::1</ipv6-forwarding-address>
          <ipv6-next-hop-global-address>2001:db8::1</ipv6-next-hop-global-address>
          <ipv6-next-hop-local-address>fe80::1</ipv6-next-hop-local-address>
          <ipv6-next-hop-prefer-global>true</ipv6-next-hop-prefer-global>
          <ipv6-next-hop-prefer-peer>true</ipv6-next-hop-prefer-peer>
          <ipv6-vpn-next-hop-address>2001:db8::1</ipv6-vpn-next-hop-address>
          <large-community>65000:100:200</large-community>
          <delete-large-community-list>EXAMPLE_DELETE_LARGE_COMMUNITY_LIST</delete-large-community-list>
          <metric-type>type-1</metric-type>
          <set-metric>100</set-metric>
          <ipv4-source-address>192.168.1.1</ipv4-source-address>
          <table>100</table>
          <tag>200</tag>
        </set-action>
        <on-match>
          <goto>20</goto>
        </on-match>
      </route-map>
    </route-maps>
  </data>

Create route-map

<config><top>
  <route-maps>
    <route-map operation="create">
      <name>test</name>
      <sequence-id>11</sequence-id>
      <action>permit</action>
      <match-condition>
        <as-path>65000:100</as-path>
        <alias>EXAMPLE_ALIAS</alias>
        <community>65000:100</community>
        <extended-community>RT:65000:100</extended-community>
        <large-community>65000:100:200</large-community>
        <local-preference>100</local-preference>
        <origin>igp</origin>
        <metric>100</metric>
        <tag>200</tag>
        <source-instance>1</source-instance>
        <source-protocol>bgp</source-protocol>
      </match-condition>
      <set-action>
        <aggregator-as-number>65000</aggregator-as-number>
        <aggregator-ip-address>192.168.1.1</aggregator-ip-address>
        <exclude-as>65001</exclude-as>
        <prepend-as>65000</prepend-as>
        <atomic-aggregate>true</atomic-aggregate>
        <community>65000:100</community>
        <delete-community-list>EXAMPLE_DELETE_COMMUNITY_LIST</delete-community-list>
        <distance>200</distance>
        <local-preference>150</local-preference>
        <origin>igp</origin>
        <originator-id>192.168.1.1</originator-id>
        <weight>100</weight>
        <ipv4-source-address>192.168.1.1</ipv4-source-address>
        <table>100</table>
        <tag>200</tag>
      </set-action>
      <on-match>
        <goto>20</goto>
      </on-match>
    </route-map>
  </route-maps>
</top></config>

Delete route-map

<config><top>
  <route-maps>
    <route-map operation="delete">
      <name>test</name>
      <sequence-id>11</sequence-id>
      <action>permit</action>
    </route-map>
  </route-maps>
</top></config>

Show route-map json

Request example via rpc get-config

<show-route-map-json/>

Reply example via rpc get-config

<rpc-reply xmlns="urn:ietf:params:xml:ns:netconf:base:1.0" message-id="urn:uuid:01d878ea-386f-4333-a085-f26be6234b5b">
  <data>
    <ZEBRA>
      <test>
        <invoked>0</invoked>
        <disabledOptimization>False</disabledOptimization>
        <processedChange>False</processedChange>
        <rules>
          <sequenceNumber>11</sequenceNumber>
          <type>permit</type>
          <invoked>0</invoked>
          <action>Exit routemap</action>
        </rules>
      </test>
    </ZEBRA>
    <OSPF>
      <test>
        <invoked>0</invoked>
        <disabledOptimization>False</disabledOptimization>
        <processedChange>False</processedChange>
        <rules>
          <sequenceNumber>11</sequenceNumber>
          <type>permit</type>
          <invoked>0</invoked>
          <action>Exit routemap</action>
        </rules>
      </test>
    </OSPF>
    <OSPF6>
      <test>
        <invoked>0</invoked>
        <disabledOptimization>False</disabledOptimization>
        <processedChange>False</processedChange>
        <rules>
          <sequenceNumber>11</sequenceNumber>
          <type>permit</type>
          <invoked>0</invoked>
          <action>Exit routemap</action>
        </rules>
      </test>
    </OSPF6>
    <BGP>
      <test>
        <invoked>0</invoked>
        <disabledOptimization>False</disabledOptimization>
        <processedChange>False</processedChange>
        <rules>
          <sequenceNumber>11</sequenceNumber>
          <type>permit</type>
          <invoked>0</invoked>
          <action>Exit routemap</action>
        </rules>
      </test>
    </BGP>
    <ISIS>
      <test>
        <invoked>0</invoked>
        <disabledOptimization>False</disabledOptimization>
        <processedChange>False</processedChange>
        <rules>
          <sequenceNumber>11</sequenceNumber>
          <type>permit</type>
          <invoked>0</invoked>
          <action>Exit routemap</action>
        </rules>
      </test>
    </ISIS>
  </data>
</rpc-reply>

Properties Descriptions

Route Maps

Tree Diagram

/workspaces/as-mgmt-doc/doc/resource/yang/asternos-route-map.yang:158: error: unexpected keyword "error-message"
/workspaces/as-mgmt-doc/doc/resource/yang/asternos-route-map.yang:159: error: unexpected keyword "error-app-tag"
module: asternos-route-map
  +--rw route-maps
     +--rw route-map* [name sequence-id]
        +--rw name               route-map-name
        +--rw sequence-id        route-map-sequence
        +--rw description?       string
        +--rw action             enumeration
        +--rw match-condition
        |  +--rw as-path?                         string
        |  +--rw alias?                           string
        |  +--rw community?                       string
        |  +--rw extended-community?              string
        |  +--rw large-community?                 string
        |  +--rw local-preference?                uint32
        |  +--rw origin?                          enumeration
        |  +--rw interface?                       union
        |  +--rw ipv4-prefix-list?                filter:prefix-list-name
        |  +--rw ipv4-prefix-len?                 uint8
        |  +--rw ipv4-next-hop-address?           inet:ipv4-address-no-zone
        |  +--rw ipv4-next-hop-prefix-list?       filter:prefix-list-name
        |  +--rw ipv4-next-hop-type?              enumeration
        |  +--rw ipv4-next-hop-prefix-len?        uint8
        |  +--rw ipv4-route-source-prefix-list?   filter:prefix-list-name
        |  +--rw ipv6-prefix-list?                filter:prefix-list-name
        |  +--rw ipv6-prefix-len?                 uint8
        |  +--rw ipv6-next-hop-address?           inet:ipv6-address-no-zone
        |  +--rw ipv6-next-hop-prefix-list?       filter:prefix-list-name
        |  +--rw ipv6-next-hop-type?              enumeration
        |  +--rw (peer-value)?
        |  |  +--:(peer-ipv4-address)
        |  |  |  +--rw peer-ipv4-address?         inet:ipv4-address-no-zone
        |  |  +--:(peer-ipv6-address)
        |  |  |  +--rw peer-ipv6-address?         inet:ipv6-address-no-zone
        |  |  +--:(peer-interface)
        |  |  |  +--rw peer-interface?            if:interface-ref
        |  |  +--:(peer-local)
        |  |     +--rw peer-local?                boolean
        |  +--rw metric?                          uint32
        |  +--rw tag?                             uint32
        |  +--rw source-instance?                 uint32
        |  +--rw source-protocol?                 protocol-types
        |  +--rw source-vrf?                      vrf:vrf-ref
        +--rw set-action
        |  +--rw aggregator-as-number                uint32
        |  +--rw aggregator-ip-address               inet:ipv4-address-no-zone
        |  +--rw exclude-as*                         uint32
        |  +--rw (prepend)?
        |  |  +--:(prepend-as)
        |  |  |  +--rw prepend-as*                   uint32
        |  |  +--:(prepend-last-as)
        |  |     +--rw prepend-last-as?              uint8
        |  +--rw atomic-aggregate?                   boolean
        |  +--rw community*                          string
        |  +--rw delete-community-list?              string
        |  +--rw distance?                           uint8
        |  +--rw local-preference?                   uint32
        |  +--rw origin?                             enumeration
        |  +--rw originator-id?                      inet:ipv4-address-no-zone
        |  +--rw weight?                             uint32
        |  +--rw (bandwidth)
        |  |  +--:(bandwidth)
        |  |  |  +--rw bandwidth-value?              uint16
        |  |  +--:(bandwidth-cumulative)
        |  |  |  +--rw bandwidth-cumulative?         boolean
        |  |  +--:(bandwidth-num-multipaths)
        |  |     +--rw bandwidth-num-multipaths?     boolean
        |  +--rw bandwidth-non-transitive?           boolean
        |  +--rw (next-hop)?
        |  |  +--:(ipv4-next-hop-address)
        |  |  |  +--rw ipv4-next-hop-address?        inet:ipv4-address-no-zone
        |  |  +--:(ipv4-next-hop-peer-address)
        |  |  |  +--rw ipv4-next-hop-peer-address?   boolean
        |  |  +--:(ipv4-next-hop-unchanged)
        |  |     +--rw ipv4-next-hop-unchanged?      boolean
        |  +--rw ipv4-vpn-next-hop-address?          inet:ipv4-address-no-zone
        |  +--rw ipv6-forwarding-address?            inet:ipv6-address-no-zone
        |  +--rw ipv6-next-hop-global-address?       inet:ipv6-address-no-zone
        |  +--rw ipv6-next-hop-local-address?        inet:ipv6-address-no-zone
        |  +--rw ipv6-next-hop-prefer-global?        boolean
        |  +--rw ipv6-next-hop-prefer-peer?          boolean
        |  +--rw ipv6-vpn-next-hop-address?          inet:ipv6-address-no-zone
        |  +--rw large-community*                    string
        |  +--rw delete-large-community-list?        string
        |  +--rw metric-type?                        enumeration
        |  +--rw (value)?
        |  |  +--:(set-metric)
        |  |  |  +--rw set-metric?                   uint32
        |  |  +--:(add-metric)
        |  |  |  +--rw add-metric?                   uint32
        |  |  +--:(use-round-trip-time)
        |  |  |  +--rw use-round-trip-time?          boolean
        |  |  +--:(add-round-trip-time)
        |  |  |  +--rw add-round-trip-time?          boolean
        |  |  +--:(subtract-round-trip-time)
        |  |     +--rw subtract-round-trip-time?     boolean
        |  +--rw (source-address)?
        |  |  +--:(ipv4-source-address)
        |  |  |  +--rw ipv4-source-address?          inet:ipv4-address-no-zone
        |  |  +--:(ipv6-source-address)
        |  |     +--rw ipv6-source-address?          inet:ipv6-address-no-zone
        |  +--rw table?                              uint32
        |  +--rw tag?                                uint32
        +--rw on-match
           +--rw goto?   uint32
           +--rw next?   boolean

Table of Properties

Name	Required	Type/Range	Description
route-maps	M		Path-only node, has no configurable value.
route-map	M		Path-only node, has no configurable value. Route map instance.
name	O	string (length 1..64)	Route map instance name.
sequence-id	O	1..65535	Route map instance priority (low number means higher priority).
description	O	string	Route map description.
action	M	”permit" "deny”	Route map actions: permit (executes action), deny (quits evaluation).
match-condition	M		Path-only node, has no configurable value. Route map match conditions.
as-path	O	string	Match BGP AS path list.
alias	O	string	Match BGP community alias name.
community	O	string	Match BGP community list. Value in (1-99) For Standard Community-list number or Value in (100-500) Expanded Communitly-list number or Value of Community-list name
extended-community	O	string	Match BGP/VPN extended community list. Value in (1-99) For Standard Extended Community-list number or Value in (100-500) Expanded Extended Communitly-list number or Value of Extended Community-list name
large-community	O	string	Match BGP large community list. Value in (1-99) For Standard Large Community-list number or Value in (100-500) Expanded Large Communitly-list number or Value of Large Community-list name
local-preference	O	0..4294967295	Match BGP local-preference of route.
origin	O	”egp" "igp" "incomplete”	Match BGP origin code.
interface	O	→ asternos-interfaces:interface-ref	Match first hop interface of route.
ipv4-prefix-list	O	filter:prefix-list-name	Match an IPv4 prefix-list.
ipv4-prefix-len	O	0..32	Match prefix length of IP address.
ipv4-next-hop-address	O	inet:ipv4-address-no-zone	Match an IPv4 next-hop address.
ipv4-next-hop-prefix-list	O	filter:prefix-list-name	Match an IPv4 next-hop prefix list.
ipv4-next-hop-type	O	”blackhole”	Match an IPv4 next-hop type.
ipv4-next-hop-prefix-len	O	0..32	Match IPv4 prefixlen of given nexthop.
ipv4-route-source-prefix-list	O	filter:prefix-list-name	Match advertising source IPv4 address of route.
ipv6-prefix-list	O	filter:prefix-list-name	Match an IPv6 prefix-list.
ipv6-prefix-len	O	0..128	Match prefix length of IPv6 address.
ipv6-next-hop-address	O	inet:ipv6-address-no-zone	Match an IPv6 next-hop address.
ipv6-next-hop-prefix-list	O	filter:prefix-list-name	Match an IPv6 next-hop prefix list.
ipv6-next-hop-type	O	”blackhole”	Match an IPv6 next-hop type.
peer-ipv4-address	O	inet:ipv4-address-no-zone	IPv4 address of peer.
peer-ipv6-address	O	inet:ipv6-address-no-zone	IPv6 address of peer.
peer-interface	O	if:interface-ref	Interface name of peer.
peer-local	O	”true" "false”	Static or Redistributed routes.
metric	O	0..4294967295	Match a route metric.
tag	O	0..4294967295	Match a route tag.
source-instance	O	0..255	Match the protocol’s instance number.
source-protocol	O	”kernel" "connected" "static" "ospf" "ospf6" "isis" "bgp" "table”	Match protocol via which the route was learnt.
source-vrf	O	vrf:vrf-ref	Match source vrf.
set-action	M		Path-only node, has no configurable value. Route map set actions.
aggregator-as-number	M	1..4294967295	Set AS number of aggregator.
aggregator-ip-address	M	inet:ipv4-address-no-zone	Set IP address of aggregator.
exclude-as	O	1..4294967295	Exclude from the as-path.
prepend-as	O	1..4294967295	AS number to prepend.
prepend-last-as	O	1..10	Number of times to insert last-as.
atomic-aggregate	O	”true" "false”	Set BGP atomic aggregate attribute.
community	O	string	Set BGP community attribute. Community number in AA:NN format (where AA and NN are (0-65535)) or local-AS
delete-community-list	O	string	set BGP community list (for deletion). Value in (1-99) For Standard Community-list number or Value in (100-500) Expanded Communitly-list number or Value of Community-list name
distance	O	integer	Set BGP Administrative Distance to use.
local-preference	O	0..4294967295	Set BGP local-preference of route.
origin	O	”egp" "igp" "incomplete”	Match BGP origin code.
originator-id	O	inet:ipv4-address-no-zone	Set BGP originator ID attribute.
weight	O	0..4294967295	Set BGP weight for routing table.
bandwidth-value	O	1..25600
bandwidth-cumulative	O	”true" "false”	Cumulative bandwidth of all multipaths (outbound-only).
bandwidth-num-multipaths	O	”true" "false”	Internally computed bandwidth based on number of multipaths (outbound-only).
bandwidth-non-transitive	O	”true" "false”	Attribute is set as non-transitive.
ipv4-next-hop-address	O	inet:ipv4-address-no-zone
ipv4-next-hop-peer-address	O	”true" "false”
ipv4-next-hop-unchanged	O	”true" "false”
ipv4-vpn-next-hop-address	O	inet:ipv4-address-no-zone	Set IPv4 VPN next-hop address.
ipv6-forwarding-address	O	inet:ipv6-address-no-zone	IPv6 Forwarding Address.
ipv6-next-hop-global-address	O	inet:ipv6-address-no-zone	Set IPv6 global address of next hop.
ipv6-next-hop-local-address	O	inet:ipv6-address-no-zone	Set IPv6 local address of next hop.
ipv6-next-hop-prefer-global	O	”true" "false”	Set Don’t modify existing Next hop address.
ipv6-next-hop-prefer-peer	O	”true" "false”	Use peer address (for BGP only).
ipv6-vpn-next-hop-address	O	inet:ipv6-address-no-zone	Set IPv6 VPN next-hop address.
large-community	O	string	Large Community number in aa:bb:cc(where aa, bb anc cc are (0-4294967295)) format or additive.
delete-large-community-list	O	string	set BGP large community list (for deletion). Value in (1-99) For Standard Large Community-list number or Value in (100-500) Expanded Large Communitly-list number or Value of Large Community-list name
metric-type	O	”type-1" "type-2”	Set type of metric
set-metric	O	0..4294967295	Use the following metric value.
add-metric	O	0..4294967295	Add value to metric.
use-round-trip-time	O	”true" "false”	Use the round trip time as metric.
add-round-trip-time	O	”true" "false”	Add round trip time to metric.
subtract-round-trip-time	O	”true" "false”	Subtract round trip time to metric.
ipv4-source-address	O	inet:ipv4-address-no-zone
ipv6-source-address	O	inet:ipv6-address-no-zone
table	O	1..4294967295	Kernel routing table id.
tag	O	0..4294967295	Tag value.
on-match	M		Path-only node, has no configurable value. Exit policy on matches.
goto	O	1..65535	Goto Clause number.
next	O	”true" "false”	Next clause.

Show Route Map Json

Tree Diagram

/workspaces/as-mgmt-doc/doc/resource/yang/asternos-route-map.yang:158: error: unexpected keyword "error-message"
/workspaces/as-mgmt-doc/doc/resource/yang/asternos-route-map.yang:159: error: unexpected keyword "error-app-tag"
module: asternos-route-map

  rpcs:
    +---x show-route-map-json
       +---w input
       |  +---w name?   route-map-name
       +--ro output
          +--ro data?   <anydata>

Table of Properties

Name	Required	Type/Range	Description
show-route-map-json	O
name	O	string (length 1..64)	Name of a route-map.
data	O		Show route-map information.