Allied Telesis AT-VST-APL Vista Manager Network Appliance Software User Guide

Allied Telesis AT-VST-APL Vista Manager Network Appliance Software

Acknowledgments
2024 Allied Telesis Inc. All rights reserved. No part of this publication may be reproduced without prior written permission from Allied Telesis, Inc. Allied Telesis, Inc. reserves the right to make changes in specifications and other information contained in this document without prior written notice. The information provided herein is subject to change without notice. In no event shall Allied Telesis, Inc. be liable for any incidental, special, indirect, or consequential damages whatsoever, including but not limited to lost profits, arising out of or related to this manual or the information contained herein, even if Allied Telesis, Inc. has been advised of, known, or should have known, the possibility of such damages.

Allied Telesis, AlliedWare Plus, Allied Telesis Management Framework, EPSRing, SwitchBlade, VCStack and VCStack Plus are trademarks or registered trademarks in the United States and elsewhere of Allied Telesis, Inc. Adobe, Acrobat, and Reader are either registered trademarks or trademarks of Adobe Systems Incorporated in the United States and/or other countries. Additional brands, names and products mentioned herein may be trademarks of their respective companies.

Getting the most from this Release Note
To get the best from this release note, we recommend using Adobe Acrobat Reader version 8 or later. You can download Acrobat free from www.adobe.com

Accessing the Web-based VST-APL GUI

This section describes how to access the GUI to manage and monitor your Vista Manager Network Appliance.

These browsers are supported

• Google Chrome™
• Mozilla Firefox™
• Microsoft Edge or Internet Explorer™ 11 or later
• Apple Safari™.

The VST-APL Web GUI is pre-installed. Connect to the GUI by following these steps.
Step 1: Connect to the appliance. Connect the appliance to the network by one of the front panel Ethernet ports. (The console port is for diagnostic use, not for device management.)
Step 2: Open a web browser and browse to the IP address for the appliance. The appliance is set to accept an IP address from DHCP. If DHCP does not assign one, it uses the default IP address 192.168.1.1/24. For more information on starting the initial management session, see the Installation Guide.
Step 3: Log in to the GUI.
The default username is manager and the default password is friend. The web browser displays the VST-APL dashboard. For more detailed information on starting the initial management session, see the Installation Guide for your appliance. Once you have logged into the GUI, you can manage the appliance itself. You will need to activate each application you require. Use the application menu item in the dashboard menu in the web-based VST-APL Web GUI to activate, monitor, manage and access each application as needed for your network. For more information about using the appliance, see Vista Manager Network Appliance (VST-APL) Technical Documents

VST-APL Software Version 3.10.1
Product family supported by this version: AT-VST-APL Vista Manager Network Appliance Series

Introduction

This release note describes the new features in software version 3.10.1 for the VST-APL Vista Manager Network Appliance and the new software features in this version. You can obtain the VST-APL upgrade from the Software Download area of the Allied Telesis website. Log in using your assigned email address and password. For more information about the product, see Vista Manager Network Appliance (VST-APL)

Technical Documents
These models support this version: For more information on VST-APL models see the Vista Manager Network Appliance datasheet.

Application support in VST-APL 3.10.1
This VST-APL version provides the following software, applications, and files:

What’s New in VST-APL 3.10.1
This VST-APL version includes the following support for new application versions.

Vista Manager
The Vista Manager application was upgraded to version 3.12.0. For release notes and other technical documents, for Vista Manager see the Vista Manager Network Appliance Technical Document page on our website.

Wireless Controller (AWC)
The Wireless Controller (AWC) application was upgraded to version 3.12.0. For Release notes and other technical documents for the Wireless Controller (AWC), see the Vista ManagerNetwork Appliance Technical Document page on our website.

SNMP
The SNMP (SNMP full) plug-in application was upgraded to 2.11.0. For release notes and other technical documents for SNMP, see the Vista Manager Network Appliance Technical Document page on our website.

AMF Cloud
The AMF Cloud application was upgraded to version 5.5.4-0.1. For release notes and other technical documents for AMF Cloud, see the Vista Manager Network Appliance Technical Document page on our website.

Upgrade procedure
This section describes how to upgrade the VST-APL GUI and applications. It describes how to:

• “Backup the system” on page 6
• “Backup application data before upgrading” on page 9
• “Upload component software” on page 10
• “Upgrade the operating system and GUI” on page 11
• “Upgrade Vista Manager, AMF Cloud, Trap Receiver and AMF Security applications” on page 12
• “Upgrade Wireless Controller (AWC) and SNMP (full) plug-in applications” on page 15
• “Remove obsolete files from memory” on page 20

