W3cubDocs

/Ansible

nxos_ospf_vrf - Manages a VRF for an OSPF router.

New in version 2.2.

Synopsis

Manages a VRF for an OSPF router.

Options

parameter required default choices comments
auto_cost
 no
Specifies the reference bandwidth used to assign OSPF cost. Valid values are an integer, in Mbps, or the keyword 'default'.
default_metric
 no
Specify the default Metric value. 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.
log_adjacency
 no
  • log
  • detail
  • default
Controls the level of log messages generated whenever a neighbor changes state. Valid values are 'log', 'detail', and 'default'.
ospf
 yes
Name of the OSPF instance.
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.
router_id
 no
Router Identifier (ID) of the OSPF router VRF instance.
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.
timer_throttle_lsa_hold
 no
Specify the hold interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_lsa_max
 no
Specify the max interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_lsa_start
 no
Specify the start interval for rate-limiting Link-State Advertisement (LSA) generation. Valid values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_spf_hold
 no
Specify minimum hold time between Shortest Path First (SPF) calculations. Valid values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_spf_max
 no
Specify the maximum wait time between Shortest Path First (SPF) calculations. Valid values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_spf_start
 no
Specify initial Shortest Path First (SPF) schedule delay. Valid values are an integer, in milliseconds, or the keyword 'default'.
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. The value of username 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.
vrf
 no default
Name of the resource instance. Valid value is a string. The name 'default' is a valid VRF representing the global OSPF.

Examples

- nxos_ospf_vrf:
    ospf: 1
    timer_throttle_spf_start: 50
    timer_throttle_spf_hold: 1000
    timer_throttle_spf_max: 2000
    timer_throttle_lsa_start: 60
    timer_throttle_lsa_hold: 1100
    timer_throttle_lsa_max: 3000
    vrf: test
    state: present
    username: "{{ un }}"
    password: "{{ pwd }}"
    host: "{{ inventory_hostname }}"

Return Values

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

name description returned type sample
end_state k/v pairs of configuration after module execution verbose mode dict {'router_id': '', 'timer_throttle_lsa_max': '3000', 'timer_throttle_spf_max': '2000', 'timer_throttle_lsa_hold': '1100', 'default_metric': '', 'log_adjacency': '', 'timer_throttle_lsa_start': '60', 'vrf': 'test', 'auto_cost': '40000', 'timer_throttle_spf_start': '50', 'ospf': '1', 'timer_throttle_spf_hold': '1000'}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['router ospf 1', 'vrf test', 'timers throttle lsa 60 1100 3000', 'timers throttle spf 50 1000 2000']
proposed k/v pairs of parameters passed into module verbose mode dict {'timer_throttle_lsa_max': '3000', 'timer_throttle_spf_max': '2000', 'timer_throttle_lsa_hold': '1100', 'timer_throttle_lsa_start': '60', 'vrf': 'test', 'timer_throttle_spf_start': '50', 'ospf': '1', 'timer_throttle_spf_hold': '1000'}
existing k/v pairs of existing configuration verbose mode dict {'router_id': '', 'timer_throttle_lsa_max': '5000', 'timer_throttle_spf_max': '5000', 'timer_throttle_lsa_hold': '5000', 'default_metric': '', 'log_adjacency': '', 'timer_throttle_lsa_start': '0', 'vrf': 'test', 'auto_cost': '40000', 'timer_throttle_spf_start': '200', 'ospf': '1', 'timer_throttle_spf_hold': '1000'}

Notes

Note

Value default restores params default value, if any. Otherwise it removes the existing param configuration.

This is a Core Module

For more information on what this means please read Core Modules

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

© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/nxos_ospf_vrf_module.html