Note
This plugin is part of the cisco.nxos collection.
To install it use: ansible-galaxy collection install cisco.nxos.
To use it in a playbook, specify: cisco.nxos.nxos_static_route.
New in version 1.0.0: of cisco.nxos
major release after 2022-06-01
Updated modules released with more functionality
nxos_static_routes
Note
This module has a corresponding action plugin.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| aggregate list / elements=dictionary | List of static route definitions | ||
| next_hop string / required | Next hop address or interface of static route. If interface, it must be the fully-qualified interface name. | ||
| pref string | Preference or administrative difference of route (range 1-255) or keyword 'default'. aliases: admin_distance | ||
| prefix string / required | Destination prefix of static route. | ||
| route_name string | Name of the route or keyword 'default'. Used with the name parameter on the CLI. | ||
| state string |
| Manage the state of the resource. | |
| tag string | Route tag value (numeric) or keyword 'default'. | ||
| track integer | Track value (range 1 - 512). Track must already be configured on the device before adding the route. | ||
| vrf string | VRF for static route. | ||
| next_hop string | Next hop address or interface of static route. If interface, it must be the fully-qualified interface name. | ||
| pref string | Preference or administrative difference of route (range 1-255) or keyword 'default'. aliases: admin_distance | ||
| prefix string | Destination prefix of static route. aliases: address | ||
| 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 |
| 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 |
| 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 |
| If no, the environment variables http_proxy and https_proxy will be ignored. | |
| use_ssl boolean |
| 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 |
| 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. | |
| route_name string | Name of the route or keyword 'default'. Used with the name parameter on the CLI. | ||
| state string |
| Manage the state of the resource. | |
| tag string | Route tag value (numeric) or keyword 'default'. | ||
| track integer | Track value (range 1 - 512). Track must already be configured on the device before adding the route. | ||
| vrf string | Default: "default" | VRF for static route. | |
Note
state=absent, the route will be removed, regardless of the non-required parameters.- cisco.nxos.nxos_static_route:
prefix: 192.168.20.64/24
next_hop: 192.0.2.3
route_name: testing
pref: 100
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: ['ip route 192.168.20.0/24 192.0.2.3 name testing 100'] |
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/nxos/nxos_static_route_module.html