Organize your machines
Before you start connecting your devices to Viam, you need to decide how you want to group your machines.
On Viam, machines are grouped into locations, and locations are grouped into organizations:
- Each location can represent either a physical location or some other conceptual grouping like “Production” and “Testing”.
- An organization is the highest level grouping, and often contains all the locations (and machines) of an entire company.
These groupings allow you to manage permissions; you can grant a user access to an individual machine, to all the machines in a location, or to everything in an entire organization. You choose how to group your machines.
Create organizations and locations
Create organizations
- Log into Viam in a web browser.
- Click the dropdown in the upper-right corner of the FLEET page and use the + button to create a new organization. Name the organization and click Create.
- Create additional organizations as needed.
Create locations
Click FLEET in the upper-left corner of the page and click LOCATIONS. A new location called
First Location
is automatically generated for you.Use the … menu to edit the location name to what it represents for your use case. Then click Save.
Create additional locations as needed using the Add location button, on the left of the LOCATIONS page.
Create sub-locations
If needed, you can add further sub-locations to, for example, differentiate groups of machines within an office.
To add a sub-location:
- Add a new location using the same Add location button.
- At the bottom of the location’s page, use the New parent location dropdown to choose a parent location. Click Change.
You can nest locations up to three levels deep.
Example
If you’d like to look at an example, see Monitor Air Quality with a Fleet of Sensors.
Frequently asked questions
Can I move a machine to a different location?
Yes, organization owners and location owners can move machines between locations within their organization.
To move a machine:
- Navigate to your machine’s page.
- Click the … button in the upper-right corner.
- Select Move to a new location.
- Choose the destination location from the organization tree.
- Confirm the move.
Important considerations
Moving a machine has several important implications:
- Machine address changes: The machine’s network address will change to
<machine-main-part-name>.<new-location-id>.viam.cloud
. You’ll need to update any code that references the old address. - Permission changes: Access permissions will be updated. Users with access to the current location lose access, and users with access to the new location gain access to the machine.
- Data access: Users in the new location cannot access historical data from when the machine was in the previous location.
Requirements for moving machines:
- You must be an organization owner, or an owner of both the current and destination locations
- The destination location must be within the same organization
- No other machine in the destination location can have the same name
Can I move a location to a different organization?
No, it is not possible to move a location to a different organization.
You can share a location with another organization. However, machines will continue to use the primary organization as a reference point. This means any captured data is associated with the primary organization and the machines are only able to use private ML models and registry items from the primary owner.
Can I rename my organization after its creation?
Yes, you can rename your organization if you are an organization owner.
Caution
If your organization owns modules or packages in the Viam Registry, the namespace for those modules and packages will be changed in the registry automatically. You will need to update any configurations that reference your modules using the old namespace.
- Click the organization name in the upper-right corner of the FLEET page and click on Settings and invites.
- Find the Details section of the page.
- Change the organization name and click on the Rename button.
How do I delete an organization?
- Delete all the locations in your organization.
- Click the organization name in the upper-right corner of the FLEET page and click on Settings and invites.
- At the bottom of the page click Delete organization.
Was this page helpful?
Glad to hear it! If you have any other feedback please let us know:
We're sorry about that. To help us improve, please tell us what we can do better:
Thank you!