Skip to content

Port Channel

Port Channel interfaces provide link aggregation capabilities that combine multiple physical Ethernet interfaces into a single logical interface, delivering increased bandwidth, redundancy, and load distribution across member interfaces using protocols such as LACP (Link Aggregation Control Protocol) or static configuration. They enable seamless failover when individual member links fail while maintaining session continuity, and support both Layer 2 switching with VLAN trunking and Layer 3 routing with comprehensive protocol support including OSPF, BGP, and spanning tree participation. Port Channels are fundamental for building resilient network infrastructures, enabling high-bandwidth connections between switches, servers, and storage systems while providing the flexibility to scale bandwidth incrementally and ensure network availability through redundant path management.

Diagram

Diagram

Classes

interfaces (iosxe.devices.configuration)

NameTypeConstraintMandatoryDefault Value
port_channelsList[port_channels]No

port_channels (iosxe.devices.configuration.interfaces)

NameTypeConstraintMandatoryDefault Value
nameIntegerYes
interface_groupsListStringNo
descriptionStringNo
shutdownBooleantrue, falseNo
vrf_forwardingStringNo
ipv4Class[ipv4]No
ipv6Class[ipv6]No
bfdClass[bfd]No
spanning_treeClass[spanning_tree]No
arp_timeoutIntegermin: 0, max: 2147483No
load_intervalIntegermin: 30, max: 600No
snmp_trap_link_statusBooleantrue, falseNo
logging_event_link_statusBooleantrue, falseNo
mplsClass[mpls]No
ospfClass[ospf]No
ospfv3Class[ospfv3]No
pimClass[pim]No
switchportClass[switchport]No
subinterfacesList[subinterfaces]No
auto_qosClass[auto_qos]No

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

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.port_channels)

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.port_channels)

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

spanning_tree (iosxe.devices.configuration.interfaces.port_channels)

NameTypeConstraintMandatoryDefault Value
guardChoiceloop, none, rootNo
link_typeChoiceshared, point-to-pointNo
portfast_trunkBooleantrue, falseNo

mpls (iosxe.devices.configuration.interfaces.port_channels)

NameTypeConstraintMandatoryDefault Value
ipBooleantrue, falseNo
mtuIntegerNo

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

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.port_channels)

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

pim (iosxe.devices.configuration.interfaces.port_channels)

NameTypeConstraintMandatoryDefault Value
passiveBooleantrue, falseNo
dense_modeBooleantrue, falseNo
sparse_modeBooleantrue, falseNo
sparse_dense_modeBooleantrue, falseNo
bfdBooleantrue, falseNo
borderBooleantrue, falseNo
bsr_borderBooleantrue, falseNo
dr_priorityIntegermin: 0, max: 4294967294No

switchport (iosxe.devices.configuration.interfaces.port_channels)

NameTypeConstraintMandatoryDefault Value
modeChoiceaccess, dot1q-tunnel, private-vlan-trunk, private-vlan-host, private-vlan-promiscuous, trunkYes
nonegotiateBooleantrue, falseNo
access_vlanIntegermin: 1, max: 4094No
trunk_allowed_vlansStringNo
trunk_allowed_vlans_noneBooleantrue, falseNo
trunk_native_vlan_tagBooleantrue, falseNo
trunk_native_vlan_idIntegermin: 1, max: 4094No
hostBooleantrue, falseNo

subinterfaces (iosxe.devices.configuration.interfaces.port_channels)

NameTypeConstraintMandatoryDefault Value
nameStringYes
descriptionStringNo
shutdownBooleantrue, falseNo
vrf_forwardingStringNo
ipv4Class[ipv4]No
ipv6Class[ipv6]No
bfdClass[bfd]No
encapsulation_dot1q_vlan_idIntegermin: 1, max: 4094No
arp_timeoutIntegermin: 0, max: 2147483No
auto_qosClass[auto_qos]No
mplsClass[mpls]No
ospfClass[ospf]No
ospfv3Class[ospfv3]No
pimClass[pim]No

auto_qos (iosxe.devices.configuration.interfaces.port_channels)

NameTypeConstraintMandatoryDefault Value
classifyBooleantrue, falseNo
classify_policeBooleantrue, falseNo
trustBooleantrue, falseNo
trust_cosBooleantrue, falseNo
trust_dscpBooleantrue, falseNo
video_ctsBooleantrue, falseNo
video_ip_cameraBooleantrue, falseNo
video_media_playerBooleantrue, falseNo
voipBooleantrue, falseNo
voip_cisco_phoneBooleantrue, falseNo
voip_cisco_softphoneBooleantrue, falseNo
voip_trustBooleantrue, falseNo
trust_deviceChoicecisco-phone, cts, ip-camera, media-playerNo

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

NameTypeConstraintMandatoryDefault Value
addressIPYes
globalBooleantrue, falseNo
vrfStringNo

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

NameTypeConstraintMandatoryDefault Value
nameStringYes
directionChoiceinput, outputYes

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

NameTypeConstraintMandatoryDefault Value
prefixIPYes
eui_64Booleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
idIntegermin: 1, max: 65535No
areasListStringNo

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

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

Examples

iosxe:
devices:
- name: Device1
configuration:
interfaces:
port_channels:
- name: 1
description: Layer 3 Port Channel to Core
shutdown: false
vrf_forwarding: PRODUCTION
ipv4:
address: 192.168.10.1
address_mask: 255.255.255.252
proxy_arp: false
redirects: false
unreachables: false
ipv6:
enable: true
addresses:
- prefix: 2001:db8:10::1/64
link_local_addresses:
- fe80::1
bfd:
enable: true
interval: 100
interval_multiplier: 3
interval_min_rx: 100
ospf:
cost: 10
network_type: point-to-point
process_ids:
- id: 1
areas:
- "0"
- name: 10
description: Layer 2 Trunk to Access Switch
shutdown: false
switchport:
mode: trunk
trunk_allowed_vlans: "10,20,30,100-200"
trunk_native_vlan_id: 1
nonegotiate: true
spanning_tree:
guard: root
link_type: point-to-point
load_interval: 30
snmp_trap_link_status: true
subinterfaces:
- name: "10.100"
description: VLAN 100 Subinterface
shutdown: false
vrf_forwarding: GUEST
encapsulation_dot1q_vlan_id: 100
ipv4:
address: 10.100.1.1
address_mask: 255.255.255.0
helper_addresses:
- address: 10.1.1.10