Skip to main content
Versa Networks

Configure Appliances, Hubs, and Hub–Controllers

Versa-logo-release-icon.pngFor supported software information, click here.

The Deploy lifecycle allows you to configure and deploy appliances, hubs, and hub–controllers. You can perform the following tasks:

  • Create an appliance, hub, or hub–controller node.
  • Set, add, or change a profile on an appliance, hub, or hub–controller.
  • Configure the bind variables for an appliance.
  • Publish an appliance configuration to Versa Director.
  • Activate appliances with ZTP.
  • View configuration history.

Create an Appliance, Hub, or Hub–Controller Node

To create a new appliance, hub, or hub–controller node in a site:

  1. In Tenant view, select the Deploy lifecycle in the left menu bar.
  2. In Honeycomb, Map, or Table view, double-click the site in which to create the new appliance or hub. The Site Summary screen displays.
  3. Click + Appliance, + Hub, or + Hub–Controller at the top of the screen.

    sites-information.png
     
  4. If you select + Appliance, enter information for the following fields.

    add-appliance-general-tab.png
     
    Field Description
    Name (Required) Enter a name for the appliance.
    Global Appliance ID

    Enter a global appliance ID number. If you do not enter an ID number, the system allocates one automatically.

    Range: 101 through 16383

    Default: None

    ZTP Type (Required)

    Click to select perform ZTP on the appliance:

    • Serial Number—Enter the serial number of the appliance.
    • URL—Serial number is entered automatically.
    Serial Number If you select Serial Number as the ZTP type, enter the serial number of the new appliance.
    RMA Serial Number Enter the RMA serial number for the device. For more information, see Update the Serial Number for an RMA Device in Concerto.
    Model Select an appliance model.
    Staging Controller Select a staging Controller node.
    VPN Profile Select a VPN profile
    License Period (Required)

    (For Releases 11.4.1 and later.) Select the period, in years, for which the license is valid:

    • 1 year
    • 3 years
    • 5 years
    Bandwidth (Required) Select the amount of bandwidth that the appliance can use.
    Site Displays the site name.
    Email Enter an email address for the site contact
    Set Template

    Click Set Template, select the template, and then click Apply. You can also select the template later. 

    Note that in Releases 12.2.2 this field is called Set Profile.

    set-template.png

  5. If you select + Hub, enter information for the following fields.

    add-hub.png
     
    Field Description
    Name (Required) Enter a name for the hub.
    Global Appliance ID

    Enter a global appliance ID number. If you do not enter an ID number, the system allocates one automatically.

    Range: 101 through 16383

    Default: None

    ZTP Type (Required)

    Click to select how to perform ZTP on the hub:

    • Serial Number—Enter the serial number of the appliance.
    • URL—Serial number is entered automatically.
    Serial Number If you select Serial Number as the ZTP type, enter the serial number for the new hub.
    RMA Serial Number Enter the RMA serial number of the device. For more information, see Update the Serial Number for an RMA Device in Concerto.
    Model Select a hub model.
    Staging Controller Select a staging Controller node.
    VPN Profile Select a VPN profile.
    License Period (Required)

    (For Releases 11.4.1 and later.) Select the period, in years, for which the license is valid:

    • 1 year
    • 3 years
    • 5 years
    Bandwidth (Required) Select the amount of bandwidth that the hub can use.
    Site Displays the site name.
    Email Enter an email address for the site contact.
    Set Template

    Click Set Template, select the template, and then click Apply. You can also select the template later. 

    Note that in Releases 12.2.2 this field is called Set Profile.
     

    set-template-hub.png

  6. (Releases 11.4.1 and later) If you select + Hub–Controller, enter information for the following fields.

    add-hub-controller.png
     
    Field Description
    Name (Required) Enter a name for the hub–controller.
    Global Appliance ID

    Enter a global appliance ID number. If you do not enter an ID number, the system allocates one automatically.

    Range: 101 through 16383

    Default: None

    ZTP Type (Required)

    Click how to perform ZTP on the hub–controller:

    • Serial Number—Enter the serial number of the appliance.
    • URL—Serial number is entered automatically.
    Serial Number If you selected Serial Number as the ZTP type, enter the serial number of the new hub–controller.
    RMA Serial Number Enter the RMA serial number of the device. For more information, see Update the Serial Number for an RMA Device in Concerto.
    Model Select a device model.
    Staging WAN Connection (Group of Fields)  
    • Connection Name
    Select WAN connection. If you have enabled staging, this WAN connection is used to perform ZTP on spoke appliances that use this hub–controller. A staging IPsec VPN profile is created for each of the staging-enabled WAN connections.
    • Staging
    Click to enable the staging.
    • Pool Size

    Select the staging pool size:

    • 8
    • 32
    • 64
    • 128
    • 256
    • Public IP Address
    If the WAN connection has a public IP address that is different from the IP address of the interface, enter the public IP address of the WAN connection.
    • + Add Another
    Click to add the staging WAN connection and to show the GUI fields to add another staging WAN connection. Click the delete-minus-icon.png Delete icon to remove a connection from the list.
    Staging Controller If you have enabled URL ZTP for the hub–controller, select a staging Controller node.
    VPN Profile Select a VPN profile on the selected staging Controller node.
    License Period (Required)

    Select the period, in years, for which the license is valid:

    • 1 year
    • 3 years
    • 5 years
    Bandwidth (Required) Select the amount of bandwidth that the hub–controller node can use.
    Site Displays the site name.
    Email Enter an email address for the site contact.
    Set Template

    Click Set Template, select the template, and then click Apply. You can also select the template later. 

    Note that in Releases 12.2.2 this field is called Set Profile.
     

    set-template-hub-controller.png

  7. Click Next. The Permissions tab displays for Add Appliance, Add Hub, and Add Hub-Controller. The screen displays permissions for all of the configured roles. The permission for each role is selected by default, and you can update it. To change permissions for a role, select or deselect the Read, Update, Delete, Set Template, Edit Configuration, Sync From Director, Set Variable, Clear Alarm, and Publish fields for the role. The following screen shows the Permissions tab for the Add Appliance.

    add-appliance-permissions-tab.png
  8. Click Save.