Backup the system
In VST-APL 3.4.x and later, you can use the Backup and Restore feature to create a backup file for a VST-APL Network Appliance.
The backup file records, and can be restored:

• the appliance configuration
• the APP files stored in the appliance’s persistent memory.
• These contain the images of the application software. You can choose which of these application files to back up.
• snapshots of selected application instances or all instances.
• Each of these is a snapshot of the configuration and application data of an application instance on the device.
• This feature does not back up application bundle files. We recommend backing these up manually.

Backup and restore: back up the appliance
To back up all the appliance configuration, any application image files (.app) and the application data for all application instances, follow these steps. This provides a backup that can later be used to restore either an individual application instance or all the application configuration and application instances.

1. If there is an unsaved appliance configuration that you want to include in the backup, click the Save button at the top of the VST-APL GUI page.

2. Connect external media for storing the backup to the appliance’s USB port. The external media must have one of the following supported formats: FAT32, exFAT, ext2, ext3 or ext4.
   Note that if the external media file system format does not support a sufficiently large file size, the backup will fail. Choose a different external media with a file system format that supports a larger maximum file size, such as ext4.

3. In the VST-APL menu, navigate to System > Backup and Restore.

4. On the Backup and Restore page, click + Create Backup at the top right of the Previous Backups panel. The Backup dialogue box opens, showing the default settings for the backup you are about to create, and the storage space it estimates that you need to have free on the external media.5. In the Backup dialog box, click the down-arrow at the right of Select backup location and from the locations available, choose the external media connected previously.

5. Check that the backup location has sufficient free space for the new backup file. You can see the free space available on the backup media in this panel. You can also see the file system of the external media by navigating to the System > File
   Management page and then clicking on the file path at the top of the File System (fs)panel.

6. By default, the backup configuration sets the device to back up everything it can.
   Check that the following are selected for backup:

   • Back up configuration file? is set to Yes. This sets the file default. cfg to back up.
   • all application image files stored in the device’s file system, such as vista-x86_64-x.x.x.app and other APP files. (It does not backup bundle files.)
   • all application instances on the device that are Running or Stopped, such as AT-VISTA-app and other application instances.
   • If an application instance is not in the drop-down list, then make sure it is Running or Stopped. (To check this, from the VST-APL menu, navigate to the VST-APL page for the application or to System > Container Services).

7. Click the green Back Up Now button at the bottom right. The backup dialogue box closes, and the current backup job shows in the In Progress panel on the Backup and Restore page. Backing up may take several minutes.

If the appliance estimates that the space required for the backup is close to the free space available on the external media, a pop-up window with a warning message appears after clicking Back Up Now. Consider providing more free space on the external media.
When the backup is complete, it disappears from the In Progress panel and shows in the Previous Backups panel. Here you can see the time (Last Modified) and file size of the backup. Status Valid confirms that the backup file has been stored successfully with a valid checksum file. For more information about the Backup and Restore feature and how to restore a VST-APL system or application, see the Vista Manager Network Appliance Technical Document page on our website.

Backup application data before upgrading
We recommend backing up application data for all applications regularly. You should also back up all the application data before following this upgrade procedure. See the relevant application’s user manual for information on how to back up an application. If you are using the Wireless Controller (AWC) or the SNMP (full) plug-in applications, you must back up these applications before proceeding. This is because the application instance needs to be destroyed and recreated during the process. (Use the backup feature in the applications; do not use the VST-APL backup and restore feature).

Back up application data
Before upgrading the Wireless Controller and SNMP Full applications, you must back up their system data. The procedures for this are described in this section. We recommend also backing up other applications. The procedures are similar. Make sure that directories and filenames used for backup and restoration do not contain any multibyte characters. Back up system data for the Wireless Controller (AWC) plug-in application

1. Log into Vista Manager EX using an Admin account.
2. From the AWC Plug-in menu, select System Setting.
3. To create a backup file for the log data in addition to the other data backup, check the
4. Include the Log Data checkbox to the right of the Backup button under the System Maintenance (optional).
5. To start the backup downloading, click the Backup button in the System Maintenance section.
6. From your web browser’s dialogue box, save the backup file to your local computer. The backup filename will be in the format: “configatawc-X.X.X-YYYYMMDDhhmmss.zip”.

Back up system data for the SNMP plug-in application

