Try SpotterManages a VRF for an OSPF router.
| "added in version" 2.2 of ansible.builtin"
Authors: Gabriele Gerbino (@GGabriele)
preview | supported by network
pipInstall with pip install ansible==2.9.13
Manages a VRF for an OSPF router.
- 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
bfd:
choices:
- enable
- disable
description:
- Enables BFD on all OSPF interfaces.
- 'Dependency: ''feature bfd'''
type: str
version_added: '2.9'
version_added_collection: ansible.builtin
vrf:
default: default
description:
- Name of the resource instance. Valid value is a string. The name 'default' is a
valid VRF representing the global OSPF.
ospf:
description:
- Name of the OSPF instance.
required: true
state:
choices:
- present
- absent
default: present
description:
- State of ospf vrf configuration.
provider:
description:
- B(Deprecated)
- 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).'
- 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.'
- This option will be removed in a release after 2022-06-01.
- For more information please see the L(NXOS Platform Options guide, ../network/user_guide/platform_nxos.html).
- HORIZONTALLINE
- A dict object containing connection details.
suboptions:
auth_pass:
description:
- Specifies the password to use if required to enter privileged mode on the remote
device. If I(authorize) is false, then this argument does nothing. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS)
will be used instead.
type: str
authorize:
default: false
description:
- 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead.
type: bool
host:
description:
- 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.
type: str
password:
description:
- Specifies the password to use to authenticate the connection to the remote device. This
is a common argument used for either I(cli) or I(nxapi) transports. If the value
is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD)
will be used instead.
type: str
port:
description:
- Specifies the port to use when building the connection to the remote device. This
value applies to either I(cli) or I(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).
type: int
ssh_keyfile:
description:
- Specifies the SSH key to use to authenticate the connection to the remote device. This
argument is only used for the I(cli) transport. If the value is not specified
in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will
be used instead.
type: str
timeout:
description:
- 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).
type: int
transport:
choices:
- cli
- nxapi
default: cli
description:
- 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.
type: str
use_proxy:
default: true
description:
- If C(no), the environment variables C(http_proxy) and C(https_proxy) will be
ignored.
type: bool
use_ssl:
default: false
description:
- Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi),
otherwise this value is ignored.
type: bool
username:
description:
- 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 C(ANSIBLE_NET_USERNAME) will
be used instead.
type: str
validate_certs:
default: false
description:
- If C(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.
type: bool
type: dict
auto_cost:
description:
- Specifies the reference bandwidth used to assign OSPF cost. Valid values are an
integer, in Mbps, or the keyword 'default'.
router_id:
description:
- Router Identifier (ID) of the OSPF router VRF instance.
log_adjacency:
choices:
- log
- detail
- default
description:
- Controls the level of log messages generated whenever a neighbor changes state.
Valid values are 'log', 'detail', and 'default'.
default_metric:
description:
- Specify the default Metric value. Valid values are an integer or the keyword 'default'.
passive_interface:
description:
- Setting to C(yes) will suppress routing update on interface.
type: bool
version_added: '2.4'
version_added_collection: ansible.builtin
timer_throttle_lsa_max:
description:
- 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_spf_max:
description:
- Specify the maximum wait time between Shortest Path First (SPF) calculations. Valid
values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_lsa_hold:
description:
- 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_spf_hold:
description:
- Specify minimum hold time between Shortest Path First (SPF) calculations. Valid
values are an integer, in milliseconds, or the keyword 'default'.
timer_throttle_lsa_start:
description:
- 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_start:
description:
- Specify initial Shortest Path First (SPF) schedule delay. Valid values are an integer,
in milliseconds, or the keyword 'default'.
commands: description: commands sent to the device returned: always sample: - router ospf 1 - vrf test - bfd - timers throttle lsa 60 1100 3000 type: list