Creating a Site from a Link

It may not be easy for a user to create a new site using the Site Wizard. Instead, you can email a link to users. When the user clicks the link, the site is automatically created in the user's client.

An example of a link that you can send to users:

cpvpn:///?host=192.0.2.198&auth=username-password

The link must be a clickable hyperlink, and the Remote Access client must run on the user's Windows computer.

Starting from R80.10, you can only create a site from a link when Feature Overview are not configured for the Security Gateway.

Link Syntax

Copy
cpvpn:///?host=<host>&auth=<auth_method>[&regKey=<cert_reg_key>][&fingerprint=<fingerprint>][&displayName=<displayName>]

Note - The syntax is case sensitive..

Parameters

Value

Description

<host>

Gateway IPv4 address or hostname. Mandatory.

<auth_method>

Authentication method. Mandatory. Must be one of these:

  • username-password

  • certificate (For a CAPI certificate)

  • p12-certificate

  • challenge-response

  • securIDKeyFob

  • securIDPinPad

  • SoftID

<cert_reg_key>

Optional. The registration key for the user's CAPI certificate. Not available for a P12 certificate. Add it if you want the Internal Certificate Authority to allocate a certificate automatically after the user creates the site (Feature Overview).

<fingerprint>

Optional: If you do not add this to the link, users are asked to approve the fingerprint the first time that they connect to the Gateway. Use the "+" character between the groups of characters in the fingerprint. For example:

GENE+RUN+HAND+JAY+HOOF+RAN+JILL+GRID+DARE+OATH+NICK+MIGO

<displayName>

Optional: If you do not add this to the link, then the <host> is the display name for users. Spaces are not supported.

Link Examples

  • cpvpn:///?host=192.0.2.198&auth=certificate&regKey=27391-wbtx8d&fingerprint=LOY+LUSH+CANT+LOFT+LOB+TUCK+FAN+ALVA+MOW+AVER+A+SWAM

  • cpvpn:///?host=192.0.2.198&auth=username-password

  • cpvpn:///?host=192.0.2.198&auth=username-password&fingerprint=LOY+LUSH+CANT+LOFT+LOB+TUCK+FAN+ALVA+MOW+AVER+A+SWAM