Skip to content

Tunnel

Tunnel interfaces provide virtual point-to-point connections across IP networks, enabling secure communication, network extension, and overlay services through various encapsulation protocols including GRE, IPsec, and MPLS over IP. They support multiple tunnel types for different use cases such as site-to-site VPNs, dynamic routing over WANs, traffic engineering, and network virtualization while maintaining full Layer 3 functionality with routing protocol support and quality of service capabilities. Tunnel interfaces are essential for connecting remote sites, extending private networks across public infrastructure, implementing overlay networks, and providing secure communication channels that abstract the underlying physical network topology.

Diagram

Diagram

Classes

interfaces (iosxe.devices.configuration)

NameTypeConstraintMandatoryDefault Value
tunnelsList[tunnels]No

tunnels (iosxe.devices.configuration.interfaces)

NameTypeConstraintMandatoryDefault Value
nameIntegerYes
interface_groupsListStringNo
descriptionStringNo
shutdownBooleantrue, falseNo
vrf_forwardingStringNo
ipv4Class[ipv4]No
ipv6Class[ipv6]No
bfdClass[bfd]No
tunnel_destination_ipv4IPNo
ospfClass[ospf]No
ospfv3Class[ospfv3]No
arp_timeoutIntegermin: 0, max: 2147483No
ip_mtuIntegermin: 576, max: 1500No
load_intervalIntegermin: 30, max: 600No
snmp_trap_link_statusBooleantrue, falseNo
logging_event_link_status_enableBooleantrue, falseNo
tunnel_vrfStringNo
tunnel_mode_ipsec_ipv4Booleantrue, falseNo
tunnel_protection_ipsec_profileStringNo
tunnel_sourceStringNo

ipv4 (iosxe.devices.configuration.interfaces.tunnels)

NameTypeConstraintMandatoryDefault Value
addressIPNo
address_maskIPNo
proxy_arpBooleantrue, falseNo
arp_inspection_trustBooleantrue, falseNo
arp_inspection_limit_rateIntegermin: 0, max: 4294967295No
dhcp_snooping_trustBooleantrue, falseNo
dhcp_relay_source_interface_typeChoiceLoopback, Vlan, GigabitEthernet, FiveGigabitEthernet, TenGigabitEthernet, FortyGigabitEthernet, HundredGigabitEthernet, PortChannelNo
dhcp_relay_source_interface_idStringNo
helper_addressesList[helper_addresses]No
access_group_inStringNo
access_group_outStringNo
flow_monitorsList[flow_monitors]No
redirectsBooleantrue, falseNo
unreachablesBooleantrue, falseNo
unnumberedStringNo

ipv6 (iosxe.devices.configuration.interfaces.tunnels)

NameTypeConstraintMandatoryDefault Value
enableBooleantrue, falseNo
addressesList[addresses]No
link_local_addressesListIPNo
address_autoconfig_defaultBooleantrue, falseNo
address_dhcpBooleantrue, falseNo
mtuIntegermin: 1280, max: 9976No
nd_ra_suppress_allBooleantrue, falseNo
flow_monitorsList[flow_monitors]No

bfd (iosxe.devices.configuration.interfaces.tunnels)

NameTypeConstraintMandatoryDefault Value
templateStringNo
enableBooleantrue, falseNo
local_addressStringNo
intervalIntegermin: 50, max: 9999No
interval_min_rxIntegermin: 50, max: 9999No
interval_multiplierIntegermin: 3, max: 50No
echoBooleantrue, falseNo

ospf (iosxe.devices.configuration.interfaces.tunnels)

NameTypeConstraintMandatoryDefault Value
costIntegermin: 1, max: 65535No
dead_intervalIntegermin: 1, max: 65535No
hello_intervalIntegermin: 1, max: 65535No
mtu_ignoreBooleantrue, falseNo
network_typeChoicebroadcast, non-broadcast, point-to-multipoint, point-to-pointNo
priorityIntegermin: 0, max: 255No
ttl_security_hopsIntegermin: 1, max: 254No
process_idsList[process_ids]No
message_digest_keysList[message_digest_keys]No

ospfv3 (iosxe.devices.configuration.interfaces.tunnels)

NameTypeConstraintMandatoryDefault Value
network_typeChoicebroadcast, non-broadcast, point-to-multipoint, point-to-pointNo
costIntegermin: 1, max: 65535No

helper_addresses (iosxe.devices.configuration.interfaces.tunnels.ipv4)

NameTypeConstraintMandatoryDefault Value
addressIPYes
globalBooleantrue, falseNo
vrfStringNo

flow_monitors (iosxe.devices.configuration.interfaces.tunnels.ipv4)

NameTypeConstraintMandatoryDefault Value
nameStringYes
directionChoiceinput, outputYes

addresses (iosxe.devices.configuration.interfaces.tunnels.ipv6)

NameTypeConstraintMandatoryDefault Value
prefixIPYes
eui_64Booleantrue, falseNo

process_ids (iosxe.devices.configuration.interfaces.tunnels.ospf)

NameTypeConstraintMandatoryDefault Value
idIntegermin: 1, max: 65535No
areasListStringNo

message_digest_keys (iosxe.devices.configuration.interfaces.tunnels.ospf)

NameTypeConstraintMandatoryDefault Value
idIntegermin: 1, max: 255Yes
md5_auth_keyStringNo
md5_auth_typeChoice0, 7No

Examples

iosxe:
devices:
- name: Device1
configuration:
interfaces:
tunnels:
- name: 100
description: GRE Tunnel to Remote Site
shutdown: false
vrf_forwarding: WAN
tunnel_destination_ipv4: 203.0.113.10
tunnel_source: GigabitEthernet0/0/1
tunnel_mode_ipsec_ipv4: false
ipv4:
address: 10.255.1.1
address_mask: 255.255.255.252
redirects: false
unreachables: false
ipv6:
enable: true
addresses:
- prefix: 2001:db8:tunnel::1/64
bfd:
enable: true
interval: 100
interval_multiplier: 3
ospf:
cost: 1000
network_type: point-to-point
process_ids:
- id: 1
areas:
- "0"
load_interval: 30
ip_mtu: 1476
- name: 200
description: IPsec VPN Tunnel
shutdown: false
tunnel_destination_ipv4: 198.51.100.20
tunnel_source: GigabitEthernet0/0/0
tunnel_mode_ipsec_ipv4: true
tunnel_protection_ipsec_profile: IPSEC-PROFILE-1
tunnel_vrf: INTERNET
ipv4:
address: 172.16.255.1
address_mask: 255.255.255.252
logging_event_link_status_enable: true
snmp_trap_link_status: true