Using Cloud connectivity tokens

Follow

If you have an Enterprise subscription computers can be joined to the cloud from the command line or via a script using a cloud connectivity token.

Computers can also be added to groups using cloud connectivity tokens if you need to restrict discovery of the computer to certain members of the team. 

Generating a cloud connectivity token 

Cloud connectivity tokens can be found under the Deployment page of your RealVNC account. To generate a new cloud connectivity token use the Generate Token button in the Cloud connectivity tokens section.

mceclip1.png

Next, select how long the token will be valid for; either one hour or indefinitely.

 mceclip0.png

The token will then be generated and will appear in the token column of the table.

mceclip0.png

Once generated the token can then be applied either by using the command line or via a script file.

Deploying a cloud connectivity token

Please note that <TOKEN> should be replaced with the token you generated in the Deployment page of your RealVNC Account for both deployment options.

Alternatively, you can download a JSON file containing your token from the Deployment page, and replace <TOKEN> with the path to the downloaded JSON file.

Command line

Windows

In an administrator / elevated command prompt run:

"%programfiles%\RealVNC\VNC Server\vncserver.exe" -service -joinCloud <TOKEN>

Mac

In Terminal:

sudo /library/vnc/vncserver -service -joinCloud <TOKEN>

Linux

In a terminal application run:

sudo vncserver-x11 -service -joinCloud <TOKEN>

Script file

Windows (batch)

To deploy a cloud connectivity token using a batch file please create a new batch file with the following contents:

@ECHO OFF
IF NOT EXIST C:\ProgramData\RealVNC-Service\vncserver.d\CloudCredentials.bed (
    "C:\Program Files\RealVNC\VNC Server\vncserver.exe" -service -joinCloud <TOKEN>
    echo VNC Server successfully joined to cloud > C:\vnccloudjoined.txt
)

Additional Options

Adding a computer to a group

To add a computer to a group using a token the option -joinGroup <GROUP> must be added to the end of the joinCloud command.

You need to replace <GROUP> with the name of the group the computer is to be added to. Group names can be referenced from the Computers page of your RealVNC account and must exist before they can be used by -joinGroup.

Changing the name VNC Server uses when joining the cloud

VNC Server will use the computer's hostname when joining the cloud by default. To use a different name the option -joinName <NAME> must be added to the end of the joinCloud command.

You need to replace <NAME> with the name that you would like to use for the computer.

Was this article helpful?
2 out of 7 found this helpful

Comments

0 comments

Please sign in to leave a comment.