Introduced : BIG-IP_v12.0.0
Adds CNAME type non-terminal members with their specified orders and static-target states. The parent pools must be of type CNAME. In the PoolV2 interface members can now also be non-terminal type members (no longer only virtual servers). Non-terminal members are specified with a required dname. The dname of the non-terminal member is non-folderized and must be a fully-qualified domain name. The dname of the non-terminal member must match (exactly or via wide IP wildcard match) the name of a corresponding wide IP of the correct type (without the folder name). Note that in the special case where static-target is enabled on a CNAME member, this member is not backed by a wide IP. The dname of CNAME type non-terminal members (with static-target disabled) must match the name of an existing A, AAAA, CNAME, MX, SRV, or NAPTR type wide IP. The members are reordered starting with 0, with no gaps, so the system maintains the relative order but not the absolute numbers originally specified for ordering. If static-target is enabled it means the non-terminal member is not backed by a wide IP and instead when the member is picked it simply returns the dname of the member as a static answer. Note: the default static-target setting is disabled.


    in GlobalLB__PoolID [] pools,
    in String [] [] members,
    in long [] [] orders,
    in EnabledState [] [] states


Parameter Type Description
pools PoolID [] The list of pools to modify.
members String [] [] Non-terminal members to create for each specified pool.
orders long [] [] Order for each specified non-terminal member of each specified pool.
states EnabledState [] [] Static-target state for each specified non-terminal member of each specified pool.

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.