f5networks.f5_modules.bigip_static_route module – Manipulate static routes on a BIG-IP
Note
This module is part of the f5networks.f5_modules collection (version 1.27.1).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
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 f5networks.f5_modules 1.0.0
Synopsis
Manipulate static routes on a BIG-IP system.
Parameters
Parameter |
Comments |
|---|---|
Descriptive text that identifies the route. |
|
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. |
|
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 |
|
Specifies a specific maximum transmission unit (MTU). |
|
Name of the static route. |
|
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. |
|
Device partition to manage resources on. Default: |
|
Specifies the pool through which the system forwards packets to the destination. |
|
A dict object containing connection details. |
|
Configures the auth provider for to obtain authentication tokens from the remote device. This option is really used when working with BIG-IQ devices. |
|
If You may omit this option by setting the environment variable Previously used variable Choices:
|
|
The password for the user account used to connect to the BIG-IP or the BIG-IQ. You may omit this option by setting the environment variable |
|
The BIG-IP host or the BIG-IQ host. You may omit this option by setting the environment variable |
|
The BIG-IP server port. You may omit this option by setting the environment variable Default: |
|
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. |
|
Configures the transport connection to use when connecting to the remote device. Choices:
|
|
The username to connect to the BIG-IP or the BIG-IQ. This user must have administrative privileges on the device. You may omit this option by setting the environment variable |
|
If You may omit this option by setting the environment variable Choices:
|
|
Specifies the system drops packets sent to the destination. Choices:
|
|
The route domain ID of the system. When creating a new static route, if this value is not specified, the default value is This value cannot be changed once it is set. |
|
When When Choices:
|
|
Specifies the VLAN or Tunnel through which the system forwards packets to the destination. When |
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: false
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Descriptive text that identifies the route. Returned: changed Sample: |
|
An IP address for the static entry in the routing table. Returned: changed Sample: |
|
The router for the system to use when forwarding packets to the destination host or network. Returned: changed Sample: |
|
Netmask of the destination. Returned: changed Sample: |
|
The partition that the static route was created on. Returned: changed Sample: |
|
Whether the banner is enabled or not. Returned: changed Sample: |
|
Specifies the system drops packets sent to the destination. Returned: changed Sample: |
|
The route domain ID of the system. Returned: changed Sample: |
|
The VLAN or Tunnel through which the system forwards packets to the destination. Returned: changed Sample: |