Resource Type: cisco_route_map

Defined in:
lib/puppet/type/cisco_route_map.rb
Providers:
cisco

Overview

Manages a route map.

cisco_route_map <sequence> <action>":

..attributes..

<rmname> is the name of the route map. <sequence> is sequence to insert/delete existing route-map entry <action> is permit or deny.

Examples: cisco_route_map 123 permit’:

ensure                                 => 'present',
description                            => 'Testing',
match_as_number                        => ['3', '22-34', '38'],
match_as_number_as_path_list           => ['abc', 'xyz', 'pqr'],
match_community                        => ['public', 'private'],
match_community_exact_match            => true,
match_evpn_route_type_1                => true,
match_evpn_route_type_2_all            => true,
match_evpn_route_type_2_mac_ip         => true,
match_evpn_route_type_2_mac_only       => true,
match_evpn_route_type_3                => true,
match_evpn_route_type_4                => true,
match_evpn_route_type_5                => true,
match_evpn_route_type_6                => true,
match_evpn_route_type_all              => true,
match_ext_community                    => ['epublic', 'eprivate'],
match_ext_community_exact_match        => true,
match_interface                        => ['loopback2', 'mgmt0'],
match_ipv4_addr_access_list            => 'access1',
match_ipv4_addr_prefix_list            => ['p1', 'p7', 'pre5'],
match_ipv4_multicast_enable            => true,
match_ipv4_multicast_src_addr          => '242.1.1.1/32',
match_ipv4_multicast_group_addr        => '239.2.2.2/32',
match_ipv4_multicast_group_range_begin_addr => default,
match_ipv4_multicast_group_range_end_addr => default,
match_ipv4_multicast_rp_addr           => '242.1.1.1/32',
match_ipv4_multicast_rp_type           => 'ASM',
match_ipv4_next_hop_prefix_list        => ['nh5', 'nh1', 'nh42'],
match_ipv4_route_src_prefix_list       => ['rs2', 'rs22', 'pre15'],
match_ipv6_addr_access_list            => 'v6access',
match_ipv6_addr_prefix_list            => ['pv6', 'pv67', 'prev6'],
match_ipv6_multicast_enable            => true,
match_ipv6_multicast_src_addr          => '2001::348:0:0/96',
match_ipv6_multicast_group_addr        => 'ff0e::2:101:0:0/96',
match_ipv6_multicast_group_range_begin_addr => default,
match_ipv6_multicast_group_range_end_addr => default,
match_ipv6_multicast_rp_addr           => '2001::348:0:0/96',
match_ipv6_multicast_rp_type           => 'ASM',
match_ipv6_next_hop_prefix_list        => ['nhv6', 'v6nh1', 'nhv42'],
match_ipv6_route_src_prefix_list       => ['rsv6', 'rs22v6', 'prev6'],
match_length                           => ['45', '345'],
match_mac_list                         => ['mac1', 'listmac'],
match_metric                           => [['8', '0'], ['224', '9']]
match_ospf_area                        => ['10', '7', '222'],
match_route_type_external              => true,
match_route_type_inter_area            => true,
match_route_type_internal              => true,
match_route_type_intra_area            => true,
match_route_type_level_1               => true,
match_route_type_level_2               => true,
match_route_type_local                 => true,
match_route_type_nssa_external         => true,
match_route_type_type_1                => true,
match_route_type_type_2                => true,
match_src_proto                        => ['tcp', 'udp', 'igmp'],
match_tag                              => ['5', '342', '28', '3221'],
match_vlan                             => '32, 45-200, 300-399, 402',
set_as_path_prepend                    => ['55.77', '12', '45.3'],
set_as_path_prepend_last_as            => 1,
set_as_path_tag                        => true,
set_comm_list                          => 'abc',
set_community_additive                 => true,
set_community_asn                      => ['11:22', '33:44', '123:11'],
set_community_internet                 => true,
set_community_local_as                 => true,
set_community_no_advtertise            => true,
set_community_no_export                => true,
set_community_none                     => false,
set_dampening_half_life                => 6,
set_dampening_max_duation              => 55,
set_dampening_reuse                    => 22,
set_dampening_suppress                 => 44,
set_distance_igp_ebgp                  => 44,
set_dampening_suppress                 => 44,
set_dampening_suppress                 => 1,
set_distance_internal                  => 2,
set_distance_local                     => 3,
set_extcomm_list                       => 'xyz',
set_extcommunity_4bytes_additive       => true,
set_extcommunity_4bytes_non_transitive => ['21:42', '43:22', '59:17'],
set_extcommunity_4bytes_transitive     => ['11:22', '33:44', '66:77'],
set_extcommunity_cost_igp              => [[0, 23], [3, 33]],
set_extcommunity_cost_pre_bestpath     => [[23, 999], [88, 482]],
set_extcommunity_rt_additive           => true,
set_extcommunity_rt_asn                => ['11:22', '123.256:543'],
set_forwarding_addr                    => true,
set_interface                          => 'Null0',
set_ipv4_default_next_hop              => ['1.1.1.1', '2.2.2.2'],
set_ipv4_default_next_hop_load_share   => true,
set_ipv4_next_hop                      => ['3.3.3.3', '4.4.4.4'],
set_ipv4_next_hop_load_share           => true,
set_ipv4_next_hop_peer_addr            => true,
set_ipv4_next_hop_redist               => true,
set_ipv4_next_hop_unchanged            => true,
set_ipv4_precedence                    => 'critical',
set_ipv4_prefix                        => 'abcdef',
set_ipv6_default_next_hop              => ['2000::1', '2000::11'],
set_ipv6_default_next_hop_load_share   => true,
set_ipv6_next_hop                      => ['2000::1', '2000::11'],
set_ipv6_next_hop_load_share           => true,
set_ipv6_next_hop_peer_addr            => true,
set_ipv6_next_hop_redist               => true,
set_ipv6_next_hop_unchanged            => true,
set_ipv6_precedence                    => 'network',
set_ipv6_prefix                        => 'wxyz',
set_level                              => 'level-1',
set_local_preference                   => 100,
set_metric_additive                    => false,
set_metric_bandwidth                   => 44,
set_metric_delay                       => 55,
set_metric_reliability                 => 66,
set_metric_effective_bandwidth         => 77,
set_metric_mtu                         => 88,
set_metric_type                        => 'external',
set_nssa_only                          => true,
set_origin                             => 'egp',
set_path_selection                     => true,
set_tag                                => 101,
set_vrf                                => 'igp',
set_weight                             => 222,

