Alcatel-Lucent OmniVista Cirrus

Network Management as a Service

Device Catalog

The Inventory Device Catalog Screen displays detailed information about all devices known to OmniVista Cirrus. It is also used to add devices, assign/release licenses to/from devices; and edit, delete, and search for devices. To manage a device in OmniVista Cirrus, the device must first be added to the Device Catalog. The device is then validated by the OmniVista Cirrus Server. Once the device is validated and connected to your network, it is available for limited management. With limited management, a device is displayed in the Device Catalog and you can perform one software upgrade on the device (i.e., Freemium level management). For full management, a device must be licensed. An overview of the device catalog workflow is shown below.

Note: There are certain prerequisites that you must verify/configure on your local network (e.g., DCHP Server, Firewall, NTP Server) and devices (e.g., OS release) for devices to communicate with OmniVista Cirrus. If you are setting up a Freemium Account, or are having trouble with devices connecting to the OmniVista Cirrus Server, verify that these prerequisites have been met.

Device Catalog Process/Workflow

An overview of the basic process flow for adding/licensing devices is shown below. OmniVista Cirrus Server processing steps are shown in gray. The device status that must be reached to move to the next step is shown in italics. Device status is displayed in real time in the Device Status column on the Device Catalog Screen. (For a Virtual Chassis, each device in the Virtual Chassis reflects the status of the master.) Note that a device may go through several intermediate steps (e.g., Upgrading) before reaching a final step (e.g., OV Managed). Detailed device status information is provided below.

The steps for adding devices to the Device Catalog are shown below. The steps must be performed in order. If you are adding a device for limited management, you do not have to license the device, just add the device and start the activation process. If you are adding a device for full management, complete all of the steps.

  1. Adding Devices to the Device Catalog
  2. Licensing Devices
  3. Starting the Activation Process on Devices

Note: If you have enabled automatic licensing, Step 2 is not required. An available license will be automatically be assigned to the device after it is added. The Automatic Licensing Option is presented when you upgrade to a Trial or Paid Account. It can also be enabled at any time in the Device Catalog License Wizard.

Note: If a device supports the Automatic Call Home Feature, Step 3 is not required. The device will automatically contact the OmniVista Server at the configured Call Home Interval (Default = 5 minutes) and initiate the activation process. LAN Devices running AOS 6.7.2.R04 (and later) or AOS 8.5R2 (and later), and APs running AWOS 3.0.4 MR1 support the Automatic Call Home Feature.

Adding Devices to the Device Catalog

To manage a device, you must first add the device to the Device Catalog. You add devices by inputting the serial number (and MAC address for APs) for each device. The serial numbers/MAC addresses are sent to the OmniVista Cirrus Server for validation. There are three ways you can add a device:

Note: For LAN devices, make sure the device is running a minimum software version of AOS 6.7.2.R03 or 8.4.1.R03, before adding it to the Device Catalog. For APs, make sure the device is running a minimum software version of AWOS 3.0.2.40. before adding it to the Device Catalog. Click here for instructions on upgrading device software.

Manually Adding a Device

1. Click on the Add icon to bring up the Add a Device Screen.

2. Complete the fields as follows:

  • Serial Number - Enter the Serial Number for the device.
  • MAC Address - If you enter a Serial Number for an AP, enter the AP MAC address (not required or displayed for switches).
  • Desired Software Version - Select a software version for the device.
    • Select a Software Version - Select a specific software version from the drop-down. The device will automatically download and install the selected software version as part of the activation process. Note the selected software version must be higher than the version currently installed on the device. Also note that if the device does not support the selected software version, the "Desired Software Version" field will be set to "Do Not Upgrade" after the device is validated.
    • Do Not Upgrade - Select "Do Not Upgrade" if you do not want to change the installed software on the device.

    Note: If the device is part of an existing network, selecting “Do Not Upgrade” will leave your device in its current software version. If this is a new device, updating to the latest release is recommended. In general, you should only select a specific release if you understand the features of the specific release.

4. Click on the Create button.

When you first add the devices, basic information for the device will appear in the Device Catalog with the Device Status column displaying "Waiting for Validation". (For a Virtual Chassis, each device in the Virtual Chassis reflects the status of the master.) When the validation process successfully completes, the Device Status will display "Waiting for First Contact". (It can take a few minutes for all devices to be validated.)