Configure a LAN Interface on an Appliance 

You can configure the following LAN interfaces on an appliance:

  • Layer 2 Wired—Multiple Layer 2 wired interfaces can have the same Layer 3 integrated routing and bridging (IRB) interface.
  • Layer 2 Wireless—Wireless LAN is a network based on radio transmissions rather than wired connections, such as a WiFi network. The devices in a WLAN share a service set identifier (SSID)
  • IRB—Associates a Layer 3 interface with a Layer 2 bridge domain so that packets can be routed to and from the bridge domain. 

Configure a LAN Interface on an Appliance (Releases 13.1.1 and Later)

To configure a Layer 2 wired, Layer 2 wireless, or an IRB interface on an existing appliance:

  1. In Tenant view, select the Deploy lifecycle in the left menu bar. The Sites tab is selected by default and displays all configured sites.

    sites-tab.png
  2. Double-click a site to open it.

    sites-view-configuration.png
  3. Hover over an appliance hexagon, and then click View Configuration from the action menu. The Edit Main Template screen displays workflow step 1, Deployment Tier and High Availability.
  4. Select workflow step 2, Network Interfaces. 

    edit-template-interface.png
     
  5. Select the LAN tab, and then click Add and select Add New LAN Interface. 
     
    primary-device-lan.png
  6. In the Add LAN Interface screen, enter information for the following fields:
    • To add a Layer 2 wired interface:
       
      Field Description
      Category Select LAN or Secondary Device LAN.
      Sub-Category Select Wired.
      Interface Type

      Select the interface type:

      • enet
      • vni
      Interface (Required) Select a VNI or enet interface.
      VLAN ID

      Enter a VLAN number. 

      Default: None

      Range: 0 through 4094

      Note: For tagged interfaces, use VLAN IDs 1 through 4094. Use VLAN 0 only for an untagged interface.

      Link Configuration (Group of Fields) Define the properties for data transmission on the interface.
      • Speed

      Select a speed option for the interface:

      • Auto
      • 10 Mbps
      • 100 Mbps
      • 1 Gbps
      • 10 Gbps
      • 40 Gbps
      • 100 Gbps
      • Mode

      Select the mode for the interface. The options are:

      • Auto
      • Half duplex
      • Full duplex
      • MTU

      Enter the maximum transmission unit (MTU) size, in bytes, of the largest PDU that the interface can receive or transmit.

      Range: 72 through 9000 bytes

      Default: None

      Is this interface for guests? Click the toggle to enable the interface for guests. When enabled, the interface is designated for guest connectivity only. Guest user traffic is not mixed with enterprise traffic. You can select a routing instance that has been designated for use by guests.

      Default: Disabled

      Routing Instance Name (Required) Select a routing instance for the LAN interface. If you disable the guest user option, you can choose an enterprise routing instance. If you enable the guest user options, choose a guest routing instance.
    • To add a Layer 2 wireless interface:
       
      Field Description
      Category Select LAN or Secondary Device LAN.
      Sub-Category Select Wireless.
      Wireless LAN (WLAN) (Group of Fields)  
      • Service Set Identifier (SSID)
      Enter a value for the SSID.
      • Broadcast SSID
      Click to enable the broadcast identifier.
      • Protocol
      Select the protocol. 
      WiFi Radio (Group of Fields)  
      • Frequency

      Select the frequency range.

      • 2.4 GHz
      • 5 GHz
      • WiFi Radio Name (Required)
      Select a WiFi radio name.
      Is this interface for guests? Click the toggle to enable the interface for guests. When enabled, the interface is designated for guest connectivity only. Guest user traffic is not mixed with enterprise traffic. You can select a routing instance that has been designated for use by guests.

      Default: Disabled. 

      Routing Instance Name (Required) Select a routing instance for the LAN interface. If you disable the guest user option, you can choose an enterprise routing instance. If you enable the guest user options, choose a guest routing instance.
    • To add an IRB interface:
       
      Field Description
      Category Select LAN or WAN.
      Sub Category Select VLAN interface (IRB or SVI).
      Interface (Required) Select a VNI or enet interface.
      VLAN ID VLAN ID—Enter a VLAN number.
      • Range: 0 through 4094
      • Default: None

      Note: For tagged interfaces, use VLAN IDs 1 through 4094. Use VLAN 0 only for an untagged interface. 

      Is this interface for guests? Click the toggle to enable the interface for guests. When enabled, the interface is designated for guest connectivity only. Guest user traffic is not mixed with enterprise traffic. You can select a routing instance that has been designated for use by guests.

      Default: Disabled.

      Routing Instance Name (Required) Select a routing instance for the LAN interface. If you disable the guest user option, you can choose an enterprise routing instance. If you enable the guest user options, choose a guest routing instance.
  7. Select step 5, Review and Submit.
  8. Review the configuration and make any needed changes, and then click Submit. 

