New in version 2.5.
The below requirements are needed on the host that executes this module.
Parameter |
Choices/Defaults |
Comments |
|---|---|---|
|
config_sync_ip
|
|
Local IP address that the system uses for ConfigSync operations.
|
|
failover_multicast
|
|
When
yes, ensures that the Failover Multicast configuration is enabled and if no further multicast configuration is provided, ensures that multicast_interface, multicast_address and multicast_port are the defaults specified in each option's description. When no, ensures that Failover Multicast configuration is disabled. |
|
mirror_primary_address
|
|
Specifies the primary IP address for the system to use to mirror connections.
|
|
mirror_secondary_address
|
|
Specifies the secondary IP address for the system to use to mirror connections.
|
|
multicast_address
|
|
IP address for the system to send multicast messages associated with failover. When
failover_multicast is yes and this option is not provided, a default of 224.0.0.245 will be used. |
|
multicast_interface
|
|
Interface over which the system sends multicast messages associated with failover. When
failover_multicast is yes and this option is not provided, a default of eth0 will be used. |
|
multicast_port
|
|
Port for the system to send multicast messages associated with failover. When
failover_multicast is yes and this option is not provided, a default of 62960 will be used. This value must be between 0 and 65535. |
|
password
required |
|
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
|
provider
(added in 2.5) |
|
A dict object containing connection details.
|
|
ssh_keyfile
|
|
Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
|
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.
|
|
server
required |
|
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
|
user
required |
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
|
server_port
|
Default:
443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
password
required |
|
The password for the user account used to connect to the BIG-IP. You can omit this option if the environment variable
F5_PASSWORD is set.aliases: pass, pwd |
|
validate_certs
|
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
|
transport
required |
|
Configures the transport connection to use when connecting to the remote device.
|
|
server
required |
|
The BIG-IP host. You can omit this option if the environment variable
F5_SERVER is set. |
|
server_port
(added in 2.2) |
Default:
443
|
The BIG-IP server port. You can omit this option if the environment variable
F5_SERVER_PORT is set. |
|
unicast_failover
|
|
Desired addresses to use for failover operations. Options
address and port are supported with dictionary structure where address is the local IP address that the system uses for failover operations. Port specifies the port that the system uses for failover operations. If port is not specified, the default value 1026 will be used. If you are specifying the (recommended) management IP address, use 'management-ip' in the address field. |
|
user
required |
|
The username to connect to the BIG-IP with. This user must have administrative privileges on the device. You can omit this option if the environment variable
F5_USER is set. |
|
validate_certs
(added in 2.0) |
|
If
no, SSL certificates will not be validated. Use this only on personally controlled sites using self-signed certificates. You can omit this option if the environment variable F5_VALIDATE_CERTS is set. |
Note
- name: Configure device connectivity for standard HA pair
bigip_device_connectivity:
config_sync_ip: 10.1.30.1
mirror_primary_address: 10.1.30.1
unicast_failover:
- address: management-ip
- address: 10.1.30.1
server: lb.mydomain.com
user: admin
password: secret
delegate_to: localhost
Common return values are documented here, the following are the fields unique to this module:
Key |
Returned |
Description |
|---|---|---|
|
changed
bool
|
always |
Denotes if the F5 configuration was updated.
|
|
config_sync_ip
string
|
changed |
The new value of the
config_sync_ip setting.Sample:
10.1.1.1
|
|
failover_multicast
bool
|
changed |
Whether a failover multicast attribute has been changed or not.
|
|
mirror_primary_address
string
|
changed |
The new value of the
mirror_primary_address setting.Sample:
10.1.1.2
|
|
mirror_secondary_address
string
|
changed |
The new value of the
mirror_secondary_address setting.Sample:
10.1.1.3
|
|
multicast_address
string
|
changed |
The new value of the
multicast_address setting.Sample:
224.0.0.245
|
|
multicast_interface
string
|
changed |
The new value of the
multicast_interface setting.Sample:
eth0
|
|
multicast_port
string
|
changed |
The new value of the
multicast_port setting.Sample:
1026
|
|
unicast_failover
list
|
changed |
The new value of the
unicast_failover setting.Sample:
[{'port': 1026, 'address': '10.1.1.2'}]
|
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Hint
If you notice any issues in this documentation you can edit this document to improve it.