5. Repeat to add any additional devices.

Bulk Import Multiple Devices

You can add multiple devices by importing a .csv file containing serial numbers (and MAC addresses for APs) for each device.

1. Click on the Import button at the top of the screen. The Import Devices Screen appears.

2. If necessary, click on the Template button to download a .csv template file (shown below). If you already have a .csv file prepared, go to Step 5 to import the file.

3. Use the template to create a list of device serial numbers. A MAC address is only required for APs.

4. Save the template file.

5. On the Import Devices Screen, click on the Browse button to locate the file, then click on the Import button to import the file to OmniVista.

6. At the prompt, set the software version for the devices in the list.

  • Same Software Version for all selected devices - Select this radio button, then select a software option below to perform that option on all devices in the import file.
    • Set Software Version (same model type only) - If all of the devices you are importing are the same model type, you can select the software version to be used for all devices from the Desired Software Version drop-down.
    • Do Not Upgrade - Select "Do Not Upgrade" if you do not want to change the installed software on the device. This is the only option available if there are different model types in your list of imported devices.
  • Different Software Version - Select this radio button to bring up a list of all of the devices in the import file. You can then set a different software operation for each device.
    • Click on the drop-down list in the Desired Software Version column next to a device to bring up a list of the available software versions and select an option for the device.
      • Desired Software Version - Select a specific software version for devices from the drop-down. The device will automatically download and install the selected software version as part of the activation process. Note the selected software version must be higher than the version currently installed on the device. Also note that if the device does not support the selected software version, the "Desired Software Version" field will be set to "Do Not Upgrade" after the device is validated.
      • Do Not Upgrade - Select "Do Not Upgrade" if you do not want to change the installed software on the device.

    Note: If the device is part of an existing network, selecting “Do Not Upgrade” will leave your device in its current state. If this is a new device, updating to the latest release is recommended. In general, you should only select a specific release if you understand the features of the specific release.

7. When you are done, click the Apply button.

When you first add the devices, basic information for the device will appear in the Device Catalog with the Device Status column displaying "Waiting for Validation". (For a Virtual Chassis, each device in the Virtual Chassis reflects the status of the master.) When the validation process successfully completes, the Device Status will display "Waiting for First Contact". (It can take a few minutes for all devices to be validated.)

Adding Devices Using the OV Cirrus Assistant Mobile App

The OV Cirrus Assistant App can be used to quickly add devices to the Device Catalog. Go the Apple App Store or Google Play and download the OV Cirrus Assistant app to your phone. Follow the steps below to scan device serial numbers into the Device Catalog.

1. Log into the app using your OmniVista Cirrus username and password.

2. Click on Scan to scan a serial number on a single device. Click on Batch Scan to scan serial numbers on multiple devices.

3. Aim the camera at the device's bar code or QR Code. (You can scan a bar code or QR Code.) If you are scanning a single serial number, the app will return to the first screen. If you are scanning serial numbers on multiple devices, the app will "beep" after it captures a number. Continue to scan additional numbers. When you are finished, click Cancel. The app will return to the first screen.

4. You can click on Scanned Devices to verify that you have successfully captured all of the device serial numbers. The scanned devices will appear in the Device Catalog Screen.

When you first add the devices, basic information for the device will appear in the Device Catalog with the Device Status column displaying "Waiting for Validation". (For a Virtual Chassis, status is displayed in the VC Device Status column.) When the validation process successfully completes, the Device Status will display "Waiting for First Contact". (It can take a few minutes for all devices to be validated.)

Note: Devices added using the scanning app are added with the Desired Software Version field set to "Do Not Upgrade". You can edit the field at any time.

Licensing Devices

The Device Catalog Screen is also used to access the License Wizard, which is used to assign/release licenses to/from devices. If you have a Trial or Paid Account, you must license your devices to fully manage them. As part of your Trial or Paid Account, you have a specific number of device licenses. Licenses can be assigned/released to/from a device at any time. For example, you may want to remove a license from one device (making it a limited management device) and assign that license to another device (making it a full management device).

Note: If you have enabled automatic licensing, an available license will be automatically be assigned to a device after it is added. The Automatic Licensing Option is presented when you upgrade to a Trial or Paid Account. It can also be enabled at any time in the Device Catalog License Wizard.