Configure a LAN Interface on an Appliance (Releases 12.2.2 and Earlier)

To configure a Layer 2 wired, Layer 2 wireless, or an IRB interface on an existing appliance:

  1. In Tenant view, select the Deploy lifecycle in the left menu bar. The Sites tab is selected by default and displays all configured sites.

    deploy-sites-dashboard-border.png
  2. Double-click a site to open it.

    deploy-sites-view-configuration-v3-border.png
  3. Hover over an appliance hexagon, and then click View Configuration from the action menu. The Edit Appliance Configuration screen displays with the General tab selected by default.

    edit-appliance-config-general-tab-border.png
  4. Select the Profile > Network tab, and then click the LAN box.

    edit-appliance-config-Network-LAN-border.png
  5. In the LAN screen, click Add Interfaces, then click Create New to add a new interface.

    edit-appliance-config-Network-LAN-border.png
  6. In the Create Interface screen, select the General tab.

    create-interface-Layer-2-v5-border.png
  7. Enter information for the following fields:
    • To add a Layer 2 wired interface:
       
      Field Description
      Name Enter a name for the Layer 2 interface.
      Type Select Physical as the interface Type.
      Enabled Click the toggle to Enabled to enable the interface.
      Category Select Layer 2.
      Sub Category Select Wired.
      Location Select a VNI interface.
      Interface Mode Select Access or Trunk.
      VLAN ID

      If you selected the Access interface mode, enter a VLAN ID.

      If you selected the Trunk interface mode, enter one or more VLAN IDs or VLAN ID ranges. Click the  Check icon to add the VLAN ID or VLAN ID range. Click the delete-x-icon.png Delete icon to clear the VLAN ID field.

      Range: 1 through 4094

      Default: None

      IRB Membership (Access interfaces only.) Select an IRB of which the Layer 2 interface is a member.
      Link (Group of Fields)
      • Speed

      Select a link speed for the interface:

      • Auto
      • 10 Mbps
      • 100 Mbps
      • 1 Gbps
      • Mode

      Select the link mode:

      • Auto duplex
      • Full duplex
      • Half duplex
      • MTU

      Enter a maximum transmission unit (MTU) for the interface.

      Range: 72 through 9000

      Default: None

    • To add a Layer 2 wireless interface:
       
      Field Description
      Name Enter a name for the Layer 2 interface.
      Type Select Physical as the interface Type.
      Enabled Click the toggle to enable the interface.
      Category Select Layer 2.
      Sub Category Select Wireless.
      Virtual Location Select WiFi, and then select a WLAN interface in the field to the right.
      IRB Membership Select an IRB of which the Layer 2 interface is a member.
      Radio (Group of Fields)
      • Frequency

      Select a frequency for the interface:

      • 2.4 GHz
      • 5 GHz
      • Profile Name

      Select a profile name according to the frequency selected:

      • Radio-2.4 GHz
      • Radio-5 GHz
      Tags Enter one or more tags. A tag is an alphanumeric text descriptor with no white space or special characters. You can add multiple tags for the same object. These tags are used for searching the objects.
    • To add an IRB interface:
       
      Field Description
      Name Enter a name for the IRB interface.
      Type Select Physical as the interface Type.
      Enabled Click the toggle to enable the interface.
      Category Select LAN or WAN.
      Sub Category Select IRB.
      Location Select an IRB location to which the IRB interface is a member.
  8. Click Next, or click the Permissions tab and revise the permissions as desired.
  9. Click Save.

