cisco.nxos.nxos_interface_ospf module – (deprecated, removed after 2022-10-26) Manages configuration of an OSPF interface instance.
Note
This module is part of the cisco.nxos collection (version 3.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 cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_interface_ospf
.
New in cisco.nxos 1.0.0
DEPRECATED
- Removed in:
major release after 2022-10-26
- Why:
Updated modules released with more functionality
- Alternative:
nxos_ospf_interfaces
Synopsis
Manages configuration of an OSPF interface instance.
Note
This module has a corresponding action plugin.
Parameters
Parameter |
Comments |
---|---|
Ospf area associated with this cisco_interface_ospf instance. Valid values are a string, formatted as an IP address (i.e. “0.0.0.0”) or as an integer. |
|
Enables bfd at interface level. This overrides the bfd variable set at the ospf router level. Valid values are ‘enable’, ‘disable’ or ‘default’. Dependency: ‘’feature bfd’’ Choices:
|
|
The cost associated with this cisco_interface_ospf instance. |
|
Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer or the keyword ‘default’. |
|
Time between sending successive hello packets. Valid values are an integer or the keyword ‘default’. |
|
Name of this cisco_interface resource. Valid value is a string. |
|
Enables or disables the usage of message digest authentication. Choices:
|
|
Algorithm used for authentication among neighboring routers within an area. Valid values are ‘md5’ and ‘default’. Choices:
|
|
Specifies the scheme used for encrypting message_digest_password. Valid values are ‘3des’ or ‘cisco_type_7’ encryption or ‘default’. Choices:
|
|
Md5 authentication key-id associated with the ospf instance. If this is present, message_digest_encryption_type, message_digest_algorithm_type and message_digest_password are mandatory. Valid value is an integer and ‘default’. |
|
Specifies the message_digest password. Valid value is a string. |
|
Specifies interface ospf network type. Valid values are ‘point-to-point’ or ‘broadcast’. Choices:
|
|
Name of the ospf instance. |
|
Enable or disable passive-interface state on this interface. true - (enable) Prevent OSPF from establishing an adjacency or sending routing updates on this interface. false - (disable) Override global ‘passive-interface default’ for this interface. Choices:
|
|
Deprecated Starting with Ansible 2.5 we recommend using Starting with Ansible 2.6 we recommend using This option will be removed in a release after 2022-06-01. For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.html. A dict object containing connection details. |
|
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable |
|
Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable Choices:
|
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. |
|
Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or nxapi transports. If the value is not specified in the task, the value of environment variable |
|
Specifies the port to use when building the connection to the remote device. This value applies to either cli or nxapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). |
|
Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the cli transport. If the value is not specified in the task, the value of environment variable |
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). |
|
Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. Choices:
|
|
If Choices:
|
|
Configures the transport to use SSL if set to Choices:
|
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable |
|
If Choices:
|
|
Determines whether the config should be present or not on the device. Choices:
|
Notes
Note
Tested against NXOSv 7.3.(0)D1(1) on VIRL
Unsupported for Cisco MDS
Default, where supported, restores params default value.
To remove an existing authentication configuration you should use
message_digest_key_id=default
plus all other options matching their existing values.Loopback interfaces only support ospf network type ‘point-to-point’.
state=absent
removes the whole OSPF interface configuration.For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.
Examples
- cisco.nxos.nxos_interface_ospf:
interface: ethernet1/32
ospf: 1
area: 1
bfd: disable
cost: default
- cisco.nxos.nxos_interface_ospf:
interface: loopback0
ospf: prod
area: 0.0.0.0
bfd: enable
network: point-to-point
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
commands sent to the device Returned: always Sample: |
Status
This module will be removed in a major release after 2022-10-26. [deprecated]
For more information see DEPRECATED.