bigip_device_traffic_group

Manage BIG-IP traffic groups

Collection: f5networks.f5_modules

Full Name: f5networks.f5_modules.bigip_device_traffic_group

Synopsis

Manage BIG-IP traffic groups

Parameters

Name	Type	Required	Description
provider	dict		BIG-IP connection: server, server_port (443), user, private password/pass/pwd, validate_certs (true), transport (rest), timeout, no_f5_teem (false), auth_provider. Fallbacks resolve on the execution host.
name	str	yes	Traffic group name. Required; explicit null converts to empty. Original name is sent on create.
mac_address	str		Optional floating MAC address; empty clears. No MAC syntax validation. Changed clear returns an empty string.
ha_order	list		Ordered device names qualified with partition. Duplicates remain. Empty string or [null] clears and returns an empty STRING; [] remains an empty ARRAY. Null is unmanaged.
ha_group	str		Optional HA group. Empty clears; nonempty cannot enable auto_failback. Current literal true also guards group changes unless auto_failback is explicitly false.
ha_load_factor	int		Load factor 1..1000 on present only. Integral decimal values accepted; authored true remains a JSON boolean in changed output.
auto_failback	bool		Optional failback. Changed output is the STRING yes/no. Empty-string order cannot enable failback; [] may.
auto_failback_time	int		Delay 0..300 on present only. Authored booleans remain JSON booleans. Null is unmanaged.
state	str		present (default) creates or updates; absent deletes and verifies. Check mode still reads and evaluates reached properties. Explicit null fails choices.
partition	str		Execution-host F5_PARTITION or Common when omitted. Surrounding slashes stripped. Create requires Common ignoring case; existing resources may update/delete in other partitions. Explicit null becomes empty.

Example

yaml

- name: Create a traffic group
  f5networks.f5_modules.bigip_device_traffic_group:
    name: traffic-group-app
    ha_load_factor: 10
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost

- name: Configure ordered failover
  f5networks.f5_modules.bigip_device_traffic_group:
    name: traffic-group-app
    ha_order: [bigip1, bigip2]
    auto_failback: true
    auto_failback_time: 30
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost

- name: Clear the MAC and HA order
  f5networks.f5_modules.bigip_device_traffic_group:
    name: traffic-group-app
    mac_address: ''
    ha_order: ''
    auto_failback: false
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost

- name: Preview a traffic group change
  f5networks.f5_modules.bigip_device_traffic_group:
    name: traffic-group-app
    ha_group: app-ha
    auto_failback: false
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
  check_mode: true
  delegate_to: localhost

- name: Delete and verify a traffic group
  f5networks.f5_modules.bigip_device_traffic_group:
    name: traffic-group-app
    state: absent
    provider:
      server: lb.example.com
      user: admin
      password: '{{ bigip_password }}'
  delegate_to: localhost