Set, Add, or Change a Template on an Appliance or Hub 

After you create a site and add appliances to it, you add a template to the appliances from the existing templates. You can set templates from any of the Deploy lifecycle views—honeycomb, map, or table. You can change an appliance's template using the same procedure.

Set, Add, or Change a Template on an Appliance or Hub (Releases 13.1.1 and Later)

  1. In Tenant view, select the Deploy lifecycle in the left menu bar.
  2. Select a site that has one or more appliances.

    sites-templates.png
  3. To assign a template to the appliances, click Set Template. The Set Template screen displays.

    choose-appliances.png
     
  4. Select one or more appliances, and then click Next. The Choose Profile tab displays.

    choose-profile.png
     
  5. In the Search box, search for a template, or select a template from the list of available templates. Note that you can apply different versions of the same templates to different appliances.
  6. Click Apply.
  7. To publish the new or changed template for the site, select the Publish command in the Honeycomb, Map, or Table views.

    publish-sites.png

When you modify a reusable object, such as a main template, it becomes a custom version. Creating a custom template does not create a new version of the main template, and the change is not added to the repository of reusable objects.

For example, in the screenshot below, the profiles HQ-Device-Profile version 4 and WestCoast-Security version 2 have been modified, so the version is appended, as indicated by the word Custom.

