Try SpotterManipulate static routes on a BIG-IP
| "added in version" 1.0.0 of f5networks.f5_modules"
Authors: Tim Rupp (@caphrim007)
Install with ansible-galaxy collection install f5networks.f5_modules:==1.28.0
collections:
- name: f5networks.f5_modules
version: 1.28.0Manipulate static routes on a BIG-IP system.
- 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
mtu:
description:
- Specifies a specific maximum transmission unit (MTU).
type: str
name:
description:
- Name of the static route.
required: true
type: str
pool:
description:
- Specifies the pool through which the system forwards packets to the destination.
type: str
vlan:
description:
- Specifies the VLAN or Tunnel through which the system forwards packets to the destination.
When C(gateway_address) is a link-local IPv6 address, this value is required.
type: str
state:
choices:
- present
- absent
default: present
description:
- When C(present), ensures the static route exists.
- When C(absent), ensures the static does not exist.
type: str
reject:
description:
- Specifies the system drops packets sent to the destination.
type: bool
netmask:
description:
- 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.
type: str
provider:
description:
- A dict object containing connection details.
suboptions:
auth_provider:
description:
- Configures the auth provider for to obtain authentication tokens from the remote
device.
- This option is really used when working with BIG-IQ devices.
type: str
no_f5_teem:
default: false
description:
- If C(yes), TEEM telemetry data is not sent to F5.
- You may omit this option by setting the environment variable C(F5_TELEMETRY_OFF).
- Previously used variable C(F5_TEEM) is deprecated as its name was confusing.
type: bool
password:
aliases:
- pass
- pwd
description:
- 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 C(F5_PASSWORD).
required: true
type: str
server:
description:
- The BIG-IP host or the BIG-IQ host.
- You may omit this option by setting the environment variable C(F5_SERVER).
required: true
type: str
server_port:
default: 443
description:
- The BIG-IP server port.
- You may omit this option by setting the environment variable C(F5_SERVER_PORT).
type: int
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.
type: int
transport:
choices:
- rest
default: rest
description:
- Configures the transport connection to use when connecting to the remote device.
type: str
user:
description:
- 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 C(F5_USER).
required: true
type: str
validate_certs:
default: true
description:
- If C(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 C(F5_VALIDATE_CERTS).
type: bool
type: dict
version_added: 1.0.0
version_added_collection: f5networks.f5_modules
partition:
default: Common
description:
- Device partition to manage resources on.
type: str
description:
description:
- Descriptive text that identifies the route.
type: str
destination:
description:
- 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.
type: str
route_domain:
description:
- The route domain ID of the system. When creating a new static route, if this value
is not specified, the default value is C(0).
- This value cannot be changed once it is set.
type: int
gateway_address:
description:
- 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 C(FE80:), the
address is treated as a link-local address. This requires the C(vlan) parameter
also be supplied.
type: str
description:
description: Descriptive text that identifies the route.
returned: changed
sample: Route tho DMZ
type: str
destination:
description: An IP address for the static entry in the routing table.
returned: changed
sample: 0.0.0.0/0
type: str
gateway_address:
description: The router for the system to use when forwarding packets to the destination
host or network.
returned: changed
sample: 10.2.2.3
type: str
netmask:
description: Netmask of the destination.
returned: changed
sample: 255.255.255.255
type: str
partition:
description: The partition that the static route was created on.
returned: changed
sample: Common
type: str
pool:
description: Whether the banner is enabled or not.
returned: changed
sample: true
type: str
reject:
description: Specifies the system drops packets sent to the destination.
returned: changed
sample: true
type: bool
route_domain:
description: The route domain ID of the system.
returned: changed
sample: 1
type: int
vlan:
description: The VLAN or Tunnel through which the system forwards packets to the
destination.
returned: changed
sample: /Common/vlan1
type: str