velos_partition_ha_config – Managing high availability for the VELOS partition

New in version 1.19.0.

Synopsis

  • Configure redundancy mode of a F5OS partition
  • This module allows setting a specific controller as active in an HA pair.
  • Manually trigger a failover of the partition controllers

Parameters

Parameter Choices/Defaults Configuration Comments
auto_failback
dictionary
Dictionary to configure auto-failback behavior for the partition.
When enabled, the system will automatically fail back to the preferred controller after a failover event.
If the partition prefer_mode remains as auto, you do not have to enable the auto_failback.
The failback_delay specifies the number of seconds to wait before failback occurs.
enabled
boolean
    Choices:
  • no ←
  • yes
Whether auto-failback is enabled.
failback_delay
integer
Default:
30
Number of seconds to wait before performing auto-failback.
prefer_node
string / required
    Choices:
  • prefer-1
  • prefer-2
  • active-controller
  • auto
Specifies which controller mode should be active.
When set to prefer-1, controller 1 will be set as active.
When set to prefer-2, controller 2 will be set as active.
When set to active-controller, the active controller will be set based on the current active controller.
When set to auto, the system will automatically determine the active controller.
state
string
    Choices:
  • present ←
When present, ensures the specified controller is active.
When absent, This module does not support removing the active controller setting.

Notes

Note

  • This module is supported only for F5OS VELOS partitions.
  • The absent state is not applicable for this module as it does not support removing the active controller setting.

Examples

- name: Set controller 1 as active
  velos_partition_ha_config:
    prefer_node: prefer-1
    state: present

- name: Set controller 2 as active
  velos_partition_ha_config:
    prefer_node: prefer-2
    state: present

- name: Set controller to auto mode
  velos_partition_ha_config:
    prefer_node: auto
    state: present

- name: Set controller 1 as active with auto-failback enabled
  velos_partition_ha_config:
    prefer_node: prefer-1
    auto_failback:
      enabled: true
      failback_delay: 60
    state: present

Return Values

The following are the fields unique to this module:

Key Returned Description
auto_failback
dictionary
changed
The auto_failback configuration that was set.

Sample:
{'enabled': True, 'failback_delay': 60}
prefer_node
string
changed
The prefer_node that was set as active.

Sample:
prefer-1


Status

Authors

  • Ravinder Reddy (@chnthalapalli)