deploy-master-profile-custom-border.png

To display summary information about a site, double-click the site. The Site Summary displays the templates that are assigned to each site.

site-summary.png

Set, Add, or Change a Profile on an Appliance or Hub (Releases 12.2.2 and Earlier)

  1. In Tenant view, select the Deploy lifecycle in the left menu bar.
  2. Select a site that has one or more appliances.

    Deploy-site-appliance-set-profile-border.png
  3. To assign a profile to the appliances, click Set Profile. The Set Profile screen displays.

    set-profile-map-view-v3-border.png
     
  4. Select one or more appliances, and then click Next. The Choose Profile tab displays.

    set-profile-map-view-choose-profile-v2-edit-border.png
     
  5. In the Search box, search for a profile, or select a profile from the list of available profiles. Note that you can apply different versions of the same profile to different appliances.
  6. Click Apply.
  7. To publish the new or changed profile for the site, select the Publish command in the Honeycomb, Map, or Table views.

    Deploy-site-appliance-publish-border.png

When you modify a reusable object, such as a master profile, it becomes a custom version. Creating a custom profile does not create a new version of the master profile, and the change is not added to the repository of reusable objects.

For example, in the screenshot below, the profiles HQ-Device-Profile version 4 and WestCoast-Security version 2 have been modified, so the version is appended, as indicated by the word Custom.

deploy-master-profile-custom-border.png

To display summary information about a site, double-click the site. The Site Summary displays the profiles that are assigned to each site.

map-view-site-summary-border.png

Download Template Assignments in CSV Format

For Releases 11.3.2 and later.

You can download a report to a file in CSV format that shows which devices are assigned a specific template, and also download a report that shows all the devices at a site and which templates are assigned to them.

Note: For Releases 12.2.2 and earlier, the Template Assignment section of the Site Summary pane was called Profile Assignment.

To download template assignments reports to a file in CSV format:

  1. Go to the Deploy lifecycle. All configured sites display, along with a summary of all the sites in the right-hand pane.

    template-assignment.png
     
  2. In the Template Assignment section of the Site Summary, click the expand-icon.png Expand icon. The Profile Usage screen displays with the first profile in the list highlighted in the main pane and in the Summary pane (profile kpt1.v1-Custom in the example below). You can click the name of a different profile in the main pane to see the details of the appliances assigned to that profile in the Summary pane.

    profile-usage-details.png
     
  3. To download the summary information for the highlighted profile, click the download-button-black-on-light-blue.png Download icon in the Summary pane.

    profile-usage-summary.png

    The summary information downloads to a file in CSV format, similar to the following:

    download-sinlge-profile-border.png
  4. To download a report that shows all the devices at a site and which profiles are assigned to them, click the download-button-black-on-light-blue.png Download icon to the left of the Publish button.

    publish-all-summary.png

    The information downloads to a file in CSV format.

Configure the Bind Variables for an Appliance

After you add a main template to an appliance, you enter any bind variable values in the main template that are specific to the appliance. When you hover over the cog-icon.png Gear icon in device's hexagon, a Pending Variables message indicates that a bind variable value has not been configured.

publication-status.png

To configure bind variable values:

  1. Double-click the site hexagon for a site that has pending variables. The site-specific devices display. The screenshot here shows only two devices at the site, pw_site.

    bind-variable-view-config.png
     
  2. In the action menu for the device, click View Configuration. The Edit Appliance Configuration screen displays.

    edit-appliance-configuration-general-tab-variables-popup-border.png
     
  3. Hover over the Interface IP variable. The popup window shows that the value for LAN-1-Address is missing.
  4. Click the variable name. In the Variables window, enter a value for the missing variable. The screenshot here shows that the value is the IP address of LAN-1-Address.

    Deploy-variables-border-v2.png
     
  5. Click Add. The Edit Appliance Configuration window displays again.
  6. Select the Permissions tab, and click Save to save the variable.
  7. On the Edit Appliance Configuration screen, click Save to save the updated master profile.

