bigip_device_connectivity – Manages device IP configuration settings for HA on a BIG-IP

From Get docs
Ansible/docs/2.7/modules/bigip device connectivity module


bigip_device_connectivity – Manages device IP configuration settings for HA on a BIG-IP

New in version 2.5.


Synopsis

  • Manages device IP configuration settings for HA on a BIG-IP. Each BIG-IP device has synchronization and failover connectivity information (IP addresses) that you define as part of HA pairing or clustering. This module allows you to configure that information.

Requirements

The below requirements are needed on the host that executes this module.

  • f5-sdk >= 3.0.16

Parameters

Parameter Choices/Defaults Comments

cluster_mirroring

-

added in 2.7

  • between-clusters
  • within-cluster

Specifies whether mirroring occurs within the same cluster or between different clusters on a multi-bladed system.

This parameter is only supported on platforms that have multiple blades, such as Viprion hardware. It is not supported on VE.

config_sync_ip

-

Local IP address that the system uses for ConfigSync operations.

failover_multicast

boolean

  • no
  • yes

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 may omit this option by setting the environment variable F5_PASSWORD.


aliases: pass, pwd

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 F5_PASSWORD.


aliases: pass, pwd

server

- / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

-

Default:

443

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

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 ANSIBLE_NET_SSH_KEYFILE.

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

  • rest
  • cli

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 F5_USER.

validate_certs

boolean

  • no
  • yes

If 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 F5_VALIDATE_CERTS.

server

- / required

The BIG-IP host.

You may omit this option by setting the environment variable F5_SERVER.

server_port

-

added in 2.2

Default:

443

The BIG-IP server port.

You may omit this option by setting the environment variable F5_SERVER_PORT.

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 may omit this option by setting the environment variable F5_USER.

validate_certs

boolean

added in 2.0

  • no
  • yes

If 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 F5_VALIDATE_CERTS.



Notes

Note

  • This module is primarily used as a component of configuring HA pairs of BIG-IP devices.
  • Requires BIG-IP >= 12.0.0
  • 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: 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description

changed

boolean

always

Denotes if the F5 configuration was updated.


cluster_mirroring

string

changed

The current cluster-mirroring setting.


Sample:

between-clusters

config_sync_ip

string

changed

The new value of the config_sync_ip setting.


Sample:

10.1.1.1

failover_multicast

boolean

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:

[{'address': '10.1.1.2', 'port': 1026}]




Status

  • This module is guaranteed to have no backward incompatible interface changes going forward. [stableinterface]
  • This module is maintained by an Ansible Partner. [certified]

Authors

  • Tim Rupp (@caphrim007)

Hint

If you notice any issues in this documentation you can edit this document to improve it.


© 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_device_connectivity_module.html