Page tree

Versions Compared


  • This line was added.
  • This line was removed.
  • Formatting was changed.

A join token is a special-purpose secret used to authenticate a virtual on-prem host to automatically associate itself with its corresponding user account and establish a connection to BloxOne DDI.


A join token is necessary when you set up a virtual appliance; it is not required for BloxOne physical appliance deployment.

To deploy a virtual appliance, you must first create a join token and issue it to the corresponding on-prem host when you set up your machine. You can use the same join token to deploy multiple virtual appliances. You can also create as many join tokens as you need and use them for different purposes. For example, you can create one join token to provision a set of remote devices and assign them to your Cloud Services Portal account. You can create another join token for an admin who will need to join on-prem hosts only for a short period of time. When the admin finishes the task, you can revoke the join token and they will not be able to provision any new hosts. You can also revoke a token if a join token has been compromised for any reason to prevent its use to provision new on-prem hosts. A host cannot establish a new connection to the cloud if you use a revoked token; however, it keeps an existing connection. Note that join tokens are valid until you revoke them through the Cloud Services Portal.

Creating Join Tokens

To create a join token, complete the following:


  • Name: Enter a name for the new token.
  • Description: Enter some information about this token,
  • TAGS: Click Add to associate keys with the on-prem host and specify the following:
    • KEY: Enter a meaningful name for the key, such as a location or a department.  

    • VALUE: Enter a value for the key. Select the respective check box and click Remove to delete the associated key. For information about tags, see Managing Tags.



The join token you created appears only once in the dialog box. When you close the dialog box, you will not be able to retrieve the join token. Ensure that you copy it and save it on your system for future deployment purposes.

You can now deploy the virtual on-prem host using either the Docker or OVA package that Infoblox provides. For information about how to deploy virtual on-prem hosts, see Deploying On-Prem Hosts.

Viewing Join Tokens

To view all join tokens you have created, do the following:

  1. From the Cloud Services Portal, click Manage -> On-Prem Hosts.
  2. Click the Join Tokens tab, and the Cloud Services Portal displays the following information:
    • TOKEN NAME: The name of the token.
    • STATUS: The current status of the token. This can be Active or Revoked.
    • COUNT: The number of times you have used this token to set up your virtual appliances. You can reuse the same token multiple times for different virtual appliances. This number is useful for security purposes. For example, if you have given a join token for a certain number of appliances using this token for connection, which does not match the number showing here, you might want to review the appliances that join your network.
    • LAST USED: The timestamp when the token was last used, in mm/dd/yy hh:mm:ss time zone format.
    • DESCRIPTION: Information about the join token.

Revoking Join Tokens

You can revoke a join token that you no longer need it, or if its security has been compromised.

To revoke a join token, complete the following:

  1. From the Cloud Services Portal, click Manage -> On-Prem Hosts.
  2. Click the Join Tokens tab.
  3. On the Join Tokens page, select the check boxes of the join tokens you want to revoke.
  4. Click the Revoke button. In the dialog box, click Revoke to confirm.




Include Page
BloxOneCloud:Managing Join Tokens for On-Prem Hosts
BloxOneCloud:Managing Join Tokens for On-Prem Hosts