Help us improve your experience.

Let us know what you think.

Do you have time for a two-minute survey?

 
ON THIS PAGE
 

Importing Data for Multiple Tenants

You can use the Import Tenants page to import tenant data and other objects associated with the tenant, such as administrative users, sites, and topology. You can start by downloading a JSON template and using it to customize the data file that you want to import.

Creating a Tenant Data File

To create a tenant data file:

  1. On the Tenants page, click Import Tenants > Import.

    The Import Tenants page appears.

  2. Click Download Sample JSON to download a sample JavaScript Object Notation (JSON) template.

    The sample tenant template file is downloaded to your system.

  3. On the Import Tenants page, click Cancel.
  4. Open the template file.
  5. Save the template file to your computer with an appropriate name.
  6. Customize the file with your tenant data, using Table 1 as a reference.
  7. Save the customized tenant data file.

You can add tenants using the customized tenant data file.

Table 1: Tenant Configuration Fields

Field

Description

tenant_name

Specify a unique name for the tenant. CSO uses the unique name for internal communications.

tenant_display_name

Specify the display name for the tenant to be displayed on the GUI interfaces. You can only use alphanumeric characters and hyphens; the maximum length allowed is 32 characters.

password_expiration_radio

Specify the duration (in days) after which the password expires and must be changed.

tenant_admin

admin_user_name

Specify a unique name for the tenant administrator.

Example: admin-tenant-a

first_name

Enter the first name of the tenant.

last_name

Enter the second name of the tenant.

password_expiration_interval

Specify the duration (in days) after which the password expires and must be changed.

The range is from 1 through 365.

topology_type

Specify the topology type (SD-WAN )

default_ssl_proxy_profile

Specify whether you want to enable or disable SSL proxy profile for the tenant

properties

If you have set up a third-party provider edge (PE) device by using software other than Contrail Service Orchestration, then configure settings on that router by specifying custom parameters and its corresponding values.

Specify information (name and value) about the site that you want to pass to a third-party router.

vpn

Specify the VPN authentication method to establish a secure IPsec tunnel.

departments

Specify if you want to enable network segmentation on the tenant.

managed_wan_topology

network_name

Specify a unique name for the customer Layer 3 VPN network. You can use an unlimited number of alphanumeric characters, including symbols.

Example: vcpe-tenant-a-l3vpn

router_info (cloud_site_info)

router_name

Specify the router name that connects to the tenant site.

route_target

Specify the route target of the transit network for the tenant.

Example: 8888:889

right_network_name

Specify the name of the transit network for the tenant.

Example: internet, corp-vpn-right

subnet

Specify the subnet of the transit network for the tenant.

Example: 10.154.0.0/24

route_target (internet-info)

Specify the route target of the site virtual network.

Example: 8888:887

subnet (internet-info)

Specify the IP address of the subnet that connects the site to the Internet.

Example: 10.155.0.0/24

pop_info (cloud_site_info)

pop_name

Specify the name of the POP that manages the site. You can use an unlimited number of alphanumeric characters, including symbols.

Example: pne-pop10

route_target

Specify the route target of the transit network for the tenant.

Example: 8828:889

right_network_name

Specify the name of the transit network for the tenant.

Example: corp-vpn-right

subnet

Specify the subnet of the transit network for the tenant.

Example: 10.151.0.0/24

route_target (internet-info)

Specify the route target of the site virtual network.

Example: 8888:887

subnet (internet-info)

Specify the IP address of the subnet that connects the site to the Internet.

Example: 10.155.0.0/24

pop_info (data_center_site_info)

pop_name

Specify the name of the POP. You can use an unlimited number of alphanumeric characters, including symbols.

Example: pne-pop10

route_target

Specify the route target for the corporate data center network.

Example: 65412:772

subnet

Specify the subnet of the corporate data center network.

Example: 10.155.0.0/24

route_target (internet-info)

Specify the route target for the Internet network.

Example: 8888:887

subnet (internet-info)

Specify the subnet IPv4 address for the Internet network.

Example: 10.155.0.0/24

Importing Tenant Data

To import tenant data:

  1. Click Tenants > All Tenants > Import Tenants.

    The Import Tenants page is displayed.

  2. Click Browse and navigate to the directory where the tenant file is located.
  3. Select the tenant file and click Open.
  4. Click Import.

    The status of the import operation is displayed. You can click View Details for more information about the import operation. If the import operation state is successful, then proceed to Step 4 or verify the tenant file format.

  5. Click OK.

    The new tenants are displayed on the Tenants page. You can click any tenant to view more information about the tenant.

Related Documentation