Skip to content
Network as Code

Ethernet

Ethernet interfaces provide the fundamental physical and logical connectivity for network devices, supporting various speeds from Fast Ethernet (100 Mbps) to multi-gigabit rates (1G, 2.5G, 5G, 10G, 25G, 40G, 100G) with comprehensive Layer 2 switching and Layer 3 routing capabilities. They offer extensive configuration options including switchport modes (access, trunk), VLAN assignments, spanning tree parameters, quality of service policies, security features, and advanced protocols such as OSPF, BFD, and IPv6. Ethernet interfaces serve as the backbone of modern networks, enabling both access layer connectivity for end devices and high-performance trunk links between network infrastructure components while supporting features like port channels, network access control, and comprehensive monitoring capabilities.

Diagram

Diagram

Classes

interfaces (iosxe.devices.configuration)

NameTypeConstraintMandatoryDefault Value
ethernetsList[ethernets]No

ethernets (iosxe.devices.configuration.interfaces)

NameTypeConstraintMandatoryDefault Value
typeChoiceGigabitEthernet, FastEthernet, Ethernet, Port-channel, FiveGigabitEthernet, TenGigabitEthernet, TwentyFiveGigE, FortyGigabitEthernet, HundredGigE, TwoHundredGigE, FourHundredGigEYes
idStringYes
interface_groupsListStringNo
media_typeChoiceauto-select, rj45, sfpNo
bandwidthIntegermin: 1, max: 200000000No
mtuIntegermin: 64, max: 18000No
descriptionStringNo
shutdownBooleantrue, falseNo
vrf_forwardingStringNo
ipv4Class[ipv4]No
ipv6Class[ipv6]No
bfdClass[bfd]No
spanning_treeClass[spanning_tree]No
speedChoice100, 1000, 2500, 5000, 10000, 25000, 40000, 100000, autoNo
speed_nonegotiateBooleantrue, falseNo
port_channel_idIntegermin: 1, max: 512No
port_channel_modeChoiceactive, auto, desirable, on, passiveNo
source_templatesList[source_templates]No
arp_timeoutIntegermin: 0, max: 2147483No
negotiation_autoBooleantrue, falseNo
service_policy_inputStringNo
service_policy_outputStringNo
load_intervalIntegermin: 30, max: 600No
snmp_trap_link_statusBooleantrue, falseNo
logging_event_link_statusBooleantrue, falseNo
device_trackingBooleantrue, falseNo
device_tracking_attached_policiesListStringNo
encapsulation_dot1q_vlan_idIntegermin: 1, max: 4094No
nbar_protocol_discoveryBooleantrue, falseNo
mplsClass[mpls]No
ospfClass[ospf]No
ospfv3Class[ospfv3]No
pimClass[pim]No
switchportClass[switchport]No
network_access_controlClass[network_access_control]No
auto_qosClass[auto_qos]No

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

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

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

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

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

source_templates (iosxe.devices.configuration.interfaces.ethernets)

NameTypeConstraintMandatoryDefault Value
nameStringYes
mergeBooleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
ipBooleantrue, falseNo
mtuIntegerNo

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

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

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

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

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

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

network_access_control (iosxe.devices.configuration.interfaces.ethernets)

NameTypeConstraintMandatoryDefault Value
authentication_periodicBooleantrue, falseNo
authentication_timer_reauthenticateIntegermin: 1, max: 1073741823No
authentication_timer_reauthenticate_serverBooleantrue, falseNo
mabBooleantrue, falseNo
mab_eapBooleantrue, falseNo
dot1x_paeChoiceauthenticator, supplicant, bothNo
dot1x_timeout_auth_periodIntegermin: 1, max: 65535No
dot1x_timeout_held_periodIntegermin: 1, max: 65535No
dot1x_timeout_quiet_periodIntegermin: 1, max: 65535No
dot1x_timeout_ratelimit_periodIntegermin: 1, max: 65535No
dot1x_timeout_server_timeoutIntegermin: 1, max: 65535No
dot1x_timeout_start_periodIntegermin: 1, max: 65535No
dot1x_timeout_supp_timeoutIntegermin: 1, max: 65535No
dot1x_timeout_tx_periodIntegermin: 1, max: 65535No
dot1x_max_reqIntegermin: 1, max: 10No
dot1x_max_reauth_reqIntegermin: 1, max: 10No

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

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.ethernets.ipv4)

NameTypeConstraintMandatoryDefault Value
addressIPYes
globalBooleantrue, falseNo
vrfStringNo

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

NameTypeConstraintMandatoryDefault Value
nameStringYes
directionChoiceinput, outputYes

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

NameTypeConstraintMandatoryDefault Value
prefixIPYes
eui_64Booleantrue, falseNo

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

NameTypeConstraintMandatoryDefault Value
idIntegermin: 1, max: 65535No
areasListStringNo

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

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

Examples

iosxe:
  devices:
    - name: Device1
      configuration:
        interfaces:
          ethernets:
            - id: 1/1
              type: GigabitEthernet
              description: Server 1 Interface
              speed: 1000
              port_channel_id: 10
              port_channel_mode: active
              switchport:
                mode: access
                access_vlan: 100
              spanning_tree:
                guard: loop
iosxe:
  devices:
    - name: Device1
      configuration:
        interfaces:
          ethernets:
            - type: GigabitEthernet
              id: 1/0/2
              description: L3 interface
              vrf_forwarding: "VRF-PROD"
              speed: 10000
              arp_timeout: 300
              load_interval: 90
              snmp_trap_link_status: false
              logging_event_link_status: false
              ipv4:
                arp_inspection_limit_rate: 40
                arp_inspection_trust: true
                address: 192.168.100.1
                address_mask: 255.255.255.0
                proxy_arp: true
                dhcp_relay_source_interface: Gig1/0/1
                helper_addresses:
                  - address: 10.1.1.1
                access_group_in: ACL-IN
                access_group_out: ACL-OUT
                redirects: false
                unreachables: false
                flow_monitors:
                  - name: FLOW1
                    direction: input
              ipv6:
                enable: true
                addresses:
                  - prefix: 2001::1
                    prefix_length: 64
                    eui64: true
                link_local_addresses:
                  - fe80::1
                mtu: 1450
                nd_ra_suppress_all: true
              bfd:
                enable: true
                local_address: 172.16.1.1
                interval: 100
                interval_multiplier: 3
                interval_min_rx: 101
                echo: false
              ospf:
                cost: 10
                dead_interval: 40
                hello_interval: 11
                mtu_ignore: false
                network_type: point-to-point
                priority: 1
                ttl_security_hops: 2
                process_ids:
                  - id: 1
                    areas:
                      - "0"
                message_digest_keys:
                  - id: 1
                    md5_auth_key: "cisco"
                    md5_auth_type: "0"
              ospfv3:
                cost: 10
                network_type: point-to-point
iosxe:
  devices:
    - name: Device1
      configuration:
        interfaces:
          ethernets:
            - type: GigabitEthernet
              id: 1/0/3
              description: L2 interface
              speed: 2500
              speed_nonegotiate: false
              spanning_tree:
                guard: root
                link_type: shared
                portfast_trunk: true
              switchport:
                mode: trunk
                trunk_allowed_vlans: 10-20,30,32
                trunk_native_vlan_id: 5