Introduced : BIG-IP_v11.4.0
Sets the keys for a set of tunnels. A key can be used to signify different values depending on the type of tunnel. As an example, it is used as the Virtual Network Identifier (VNI) for VXLAN tunnels. The default value is 0.


    in String [] tunnels,
    in long [] keys


Parameter Type Description
tunnels String [] Names of the tunnels to modify.
keys long [] The key for each specified tunnel (default: 0).

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.