Introduced : BIG-IP_v11.2.0
Sets the specified traffic groups to standby mode. The traffic groups become active on the given device. If the list of traffic groups is empty, all traffic groups will be set to standby and will become active on the specified device.


    in String [] traffic_groups,
    in String device


Parameter Type Description
traffic_groups String [] The traffic groups to set to standby mode. The full path name must be specified for each traffic group.
device String The device to become active for the traffic_group. The full path name for the device must be specified.

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.