1. Click on the Manage Device Licenses button to bring up the first screen of the License Wizard (shown below).

Unlicensed devices appear on the left side of the screen. License devices appear on the right side of the screen. The Device License type is displayed underneath the device description. There are different License Types (e.g., E - Essential Switch, A - Advanced Switch) for different devices types (e.g., OS6350, OS6865). The number of licenses used for each type is shown at the top of the screen (e.g., E 1/10, A 3/10).

2. To license a device, click on the Add icon to move the device from the left side of the screen to the right side. Select the device(s) you want to license and click Next.

3. The Settings Screen (above) displays the current Automatic Licensing setting and can be used to enable/disable the feature. Click Next.

.

4. Review the license configuration, then click Apply, then click OK on Assign & Release License - Confirmation prompt. Once devices are licensed, you can manage them in OmniVista Cirrus.

Note: To remove a license from a device, click on the Remove icon to move the device from the right side to the left side of the screen.

You can also assign/release licenses to/from a device by selecting the device(s) in the Device Catalog and clicking on the Assign License or Release License button at the top of the Device Catalog. The License Wizard will open with the selected devices displayed in the applicable column. Click OK to complete the action (Assign/Release), then click OK on the Assign & Release License - Confirmation Screen Page.

For example, if you wanted to release license(s) from a group of devices, you would select the devices in the Device Catalog and click on the Release License button. The License Wizard would open with the selected licensed devices displayed in the Release License column. Click OK to release the licenses, then click OK on Assign & Release License - Confirmation prompt.

Note: Any time you add/remove licenses for device that are already connected to the network, you must restart the activation process on the affected devices (both the devices you add the license to and the devices you removed the license from).

License Types

There are different licenses for different device types. When you select a switch in the License Wizard, the applicable license is applied to the device.

  • Essential Switch (E) - OS6350/OS6450 - (6.7.2.R03 - Build 112 or higher), OS6465 (8.5R02 or higher), OS6560 (8.4.1.R03 or higher)
  • Core Switch (C) - OS6900 (8.4.1.R03 or higher)
  • Advanced Switch (A) - OS6860/OS6860E/OS6865 (8.4.1.R03 or higher)
  • Stellar AP (SA) - OAW-AP1101, OAW-1201H, OAW-AP1221, OAW-AP1222, OAW-AP1231, OAW-AP1232, OAW-AP1251 (AWOS 3.0.4 MR1)

Automatic Call Home Feature

LAN Devices running AOS 6.7.2.R04 (and later) or AOS 8.5R2 (and later), and APs running AWOS 3.0.4 MR1 support the Automatic Call Home Feature. These devices automatically contact the OmniVista Cirrus Server at regular intervals. For these devices, there is no need to manually start or restart the activation process. The devices will automatically contact the OmniVista Server at the configured Call Home interval.

Starting the Activation Process on Devices

A device must connect to the OmniVista Cirrus Server to complete the activation process. If it is an unconfigured device (a new device, or an old device that has been reset to the factory default configuration), or a device that supports the Automatic Call Home Feature, just connect the device to your network. Otherwise, connect the device to your network (if necessary) and restart the activation process on the device.

Connecting Devices to Your Network

Connect the device to your network and power it on. The device will automatically contact the OmniVista Cirrus Server and complete the activation process, if the Network and Device Prerequisites are met.

Restarting the Activation Process

If the device supports the Automatic Call Home Feature, the device will automatically retry the activation process. Otherwise, restart the activation process on the LAN device or AP as described below. The options for restarting the activation process on a device depend on whether you are adding the device for limited management (unlicensed device) or full management (licensed device).

Restarting The Activation Process (Limited Management)

If you are adding unlicensed devices for limited management, restart the activation process as described below.

  • LAN Device - Use one of the following options:
    • Manually Reboot the Device - Power on and power off the device.
    • Restart the Cloud Agent on the Device - Telnet to the device and disable the Cloud Agent using the following command: cloud-agent admin-state disable force (enter y at the confirmation prompt). Then enable the Cloud Agent using the following command: cloud-agent admin-state enable.
  • AP - Use one of the following options:
    • Manually Reboot the AP - Power on and power off the AP.
    • SSH to the AP and Reboot the AP - SSH to the AP and execute the "reboot" command.
    • Use the Express UI to Reboot APs - Click on the "reboot" link next to each AP you want to reboot.

