Polatis L1 Shell

Release date: June 2019

Shell version: 1.0.0

Document version: 1.0

In This Guide

• Overview
• Downloading the Shell
• Importing and Configuring the Shell
• Updating Python Dependencies for Shells
• Upgrading the L1 Shell and Datamodel
• Typical Workflows
• References
• Release Notes

Overview

A shell integrates a device model, application or other technology with CloudShell. A shell consists of a data model that defines how the device and its properties are modeled in CloudShell, along with automation that enables interaction with the device via CloudShell.

L1 Switch Shells

L1 switch shells allow CloudShell to manage networking connectivity between physical resources and private cloud provider Apps, such as vCenter.

For additional information, see the L1 Switches online help topic.

Polatis L1 Shell

The Polatis L1 shell provides you with the capability to communicate with network topology managed by the Polatis switch.

The shell allows CloudShell users to interact with the device, for example, create and modify route mappings, get device information, and more.

For more information on the Polatis, see the official [Device Manufacturer] product documentation.

Standard version

The Polatis L1 shell is based on the Layer 1 Switch Shell Standard.

Supported OS

▪ [OS Name]

Requirements

Release: Polatis L1 Shell

▪ CloudShell version: 8.0 and above

▪ Other: [version x.x]

Data Model

The shell's data model includes all shell metadata, families, and attributes.

Polatis Families and Models

The L1 switch families and models are listed in the following table:

Family	Model	Description
L1 Switch	Polatis Chassis	L1 Switch Chassis
L1 Switch Blade	Generic L1 Module	Generic L1 Module
L1 Switch Port	Generic L1 Port	Generic L1 Port

Polatis Attributes

The Polatis Chassis attribute names and types are listed in the following table:

Attribute	Type	Description
Model Name	String	Model name
Serial Number	String	Serial number
OS Version	String	OS version

The Generic L1 Module attribute names and types are listed in the following table:

Attribute	Type	Description
Model Name	String	Model name
Serial Number	String	Serial number

The Generic L1 Port attribute names and types are listed in the following table:

Attribute	Type	Default	Description
Auto Negotiation	Boolean	True	Port auto negotiation
Duplex	Lookup	Full	Port duplex
Port Speed	String		Port speed
Protocol	Lookup	Transparent	Port protocol
Protocol Type Value	String		Port protocol type value
Protocol Value	String		Port protocol value
Rx Power (dBm)	String	0	Optical port Rx signal strength
Tx Power (dBm)	String	0	Optical port Tx signal strength
Wavelength	String	0	Optical port wavelength

Automation

This section describes the automation (drivers) associated with the data model. The shell’s driver is provided as part of the shell package. There are two types of automation processes, Autoload and Resource. Autoload is executed when creating the resource in the Inventory dashboard, while resource commands are run in the sandbox.

Command	Description
Autoload	Discovers and creates the internal resources of the root resource (for example, switch cards and ports).
MapBidi	Creates a bi-directional mapping between two ports.
MapUni	Creates a uni-directional mapping between two ports.
MapClear	Clears any connection ending in this port.
MapClearTo	Clears a uni-directional connection between two ports.
GetAttributeValue	Extracts attribute values from the device.
SetAttributeValue	Sets attribute values on the device.
MapTap	Adds monitor ports to an existing connection.

Note: You can only activate a TAP connection after activating a parent MapUni/MapBidi connection.

Downloading the Shell

The Polatis L1 shell is available from the Quali Community Integrations page.

The shell comprises:

File name	Description
cloudshell-L1-polatis-x.x.x.zip	Polatis L1 shell package
install_driver.bat	Polatis L1 shell installation script
polatis_runtime_config.yml	Polatis L1 shell configuration file
polatis_ResourceConfiguration.xml	XML file containing the resource structure, attributes and capabilities of the L1 switches of the same vendor

Importing and Configuring the Shell

This section describes how to import the L1 shell and configure and modify the shell’s devices.

Importing and configuring the shell in CloudShell

To import and configure the shell in CloudShell:

1. Make sure you have the shell’s zip package. If not, download the shell from the Quali Community's Integrations page.

2. Extract the Polatis L1 shell zip package to the following location on the Quali Server machine: C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers

3. Run the C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-polatis\install_driver.bat file.

4. Import the new data model.

   1. In Resource Manager Client>Admin, right-click Resource Families and select Import.
   2. Select the C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-polatis\datamodel\polatis_ResourceConfiguration.xml file.
   3. Click Open.

5. Create an L1 resource.

   1. In Resource Explorer, right-click Root and select New>Resource.
   2. Enter the Name and Address.
   3. Select the L1 Switch family.
   4. Ensure that the correct Model Polatis Chassis and Driver POLATIS are selected.
   5. Click OK.

6. Auto Load the new resource.

   1. In Resource Explorer, right-click the new resource and select Configuration.
   2. In the Internal Resources pane, right-click the switch and select Exclude.
   3. Click the Auto Load button at the bottom of the Configuration tab.

7. Define the resource connections on the L1 switch.

   1. Right-click the resource and select Configuration>Connections.
   2. Connect a resource's port to a different port in the switch resource by clicking each port's Connected To button, selecting the resource's Family and Resource, and selecting the port to connect.
   3. Click OK in the Resource connection dialog box.
   4. Save your changes.

Offline installation of a shell

Shell installation installs the required dependencies from the shell's zip package.

The install_driver.bat script creates a virtual environment on the Quali Server machine under C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-polatis and installs the required dependencies in this virtual environment from the extracted L1 shell folder (under ~cloudshell-L1-polatis\packages).

Updating Python Dependencies for Shells

This section explains how to update your Python dependencies folder. This is required when you upgrade a shell that uses new/updated dependencies. It applies to both online and offline dependencies.

L1 shells do not have separate Python dependencies files. All dependencies are included in the L1 shell itself and are installed along with the shell. Therefore, in order to update the shell's Python dependencies, you must upgrade the shell. See Upgrading the L1 Shell and Datamodel.

Upgrading the L1 Shell and Datamodel

Note: Upgrading an L1 shell requires the use of the QsMigrationUtility, which is provided out-of-the-box with CloudShell.

To upgrade the L1 shell and datamodel:

1. In the Quali Server machine, remove or rename the L1 shell's folder located in the Drivers folder: C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers.

2. Extract the new L1 shell to the Drivers folder: C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers.

3. In the extracted L1 shell's folder, run install_driver.bat.

4. Create a new folder: C:\Program Files (x86)\QualiSystems\CloudShell\Server\Configuration.

5. Copy the upgraded shell's datamodel file from:

   C:\Program Files (x86)\QualiSystems\CloudShell\Server\Drivers\cloudshell-L1-polatis\datamodel\polatis_ResourceConfiguration.xml

   to:

   C:\Program Files (x86)\QualiSystems\CloudShell\Server\Configuration.

6. Run C:\Program Files (x86)\QualiSystems\CloudShell\Server\QsMigrationUtility.exe.

Typical Workflows

(add as necessary depending on the shell)

References

To download and share integrations, see Quali Community's Integrations.

For instructional training and documentation, see Quali University.

To suggest an idea for the product, see Quali's Idea box.

To connect with Quali users and experts from around the world, ask questions and discuss issues, see Quali's Community forums.

Release Notes

What's New

For release updates, see the shell's GitHub releases page.