f5networks.f5_modules.bigip_virtual_address – Manage LTM virtual addresses on a BIG-IP
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.6.0).
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
Synopsis
- Manage LTM virtual addresses on a BIG-IP system.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
address string |
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. | ||
arp boolean |
|
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 | |
auto_delete boolean |
|
Specifies whether the system automatically deletes the virtual address with the deletion of the last associated virtual server. When | |
availability_calculation string |
|
Specifies which routes of the virtual address the system advertises. When
| |
connection_limit integer |
Specifies the number of concurrent connections the system allows on this virtual address. | ||
icmp_echo string |
|
Specifies how the system sends responses to (ICMP) echo requests on a per-virtual address basis for enabling route advertisement. When | |
name string |
Name of the virtual address. If this parameter is not provided, the system uses the value of | ||
netmask string |
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 | ||
partition string |
Default: "Common" |
Device partition to manage resources on. | |
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 |
|
If You may omit this option by setting the environment variable | |
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
| ||
server string / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port integer |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
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 |
|
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 | ||
validate_certs boolean |
|
If You may omit this option by setting the environment variable | |
route_advertisement string |
|
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 | |
route_domain string |
The route domain of the This value cannot be modified after it is set. | ||
spanning boolean |
|
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 | |
state string |
|
The virtual address state. If | |
traffic_group string |
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 | Returned | Description |
---|---|---|
address integer |
created |
The address of the virtual address.
Sample: 2345 |
arp boolean |
changed |
The new way the virtual address handles ARP requests.
Sample: True |
auto_delete boolean |
changed |
New setting for auto deleting virtual address.
Sample: True |
availability_calculation string |
changed |
Specifies which routes of the virtual address the system advertises.
Sample: always |
connection_limit integer |
changed |
The new connection limit of the virtual address.
Sample: 1000 |
icmp_echo string |
changed |
New ICMP echo setting applied to virtual address.
Sample: disabled |
netmask integer |
created |
The netmask of the virtual address.
Sample: 2345 |
spanning string |
changed |
Whether spanning is enabled or not.
Sample: disabled |
state string |
changed |
The new state of the virtual address.
Sample: disabled |
Authors
- Tim Rupp (@caphrim007)
- Wojciech Wypior (@wojtek0806)
© 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_virtual_address_module.html