When the activation process completes, the Device Status column will display "Registered". If you have trouble activating devices, click here for common problems and troubleshooting tips.

Restarting The Activation Process (Full Management)

If you are adding licensed devices for full management, restart the activation process as described below.

  • LAN Device - Use one of the following options:
    • Manually Reboot the Device - Power on and power off the device.
    • Restart the Cloud Agent on the Device - Telnet to the device and disable the Cloud Agent using the following command: cloud-agent admin-state disable force (enter y at the confirmation prompt). Then enable the Cloud Agent using the following command: cloud-agent admin-state enable.
  • AP - Use one of the following options:
    • Manually Reset the AP - Press the "Reset" button on the device until the LED starts flashing Red. When the light stops flashing or goes out, release the reset button.
    • SSH to the AP and Reboot the AP - SSH to the AP and execute "firstboot" and "reboot" commands.
    • Use the Express UI - If the AP Work Mode column on the Device Catalog Screen displays "Cluster", go to the Express UI, select the device(s) you want to add to OmniVista and click on the Connect to OmniVista Cirrus button.

When the activation process completes, the Device Status column will display "OV Managed". If you have trouble activating devices, click here for common problems and troubleshooting tips.

Editing a Device

You can edit the "Desired Software Version" configuration for a single device or multiple devices. Note that if a device fails validation due to an incorrect serial number or MAC address (APs only), you can also edit those fields.

Editing a Single Device

You can edit the "Desired Software Version" configuration for a device. To edit a single device, select a device in the Device Catalog and click on the Edit icon . The Edit a Device Screen appears. Select an option from the Desired Software Version drop-down (as described below) and click on the Update button.

  • Select a Software Version - Select a specific software version from the drop-down. The device will automatically download and install the selected software version the next time the device "calls home" (device is rebooted or the activation process is restarted on the device). Note the selected software version must be higher than the version currently installed on the device.
  • Do Not Upgrade - Select "Do Not Upgrade" if you do not want to change the installed software on the device.

Editing Multiple Devices

To edit multiple devices, select the devices and click on the Set Software Version button at the top of the Device Catalog. The Set Software Version Window appears. Update the software versions (as described below) and click on the Apply button.

  • Same Software Version for all selected devices - Select this radio button, then select a software option below to perform that option on all devices in the import file.
    • Set Software Version (same model type only) - If all of the devices you selected are the same model type, you can select the software version to be used for all devices from the Desired Software Version drop-down.
    • Do Not Upgrade - Select "Do Not Upgrade" if you do not want to change the installed software on the device. This is the only option available if you selected different model types.
  • Different Software Version - Select this radio button to bring up a list of all of the selected devices. You can then select to set a software operation for each device.
    • Click on the drop-down list in the Desired Software Version column next to a device to bring up a list of the available software versions and select an option for the device.
      • Desired Software Version - Select a specific software version for devices from the drop-down. The device will automatically download and install the selected software version as part of the activation process. Note the selected software version must be higher than the version currently installed on the device. Also note that if the device does not support the selected software version, the "Desired Software Version" field will be set to "Do Not Upgrade" after the device is validated.
      • Do Not Upgrade - Select "Do Not Upgrade" if you do not want to change the installed software on the device.

Deleting a Device

To delete a device from the Device Catalog, select the device(s), click on the Delete icon , then click OK at the confirmation prompt. The device will be removed from the Device Catalog. If the device(s) was managed, it will also be removed from the Managed Devices Table and the license(s) will be released.

Searching for a Device

You can search for a device by entering search criteria in the Search fields at the top of the Inventory List. Enter any search criteria based on the contents found in the table and the list will change to display only those devices containing the search criteria.

Device Catalog Information

The Device Catalog List displays information for all devices known to OmniVista Cirrus. You can click on a device's Serial Number to display the device in the Topology application; or click anywhere on the row corresponding to a device to display detailed information for the device in a condensed format.

