Manual Chapter :
About starting the client from a URL scheme
Applies To:
Show Versions
BIG-IP APM
- 17.1.1, 17.1.0, 17.0.0, 16.1.4, 16.1.3, 16.1.2, 16.1.1, 16.1.0, 16.0.1, 16.0.0, 15.1.10, 15.1.9, 15.1.8, 15.1.7, 15.1.6, 15.1.5, 15.1.4, 15.1.3, 15.1.2, 15.1.1, 15.0.1, 15.0.0, 14.1.5, 14.1.4, 14.1.3, 14.1.2, 14.1.0, 14.0.1, 14.0.0, 13.1.5, 13.1.4, 13.1.3, 13.1.1, 13.1.0, 12.1.4
About starting the client from a URL scheme
You can start F5 Access connections for users from a URL. You can then provide these URLs to
users, so they can start the VPN connection without having to manually start the application.
If there is already an active connection, a prompt appears to warn the user that the existing
connection must be stopped before the new connection can start. The connection uses a client
certificate if it is specified in the existing configuration.
URL connections use the following parameters. This is an example, you must provide your own
parameters and values.
f5access://{start|stop}?[parameter1=value1¶meter2=value2...]
Special characters in parameters must be URL-encoded.
The syntax to start a connection from a URL follows.
- start
- Starts a connection. Thestartcommand requires either thenameorserverparameter to be present in the URL. If thenameparameter is specified, then F5 Access looks for the name in the list of existing configuration entries. If theserverparameter is specified, then thenameparameter is set to the same value as theserverparameter. A new configuration is created if a configuration with that name does not exist. If the specified configuration already exists, the other parameters specified in the URL are merged with the existing configuration. The result of this merged configuration is used only for the current, active connection, and does not persist. If anameis specified with other parameters, such asserver,username, orpassword, those parameters override what is specified in the configuration.
- username
- A parameter used to specify the user name with which to start the connection. When theusernameis specified without apassword, then an authentication prompt is displayed.
- password
- A parameter used to specify the password with which to start the connection. When thepasswordparameter is specified, it is used as a one-time password and not saved in the configuration.
- postlaunch_url
- A parameter used to specify the URL that starts after the connection starts.
- logon_mode
- An optional parameter that specifies whether the logon mode is the standard logon (native) or web logon (web). The default logon mode isnative.
