mirror of
https://github.com/netbirdio/docs.git
synced 2026-04-19 08:56:35 +00:00
132 lines
6.8 KiB
Plaintext
132 lines
6.8 KiB
Plaintext
# NetBird MSP Portal for Managed Service Providers
|
||
|
||
NetBird Cloud offers a multi-tenant MSP Portal for Managed Service Providers (MSPs) and Managed Security Service Providers (MSSPs)
|
||
to manage customers (tenants) from a single place. As an MSP, you can manage multiple NetBird accounts under your organization,
|
||
configure network settings, billing, and control network access for each tenant just like you would for your own NetBird account.
|
||
|
||
An MSP account is a standard NetBird account with the added 'Tenants' section, allowing for the management of customer networks.
|
||
With an MSP account, you can also manage your own internal network, just like with a regular NetBird account.
|
||
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/tenants.png" alt="tenants" className="imagewrapper-big"/>
|
||
</p>
|
||
|
||
The MSP Portal is designed to help you efficiently manage multiple tenant networks, providing a seamless experience for
|
||
switching between tenants and your MSP account. You can do so without the need to log in and out of different accounts
|
||
or inconvenient customer-specific URLs.
|
||
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/tenant-switch.png" alt="tenant-switch" className="imagewrapper"/>
|
||
</p>
|
||
|
||
## How to Apply for an MSP Account?
|
||
To apply for an MSP account, follow these steps:
|
||
|
||
* Ensure you have an active NetBird subscription ([Team plan](https://netbird.io/pricing) or higher).
|
||
* Visit our MSP application form at [https://netbird.io/msp](https://netbird.io/demo?form=msp&utm_source=docs&utm_medium=docs&utm_content=msp-portal).
|
||
* Complete the application form with your details and company information.
|
||
|
||
Submit the form for review by our team. Our team will evaluate your application and, if approved, grant you MSP status
|
||
and access to the MSP Portal.
|
||
|
||
## Access the MSP Portal
|
||
Once approved as an MSP, you will see the 'Tenants' section in your NetBird dashboard.
|
||
You can now add new tenant accounts under your organization.
|
||
|
||
## Add New Tenants
|
||
|
||
In the 'Tenants' section of your dashboard, click on the 'Add Tenant' button to add a new tenant account.
|
||
|
||
1. Provide the tenant's name and domain:
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/add-new-tenant-name-domain.png" alt="add-new-tenant-name-domain" className="imagewrapper"/>
|
||
</p>
|
||
|
||
2. Define who can access the tenant account by selecting user groups of your account. Only users from the selected groups will
|
||
be able to switch to and manage the tenant account.
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/add-new-tenant-permissions.png" alt="add-new-tenant-permissions" className="imagewrapper"/>
|
||
</p>
|
||
|
||
3. To ensure that you have rights to manage the tenant, you need to verify the ownership of the tenant domain by adding
|
||
a TXT DNS record to the tenant's domain:
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/add-new-tenant-verify-domain.png" alt="add-new-tenant-verify-domain" className="imagewrapper"/>
|
||
</p>
|
||
|
||
4. Once the domain is verified, select a plan for the tenant.
|
||
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/add-new-tenant-plan.png" alt="add-new-tenant-plan" className="imagewrapper"/>
|
||
</p>
|
||
|
||
<Note>
|
||
If you want to add an existing NetBird account as a tenant, please write us at msp@netbird.io providing the
|
||
tenant's owner email address.
|
||
</Note>
|
||
|
||
## Manage Tenant Networks
|
||
|
||
Every user in your MSP account that has permissions to manage tenants can switch between the MSP account and tenant
|
||
accounts using the tenant switcher in the top right corner.
|
||
|
||
Choose the tenant you want to manage from the dropdown list to switch to the tenant account and the system will redirect
|
||
you to the tenant's network.
|
||
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/tenant-switch.png" alt="tenant-switch" className="imagewrapper"/>
|
||
</p>
|
||
|
||
<Note>
|
||
If no tenants appear in the dropdown list, it may be because your user lacks the necessary permissions to manage tenants.
|
||
Please verify that your user is assigned to the appropriate groups listed under the 'Permission Groups' column in the 'Tenants'
|
||
table.
|
||
</Note>
|
||
|
||
Once you switch to a tenant account, you can manage the tenant's network settings, enable integrations, control network access, and more.
|
||
Your user will have the 'Admin' role within the tenant account, granting you full administrative access.
|
||
|
||
Note that your user will not appear in the 'Team' -> 'Users' section of the tenant account, as user management is handled
|
||
through the MSP account. However, your user will be visible in the Audit Log, labeled as 'External.'
|
||
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/tenant-audit-log.png" alt="audit-log" className="imagewrapper-big"/>
|
||
</p>
|
||
|
||
## Tenant Usage, Billing and Subscription Management
|
||
|
||
For your convenience, NetBird provides a daily usage overview.
|
||
Please note that the usage displayed in the MSP portal may differ from what you see when switching to a tenant account.
|
||
This is because the MSP portal shows billable usage — meaning only active users and machines are counted
|
||
(see [NetBird plans](/how-to/plans-and-billing#net-bird-plans) for more details).
|
||
|
||
The usage data is refreshed once per day and reflects the number of users and peers that will be included in your billing at the end of the cycle.
|
||
|
||
<p>
|
||
<img src="/docs-static/img/how-to-guides/msp-portal/tenant-usage.png" alt="tenant-usage" className="imagewrapper-big"/>
|
||
</p>
|
||
|
||
Each tenant you add is treated as an individual Stripe subscription under your MSP account. When you go to Manage Plan
|
||
in the 'Plans & Billing' section, you'll see a list of subscriptions — one for each tenant.
|
||
|
||
However, you’ll only be charged once, with the total consolidated amount across all tenant subscriptions.
|
||
A single consolidated invoice is generated for your convenience, which you can download from the 'Tenants' overview page.
|
||
|
||
<Note>
|
||
All tenant billing cycles are automatically aligned with your MSP account's billing cycle.
|
||
For example, if your MSP subscription starts on March 2nd and you add a new tenant on March 15th,
|
||
the tenant’s billing cycle will still be set to March 2nd. As a result, the first full-month charge will occur on April 2nd.
|
||
</Note>
|
||
|
||
## Free Trial for Tenant Accounts
|
||
|
||
To make things easier for you, all new tenant accounts come with a 14-day free trial. This gives you the perfect opportunity
|
||
to showcase NetBird to your customers before committing to a paid plan. Simply select 'Continue with Free Trial' when
|
||
setting up a new tenant plan.
|
||
|
||
## Delayed Tenant Domain Verification
|
||
|
||
Just like with the free trial, you have the flexibility to verify your tenant's domain at a later time, making it easier
|
||
to demo NetBird to companies that aren't yet your customers. However, if someone logs in using the same domain, NetBird will
|
||
create a separate account to avoid any security risks. We hope that the ease of use and advanced security features of NetBird will help drive
|
||
your business growth and attract new customers. |