f5networks.f5_modules.bigip_virtual_address – Manage LTM virtual addresses on a BIG-IP
Note
This plugin is part of the f5networks.f5_modules collection (version 1.13.0).
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_virtual_address
.
New in version 1.0.0: of f5networks.f5_modules
Parameters
Parameter |
Comments |
---|---|
Specifies the virtual address. This value cannot be modified after it is set. If you never created a virtual address, but did create virtual servers, a virtual address for each virtual server was created automatically. The name of this virtual address is its IP address value. |
|
Specifies whether the system accepts ARP requests. When When Both ARP and ICMP Echo must be disabled in order for forwarding virtual servers using that virtual address to forward ICMP packets. When creating a new virtual address, if this parameter is not specified, the default value is Choices:
|
|
Specifies whether the system automatically deletes the virtual address with the deletion of the last associated virtual server. When Choices:
|
|
Specifies which routes of the virtual address the system advertises. When Choices:
|
|
Specifies the number of concurrent connections the system allows on this virtual address. |
|
Specifies how the system sends responses to (ICMP) echo requests on a per-virtual address basis for enabling route advertisement. When Choices:
|
|
Name of the virtual address. If this parameter is not provided, the system uses the value of |
|
Specifies the netmask of the provided virtual address. This value cannot be modified after it is set. When creating a new virtual address, if this parameter is not specified, the default value is |
|
Device partition to manage resources on. Default: “Common” |
|
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. You may omit this option by setting the environment variable |
|
The BIG-IP 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: 443 |
|
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 with. 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 whether the system uses route advertisement for this virtual address. When disabled, the system does not advertise routes for this virtual address. The majority of these options are only supported on versions 13.0.0-HF1 or later. On versions prior than this, all choices expect When When When When When When Choices:
|
|
The route domain of the This value cannot be modified after it is set. |
|
Enables all BIG-IP systems in a device group to listen for and process traffic on the same virtual address. Spanning for a virtual address occurs when you enable the Spanning also relies on the upstream router to distribute application flows to the BIG-IP systems using ECMP routes. ECMP defines a route to the virtual address using distinct Floating self-IP addresses configured on each BIG-IP system. You must also configure MAC masquerade addresses and disable When creating a new virtual address, if this parameter is not specified, the default valus is Choices:
|
|
The virtual address state. If Choices:
|
|
The traffic group for the virtual address. When creating a new address, if this value is not specified, the default is |
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: Add virtual address
bigip_virtual_address:
state: present
partition: Common
address: 10.10.10.10
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
- name: Enable route advertisement on the virtual address
bigip_virtual_address:
state: present
address: 10.10.10.10
route_advertisement: any
provider:
server: lb.mydomain.net
user: admin
password: secret
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The address of the virtual address. Returned: created Sample: 2345 |
|
The new way the virtual address handles ARP requests. Returned: changed Sample: true |
|
New setting for auto deleting virtual address. Returned: changed Sample: true |
|
Specifies which routes of the virtual address the system advertises. Returned: changed Sample: “always” |
|
The new connection limit of the virtual address. Returned: changed Sample: 1000 |
|
New ICMP echo setting applied to virtual address. Returned: changed Sample: “disabled” |
|
The netmask of the virtual address. Returned: created Sample: 2345 |
|
Whether spanning is enabled or not. Returned: changed Sample: “disabled” |
|
The new state of the virtual address. Returned: changed Sample: “disabled” |
Authors
Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)