Try SpotterCreate, update or delete an OSPF interface configuration.
| "added in version" 4.1.0 of arubanetworks.aoscx"
Authors: Aruba Networks (@ArubaNetworks)
preview | supported by certified
Install with ansible-galaxy collection install arubanetworks.aoscx:==4.3.2
collections:
- name: arubanetworks.aoscx
version: 4.3.2This module provides configuration management of OSPF interface on AOS-CX devices.
---
- name: Attach an OSPF router and area to interface 1/1/1
aoscx_ospf_interface:
vrf: RED
version: v3
ospf_id: 5
area_id: 1.1.1.1
interface_name: 1/1/1
state: create
- name: Remove interface 1/1/3 from OSPFv3 Area 1.1.1.1
aoscx_ospf_interface:
vrf: RED
version: v3
ospf_id: 5
area_id: 1.1.1.1
interface_name: 1/1/3
state: delete
- name: Set the OSPFv3 transmit delay in interface 1/1/13
aoscx_ospf_interface:
vrf: default
version: v3
ospf_id: 4
area_id: 1.1.1.2
interface_name: 1/1/13
transmit_delay: 20
- name: Enable OSPF authentication
aoscx_ospf_interface:
vrf: default
version: v2
ospf_id: 5
area_id: 1.1.1.1
interface_name: 1/1/4
ospfv2_auth_type: sha1
ospfv2_auth_sha_keys:
- id: 1
key: sha_key_1
- id: 2
key: sha_key_2
bfd:
choices:
- enable
- disable
- default
description: 'Specifies whether the router global Bidirectional Forwarding Detection
(BFD) mode should be overridden for this particular interface.
'
required: false
type: str
vrf:
description: Alphanumeric name of the VRF the OSPF ID belongs to.
required: true
type: str
cost:
description: Output cost configured for the interface.
required: false
type: int
type:
choices:
- none
- broadcast
- nbma
- point_to_point
- point_to_multipoint
- virtual_link
- loopback
description: The type of the OSPF network interface.
required: false
type: str
state:
choices:
- create
- update
- delete
default: create
description: 'Create, update, or delete the OSPF interface_name configuration.
'
required: false
type: str
area_id:
description: Unique identifier in X.X.X.X format.
required: true
type: str
ospf_id:
description: OSPF process ID between numbers 1-63.
required: true
type: int
version:
choices:
- v2
- v3
description: 'OSPF version. ''v2'' for OSPFv2 and ''v3'' for OSPFv3.
'
required: true
type: str
priority:
description: 'The router with the highest priority will be more eligible to become
the Designated Router. Setting the value to 0, makes the router ineligible to become
the Designated Router.
'
required: false
type: int
shutdown:
description: Shutdown OSPF functionalities on this interface.
required: false
type: bool
dead_interval:
description: 'The time duration, in seconds, that a neighbor should wait for a Hello
packet before tearing down adjacencies with the local router.
'
required: false
type: int
hello_interval:
description: 'The Hello packet will be sent every hello interval timer value seconds.
'
required: false
type: int
interface_name:
description: 'Name of the Interface in which the OSPF process must be attached.
'
required: true
type: str
transmit_delay:
description: 'The estimated time in seconds to transmit an LSA to a neighbor.
'
required: false
type: int
ospfv3_ipsec_ah:
description: 'IPsec Authentication Header (AH) configuration. ''ospfv3_ipsec_ah''
will be used if ''ospfv3_ipsec_esp'' is also configured.
'
required: false
suboptions:
ah_null:
description: 'Disable OSPF IPsec AH authentication. This is used to override OSPF_Area
level IPsec AH authentication. When IPsec AH is configured at OSPF_Area, set
true to disable OSPF IPsec AH on this interface. When IPsec AH is configured
at OSPF_Area and OSPF Interface, making true will remove OSPF Interface IPsec
AH configuration and disable OSPF IPsec AH on this interface.
'
required: false
type: bool
auth_key:
description: 'Authentication key. This parameter is required if auth_type and
spi are set.
'
required: false
type: str
auth_type:
choices:
- md5
- sha1
description: 'Authentication algorithm. This parameter is required if auth_key
is set.
'
required: false
type: str
spi:
description: 'Security Parameters Index (SPI) for the Security Association. AH
SPI must be unique on a router. This parameter is required if auth_key is set.
'
required: false
type: int
type: dict
ospfv2_auth_type:
choices:
- none
- text
- md5
- sha1
- sha256
- sha384
- sha512
- keychain
description: 'The type of OSPFv2 authentication. If not set, then parent area level
authentication holds for the port.
'
required: false
type: str
ospfv3_ipsec_esp:
description: 'IPsec Encapsulating Security Payload (ESP) configuration. ''ospfv3_ipsec_ah''
will be used if ''ospfv3_ipsec_esp'' is also configured.
'
required: false
suboptions:
auth_key:
description: IPsec ESP authentication key.
required: true
type: str
auth_type:
choices:
- md5
- sha1
description: IPsec ESP authentication algorithm.
required: true
type: str
encryption_key:
description: IPsec ESP encryption key.
required: false
type: str
encryption_type:
choices:
- des
- 3des
- aes
- none
description: IPsec ESP encryption algorithm.
required: true
type: str
esp_null:
description: 'Disable OSPF IPsec ESP encryption and authentication. This is used
to override OSPF Area-level IPsec ESP encryption and authentication. When IPsec
ESP is configured at OSPF Area-level, true disables OSPF IPsec ESP on this interface.
When IPsec ESP is configured at OSPF Area-level and OSPF Interface, true removes
OSPF Interface IPsec ESP configuration and disable OSPF IPsec ESP on this interface.
'
required: false
type: bool
spi:
description: 'Security Parameters Index (SPI) for the Security Association. ESP
SPI must be unique on a router.
'
required: true
type: int
type: dict
no_ospfv3_ipsec_ah:
description: 'Option to delete ospfv3 IPsec AH configuration. This option is mutually
exclusive with the `ospfv3_ipsec_ah` option.
'
required: false
type: bool
retransmit_interval:
description: The number of seconds between LSA retransmissions.
required: false
type: int
ospfv2_auth_keychain:
description: 'Name of the "Keychain" used for cryptographic authentication. Supports
MD5, SHA-1, SHA-256, SHA-384, and SHA-512.
'
required: false
type: str
ospfv2_auth_md5_keys:
description: 'The authentication keys for OSPFv2 authentication type "md5".
'
elements: dict
required: false
suboptions:
id:
description: Key ID for secure-hash key. In range 1, 255.
required: true
type: int
key:
description: MD5 key to use.
required: true
type: str
type: list
ospfv2_auth_sha_keys:
description: 'The authentication keys for OSPFv2 authentication type "sha".
'
elements: dict
required: false
suboptions:
id:
description: Key ID for secure-hash key. In range 1, 255.
required: true
type: int
key:
description: SHA key to use.
required: true
type: str
type: list
ospfv2_auth_text_key:
description: 'The authentication key for OSPFv2 authentication type "text".
'
required: false
type: str