arista.eos.eos_ospf_interfaces – OSPF Interfaces Resource Module.
Note
This plugin is part of the arista.eos collection (version 2.2.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 arista.eos.
To use it in a playbook, specify: arista.eos.eos_ospf_interfaces.
New in version 1.1.0: of arista.eos
Synopsis
This module manages OSPF configuration of interfaces on devices running Arista EOS.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
|---|---|
A list of OSPF configuration for interfaces. |
|
OSPF settings on the interfaces in address-family context. |
|
Address Family Identifier (AFI) for OSPF settings on the interfaces. Choices:
|
|
Area associated with interface. Valid only when afi = ipv4. |
|
Area ID as a decimal or IP address format. |
|
Configure the authentication key for the interface. Valid only when afi = ipv4. |
|
0 Specifies an UNENCRYPTED authentication key will follow. 7 Specifies a proprietry encryption type.` |
|
password (up to 8 chars). |
|
Authentication settings on the interface. Valid only when afi = ipv4. |
|
Use message-digest authentication. Choices:
|
|
Enable authentication on the interface. Choices:
|
|
Authentication settings on the interface. Valid only when afi = ipv6. |
|
Encryption alsgorithm. Choices:
|
|
128 bit MD5 key or 140 bit SHA1 key. |
|
Specifies if an unencrypted/hidden follows. 0 denotes unencrypted key. 7 denotes hidden key. |
|
Passphrase String for deriving keys for authentication and encryption. |
|
IPsec Security Parameter Index. |
|
Enable BFD. Choices:
|
|
metric associated with interface. |
|
Time interval to detect a dead router. |
|
Authentication settings on the interface. Valid only when afi = ipv6. |
|
algorithm. Choices:
|
|
encryption type. Choices:
|
|
key |
|
Specifies if an unencrypted/hidden follows. 0 denotes unencrypted key. 7 denotes hidden key. |
|
Passphrase String for deriving keys for authentication and encryption. |
|
IPsec Security Parameter Index. |
|
Timer interval between transmission of hello packets. |
|
Specify parameters for IPv4/IPv6. Valid only when afi = ipv6. |
|
Address Family Identifier (AFI) for OSPF settings on the interfaces. Choices:
|
|
Area associated with interface. Valid only when afi = ipv4. |
|
Area ID as a decimal or IP address format. |
|
Enable BFD. Choices:
|
|
metric associated with interface. |
|
Time interval to detect a dead router. |
|
Timer interval between transmission of hello packets. |
|
if True, Disable MTU check for Database Description packets. Choices:
|
|
Interface type. |
|
Suppress routing updates in an interface. Choices:
|
|
Interface priority. |
|
LSA retransmission interval. |
|
LSA transmission delay. |
|
Message digest authentication password (key) settings. |
|
0 Specifies an UNENCRYPTED ospf password (key) will follow. 7 Specifies a proprietry encryption type. |
|
Authentication key (upto 16 chars). |
|
Key ID. |
|
if True, Disable MTU check for Database Description packets. Choices:
|
|
Interface type. |
|
Suppress routing updates in an interface. Valid only when afi = ipv6. Choices:
|
|
Interface priority. |
|
LSA retransmission interval. |
|
Shutdown OSPF on this interface. Choices:
|
|
LSA transmission delay. |
|
Name/Identifier of the interface. |
|
This option is used only with state parsed. The value of this option should be the output received from the EOS device by executing the command show running-config | section interface. The state parsed reads the configuration from |
|
The state the configuration should be left in. Choices:
|
Examples
# Using merged
# Before state
# veos(config)#show running-config | section interface | ospf
# veos(config)#
- name: Merge provided configuration with device configuration
arista.eos.eos_ospf_interfaces:
config:
- name: "Vlan1"
address_family:
- afi: "ipv4"
area:
area_id: "0.0.0.50"
cost: 500
mtu_ignore: True
- afi: "ipv6"
dead_interval: 44
ip_params:
- afi: "ipv6"
mtu_ignore: True
network: "point-to-point"
state: merged
# After State
# veos(config)#show running-config | section interface | ospf
# interface Vlan1
# ip ospf cost 500
# ip ospf mtu-ignore
# ip ospf area 0.0.0.50
# ospfv3 dead-interval 44
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# veos(config)#
#
#
# Module Execution:
#
# "after": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.50"
# },
# "cost": 500,
# "mtu_ignore": True
# },
# {
# "afi": "ipv6",
# "dead_interval": 44,
# "ip_params": [
# {
# "afi": "ipv6",
# "mtu_ignore": True,
# "network": "point-to-point"
# }
# ]
# }
# ],
# "name": "Vlan1"
# }
# ],
# "before": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# }
# ],
# "changed": True,
# "commands": [
# "interface Vlan1",
# "ip ospf area 0.0.0.50",
# "ip ospf cost 500",
# "ip ospf mtu-ignore",
# "ospfv3 dead-interval 44",
# "ospfv3 ipv6 mtu-ignore",
# "ospfv3 ipv6 network point-to-point"
# ],
#
# Using replaced
#---------------
# Before State:
# veos(config)#show running-config | section interface | ospf
# interface Vlan1
# ip ospf cost 500
# ip ospf dead-interval 29
# ip ospf hello-interval 66
# ip ospf mtu-ignore
# ip ospf area 0.0.0.50
# ospfv3 cost 106
# ospfv3 hello-interval 77
# ospfv3 dead-interval 44
# ospfv3 transmit-delay 100
# ospfv3 ipv4 priority 45
# ospfv3 ipv4 area 0.0.0.5
# ospfv3 ipv6 passive-interface
# ospfv3 ipv6 retransmit-interval 115
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# !
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
# veos(config)#
- name: Replace device configuration with provided configuration
arista.eos.eos_ospf_interfaces:
config:
- name: "Vlan1"
address_family:
- afi: "ipv6"
cost: 44
bfd: True
ip_params:
- afi: "ipv6"
mtu_ignore: True
network: "point-to-point"
dead_interval: 56
state: replaced
# After State:
# veos(config)#show running-config | section interface | ospf
# interface Vlan1
# ospfv3 bfd
# ospfv3 cost 44
# no ospfv3 ipv6 passive-interface
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# !
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
# veos(config)#
#
# Module Execution:
#
# "after": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "bfd": True,
# "cost": 44,
# "ip_params": [
# {
# "afi": "ipv6",
# "mtu_ignore": True,
# "network": "point-to-point"
# }
# ]
# }
# ],
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ],
# "before": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.50"
# },
# "cost": 500,
# "dead_interval": 29,
# "hello_interval": 66,
# "mtu_ignore": True
# },
# {
# "afi": "ipv6",
# "cost": 106,
# "dead_interval": 44,
# "hello_interval": 77,
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.5"
# },
# "priority": 45
# },
# {
# "afi": "ipv6",
# "mtu_ignore": True,
# "network": "point-to-point",
# "passive_interface": True,
# "retransmit_interval": 115
# }
# ],
# "transmit_delay": 100
# }
# ],
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ],
# "changed": True,
# "commands": [
# "interface Vlan1",
# "no ip ospf cost 500",
# "no ip ospf dead-interval 29",
# "no ip ospf hello-interval 66",
# "no ip ospf mtu-ignore",
# "no ip ospf area 0.0.0.50",
# "ospfv3 cost 44",
# "ospfv3 bfd",
# "ospfv3 authentication ipsec spi 30 md5 passphrase 7 7hl8FV3lZ6H1mAKpjL47hQ==",
# "no ospfv3 ipv4 priority 45",
# "no ospfv3 ipv4 area 0.0.0.5",
# "ospfv3 ipv6 dead-interval 56",
# "no ospfv3 ipv6 passive-interface",
# "no ospfv3 ipv6 retransmit-interval 115",
# "no ospfv3 hello-interval 77",
# "no ospfv3 dead-interval 44",
# "no ospfv3 transmit-delay 100"
# ],
#
# Using overidden:
# ----------------
# Before State:
# veos(config)#show running-config | section interface | ospf
# interface Vlan1
# ip ospf dead-interval 29
# ip ospf hello-interval 66
# ip ospf mtu-ignore
# ospfv3 bfd
# ospfv3 cost 106
# ospfv3 hello-interval 77
# ospfv3 transmit-delay 100
# ospfv3 ipv4 priority 45
# ospfv3 ipv4 area 0.0.0.5
# ospfv3 ipv6 passive-interface
# ospfv3 ipv6 dead-interval 56
# ospfv3 ipv6 retransmit-interval 115
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# !
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
# veos(config)#
- name: Override device configuration with provided configuration
arista.eos.eos_ospf_interfaces:
config:
- name: "Vlan1"
address_family:
- afi: "ipv6"
cost: 44
bfd: True
ip_params:
- afi: "ipv6"
mtu_ignore: True
network: "point-to-point"
dead_interval: 56
state: overridden
# After State:
# veos(config)#show running-config | section interface | ospf
# interface Vlan1
# ospfv3 bfd
# ospfv3 cost 44
# no ospfv3 ipv6 passive-interface
# ospfv3 ipv6 dead-interval 56
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# veos(config)#
#
#
# Module Execution:
#
# "after": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "bfd": True,
# "cost": 44,
# "ip_params": [
# {
# "afi": "ipv6",
# "dead_interval": 56,
# "mtu_ignore": True,
# "network": "point-to-point"
# }
# ]
# }
# ],
# "name": "Vlan1"
# },
# {
# "name": "Vlan2"
# }
# ],
# "before": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv4",
# "dead_interval": 29,
# "hello_interval": 66,
# "mtu_ignore": True
# },
# {
# "afi": "ipv6",
# "bfd": True,
# "cost": 106,
# "hello_interval": 77,
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.5"
# },
# "priority": 45
# },
# {
# "afi": "ipv6",
# "dead_interval": 56,
# "mtu_ignore": True,
# "network": "point-to-point",
# "passive_interface": True,
# "retransmit_interval": 115
# }
# ],
# "transmit_delay": 100
# }
# ],
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ],
# "changed": True,
# "commands": [
# "interface Vlan2",
# "no ospfv3 ipv4 hello-interval 45",
# "no ospfv3 ipv4 retransmit-interval 100",
# "no ospfv3 ipv4 area 0.0.0.6",
# "interface Vlan1",
# "no ip ospf dead-interval 29",
# "no ip ospf hello-interval 66",
# "no ip ospf mtu-ignore",
# "ospfv3 cost 44",
# "ospfv3 authentication ipsec spi 30 md5 passphrase 7 7hl8FV3lZ6H1mAKpjL47hQ==",
# "no ospfv3 ipv4 priority 45",
# "no ospfv3 ipv4 area 0.0.0.5",
# "no ospfv3 ipv6 passive-interface",
# "no ospfv3 ipv6 retransmit-interval 115",
# "no ospfv3 hello-interval 77",
# "no ospfv3 transmit-delay 100"
# ],
#
# Using deleted:
#--------------
# before State:
# veos(config)#show running-config | section interface | ospf
# interface Vlan1
# ip ospf dead-interval 29
# ip ospf hello-interval 66
# ip ospf mtu-ignore
# ospfv3 bfd
# ospfv3 cost 106
# ospfv3 hello-interval 77
# ospfv3 transmit-delay 100
# ospfv3 ipv4 priority 45
# ospfv3 ipv4 area 0.0.0.5
# ospfv3 ipv6 passive-interface
# ospfv3 ipv6 dead-interval 56
# ospfv3 ipv6 retransmit-interval 115
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# !
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
# veos(config)#
- name: Delete device configuration
arista.eos.eos_ospf_interfaces:
config:
- name: "Vlan1"
state: deleted
# After State:
# veos#show running-config | section interface | ospf
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
#
# Module Execution:
#
# "after": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ],
# "before": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv4",
# "dead_interval": 29,
# "hello_interval": 66,
# "mtu_ignore": True
# },
# {
# "afi": "ipv6",
# "bfd": True,
# "cost": 106,
# "hello_interval": 77,
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.5"
# },
# "priority": 45
# },
# {
# "afi": "ipv6",
# "dead_interval": 56,
# "mtu_ignore": True,
# "network": "point-to-point",
# "passive_interface": True,
# "retransmit_interval": 115
# }
# ],
# "transmit_delay": 100
# }
# ],
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ],
# "changed": True,
# "commands": [
# "interface Vlan1",
# "no ip ospf dead-interval 29",
# "no ip ospf hello-interval 66",
# "no ip ospf mtu-ignore",
# "no ospfv3 bfd",
# "no ospfv3 cost 106",
# "no ospfv3 hello-interval 77",
# "no ospfv3 transmit-delay 100",
# "no ospfv3 ipv4 priority 45",
# "no ospfv3 ipv4 area 0.0.0.5",
# "no ospfv3 ipv6 passive-interface",
# "no ospfv3 ipv6 dead-interval 56",
# "no ospfv3 ipv6 retransmit-interval 115",
# "no ospfv3 ipv6 network point-to-point",
# "no ospfv3 ipv6 mtu-ignore"
# ],
#
# Using parsed:
# ------------
# parsed.cfg:
# ----------
# interface Vlan1
# ip ospf dead-interval 29
# ip ospf hello-interval 66
# ip ospf mtu-ignore
# ip ospf cost 500
# ospfv3 bfd
# ospfv3 cost 106
# ospfv3 hello-interval 77
# ospfv3 transmit-delay 100
# ospfv3 ipv4 priority 45
# ospfv3 ipv4 area 0.0.0.5
# ospfv3 ipv6 passive-interface
# ospfv3 ipv6 dead-interval 56
# ospfv3 ipv6 retransmit-interval 115
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# !
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
#
- name: parse configs
arista.eos.eos_ospf_interfaces:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Module Execution:
# "parsed": [
# {
# "address_family": [
# {
# "afi": "ipv4",
# "cost": 500,
# "dead_interval": 29,
# "hello_interval": 66,
# "mtu_ignore": True
# },
# {
# "afi": "ipv6",
# "bfd": True,
# "cost": 106,
# "hello_interval": 77,
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.5"
# },
# "priority": 45
# },
# {
# "afi": "ipv6",
# "dead_interval": 56,
# "mtu_ignore": True,
# "network": "point-to-point",
# "passive_interface": True,
# "retransmit_interval": 115
# }
# ],
# "transmit_delay": 100
# }
# ],
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ]
# Using gathered:
# Device COnfig:
# veos#show running-config | section interface | ospf
# interface Vlan1
# ip ospf cost 500
# ip ospf dead-interval 29
# ip ospf hello-interval 66
# ip ospf mtu-ignore
# ip ospf area 0.0.0.50
# ospfv3 cost 106
# ospfv3 hello-interval 77
# ospfv3 transmit-delay 100
# ospfv3 ipv4 priority 45
# ospfv3 ipv4 area 0.0.0.5
# ospfv3 ipv6 passive-interface
# ospfv3 ipv6 dead-interval 56
# ospfv3 ipv6 retransmit-interval 115
# ospfv3 ipv6 network point-to-point
# ospfv3 ipv6 mtu-ignore
# !
# interface Vlan2
# ospfv3 ipv4 hello-interval 45
# ospfv3 ipv4 retransmit-interval 100
# ospfv3 ipv4 area 0.0.0.6
# veos#
- name: gather configs
arista.eos.eos_ospf_interfaces:
state: gathered
# Module Execution:
#
# "gathered": [
# {
# "name": "Ethernet1"
# },
# {
# "name": "Ethernet2"
# },
# {
# "name": "Management1"
# },
# {
# "address_family": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.50"
# },
# "cost": 500,
# "dead_interval": 29,
# "hello_interval": 66,
# "mtu_ignore": True
# },
# {
# "afi": "ipv6",
# "cost": 106,
# "hello_interval": 77,
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.5"
# },
# "priority": 45
# },
# {
# "afi": "ipv6",
# "dead_interval": 56,
# "mtu_ignore": True,
# "network": "point-to-point",
# "passive_interface": True,
# "retransmit_interval": 115
# }
# ],
# "transmit_delay": 100
# }
# ],
# "name": "Vlan1"
# },
# {
# "address_family": [
# {
# "afi": "ipv6",
# "ip_params": [
# {
# "afi": "ipv4",
# "area": {
# "area_id": "0.0.0.6"
# },
# "hello_interval": 45,
# "retransmit_interval": 100
# }
# ]
# }
# ],
# "name": "Vlan2"
# }
# ],
#
# Using rendered:
# --------------
- name: Render provided configuration
arista.eos.eos_ospf_interfaces:
config:
- name: "Vlan1"
address_family:
- afi: "ipv4"
dead_interval: 29
mtu_ignore: True
hello_interval: 66
- afi: "ipv6"
hello_interval: 77
cost : 106
transmit_delay: 100
ip_params:
- afi: "ipv6"
retransmit_interval: 115
dead_interval: 56
passive_interface: True
- afi: "ipv4"
area:
area_id: "0.0.0.5"
priority: 45
- name: "Vlan2"
address_family:
- afi: "ipv6"
ip_params:
- afi: "ipv4"
area:
area_id: "0.0.0.6"
hello_interval: 45
retransmit_interval: 100
- afi: "ipv4"
message_digest_key:
key_id: 200
encryption: 7
key: "hkdfhtu=="
state: rendered
# Module Execution:
#
# "rendered": [
# "interface Vlan1",
# "ip ospf dead-interval 29",
# "ip ospf mtu-ignore",
# "ip ospf hello-interval 66",
# "ospfv3 hello-interval 77",
# "ospfv3 cost 106",
# "ospfv3 transmit-delay 100",
# "ospfv3 ipv4 area 0.0.0.5",
# "ospfv3 ipv4 priority 45",
# "ospfv3 ipv6 retransmit-interval 115",
# "ospfv3 ipv6 dead-interval 56",
# "ospfv3 ipv6 passive-interface",
# "interface Vlan2",
# "ip ospf message-digest-key 200 md5 7 hkdfhtu==",
# "ospfv3 ipv4 area 0.0.0.6",
# "ospfv3 ipv4 hello-interval 45",
# "ospfv3 ipv4 retransmit-interval 100"
# ]
#
Authors
Gomathi Selvi Srinivasan (@GomathiselviS)