1. Log in to Vista Manager EX using an Admin account.
2. Click the SNMP Plug-in icon in the left menu of the Vista Manager application, then click the System menu.
3. In the System Maintenance panel of the System Setting page, click the Backup button. This creates a backup of application data.

Upload component software
You need the new image files in the appliance’s persistent storage to change the running software. Make sure to upgrade the operating system and all the applications you are using, so that they match. To see which version of the VST-APL operating system the appliance is currently running, use the VST-APL GUI to navigate to the System > About page. To see the application files loaded in the appliance memory, navigate to the System > File Management page. To see the current version of an application running on the appliance, go to the GUI page for the application by clicking on its menu item, and hover over the instance information icon in the Deployed Application panel.
Caution: Ensure you obtain the software image files from Allied Telesis. If you try to install software that is not provided by Allied Telesis, there is a risk of corrupting the installation.

1. Download the following files from the Software Download Centre. Save them to a directory that the appliance can access, such as the device your GUI browser is running on.
2. the appliance software operating system and web GUI. This has a filename like ATVSTAPL-x.x.x.iso. «All the applications as a bundle. This has a filename like VST-APL-x.x.x.bundle.
3. Navigate to the System > File Management page. Click the Upload button and select the software image files to upload.

Upgrade the operating system and GUI
Before upgrading the operating system, make sure to:

• “Backup the system” on page 6
• “Upload component software” on page 10

To upgrade the VST-APL operating system, follow these steps.

1. In the File Management page Set Boot Release File panel, click Browse.
2. Select the new software version and click Apply.
3. Reboot the appliance by clicking the green Reboot button at the top right of the File Management page.
4. Click Reboot again to confirm. The appliance will shut down any applications that are running, install the new version of the VST-APL operating system, and restart any applications that were running when the appliance configuration was last saved.
5. This may take several minutes. The appliance configuration, including IP addressing, is retained from the last time it was saved.
6. When the upgrade has been completed, you will need to re-authenticate to access the appliance.
7. To verify the currently running software version, log in to your VST-APL Web GUI, and navigate to the System > About page. The Software Version should agree with the VST-APL Web GUI version. Upgrade Vista Manager, AMF Cloud, Trap Receiver and AMF Security applications VST-APL version 3.4.1 and later (VST-APL Web GUI version 1.5.1 and later) support simpler upgrade of applications from a bundle. This ensures they are compatible with each other and the operating system version.

Before upgrading these applications

• “Backup application data before upgrading” on page 9
• “Upload component software” on page 10
• “Upgrade the operating system and GUI” on page 11

Use this procedure to dynamically upgrade these applications:

• Vista Manager
• AMF Cloud
• Trap Receiver plug-in
• AMF Security

1. On the Dashboard page, click the Upgrade Instances button.
2. Make sure the correct version of the bundle file is displayed in the Upgrade field at the top left of the upgrade instances panel. If not, use the drop-down list to select the correct version.
3. Applications that can be upgraded are shown as selected. We recommend upgrading them all.
4. Click the Upgrade Selected button and wait till the upgrade is complete. The Status column shows progress. They first stop, then change to the new version, and then start.
5. It is important to save the state of the VST-APL operating system after the upgrade. The Save button in the top right corner of the screen is orange when there are unsaved changes. Click on the button to save the changes.
6. Note that if you do not save and VST-APL is rebooted, the upgraded applications will revert to the old APP images and fail to start. You will see ‘configured image “and” doesn’t exist’ messages if this happens. Note that the earlier versions of the applications show as unsigned even though they are signed.
7. Vista Manager EX may prompt you to migrate the database. Select Download Database Backup to make a backup. Select Download Database Backup to make a backup.
8. Confirm you have successfully downloaded a backup file, then select Continue Migration. If you get a browser error about the page becoming unreachable, then refresh your browser.
9. Once the migration has been completed, your connection may be lost. If this happens, close your browser and reopen the application from the VST-APL dashboard.

Upgrade Wireless Controller (AWC) and SNMP (full) plug-in applications
Before upgrading these applications, make sure to:

• “Backup the system” on page 6
• “Backup application data before upgrading” on page 9
• “Upload component software” on page 10
• “Upgrade the operating system and GUI” on page 11
• The following applications are not supported by upgrading as a set from the bundle.
• Wireless Controller (AWC) plug-in
• SNMP (Full) plug-in

Instead, use these procedures

• “Destroy and recreate application instances” on page 16
• “Re-register plug-ins in Vista Manager” on page 18
• “Restore application data from back-up” on page 19

Destroy and recreate application instances Follow these steps.