Note that if any devices in the Device Catalog have unsaved configuration changes in their Working Directory, a number will appear in the Notification icon (Bell icon) at the top of the screen. The number of devices in this condition is displayed. Click on the Save Now button to save changes to the Working Directories of the devices. You can also click on the number of devices to highlight and view those devices in the Device Catalog before saving the changes.

  • Serial Number - The device serial number. Note that you can click on a device Serial Number to automatically go to the Topology application, where the device is highlighted in the Topology map.
  • Model - The device model (e.g., OS6860-P48, OAW-AP1221)
  • Current Software Version - The current software version running on the device (e.g., 8.5.125.R02, 3.0.4.1025). The information is displayed in the colors below to indicate the software status. You can also hover over the field or click on the field for more information.
    • Black - The device is running the latest software.
    • Yellow - The device is running a software version that is different than the "Desired Software Version" configured for the device. The device will automatically upgrade to the "Desired Software Version" the next time it calls home.
    • Amber - The device is running an old software version (below the latest version).
    • Red - The device is running an old software version that is not recommended by ALE. You must upgrade the device to the latest software. The following software versions must be upgraded. To upgrade a device(s), select the device(s) in the Device Catalog, click on the Set Software Version button, then select the software version specified below.
      • AOS 6.7.2.107.R03 (GA) - Upgrade to the latest 6.7.2.R04 version.
      • AWOS 3.0.2.x - Upgrade to the latest 3.0.4 version.
      • AWOS 3.0.3.x - Upgrade to the latest 3.0.4 version.
  • Desired Software Version - The "Desired Software Version" option configured for the device (e.g., Latest Version, Do Not Upgrade).
  • Device Status - The real-time device provisioning/management status for the device or virtual chassis, if applicable (e.g., Waiting for Validation, Waiting for First Contact, OV Managed). If devices are part of a virtual chassis, the Device Status for each device reflects the status of the virtual chassis. Device Status error messages/failure states are detailed in the Troubleshooting section with explanations and possible solutions.
    • Waiting For Validation - Device information provided is being checked by the OmniVista Cirrus Server.
    • Device Validation Failed - Device validation failed.
    • Waiting For First Contact - Device has been validated. The OmniVista Cirrus Server is waiting for the device to connect to it. Once the user connects the device to the network, the device will be ready for limited (unlicensed device) or full management (licensed device).
    • Obtaining Certificate - Device has contacted the OmniVista Cirrus Server and the server is creating a digital certificate that is used in creating the secure VPN channel between your device and the OmniVista Cirrus Server.
    • Certificate Previously Issued - A certificate was previously provided to this network device but it has contacted OmniVista Cirrus without it.
    • Failed To Get Certificate - Device has contacted the OmniVista Cirrus Server and the server attempted to create a certificate to achieve a more secure communication but the attempt has failed.
    • Registered - Device has successfully registered with the OmniVista Cirrus Server and is ready for limited management.
    • Upgrade - Device software version will be or is being upgraded.
    • Upgrading - Device is in the process of upgrading its software.
    • Upgrade Failed - Device software version upgrade failed.
    • Assigned - Device has contacted the OmniVista Cirrus Server and was found to be assigned to your account. The device is in the process of becoming fully managed.
    • VPN Configuring - Device is in the process of configuring a secure transport channel for connecting to the OmniVista Cirrus Server.
    • VPN Config Failed - Device was unable to configure a secure transport channel for connecting to the OmniVista Cirrus Server.
    • Connected to OV - Device has connected to the OmniVista Cirrus Server over a secure transport channel and will proceed with pre-provisioning, if required.
    • Pre-Provisioning - Device is in the process of receiving configuration information from the Pre-Provisioning application, before it is ready for full management.
    • Pre-Provision Failed - Device was unable to process configuration information from the Pre-Provisioning application.
    • OV Managed - Device is ready for full management.
    • Unsupported Device Model - The device is not supported in OmniVista Cirrus.
    • VC Mixed Accounts Failed - Devices in the Virtual Chassis belong to different accounts. At least one VC Chassis (master or slave) belongs to one account, and at least one VC Chassis (master or slave) belongs to another account.
  • Device Category - The type of device:
    • LAN Essential - OS6350, OS6450, OS6560
    • LAN Core - OS6900
    • LAN Advanced - OOS6860, OS6860E, OS6865
    • Stellar AP - AP
  • Device Name - The user-configured device name.
  • IP Address - The IP address of the device.
  • Operational Status - The operational status of the device. It displays "Up" if the device is up and responding to polls. It displays "Down" if the device is down and not responding to polls. It displays "Warning" if the device has sent at least one warning or critical trap and is thus in the warning state.
  • VC Name - The name of Virtual Chassis Master or name/serial number and number of switches in the Virtual Chassis, if applicable.
  • MAC Address - The MAC address of the device.
  • AP Group - The AP Group the device belongs to, if applicable.
  • AP Work Mode (APs Only) - The management mode for the AP.
    • Cloud - AP is being managed by OmniVista Cirrus.
    • Cluster - AP was added to the Device Catalog, but is still in Cluster mode and is not being managed by OmniVista Cirrus. You can move the device to "Cloud" by licensing (if necessary) and restarting the activation process on the device.
    • No Mode - AP needs to be rebooted to obtain work mode status.
  • Config Status - The status of the current Working Directory on the device (e.g., Saved, Unsaved, Certified, Uncertified).
  • Licensed - Indicates whether or not the device is licensed (Yes/No).
  • Role During Activation - The role of the device when activated (e.g., Standalone, Master, Slave).
  • Approximate Time of Next Call Home - The number of minutes before the device will call home again. By default, devices call home every 5 minutes. Contact Customer Support to change the call home interval.
  • Last Seen - The date and time when the last poll was initiated on the device.
  • Part Number - The device part number.

