W3cubDocs

/Ansible

nxos_static_route - Manages static route configuration

New in version 2.2.

Synopsis

Manages static route configuration

Options

parameter required default choices comments
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.
next_hop
 yes
Next hop address or interface of static route. If interface, it must be the fully-qualified interface name.
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).
pref
 no
Preference or administrative difference of route (range 1-255).
prefix
 yes
Destination prefix of static route.
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.
route_name
 no
Name of the route. Used with the name parameter on the CLI.
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
 yes
  • present
  • absent
Manage the state of the resource.
tag
 no
Route tag value (numeric).
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
VRF for static route.

Examples

- nxos_static_route:
    prefix: "192.168.20.64/24"
    next_hop: "3.3.3.3"
    route_name: testing
    pref: 100
    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 {'prefix': '192.168.20.0/24', 'pref': '100', 'tag': None, 'next_hop': '3.3.3.3', 'route_name': 'testing'}
changed check to see if a change was made on the device always boolean True
updates commands sent to the device always list ['ip route 192.168.20.0/24 3.3.3.3 name testing 100']
proposed k/v pairs of parameters passed into module verbose mode dict {'vrf': 'default', 'prefix': '192.168.20.64/24', 'pref': '100', 'next_hop': '3.3.3.3', 'route_name': 'testing'}
existing k/v pairs of existing configuration verbose mode dict {}

Notes

Note

If no vrf is supplied, vrf is set to default.

Note

If state=absent, the route will be removed, regardless of the non-required parameters.

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_static_route_module.html