Organisations
An organisation on a Nexus Telemetry Fleet server is a separate tenant, with its own terminals, its own users and its own certificate authority. Organisations form a tree: a reseller has customer organisations beneath it. Each organisation has a display name, which can be changed, and a short name, which is fixed and forms its web address, the address its users sign in at. The Organisations page is open to the Owner and Admin roles only. See Users and roles for the roles.
Current organisation
Clicking the initials at the top right of the dashboard opens a panel with the signed-in user’s name, role and, under Organisation, the short name of their organisation.
Organisations page
Organisations lists the signed-in user’s own organisation and every organisation beneath it. Each row gives the organisation’s name and its web address.
| Column | Counts |
|---|---|
| Orgs | Organisations beneath it that are not cancelled, or a dash for none |
| Groups | Its groups |
| Users | Its users |
| Status | Active, Suspended, Suspended by parent or Cancelled |
The counts in a row include every organisation beneath it. Expand all and Collapse all act on the whole tree. Find an organisation filters by name and web address as it is typed, and keeps a match’s parents in view. Cancelled organisations are hidden until Show removed is pressed. Suspended by parent means the organisation was not suspended itself, and is suspended because an organisation above it is.
Actions
Each row’s menu opens Groups, Users, Alerts, Report and Audit for that organisation, and offers these actions.
| Action | Effect |
|---|---|
| Add organisation | Takes a Name and a Parent, and shows the Web address the organisation will have before it is created |
| Edit name | Changes the display name only. The Web address does not change |
| Move to another parent | Moves the organisation under another. The list leaves out the organisation itself, its current parent, and every organisation beneath it |
| Suspend | Reversible with Resume |
| Cancel organisation | Cannot be undone |
Suspend stops the organisation and every organisation beneath it: their collectors cannot connect and their users cannot sign in. Nothing is deleted. Resume restores everything.
Cancel organisation asks for the organisation’s short name to confirm. Where the branch has enrolled collectors, it also asks for an acknowledgement that each must be enrolled elsewhere to keep reporting. A cancelled organisation stays under Show removed with the status Cancelled, and offers Resume until its data is deleted.
The signed-in user’s own organisation, and the platform organisation created at the fleet server’s first run, never offer Suspend, Move to another parent or Cancel organisation.
Branch rule
A user can see and change their own organisation and the organisations beneath it, and nothing else. A customer’s Admin sees the customer alone. A request for a parent or a sibling organisation gets a not found response. A suspension applies to every organisation beneath the suspended one.
Reseller tree
A reseller’s Admin sees its customers’ terminals on the dashboard, with their certificates and audit history, and can change them. Each customer sees only itself. Tokens are per organisation: the Tokens page generates tokens for the signed-in user’s own organisation only, so a customer’s tokens are generated by the customer’s own Admin, or at the command line.
Web addresses
The short name of a child of the platform organisation is made from the
name typed at creation. The short name of a child of any other organisation is its parent’s
short name, a hyphen, and the name typed: <parent>-<child>, at every level.
The short name is fixed at creation, so an organisation moved to a new parent
keeps its original web address.
Platform and customer administrators
| Administrator of | Manages |
|---|---|
| The platform organisation | The fleet server: the fleet-wide Settings sections, Server health, the licence, and the fleet server certificate every collector verifies |
| Any other organisation | That organisation only. The fleet-wide settings and Server health are absent, and the Certificates page marks Fleet server as Managed by your provider. The administrator can rotate the organisation’s own CA certificate, which affects only its own collectors |
Command line
| Command | Effect |
|---|---|
create-org |
Creates an organisation. --parent names the organisation it belongs to |
list-orgs |
Prints one row per organisation: ID, SLUG, STATUS and PARENT |
move-org |
Moves an organisation to another parent. A move that would make a loop is refused |
suspend-org and resume-org |
The same as Suspend and Resume, applied within 30 seconds |
cancel-org |
The same as Cancel organisation. Refused on the platform organisation |
purge-org |
Deletes a cancelled organisation’s data without waiting |
There is no rename command. The display name is changed on the page. See Command line for every flag.