1. Navigate to the application page for the application.
2. Hover over the Instance Information icon (i) and record information about the application from the Instance Information panel. Record all the Network settings (Network Type, etc).
3. On the application page, stop the application by clicking the Stop button. Destroy the application by clicking the Destroy button.
4. Click the Activate button
5. In the Application Configuration dialog box, select the new Image Version. Fill in the storage and the network data you recorded. The recommended storage values are:
   • AWC: 204 800 MB
   • SNMP Full: 102 400 MB
6. Click the Apply button. This creates a new version of the application instance. Wait a few minutes for this to start and for the Open button to appear.
7. It is important to save the state of the operating system after the upgrade. The Save button in the top right corner of the screen is orange when there are unsaved changes. Click on the button to save the changes.
8. From the device menu, navigate to the Vista Manager page and click the Open button. If necessary, wait for Vista Manager EX to perform its initial set-up.
9. Log in to Vista Manager EX. Re-register plug-ins in Vista Manager
10. You need to re-register these plug-ins in Vista Manager EX:
    • Wireless Controller (AWC)
    • SNMP (Full)
11. Follow these steps for each of the plug-ins.
12. On the Vista Manager EX page, navigate to System Management > Plugins.
13. Click AWC Plug-in at the bottom left.
14. If the plug-in is not registered, Vista Manager displays an error message like this:
15. Click Edit.
16. Click Verify Connection.
17. Check the certificate and click Save. A ‘Plug-in updated’ pop-up message confirms this step.
18. Repeat steps Step 11 to Step 14 for the SNMP (full) plug-in.
19. Restore system data for the plug-in application from the backup file (“Restore application data from back-up” below).

Restore application data from the backup
For the applications upgraded as a set in this procedure “Upgrade Vista Manager, AMF Cloud, Trap Receiver and AMF Security applications” on page 12, the data is restored automatically. For the Wireless Controller and SNMP (Full) applications, you must use thefollowing procedures to restore the system data:

• “Restore system data for the Wireless Controller plug-in” on page 19
• “Restore system data for the SNMP plug-in” on page 20

Restore system data for the Wireless Controller plug-in
Note that restoring a backup file made on another platform is not supported. To restore data from the backup file for the Wireless Controller (AWC) plug-in application, follow these steps:

1. Log in to Vista Manager EX using an Admin account.

2. In the Vista Manager EX menu, navigate to the AWC Plug-in > System Setting page.

3. Click the Restore button in the System Maintenance section to open the Restore dialogue box.

4. Click the Select File button and select a backup file.

5. Click Run.

6. Click OK on the confirmation dialogue box.

7. After the restoration process has finished, a dialogue box shows that the restoration is complete. Click OK.
   Note that the backup cannot restore the following system information. Re- configure these values as necessary:

   • Database Setting > Maximum Memory Usage
   • Network Map Setting > Wireless Client Update-Interval
   • Note that an email server and “from” address must be configured on the device for email logs to work. Use the command mail from server
   • , where the is the ‘From:’ field on the sent email, and the is the email’s destination SMTP server.

8. Set the external IP address for the plug-in application. To do this, on the Vista Manager EX page, navigate to AWC Plug-in > System Setting.

9. In the IP Address Settings page, click the drop-down list and select the AWC IP address (don’t select ‘other’). Click the Save button for that section.

Restore system data for the SNMP plug-in
To restore data from the backup of application data for the SNMP plug-in application,  follow these steps. Log in to Vista Manager EX using an Admin account.

1. In the left menu of Vista Manager EX, click the SNMP plug-in icon, then click the System menu.
2. In the System Setting page System Maintenance panel, click the Restore button.
3. This restores the data from the backup into the SNMP plug-in application.

Remove obsolete files from memory
You can make more space available in the device’s persistent memory by removing obsolete files. We recommend removing the .iso file for the previous version of the operating system and the bundle file for the previous bundle of applications. Keep the current versions.

1. From the VST-APL dashboard, navigate to the System > File Management page.
2. Click the Delete button to the right of the obsolete files you want to remove

References

• Welcome to Allied Telesis | Allied Telesis
• Adobe: Creative, marketing and document management solutions
• Software Downloads | Allied Telesis
• Datasheet: Vista Manager Network Appliance | Allied Telesis
• Vista Manager Network Appliance (VST-APL) Technical Documents | Allied Telesis
• Software Downloads | Allied Telesis

Read User Manual Online (PDF format)

Download This Manual (PDF format)

Download this manual  >>