cm_next_ha_failover – Fail-over BIG-IP Next HA instance on CM

New in version 1.0.0.

Synopsis

  • Force fail-over a BIG-IP Next HA instance managed by CM.

Parameters

Parameter Choices/Defaults Configuration Comments
active_unit_hostname
string
The hostname of the BIG-IP Next unit in HA pair to be made active.
Parameter mutually exclusive with active_unit_ip.
active_unit_ip
string
The ip address of the BIG-IP Next unit in HA pair to be made active.
Parameter mutually exclusive with active_unit_hostname.
ha_hostname
string
The hostname of the HA BIG-IP Next instance.
Parameter mutually exclusive with ha_ip.
ha_ip
string
The ip address of the HA BIG-IP Next instance.
Parameter mutually exclusive with ha_hostname.
timeout
integer
Default:
300
The amount of time to wait for the HA failover task to finish, in seconds.
The accepted value range is between 10 and 1800 seconds.

Examples

- name: Failover HA pair using IP address
  cm_next_ha_failover:
    ha_ip: "172.16.2.1"
    active_unit_ip: "172.16.1.1"
    timeout: 600

- name: Failover HA pair using hostname and ip
  cm_next_ha_failover:
    ha_hostname: "foo.bar.net"
    active_unit_ip: "172.16.1.1"
    timeout: 600

Return Values

The following are the fields unique to this module:

Key Returned Description
active_unit_hostname
string
changed
The hostname of the BIG-IP Next unit in HA pair that is active.

Sample:
unit1.bar.net
active_unit_ip
string
changed
The ip address of the BIG-IP Next unit in HA pair that is active.

Sample:
10.1.16.1


Status

Authors

  • Ravinder Reddy (@RavinderReddyF5)
  • Wojciech Wypior (@wojtek0806)