bigip_virtual_address – Manage LTM virtual addresses on a BIG-IP
bigip_virtual_address – Manage LTM virtual addresses on a BIG-IP
New in version 2.4.
Synopsis
- Manage LTM virtual addresses on a BIG-IP.
Requirements
The below requirements are needed on the host that executes this module.
- f5-sdk >= 3.0.16
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
address - |
Virtual address. This value cannot be modified after it is set. If you never created a virtual address, but did create virtual servers, then a virtual address for each virtual server was created automatically. The name of this virtual address is its IP address value. | ||
arp boolean added in 2.7 |
|
Specifies whether the system accepts ARP requests. When When Note that 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 | |
arp_state - |
|
Specifies whether the system accepts ARP requests. When (disabled), specifies that the system does not accept ARP requests. Note that both ARP and ICMP Echo must be disabled in order for forwarding virtual servers using that virtual address to forward ICMP packets. If (enabled), then the packets are dropped. Deprecated. Use the When creating a new virtual address, if this parameter is not specified, the default value is | |
auto_delete - |
Specifies whether the system automatically deletes the virtual address with the deletion of the last associated virtual server. When
| ||
availability_calculation - added in 2.6 |
|
Specifies what routes of the virtual address the system advertises. When
| |
connection_limit - |
Specifies the number of concurrent connections that the system allows on this virtual address. | ||
icmp_echo - |
|
Specifies how the systems sends responses to (ICMP) echo requests on a per-virtual address basis for enabling route advertisement. When | |
name - added in 2.6 |
Name of the virtual address. If this parameter is not provided, then the value of | ||
netmask - |
Default: "255.255.255.255" |
Netmask of the provided virtual address. This value cannot be modified after it is set. | |
partition - added in 2.5 |
Default: "Common" |
Device partition to manage resources on. | |
password - / required |
The password for the user account used to connect to the BIG-IP. You may omit this option by setting the environment variable
| ||
provider - added in 2.5 |
Default: null |
A dict object containing connection details. | |
password - / 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 - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
ssh_keyfile - |
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. You may omit this option by setting the environment variable | ||
timeout - |
Default: 10 |
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 - / required |
|
Configures the transport connection to use when connecting to the remote device. | |
user - / 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 - added in 2.6 |
|
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 higher. On versions less than this, all choices expect When When When When When When | |
route_domain - added in 2.6 |
The route domain of the This value cannot be modified after it is set. | ||
server - / required |
The BIG-IP host. You may omit this option by setting the environment variable | ||
server_port - added in 2.2 |
Default: 443 |
The BIG-IP server port. You may omit this option by setting the environment variable | |
spanning boolean added in 2.7 |
|
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 - |
|
The virtual address state. If | |
traffic_group - added in 2.5 |
The traffic group for the virtual address. When creating a new address, if this value is not specified, the default of | ||
use_route_advertisement boolean |
|
Specifies whether the system uses route advertisement for this virtual address. When disabled, the system does not advertise routes for this virtual address. Deprecated. Use the | |
user - / 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 added in 2.0 |
|
If You may omit this option by setting the environment variable |
Notes
Note
- For more information on using Ansible to manage F5 Networks devices see https://www.ansible.com/integrations/networks/f5.
- Requires the f5-sdk Python package on the host. This is as easy as
pip install f5-sdk
. - 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 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:
server: lb.mydomain.net
user: admin
password: secret
state: present
partition: Common
address: 10.10.10.10
delegate_to: localhost
- name: Enable route advertisement on the virtual address
bigip_virtual_address:
server: lb.mydomain.net
user: admin
password: secret
state: present
address: 10.10.10.10
use_route_advertisement: yes
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 string |
changed |
New setting for auto deleting virtual address.
Sample: enabled |
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 |
use_route_advertisement boolean |
changed |
The new setting for whether to use route advertising or not.
Sample: True |
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by an Ansible Partner. [certified]
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.7/modules/bigip_virtual_address_module.html