f5networks.f5_modules.bigip_static_route – Manipulate static routes on a BIG-IP

Note

This plugin is part of the f5networks.f5_modules collection (version 1.6.0).

To install it use: ansible-galaxy collection install f5networks.f5_modules.

To use it in a playbook, specify: f5networks.f5_modules.bigip_static_route.

New in version 1.0.0: of f5networks.f5_modules

Synopsis
Parameters
Notes
Examples
Return Values

Synopsis

Manipulate static routes on a BIG-IP system.

Parameters

Parameter		Choices/Defaults	Comments
description string			Descriptive text that identifies the route.
destination string			Specifies an IP address for the static entry in the routing table. When creating a new static route, this value is required. This value cannot be changed once it is set.
gateway_address string			Specifies the router for the system to use when forwarding packets to the destination host or network. Also known as the next-hop router address. This can be either an IPv4 or IPv6 address. When it is an IPv6 address that starts with `FE80:`, the address is treated as a link-local address. This requires the `vlan` parameter also be supplied.
mtu string			Specifies a specific maximum transmission unit (MTU).
name string / required			Name of the static route.
netmask string			The netmask for the static route. When creating a new static route, this value is required. This value can be in either IP or CIDR format. This value cannot be changed once it is set.
partition string		Default: "Common"	Device partition to manage resources on.
pool string			Specifies the pool through which the system forwards packets to the destination.
provider dictionary added in 1.0.0 of f5networks.f5_modules			A dict object containing connection details.
	auth_provider string		Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices.
	no_f5_teem boolean	no yes	If `yes`, TEEM telemetry data is not sent to F5. You may omit this option by setting the environment variable `F5_TEEM`.
	password string / required		The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable `F5_PASSWORD`. aliases: pass, pwd
	server string / required		The BIG-IP host. You may omit this option by setting the environment variable `F5_SERVER`.
	server_port integer	Default: 443	The BIG-IP server port. You may omit this option by setting the environment variable `F5_SERVER_PORT`.
	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.
	transport string	rest ←	Configures the transport connection to use when connecting to the remote device.
	user string / required		The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You may omit this option by setting the environment variable `F5_USER`.
	validate_certs boolean	no yes ←	If `no`, SSL certificates are not validated. Use this only on personally controlled sites using self-signed certificates. You may omit this option by setting the environment variable `F5_VALIDATE_CERTS`.
reject boolean		no yes	Specifies the system drops packets sent to the destination.
route_domain integer			The route domain ID of the system. When creating a new static route, if this value is not specified, the default value is `0`. This value cannot be changed once it is set.
state string		present ← absent	When `present`, ensures the static route exists. When `absent`, ensures the static does not exist.
vlan string			Specifies the VLAN or Tunnel through which the system forwards packets to the destination. When `gateway_address` is a link-local IPv6 address, this value is required.

Notes

Note

For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
Requires BIG-IP software version >= 12.
The F5 modules only manipulate the running configuration of the F5 product. To ensure that BIG-IP specific configuration persists to disk, be sure to include at least one task that uses the f5networks.f5_modules.bigip_config module to save the running configuration. Refer to the module’s documentation for the correct usage of the module to save your running configuration.

Examples

- name: Create static route with gateway address
  bigip_static_route:
    destination: 10.10.10.10
    netmask: 255.255.255.255
    gateway_address: 10.2.2.3
    name: test-route
    provider:
      password: secret
      server: lb.mydomain.come
      user: admin
      validate_certs: no
  delegate_to: localhost

Return Values

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

Key	Returned	Description
description string	changed	Descriptive text that identifies the route. Sample: Route tho DMZ
destination string	changed	An IP address for the static entry in the routing table. Sample: 0.0.0.0/0
gateway_address string	changed	The router for the system to use when forwarding packets to the destination host or network. Sample: 10.2.2.3
netmask string	changed	Netmask of the destination. Sample: 255.255.255.255
partition string	changed	The partition that the static route was created on. Sample: Common
pool string	changed	Whether the banner is enabled or not. Sample: True
reject boolean	changed	Specifies the system drops packets sent to the destination. Sample: True
route_domain integer	changed	The route domain ID of the system. Sample: 1
vlan string	changed	The VLAN or Tunnel through which the system forwards packets to the destination. Sample: /Common/vlan1

Authors

Tim Rupp (@caphrim007)

© 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/f5networks/f5_modules/bigip_static_route_module.html