Publish an Appliance Configuration to Versa Director

When you have configured all the bind variable values, the appliance's publication state transitions to Pending Publication. This state indicates that the configuration changes have not been published to the Director node.

pending-publication-v4.png

To publish the configuration changes to the Director node:

  1. Click Publish in the action menu. In Honeycomb view, a progress bar indicates the publication status.

    publication-progress-v5.png
  2. To display the publication task messages, click the progress bar.

    messages-publish-progress-v2.png

When the configuration is published successfully, the Director node has all the configurations, including templates, device groups, and device hardware inventory, and is ready to start the ZTP process on the appliance.

Activate Appliances with ZTP

After an appliance's configuration is published, the Director and Controller nodes have all the configuration information needed to accept the appliance into the enterprise network. The appliance, either a physical or virtual appliance, is bootstrapped using the ZTP process based either on the serial number or the URL, depending on the configuration. When the appliance completes the ZTP process, the hexagon edge color in Honeycomb view changes from gray to blue, indicating that the ZTP process has completed and the appliance is now connected to the Director node.

View the Configuration Publish History 

You can view and compare the publish history of configuration changes made locally in Concerto. You can compare any two published configurations, and you can also compare an unpublished version with the last published version.

Note: You cannot compare configuration changes made in Versa Director.

View the Configuration Publish History (Releases 13.1.1 and Later)

To view the configuration history and compare versions:

  1. In the left menu bar, select Deploy to display all sites in Honeycomb view.
  2. Double-click a site hexagon, hover over an appliance hexagon, and click View Publish History.

    view-publish-history.png
     
  3. The View Publish History pane displays the configuration version history for the appliance.

    view-publish-history1.png
     
  4. To compare versions of published configurations, click the checkbox next to the desired versions, and then click Compare Two Revisions. The Configuration Diff screen displays.

    view-publish-history2.png
     
  5. To download a text file of a configuration, click the download-config-icon.png Download icon.
  6. To view the differences between a published configuration and a current unpublished configuration, click the Arrows icon to the right of one of the versions.

    view-publish-history3.png

    The Configuration Diff screen displays. The unpublished configuration is on the right-side and is labeled Candidate.

    view-publish-history4.png
     
  7. Click Close.

View the Configuration History (Releases 12.2.2 and Earlier)

To view the configuration history and compare versions:

  1. In the left menu bar, select Deploy to display all sites in Honeycomb view.
  2. Double-click a site hexagon, hover over an appliance hexagon, and click View History.

    view-history-highlight-border.png
     
  3. The View History pane displays the configuration version history for the appliance.

    view-history-appliance-highlight-border.png
     
  4. To compare versions of published configurations, click the checkbox next to the desired versions, and then click Compare. The Configuration Diff screen displays.

    configuration-diff-published-border.png
     
  5. To download a text file of a configuration, click the download-config-icon.png Download icon.
  6. To view the differences between a published configuration and a current unpublished configuration, click the  Arrows icon to the right of one of the versions.

    view-history-applicance-unpublished-highlight-border.png

    The Configuration Diff screen displays. The unpublished configuration is on the right and is labeled Current.

    configuration-diff-unpublished.png

  7. Click Close.

Supported Software Information

Releases 10.1.1 and later support all content described in this article, except:

  • Release 10.2.1 adds support for configuring Layer 2 wired and wireless interfaces and IRB interfaces on an appliance.
  • Release 11.3.2 adds support for downloading a report to a file in CSV format that shows which devices are assigned a specific profile, and for downloading a report that shows all the devices at a site and which profiles are assigned to them.
  • Release 11.4.1 adds support for configuring hub–controller nodes on appliances and choosing a license period option for appliances and hubs.
  • Release 13.1.1 introduces a new configuration workflow for adding LAN interfaces. 

Additional Information

Concerto Deploy Lifecycle Overview