Introduced : BIG-IP_v13.0.0
Sets a HA group as monitor for the specified traffic groups. This attribute together with the failover method attribute determine the algorithm used to decide when the current device is not healthy enough and the new device that will take take over the respective traffic groups. The HA group must exist before this association.


    in String [] traffic_groups,
    in String [] ha_groups


Parameter Type Description
traffic_groups String [] Names of the traffic groups to modify.
ha_groups String [] Names of the HA Group for each specified traffic group.

Return Type

Type Description


Exception Description
Common::AccessDenied Raised if the client credentials are not valid.
Common::InvalidArgument Raised if one of the arguments is invalid.
Common::OperationFailed Raised if an operation error occurs.

See Also


The links to the sample code below are remnants of the old DevCentral wiki and will result in a 404 error. For best results, please copy the link text and search the codeshare directly on DevCentral.

Sample Code

The BIG-IP API Reference documentation contains community-contributed content. F5 does not monitor or control community code contributions. We make no guarantees or warranties regarding the available code, and it may contain errors, defects, bugs, inaccuracies, or security vulnerabilities. Your access to and use of any code available in the BIG-IP API reference guides is solely at your own risk.