dellemc.enterprise_sonic.sonic_interfaces module – Configure Interface attributes on interfaces such as, Eth, LAG, VLAN, and loopback. (create a loopback interface if it does not exist.)
Note
This module is part of the dellemc.enterprise_sonic collection (version 2.4.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.enterprise_sonic.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_interfaces.
New in dellemc.enterprise_sonic 1.0.0
Synopsis
Configure Interface attributes such as, MTU, admin statu, and so on, on interfaces such as, Eth, LAG, VLAN, and loopback. (create a loopback interface if it does not exist.)
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
|---|---|
A list of interface configurations. |
|
Advertised speeds of the interface. Supported speeds are dependent on the type of switch. Speeds may be 10, 100, 1000, 2500, 5000, 10000, 20000, 25000, 40000, 50000, 100000 or 400000. |
|
auto-negotiate transmission parameters with peer interface. Choices:
|
|
Description about the interface. |
|
Administrative state of the interface. Choices:
|
|
Interface FEC (Forward Error Correction). Choices:
|
|
MTU of the interface. |
|
The name of the interface, for example, ‘Eth1/15’. |
|
Interface speed. Supported speeds are dependent on the type of switch. Choices:
|
|
The state the configuration should be left in. Choices:
|
Notes
Note
Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports
check_mode.
Examples
# Using deleted
#
# Before state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 Ethernet-8 down 100000 9100
#Ethernet12 Ethernet-12 down on - 5000
#Ethernet16 - down 40000 9100
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed 100000
# fec AUTO
# shutdown
#
- name: Configure interfaces
sonic_interfaces:
config:
- name: Ethernet8
- name: Ethernet12
- name: Ethernet16
state: deleted
#
# After state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - up 100000 9100
#Ethernet12 - up 100000 9100
#Ethernet16 - up 100000 9100
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed 100000
# shutdown
#
# Using deleted
#
# Before state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - down 100000 9100
#Ethernet12 - down 1000 9100
#Ethernet16 - down 100000 9100
#
- name: Configure interfaces
sonic_interfaces:
config:
state: deleted
#
# After state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - up 100000 9100
#Ethernet12 - up 100000 9100
#Ethernet16 - up 100000 9100
#
#
#
# Using merged
#
# Before state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - down 100000 9100
#Ethernet12 - down 100000 9100
#Ethernet16 - down 100000 9100
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed 100000
# shutdown
#
- name: Configure interfaces
sonic_interfaces:
config:
- name: Ethernet8
fec: FEC_AUTO
- name: Ethernet12
description: 'Ethernet Twelve'
auto_negotiate: True
- name: Ethernet16
description: 'Ethernet Sixteen'
enabled: True
mtu: 3500
speed: SPEED_40GB
state: merged
#
# After state:
# ------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - down 100000 9100
#Ethernet12 Ethernet Twelve down on 100000 9100
#Ethernet16 Ethernet Sixteen up 40000 3500
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed 100000
# fec AUTO
# shutdown
#
# Using overridden
#
# Before state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 E0 up 100000 9100
#Ethernet4 E4 up 100000 9100
#Ethernet8 E8 down 100000 9100
#Ethernet12 - down 1000 9100
#Ethernet16 - down 100000 9100
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed 100000
# shutdown
#
- name: Configure interfaces
sonic_interfaces:
config:
- name: Ethernet8
fec: FEC_AUTO
- name: Ethernet12
description: 'Ethernet Twelve'
mtu: 3500
enabled: True
auto_negotiate: True
- name: Ethernet16
description: 'Ethernet Sixteen'
mtu: 3000
enabled: False
speed: SPEED_40GB
state: overridden
#
# After state:
# ------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - up 100000 9100
#Ethernet12 Ethernet Twelve up on 100000 3500
#Ethernet16 Ethernet Sixteen down 40000 3000
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed 100000
# fec AUTO
# no shutdown
#
# Using replaced
#
# Before state:
# -------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - down on 100000 9100
#Ethernet12 - down 1000 9100
#Ethernet16 - down 100000 9100
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed auto 40000
# shutdown
#
- name: Configure interfaces
sonic_interfaces:
config:
- name: Ethernet8
advertised_speed:
- "100000"
- name: Ethernet12
description: 'Ethernet Twelve'
mtu: 3500
enabled: True
auto_negotiate: True
- name: Ethernet16
description: 'Ethernet Sixteen'
mtu: 3000
enabled: False
speed: SPEED_40GB
state: replaced
#
# After state:
# ------------
#
# show interface status | no-more
#------------------------------------------------------------------------------------------
#Name Description Admin Oper AutoNeg Speed MTU
#------------------------------------------------------------------------------------------
#Ethernet0 - up 100000 9100
#Ethernet4 - up 100000 9100
#Ethernet8 - down on 100000 9100
#Ethernet12 Ethernet Twelve up on 100000 3500
#Ethernet16 Ethernet Sixteen down 40000 3000
#
# show running-configuration interface Ethernet 8
#!
#interface Ethernet8
# mtu 9100
# speed auto 100000
# fec AUTO
# shutdown
#
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration model invocation. Returned: when changed Sample: |
|
The configuration prior to the model invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |