cisco.nxos.nxos_ospf_vrf – (deprecated, removed after 2022-10-01)Manages a VRF for an OSPF router.  Note This plugin is part of the cisco.nxos collection (version 1.3.1). To install it use: ansible-galaxy collection install cisco.nxos. To use it in a playbook, specify: cisco.nxos.nxos_ospf_vrf.   New in version 1.0.0: of cisco.nxos   DEPRECATED Synopsis Parameters Notes Examples Return Values Status  DEPRECATED  Removed in 
major release after 2022-10-01  Why 
Updated modules released with more functionality.  Alternative 
nxos_ospfv2 and nxos_ospfv3   Synopsis  Manages a VRF for an OSPF router.   Note This module has a corresponding action plugin.  Parameters   Parameter Choices/Defaults Comments    auto_cost  string      Specifies the reference bandwidth used to assign OSPF cost. Valid values are an integer, in Mbps, or the keyword 'default'.     bfd  string    
Choices: enable disable    Enables BFD on all OSPF interfaces. Dependency: ''feature bfd''     default_metric  string      Specify the default Metric value. Valid values are an integer or the keyword 'default'.     log_adjacency  string    
Choices: log detail default    Controls the level of log messages generated whenever a neighbor changes state. Valid values are 'log', 'detail', and 'default'.     ospf  string / required      Name of the OSPF instance.     passive_interface  boolean    
Choices: no yes    Setting to yes will suppress routing update on interface.     provider  dictionary      Deprecated Starting with Ansible 2.5 we recommend using connection: network_cli. Starting with Ansible 2.6 we recommend using connection: httpapi for NX-API. This option will be removed in a release after 2022-06-01. For more information please see the NXOS Platform Options guide. A dict object containing connection details.      auth_pass  string      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 ANSIBLE_NET_AUTH_PASS will be used instead.      authorize  boolean    
Choices: 
no ← yes    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 ANSIBLE_NET_AUTHORIZE will be used instead.      host  string      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.      password  string      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  integer      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).      ssh_keyfile  string      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.      timeout  integer      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  string    
Choices: 
cli ← nxapi    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_proxy  boolean    
Choices: no 
yes ←    If no, the environment variables http_proxy and https_proxy will be ignored.      use_ssl  boolean    
Choices: 
no ← yes    Configures the transport to use SSL if set to yes only when the transport=nxapi, otherwise this value is ignored.      username  string      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  boolean    
Choices: 
no ← yes    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.     router_id  string      Router Identifier (ID) of the OSPF router VRF instance.     state  string    
Choices: 
present ← absent    State of ospf vrf configuration.     timer_throttle_lsa_hold  string      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  string      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  string      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  string      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  string      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  string      Specify initial Shortest Path First (SPF) schedule delay. Valid values are an integer, in milliseconds, or the keyword 'default'.     vrf  string    Default:"default"   Name of the resource instance. Valid value is a string. The name 'default' is a valid VRF representing the global OSPF.     Notes  Note  Tested against NXOSv 7.3.(0)D1(1) on VIRL Value default restores params default value, if any. Otherwise it removes the existing param configuration. For information on using CLI and NX-API see the NXOS Platform Options guide
 For more information on using Ansible to manage network devices see the Ansible Network Guide
 For more information on using Ansible to manage Cisco devices see the Cisco integration page.   Examples - cisco.nxos.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
    bfd: enable
    state: present
 Return Values Common return values are documented here, the following are the fields unique to this module:   Key Returned Description    commands  list / elements=string   always  commands sent to the device  Sample: ['router ospf 1', 'vrf test', 'bfd', 'timers throttle lsa 60 1100 3000']     Status  This module will be removed in a major release after 2022-10-01. [deprecated]
 For more information see DEPRECATED.  Authors  Gabriele Gerbino (@GGabriele) 

    © 2012–2018 Michael DeHaan
{'path': 'public/docs/ansible~2.10/collections/cisco/nxos/nxos_ospf_vrf_module.html', 'source': 'DevDocs.IO'}