Documentation

nxos_interface_ospf - Manages configuration of an OSPF interface instance.

New in version 2.2.

Synopsis

  • Manages configuration of an OSPF interface instance.

Options

parameter required default choices comments
area
yes
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.
cost
no
The cost associated with this cisco_interface_ospf instance.
dead_interval
no
Time interval an ospf neighbor waits for a hello packet before tearing down adjacencies. Valid values are an integer or the keyword 'default'.
hello_interval
no
Time between sending successive hello packets. Valid values are an integer or the keyword 'default'.
host
yes
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.
interface
yes
Name of this cisco_interface resource. Valid value is a string.
message_digest
no
  • true
  • false
Enables or disables the usage of message digest authentication. Valid values are 'true' and 'false'.
message_digest_algorithm_type
no
  • md5
Algorithm used for authentication among neighboring routers within an area. Valid values is 'md5'.
message_digest_encryption_type
no
  • cisco_type_7
  • 3des
Specifies the scheme used for encrypting message_digest_password. Valid values are '3des' or 'cisco_type_7' encryption.
message_digest_key_id
no
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'.
message_digest_password
no
Specifies the message_digest password. Valid value is a string.
ospf
yes
Name of the ospf instance.
passive_interface
no
  • true
  • false
Setting to true will prevent this interface from receiving HELLO packets. Valid values are 'true' and 'false'.
password
no
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 ANSIBLE_NET_PASSWORD will be used instead.
port
no 0 (use common port)
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).
provider
no
Convenience method that allows all nxos arguments to be passed as a dict object. All constraints (required, choices, etc) must be met either by individual arguments or values in this dict.
ssh_keyfile
no
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 ANSIBLE_NET_SSH_KEYFILE will be used instead.
state
no present
  • present
  • absent
Determines whether the config should be present or not on the device.
timeout
(added in 2.3)
no 10
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).
transport
yes cli
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.
use_ssl
no
  • yes
  • no
Configures the transport to use SSL if set to true only when the transport=nxapi, otherwise this value is ignored.
username
no
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 ANSIBLE_NET_USERNAME will be used instead.
validate_certs
no
  • yes
  • no
If no, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored.

Examples

- nxos_interface_ospf:
    interface: ethernet1/32
    ospf: 1
    area: 1
    cost: default
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
end_state k/v pairs of OSPF configuration after module execution verbose mode dict {'hello_interval': '', 'area': '0.0.0.1', 'message_digest_algorithm_type': '', 'message_digest_key_id': '', 'message_digest_encryption_type': '', 'dead_interval': '', 'cost': '', 'passive_interface': False, 'message_digest_password': '', 'interface': 'ethernet1/32', 'ospf': '1', 'message_digest': False}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['interface Ethernet1/32', 'ip router ospf 1 area 0.0.0.1']
proposed k/v pairs of parameters passed into module verbose mode dict {'interface': 'ethernet1/32', 'ospf': '1', 'area': '1'}
existing k/v pairs of existing OSPF configuration verbose mode dict {'hello_interval': '', 'area': '', 'message_digest_algorithm_type': '', 'message_digest_key_id': '', 'message_digest_encryption_type': '', 'dead_interval': '', 'cost': '', 'passive_interface': False, 'message_digest_password': '', 'interface': 'ethernet1/32', 'ospf': '', 'message_digest': False}


Notes

Note

  • 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.
  • state=absent removes the whole OSPF interface configuration.

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.