Troubleshooting

If you encounter problems adding/licensing devices, the Device Status column in the Device Catalog can be used to troubleshoot the problem. (For a Virtual Chassis, status is displayed in the VC Device Status column.)

Status

Resolution

Unsupported Device Model

The device is not supported in OmniVista Cirrus.

Failed Device Validation

You may have entered an incorrect serial number of MAC address. Check the Serial Number or MAC address (AP). Edit the information, if applicable, and restart the activation process on the device.

Waiting for First Contact

If you are adding a Device to the Device Catalog and the device remains in this state (rather than moving to "Registered"), verify that you have met all of the Network and Device Prerequisites. If necessary, make any needed configuration changes. Otherwise, restart the activation process on the device.

Registered

If you are licensing a device and it remains in this state (rather than moving to "OV Managed"), restart the activation process on the device.

VPN Config Failed

Device was unable to configure a secure transport channel for connecting to the OmniVista Cirrus Server. Wait for 30 minutes. The network device will automatically contact the OmniVista Cirrus Server again to check the configuration. If resolved, the activation process will continue. If the problem persists, contact Customer Support.

Pre-Provision Failed

Either the device was unable to process the pre-provisioning configuration sent from OmniVista Cirrus, or OmniVista Cirrus was unable to discover the device. Ensure the pre-provisioning configuration is set up properly in OmniVista Cirrus. For LAN Devices, go to the Pre-Provisioning application (Network - Pre-Provisioning); for APs, go to the AP Registration application (Network - AP Registration). Wait for 30 minutes for the network device to retry and contact the OmniVista Cirrus Server. If the problem persists, contact Customer Support.

Failed VC Mixed Accounts

Applicable only to OmniSwitch Virtual Chassis (VC). The VC devices reported by the VC master belong to multiple OmniVista Cirrus Accounts. If you or your organization own these OV Cirrus Accounts, consolidate the VC devices under a single account and wait for 30 minutes or restart the activation process on the VC (convert to link). If the problem persists, contact Customer Support.

Certificate Previously Issued

A certificate was previously provided to this network device but it has contacted OmniVista Cirrus without it. Remove device and add again to Device Catalog (fix wording); then, wait for 30 minutes or restart the activation process on the device (convert to link). If the problem persists, contact Customer Support.

Failed to Get Certificate

Device has contacted the OmniVista Cirrus Server and the server attempted to create a certificate to achieve a more secure communication but the attempt has failed. Wait for 30 minutes. The network device will automatically contact the OmniVista Cirrus Server again. If resolved, the activation process will continue. If the problem persists, contact Customer Support.

Upgrade Failed

Device software version upgrade has failed. OmniVista Cirrus will attempt to fix this internally; however, if the problem requires action outside of OmniVista Cirrus, the default admin of the OmniVista Cirrus Account will be contacted. If the problem persists for more than 24 hours, contact Customer Support.