Properties

  • description

    Description of the route-map. Valid values are string, keyword ‘default’

  • ensure (defaults to: present)

    The basic property that the resource should be in.

    Supported values:
    • present
    • absent
  • match_as_number
  • match_as_number_as_path_list
  • match_community
  • match_community_exact_match

    Enable exact matching of communities

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_1

    Enable match BGP EVPN route type-1

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_2_all

    Enable match all BGP EVPN route in type-2

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_2_mac_ip

    Enable match mac-ip BGP EVPN route in type-2

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_2_mac_only

    Enable match mac-only BGP EVPN route in type-2

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_3

    Enable match BGP EVPN route type-3

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_4

    Enable match BGP EVPN route type-4

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_5

    Enable match BGP EVPN route type-5

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_6

    Enable match BGP EVPN route type-6

    Supported values:
    • true
    • false
    • default
  • match_evpn_route_type_all

    Enable match BGP EVPN route type 1-6

    Supported values:
    • true
    • false
    • default
  • match_ext_community
  • match_ext_community_exact_match

    Enable exact matching of extended communities

    Supported values:
    • true
    • false
    • default
  • match_interface
  • match_ipv4_addr_access_list

    IPv4 access-list name. Valid values are string, keyword ‘default’

  • match_ipv4_addr_prefix_list
  • match_ipv4_multicast_enable

    Enable match IPv4 multicast

    Supported values:
    • true
    • false
    • default
  • match_ipv4_multicast_group_addr

    Match IPv4 multicast group prefix. Valid values are string, keyword ‘default’

  • match_ipv4_multicast_group_range_begin_addr

    Match IPv4 multicast group address begin range. Valid values are string, keyword ‘default’

  • match_ipv4_multicast_group_range_end_addr

    Match IPv4 multicast group address end range. Valid values are string, keyword ‘default’

  • match_ipv4_multicast_rp_addr

    Match IPv4 multicast rendezvous prefix. Valid values are string, keyword ‘default’

  • match_ipv4_multicast_rp_type

    Match IPv4 multicast rendezvous point type

    Supported values:
    • ASM
    • Bidir
    • default
  • match_ipv4_multicast_src_addr

    Match IPv4 multicast source prefix. Valid values are string, keyword ‘default’

  • match_ipv4_next_hop_prefix_list
  • match_ipv4_route_src_prefix_list
  • match_ipv6_addr_access_list

    IPv6 access-list name. Valid values are string, keyword ‘default’

  • match_ipv6_addr_prefix_list
  • match_ipv6_multicast_enable

    Enable match IPv6 multicast

    Supported values:
    • true
    • false
    • default
  • match_ipv6_multicast_group_addr

    Match IPv6 multicast group prefix. Valid values are string, keyword ‘default’

  • match_ipv6_multicast_group_range_begin_addr

    Match IPv6 multicast group address begin range. Valid values are string, keyword ‘default’

  • match_ipv6_multicast_group_range_end_addr

    Match IPv6 multicast group address end range. Valid values are string, keyword ‘default’

  • match_ipv6_multicast_rp_addr

    Match IPv6 multicast rendezvous prefix. Valid values are string, keyword ‘default’

  • match_ipv6_multicast_rp_type

    Match IPv6 multicast rendezvous point type

    Supported values:
    • ASM
    • Bidir
    • default
  • match_ipv6_multicast_src_addr

    Match IPv6 multicast source prefix. Valid values are string, keyword ‘default’

  • match_ipv6_next_hop_prefix_list
  • match_ipv6_route_src_prefix_list
  • match_length
  • match_mac_list
  • match_metric
  • match_ospf_area
  • match_route_type_external

    Enable match external route type (BGP, EIGRP and OSPF type 1/2)

    Supported values:
    • true
    • false
    • default
  • match_route_type_inter_area

    Enable match OSPF inter area type

    Supported values:
    • true
    • false
    • default
  • match_route_type_internal

    Enable match OSPF inter area type (OSPF intra/inter area)

    Supported values:
    • true
    • false
    • default
  • match_route_type_intra_area

    Enable match OSPF intra area route

    Supported values:
    • true
    • false
    • default
  • match_route_type_level_1

    Enable match IS-IS level-1 route

    Supported values:
    • true
    • false
    • default
  • match_route_type_level_2

    Enable match IS-IS level-2 route

    Supported values:
    • true
    • false
    • default
  • match_route_type_local

    Enable match locally generated route

    Supported values:
    • true
    • false
    • default
  • match_route_type_nssa_external

    Enable match nssa-external route (OSPF type 1/2)

    Supported values:
    • true
    • false
    • default
  • match_route_type_type_1

    Enable match OSPF external type 1 route

    Supported values:
    • true
    • false
    • default
  • match_route_type_type_2

    Enable match OSPF external type 2 route

    Supported values:
    • true
    • false
    • default
  • match_src_proto
  • match_tag
  • match_vlan

    Match Vlan ID. Valid values are string, keyword ‘default’

  • set_as_path_prepend
  • set_as_path_prepend_last_as

    Number of last-AS prepends. Valid values are integer, keyword ‘default’.

  • set_as_path_tag

    Set the tag as an AS-path attribute

    Supported values:
    • true
    • false
    • default
  • set_comm_list

    Set BGP community list (for deletion). Valid values are string, keyword ‘default’

  • set_community_additive

    Add to existing BGP community

    Supported values:
    • true
    • false
    • default
  • set_community_asn
  • set_community_internet

    Set Internet community

    Supported values:
    • true
    • false
    • default
  • set_community_local_as

    Do not send outside local AS

    Supported values:
    • true
    • false
    • default
  • set_community_no_advtertise

    Do not advertise to any peer

    Supported values:
    • true
    • false
    • default
  • set_community_no_export

    Do not export to next AS

    Supported values:
    • true
    • false
    • default
  • set_community_none

    Set no community attribute

    Supported values:
    • true
    • false
    • default
  • set_dampening_half_life

    Set half-life time for the penalty of BGP route flap dampening. Valid values are integer, keyword ‘default’.

  • set_dampening_max_duation

    Set maximum duration to suppress a stable route of BGP route flap dampening. Valid values are integer, keyword ‘default’.

  • set_dampening_reuse

    Set penalty to start reusing a route of BGP route flap dampening. Valid values are integer, keyword ‘default’.

  • set_dampening_suppress

    Set penalty to start suppressing a route of BGP route flap dampening. Valid values are integer, keyword ‘default’.

  • set_distance_igp_ebgp

    Set administrative distance for IGP or EBGP routes. Valid values are integer, keyword ‘default’.

  • set_distance_internal

    Set administrative distance for internal routes. Valid values are integer, keyword ‘default’.

  • set_distance_local

    Set administrative distance for local routes. Valid values are integer, keyword ‘default’.

  • set_extcomm_list

    Set BGP extended community list (for deletion). Valid values are string, keyword ‘default’

  • set_extcommunity_4bytes_additive

    Add to existing generic extcommunity

    Supported values:
    • true
    • false
    • default
  • set_extcommunity_4bytes_non_transitive
  • set_extcommunity_4bytes_none

    Set no extcommunity generic attribute

    Supported values:
    • true
    • false
    • default
  • set_extcommunity_4bytes_transitive
  • set_extcommunity_cost_igp
  • set_extcommunity_cost_pre_bestpath
  • set_extcommunity_rt_additive

    Set add to existing route target extcommunity

    Supported values:
    • true
    • false
    • default
  • set_extcommunity_rt_asn
  • set_forwarding_addr

    Set the forwarding address

    Supported values:
    • true
    • false
    • default
  • set_interface

    Set output interface

    Supported values:
    • Null0
    • default
  • set_ipv4_default_next_hop
  • set_ipv4_default_next_hop_load_share

    Enable default IPv4 next-hop load-sharing

    Supported values:
    • true
    • false
    • default
  • set_ipv4_next_hop
  • set_ipv4_next_hop_load_share

    Enable IPv4 next-hop load-sharing

    Supported values:
    • true
    • false
    • default
  • set_ipv4_next_hop_peer_addr

    Enable IPv4 next-hop peer address

    Supported values:
    • true
    • false
    • default
  • set_ipv4_next_hop_redist

    Enable IPv4 next-hop unchanged address during redistribution

    Supported values:
    • true
    • false
    • default
  • set_ipv4_next_hop_unchanged

    Enable IPv4 next-hop unchanged address

    Supported values:
    • true
    • false
    • default
  • set_ipv4_precedence

    Set precedence field

    Supported values:
    • critical
    • flash
    • flash-override
    • immediate
    • internet
    • network
    • priority
    • routine
    • default
  • set_ipv4_prefix

    Set IPv4 prefix-list. Valid values are string, keyword ‘default’

  • set_ipv6_default_next_hop
  • set_ipv6_default_next_hop_load_share

    Enable default IPv6 next-hop load-sharing

    Supported values:
    • true
    • false
    • default
  • set_ipv6_next_hop
  • set_ipv6_next_hop_load_share

    Enable IPv6 next-hop load-sharing

    Supported values:
    • true
    • false
    • default
  • set_ipv6_next_hop_peer_addr

    Enable IPv6 next-hop peer address

    Supported values:
    • true
    • false
    • default
  • set_ipv6_next_hop_redist

    Enable IPv6 next-hop unchanged address during redistribution

    Supported values:
    • true
    • false
    • default
  • set_ipv6_next_hop_unchanged

    Enable IPv6 next-hop unchanged address

    Supported values:
    • true
    • false
    • default
  • set_ipv6_precedence

    Set precedence field

    Supported values:
    • critical
    • flash
    • flash-override
    • immediate
    • internet
    • network
    • priority
    • routine
    • default
  • set_ipv6_prefix

    Set IPv6 prefix-list. Valid values are string, keyword ‘default’

  • set_level

    Set where to import route

    Supported values:
    • level-1
    • level-1-2
    • level-2
    • default
  • set_local_preference

    Set BGP local preference path attribute. Valid values are integer, keyword ‘default’.

  • set_metric_additive

    Set add to metric

    Supported values:
    • true
    • false
    • default
  • set_metric_bandwidth

    Set metric value or Bandwidth in kbps. Valid values are integer, keyword ‘default’.

  • set_metric_delay

    Set IGRP delay metric. Valid values are integer, keyword ‘default’.

  • set_metric_effective_bandwidth

    Set IGRP Effective bandwidth metric. Valid values are integer, keyword ‘default’.

  • set_metric_mtu

    Set IGRP MTU of the path. Valid values are integer, keyword ‘default’.

  • set_metric_reliability

    Set IGRP reliability metric. Valid values are integer, keyword ‘default’.

  • set_metric_type

    Set type of metric for destination routing protocol

    Supported values:
    • external
    • internal
    • type-1
    • type-2
    • default
  • set_nssa_only

    Set OSPF NSSA Areas

    Supported values:
    • true
    • false
    • default
  • set_origin

    Set BGP origin code

    Supported values:
    • egp
    • igp
    • incomplete
    • default
  • set_path_selection

    Set path selection criteria for BGP

    Supported values:
    • true
    • false
    • default
  • set_tag

    Set tag value for destination routing protocol. Valid values are integer, keyword ‘default’.

  • set_vrf

    Set the VRF for next-hop resolution. Valid values are string, keyword ‘default’

  • set_weight

    Set BGP weight for routing table. Valid values are integer, keyword ‘default’.

Parameters

  • action

    Action for set oprtations. Valid values are permit or deny.

    Supported values:
    • permit
    • deny
  • name (namevar)

    Name of cisco_route_map, not used, but needed for puppet

  • provider

    The specific backend to use for this ‘cisco_route_map` resource. You will seldom need to specify this — Puppet will usually discover the appropriate provider for your platform.

  • rmname

    Name of the route map instance. Valid values are string.

  • sequence

    Sequence to insert/delete existing route-map entry. Valid values are integer.