Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Use a Multitenant vManage NMS

A service provider can manage multiple customers, called tenants, from a single vManage NMS that is running in multitenant mode. All tenants share a single vBond orchestrator. All tenants share the service provider's domain name, with each tenant having a subdomain name to identify the tenant. For example, the service provider fruit.com might manage the tenants mango (mango.fruit.com) and plum (plum.fruit.com). For each tenant, you configure one or more vSmart controllers and vEdge routers the same way that you configure these devices on a single-tenant vManage NMS.

To create a multitenant vManage NMS, you must start with a new vManage server. You cannot migrate an existing single-tenant vManage server to a multitenant vManage server, even if you invalidate or delete all devices from the existing server.

By default, a vManage NMS is in single-tenant mode. After you place a vManage NMS server into multitenant mode, you cannot convert it back to single-tenant mode.

vManage Multitenant Dashboard

After you have placed a vManage NMS server into multitenant mode, when you log in to the vManage NMS, you see the vManage multitenant dashboard. This dashboard is also called the provider dashboard. It provides a quick summary of the overall health of all the tenants that the service provide is managing with this vManage server.

To return the the provider dashboard from other vManage screens, click Provider Name in the Top Bar.

Place the vManage NMS into Multitenant Mode

By default, a vManage NMS is in single-tenant mode. To place the vManage NMS into multitenant mode:

  1. Log in to the vManage NMS, at the URL https://system-ip-address:8443/, as a user with "admin" credentials.
  2. In vManage NMS, select Administration ► Settings.
  3. In the Tenancy Mode bar, click the Edit button to the right.
  4. In the Tenancy field, click Multitenant.
  5. In the Domain field, enter the domain name for the service provider (for example, viptela.com).
  6. Click Save. The vManage server reboots and comes back up in multitenant mode.

Add Tenants

  1. In vManage NMS, select Administration ► Tenant Management.
  2. In the left pane, click the Add Tenant button.
  3. In the Add Tenant window:
    1. Enter a name for the tenant. It can be up to 128 characters and can contain only alphanumeric characters.
    2. Enter a description for the tenant. It can be up to 256 characters and can contain only alphanumeric characters.
    3. Enter the name of the organization. The name is case-sensitive. It is the name in the certificates for all Viptela network devices, and it must be identical on all devices in the overlay network.
    4. In the URL subdomain field, enter the domain name for the tenant. The domain name must include the provider's domain name. For example, for the provider viptela.com, a valid domain name might be plum.viptela.com. You must also configure this same domain name when you enable multitenancy mode, in vManage Administration ► Settings ► Tenancy Mode.
    5. Click Save.
  4. The Create Tenant screen is displayed, and the Status column shows In progress. To view status messages related to the creation of the tenant, click the > to the left of the status column.
    After about 1 minute, the Status column changes to Success, and the tenant table shows the tenant's system IP address.

If you add another tenant immediately after adding the first one, vManage NMS adds them sequentially, not in parallel. The processing required to create the second tenant does not start until the creation of the first tenant completes.

View a Summary of Tenant Status

The provider dashboard displays a summary of the status of all tenants that are being managed by the vManage server. The provider dashboard is displayed when you log in to a multitenant vManage NMS. To return the the provider dashboard from other vManage screens in vManage NMS, click Provider Name in the Top Bar.

This dashboard shows the following:

  • Number of service provider vBond orchestrators and vManage NMSs.
  • Number of certificates that are about to expire or that are invalid.
  • Number of tenants and information about all their control status, site health, vEdge health, and vSmart status.
  • List of individual tenants, with information about each tenant's control status, site health, vEdge health, and vSmart status.

To display tenant-specific status summary information, click the tenant name in the list on the lower part of the screen. A window opens on the right side of the screen that provides additional information about the tenant's status. To close this window, click the tenant name.

View Detailed Tenant Status

If you select a tenant from the Provider Name drop-down in the Top Bar, the tenant dashboard for selected tenant is displayed. It contains the following components, which are the same components present on a single-tenant vManage dashboard:

  • Device pane—Displays all control connections from the vManage NMS to the vSmart controllers and vEdge routers in the tenant's overlay network. It also displays the status of the vManage NMSs in the network.
  • Reboot pane—Displays the total number of reboots in the last 24 hours for all devices in the network, including soft and cold reboots and reboots that occurred as a result of power-cycling a device.
  • Control Status pane—Displays whether vSmart and vEdge devices are connected to the required number of vSmart controllers.
  • Site Health View pane—Displays the state of a site's data connections.
  • Transport Interface Distribution pane—Displays interface usage in the last 24 hours for all vEdge interfaces in VPN 0.
  • vEdge Inventory pane—Displays counts of authorized, deployed, and staged vEdge routers.
  • vEdge Health pane—Displays an aggregated view for each router state and a count of how many vEdge routers are in that state.
  • Transport Health pane—Displays the aggregated average loss, latency, and jitter for all links.
  • Top Applications pane—Displays DPI and cflowd flow information for traffic transiting vEdge routers in the overlay network.
  • Application-Aware Routing pane—Displays the 10 worst tunnels based on criteria you specify from the Type drop-down list, including loss, latency, and jitter.

Modify a Tenant

  1. In vManage NMS, select Administration ► Tenant Management.
  2. In the left pane, click the name of the tenant.
  3. In the right pane, click the Pencil icon to the right of the tenant's name.
  4. In the Edit Tenant popup, modify the tenant's name, description, or domain name.
  5. Click Save.

Delete a Tenant

  1. In vManage NMS, select Administration ► Tenant Management.
  2. In the left pane, click the name of the tenant.
  3. In the right pane, click the Trash icon to the right of the tenant's name.
  4. In the Delete Tenant popup, enter your vManage password and click Save.

Release Information

Introduced in vManage NMS in Release 17.2.

  • Was this article helpful?