Tokens
An enrolment token is the code a collector presents to join a Nexus Telemetry Fleet server. A token is generated with Add telemetry collector on the dashboard, which is where its name, its number of uses and its expiry are set. By default a token allows 1 use and lasts 24 hours. The Tokens page lists every token that has not been revoked. Users with the Owner or Admin role see the page. See Users and roles for the roles.
Tokens page
The page calls a token an invitation. Every usable token is listed under Invitations. See Add a collector for generating one.
| Column | Shows |
|---|---|
| Name | The terminal name typed when the token was generated, or Invitation with the date and time when none was |
| Status | active while the token is usable. used once every use is spent, whatever its expiry. expired once its expiry has passed. revoked once revoked |
| Uses | Uses so far against the maximum, for example 0 / 1 |
| Expires | When the token stops working |
| Created | When the token was generated |
| By | Where the token was generated, dashboard or cli |
| Actions | Revoke, on a token that is still usable |
Tokens for many collectors
In Add telemetry collector, Max uses sets how many collectors a token admits, and Expires sets how long it lasts: 1 hour, 24 hours, 48 hours, 7 days or 30 days. With Max uses above 1, the name field names the token rather than a terminal. Each collector that enrols with the token appears under its own hostname, or under the name given as it enrols, and receives its own device certificate. Group, shown once a group exists, places every collector that enrols with the token in that group.
Revoke
- Find the token under Invitations.
- Press Revoke in its Actions cell.
- Confirm.
The fleet server refuses the token from then on.
Expired and used tokens
An expired or used token stays on the list with its status and offers no action. A revoked token leaves the list. A collector that tries to enrol with an expired, used or revoked token does not enrol. Its log says the token was invalid or revoked, or expired or exhausted. See Troubleshooting.