Networking::Tunnel::create_with_key

Introduced : BIG-IP_v11.4.0
Creates a set of tunnels with key values specified. It is for convenience to allow you to avoid using a transaction, because the existing tunnel create API does not allow key values to be specified during tunnel creation. (Either a transaction or this method are good ways of satisfying this validation).

Prototype

 create_with_key(
    in String [] tunnels,
    in String [] local_addresses,
    in String [] remote_addresses,
    in String [] profiles,
    in long [] keys
);

Parameters

Parameter Type Description
tunnels String [] Names of the tunnels to create.
local_addresses String [] IP addresses for the local end of each specified tunnel.
remote_addresses String [] IP addresses for the remote end of each specified tunnel.
profiles String [] Profile specifying the tunneling protocol for each specified tunnel.
keys long [] The key for each specified tunnel (default: 0).

Return Type

Type Description
void  

Exceptions

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

iControl ::
iControl :: Networking :: Tunnel

Warning

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


Copyright © 1996-2012, F5 Networks, Inc. All rights reserved.

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.