Allied Telesis ALLIEDVIEW-UM 1.6 User Manual

A
LLIEDVIEW-UM 1.6
USER'S GUIDE
PN 613-000381 Rev B Page 1 of 129
User's Guide
Copyright © 2002-2007 Allied Telesis K. K. All rights reserved. No part of this publication may be reproduced without prior written permission from Allied
Telesis K. K. Allied Telesis K. K. 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 K. K. 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 K. K. has been advised of, known, or should have known, the possibility of such damages.
PN 613-000381 Rev B Page 2 of 129
User's Guide
TABLE OF CONTENTS
1 INTRODUCTION .................................................................................................... 6
1.1 RECOMMENDED READING..................................................................................6
1.2 OTHER REQUIREMENTS.....................................................................................6
2 A GUIDED TOUR ........................................................................................................ 7
2.1 LAUNCHING THE APPLICATION ..........................................................................7
2.2 CREATING A DEVICE..........................................................................................8
2.3 UPGRADING SOFTWARE...................................................................................12
2.4 THE ALLIEDVIEW-UM SYSTEM FOLDERS ...........................................................12
3 MAIN WINDOW....................................................................................................... 13
3.1 DEVICE FAMILIES PANE ...................................................................................13
3.2 OPERATIONS SELECTION PANE........................................................................14
3.3 OPERATIONS PANE..........................................................................................16
3.4 OPERATION LOGS PANE...................................................................................16
4 DEVICE GROUPS...................................................................................................... 18
4.1 CREATING A DEVICE GROUP............................................................................18
4.2 DELETING A DEVICE GROUP ............................................................................18
4.3 RENAMING A DEVICE GROUP ...........................................................................20
4.4 LOADING DEVICE GROUPS...............................................................................21
4.5 CLOSING DEVICE GROUPS ...............................................................................22
5 DEVICE DEFINITIONS ............................................................................................... 24
5.1 CREATING A DEVICE DEFINITION.....................................................................24
5.2 LOADING DEVICE DEFINITIONS FROM A COMMA SEPARATED VALUE (CSV) FILE.29
5.3 VIEWING DEVICE DEFINITIONS........................................................................33
5.4 MODIFYING DEVICE DEFINITIONS....................................................................35
5.5 DELETING DEVICE DEFINITIONS......................................................................37
6 EXPORTING DEVICE SERIAL NUMBERS......................................................................... 38
6.1 LICENSE LIST FILE FOR RELEASE UPGRADE (ALLIEDWARE) OPERATIONS...........40
6.2 LICENSE LIST FILE FOR ENABLE FEATURES OPERATIONS ..................................40
7 RELEASE UPGRADE OPERATION.................................................................................. 42
7.1 CREATING A RELEASE UPGRADE PROFILE.........................................................43
7.2 SAVING A RELEASE UPGRADE PROFILE.............................................................48
7.3 LOADING A RELEASE UPGRADE PROFILE...........................................................49
7.4 STARTING THE RELEASE UPGRADE (ALLIEDWARE) or (OTHER) OPERATION .......51
8 INTERIM/MAINTENANCE RELEASE UPGRADE OPERATION ............................................... 52
8.1 CREATING AN INTERIM/MAINTENANCE RELEASE UPGRADE PROFILE..................53
8.2 SAVING AN INTERIM/MAINTENANCE RELEASE UPGRADE PROFILE......................55
8.3 LOADING AN INTERIM/MAINTENANCE RELEASE UPGRADE PROFILE ...................56
8.4 STARTING THE INTERIM/MAINTENANCE RELEASE UPGRADE OPERATION...........58
9 PATCH UPGRADE OPERATION..................................................................................... 60
9.1 CREATING A PATCH UPGRADE PROFILE............................................................61
9.2 SAVING A PATCH UPGRADE PROFILE................................................................63
PN 613-000381 Rev B Page 3 of 129
User's Guide
9.3 LOADING A PATCH UPGRADE PROFILE..............................................................64
9.4 STARTING THE PATCH UPGRADE OPERATION...................................................66
10 CONFIGURATION FILE UPDATE................................................................................... 67
10.1 CREATING A CONFIGURATION FILE UPDATE PROFILE .......................................68
10.2 SAVING A CONFIGURATION FILE UPDATE PROFILE ...........................................72
10.3 LOADING A CONFIGURATION FILE UPDATE PROFILE .........................................73
10.4 STARTING THE CONFIGURATION FILE UPDATE OPERATION ..............................75
11 EXECUTE SCRIPT FILE............................................................................................... 77
11.1 CREATING AN EXECUTE SCRIPT FILE PROFILE ..................................................78
11.2 SAVING AN EXECUTE SCRIPT FILE PROFILE ......................................................80
11.3 LOADING AN EXECUTE SCRIPT FILE PROFILE....................................................81
11.4 STARTING THE EXECUTE SCRIPT FILE OPERATION ...........................................83
12 GUI RESOURCE FILE UPDATE .................................................................................... 84
12.1 CREATING A GUI RESOURCE FILE UPDATE PROFILE ..........................................85
12.2 SAVING A GUI RESOURCE FILE UPDATE PROFILE ..............................................87
12.3 LOADING A GUI RESOURCE FILE UPDATE PROFILE............................................88
12.4 STARTING THE GUI RESOURCE FILE UPDATE OPERATION .................................90
13 HELP FILE UPDATE................................................................................................... 91
13.1 CREATING A HELP FILE UPDATE PROFILE .........................................................92
13.2 SAVING A HELP FILE UPDATE PROFILE .............................................................94
13.3 LOADING A HELP FILE UPDATE PROFILE...........................................................95
13.4 STARTING THE HELP FILE UPDATE OPERATION ................................................97
14 ENABLE FEATURES ................................................................................................... 98
14.1 CREATING AN ENABLE FEATURES PROFILE .......................................................99
14.2 SAVING AN ENABLE FEATURES PROFILE .........................................................101
14.3 LOADING AN ENABLE FEATURES PROFILE.......................................................102
14.4 STARTING THE ENABLE FEATURES OPERATION .............................................. 104
15 REBOOT DEVICE .................................................................................................... 105
15.1 CREATING A REBOOT DEVICE PROFILE...........................................................106
15.2 SAVING A REBOOT DEVICE PROFILE...............................................................107
15.3 LOADING A REBOOT DEVICE PROFILE ............................................................108
15.4 STARTING THE REBOOT DEVICE OPERATION..................................................110
16 AUDIT TRAIL......................................................................................................... 111
16.1 VIEWING THE AUDIT TRAIL ........................................................................... 111
17 SCHEDULING OPERATIONS ...................................................................................... 113
17.1 HOW TO SCHEDULE AN OPERATION............................................................... 113
17.2 VIEWING TASKS............................................................................................114
17.3 EDITING TASKS.............................................................................................116
17.4 ABORTING A TASK.........................................................................................118
17.5 DELETING A TASK .........................................................................................119
18 ROLLBACK ............................................................................................................ 120
18.1 ROLLBACKS AND THE AUDIT TRAIL ................................................................ 120
PN 613-000381 Rev B
Page 4 of 129
User's Guide
18.2 SPECIAL RULES ON ROLLBACKS...................................................................... 121
18.3 PERFORMING A ROLLBACK ON A DEVICE ........................................................ 122
18.4 PERFORMING A ROLLBACK ON AN OPERATION PROFILE..................................124
19 LICENSE REGISTRATION.......................................................................................... 127
20 OPTIONS.............................................................................................................. 129
20.1 VIEW SETTINGS ............................................................................................129
20.2 THREAD SETTINGS........................................................................................ 129
PN 613-000381 Rev B
Page 5 of 129
User's Guide
1 INTRODUCTION
AlliedView-UM is a Java-based application that allows fast and efficient distribution of Software Upgrades, Patches, GUI Resource files, Help, Configuration files and Script files on Allied Telesis network devices. It provides a batch method of downloading software or a file onto devices via TFTP or HTTP. It also provides the ability to enable the downloaded software or file and enable features on multiple devices.
1.1 RECOMMENDED
AlliedView-UM basically builds upon the CLI commands of Allied Telesis management software. Refer to the Software Reference Manual or CLI User’s Guide that accompanies every AT network device for a better understanding of these commands.
1.2 OTHER
REQUIREMENTS
The user should have some background in network device management specifically for AT Network Devices.
READING
PN 613-000381 Rev B Page 6 of 129
User's Guide
2 A GUIDED TOUR
This section introduces all the basic features of AlliedView-UM. This section is not intended to be a reference and will thus not explain all the details.
2.1 LAUNCHING
To begin the tour, start the application using any of the following methods: For Windows systems: Double-click on the executable file "um.exe" or its corresponding shortcut through Windows
Explorer.
Enter the installation path specified during installation followed by "\bin\um.exe" on the command
line
Click on the application icon in the AlliedView-UM program group
For Solaris and HP-UX systems: Move to the directory where AlliedView-UM was installed, and type "./bin/um" on the command line.
THE APPLICATION
PN 613-000381 Rev B Page 7 of 129
User's Guide
The image below illustrates the initial screen display of AlliedView-UM.
2.2 CREATING
Before you can use the main functions of AlliedView-UM , you will need to add Devices on the Device Families pane. To do that, follow these simple steps.
1. Click on the Device->Add Device Group option. This will display the “Add Device Group” dialog box.
PN 613-000381 Rev B
A DEVICE
Page 8 of 129
User's Guide
2. Click on the “Device Family” dropdown list and select “Rapier”. If you do not have any Rapier devices, select the appropriate device family for the device that you currently have. On the Device
Group Name field, input “Test Group” and click on the
button.
3. Look at the Device Families pane. You should see your newly created group ("Test Group") added under the Rapier Family root node.
4. Click on the Device->Add Device option.
5. The Add New Device dialog box should be displayed.
PN 613-000381 Rev B
Page 9 of 129
User's Guide
7. Input the IP address of your device in the IP Address field.
8. In the Login Name field, enter the user account name that AlliedView-UM will use to login to your device.
9. In the Password field, enter the appropriate password for the account you have entered in the previous step.
10. The SNMP Read Community, Timeout and Retries fields already have default values. You may change these if needed.
PN 613-000381 Rev B
Page 10 of 129
User's Guide
11. Click on the button. If the IP Address, Login Name, Password, and SNMP Read
Community that you specified are correct, then the Device Family, Device Model Serial Number, System Name, System Description and Configuration File fields should now be set. If an error occurs, please re-check the values you entered in steps (6) to (9).
12. Finally, click on the button to add the device.
13. Your new device should now be added. If you check the Device Families pane, you should see the
IP Address of your device under the group called, "Test Group".
PN 613-000381 Rev B
Page 11 of 129
User's Guide
2.3 UPGRADING SOFTWARE
In this section, we will be performing a simple patch upgrade using the Patch Upgrade operation. Before proceeding, make sure you have added one or more devices. If you have not done so, please go back to the previous section, "Creating a Device". You will also need to have access to an appropriate patch upgrade file for your device.
Click on the
button on the Operations Selection Pane. This will display
the Patch Upgrade pane.
Next, locate the upgrade file you will be using by clicking the selected your file, click on the
button. After you have located and
option. Check the
checkbox.
Enter the address of the server where the file is located. Make sure you enter the correct address format. If you have an HTTP server, you should enter a URL address. If you have a TFTP server, enter an IP Address.
Now, select the devices you will be applying the update to. In the "Available Devices" list box, you should see the IP Addresses of the devices you added a while ago and for which the selected patch is
applicable to. Select one of those entries and click on the
button. The IP Address that you
selected should now appear in the "Selected Devices" list box.
To start the upgrade process, click on the
button.
NOTE: Upgrading and rebooting a device will make that device unavailable for the duration of the operation. Make sure that you notify the appropriate groups or people that will be affected before proceeding.
2.4 THE ALLIEDVIEW-UM SYSTEM FOLDERS
Deleting or modifying any of the files under the AlliedView-UM installation folder is not recommended. Doing so will cause the application to function incorrectly.
PN 613-000381 Rev B
Page 12 of 129
User's Guide
3 MAIN WINDOW
After successfully starting the application, the following window will be initially displayed:
The Main Window is divided into 4 major panes (or regions), namely the (1) Device Families Pane, the
(2) Operations Selection Pane, the (3) Operations Pane and the (4) Operation Logs Pane.
3.1 DEVICE
FAMILIES PANE
The Device Families Pane is used to manage the devices that AlliedView-UM can interface with.
PN 613-000381 Rev B Page 13 of 129
User's Guide
The root nodes of the Device Families represent the AT Device Families that are currently supported by this application. The AT Device Family root node is represented by a (
) icon followed by the AT Device
Family name. Each AT Device Family root node can contain Device Group nodes. A Device Group node is represented
by a (
) icon followed by the Device Group name.
Finally, a Device Group node can contain Device nodes. A Device node is represented by a ( ) icon followed by the IP address of that device. A Device node cannot contain any other nodes under it. Double clicking on a node will display the corresponding dialog box that will allow you to perform functions pertaining to that node. For instance, if you double click on a Device Node, the Edit Device dialog box will be displayed. From the Edit Device dialog box you can view and modify some of the device attributes.
3.2 OPERATIONS
The Operations Selection Pane allows you to select an operation profile to create.
SELECTION PANE
PN 613-000381 Rev B
Page 14 of 129
User's Guide
Clicking on any of the buttons in the Operation Selections Pane will display the appropriate Operations Pane. For example, if you click on the
button, the Release
Upgrade Operations Pane will be displayed.
PN 613-000381 Rev B
Page 15 of 129
User's Guide
3.3 OPERATIONS
PANE
This is where operation panes for creating operation profiles are displayed.
For instance, the figure above displays the Release Upgrade (AlliedWare) pane after the user clicks on the
3.4 OPERATION
The Operation Logs Pane displays the status and results of operations performed.
PN 613-000381 Rev B
button.
LOGS PANE
Page 16 of 129
User's Guide
PN 613-000381 Rev B
Page 17 of 129
User's Guide
4 DEVICE GROUPS
A device group represents a logical grouping used to manage devices. A device group must first be created before any device can be defined.
4.1 CREATING
1. Click on the
A DEVICE GROUP
Device->Add Device Group option. This will display the “Add Device Group” dialog box.
2. Select the Device Family where your new Device Group will be added to.
3. Enter the name of your device group in the Device Group Name field.
4. Finally, click on the
button.
4.2 DELETING
A DEVICE GROUP
Method 1:
1. On the Device Families Pane, select the device group node to be deleted.
PN 613-000381 Rev B Page 18 of 129
User's Guide
2. Click on the
Device->Delete Device Group option.
3. A confirmation dialog box will be displayed. Click on
to proceed with the deletion.
Method 2:
1. Right click on the device group node to be deleted. A popup menu will appear.
2. Select the
3. A confirmation dialog box will be displayed. Click
Delete option.
to proceed with the deletion.
NOTE: Any device under the deleted device group will be deleted as well.
PN 613-000381 Rev B
Page 19 of 129
User's Guide
4.3 RENAMING
A DEVICE GROUP
Method 1:
1. On the Device Families Pane, select the device group node to be renamed. The device group pane will be displayed. The Name field contains the currently assigned name for that device group.
2. Click on the
Device->Rename Device Group option.
3. Type in the new name in the Device Group Name field.
4. Finally, click on the
button.
PN 613-000381 Rev B
Page 20 of 129
User's Guide
Method 2:
1. Right click on the Device Group node to be renamed.
2. Select the “Rename” option to display the Rename Device Group dialog box.
3. Rename the device group. Then click on the
4.4 LOADING DEVICE GROUPS
Device groups which have been closed can be reloaded using this function.
1. Click on File->Load Device Groups on the main menu.
button.
PN 613-000381 Rev B
Page 21 of 129
User's Guide
2. Specify the file(s) to be loaded.
3. Click the
button.
4. Once the loading is complete, the device groups with their respective devices will be displayed in the Device Families Pane.
4.5 CLOSING
DEVICE GROUPS
Unlike deleting, closing device groups will only "unload" the device groups. Unloaded device groups can be "reloaded" later using the "Load Device Groups" function.
1. To close a device group, click on File->Close Device Groups on the main menu to display the Close Device Groups dialog box.
2. Set the Family Filter to the device family of the device group to be closed.
PN 613-000381 Rev B
Page 22 of 129
User's Guide
3. Select the device group to close.
4. Finally, click on the
button.
PN 613-000381 Rev B
Page 23 of 129
User's Guide
5 DEVICE DEFINITIONS
Devices must first be defined before they can be included in any operation. Also, TELNET LOGIN support for a device must be enabled in order for AlliedView-UM to interface with
it.
5.1 CREATING
A DEVICE DEFINITION
1. Before you add any new devices, make sure you have already defined a Device Group. If you have not done so, please create one using the steps described in the previous section, Creating a Device Group.
2. Click on the
Device->Add Device option.
PN 613-000381 Rev B Page 24 of 129
User's Guide
3. The Add New Device dialog box will be displayed with the input fields blank or set to a default value:
IP Address - This is the IP Address of the device. Login Name - This is the user account recognized by the device. AlliedView-UM will login to the
device using this account to perform the different operations.
Password - This is the password for the login name. SNMP Read Community – This is the SNMP Read Community name that AlliedView-UM will use
to retrieve the device’s Model, Serial Number, System Description and Configuration file. By default, this value is set to “public”. (This field only applies to devices that use AlliedWare™ management
PN 613-000381 Rev B
Page 25 of 129
User's Guide
software. You may ignore this field when adding devices that use non-AlliedWare™ management software.)
Timeout - When retrieving the device's information, this is the number of seconds AlliedView-UM
will wait for a response before retrying. (This field only applies to devices that use AlliedWare™ management software. You may ignore this field when adding devices that use non-AlliedWare™ management software.)
Retries - This is the number of times AlliedView-UM will try to retrieve the Device Model, Serial
Number, System Description and Configuration file before displaying an error message. (This field only applies to devices that use AlliedWare™ management software. You may ignore this field when adding devices that use non-AlliedWare™ management software.)
System Name - This is an arbitraty name for the device. System Description - This is an abitrary description for the device. Configuration File - This is the configuration file that will be assigned for this device.
PN 613-000381 Rev B
Page 26 of 129
User's Guide
4. Once the fields in step (3) have been set, click on the button.
PN 613-000381 Rev B
Page 27 of 129
User's Guide
5. AlliedView-UM will retrieve the Serial Number and Device Model. If the retrieval is successful, the Device Family, Device Model, Serial Number, System Name, System Description and Configuration File fields will be set to that of the device. (For devices that run on non-AlliedWare™ management software, the Serial Number will be set to "N/A".) The Device Group combo box will also be populated with the groups defined under the device family.
6. Click on the
PN 613-000381 Rev B
button to add the new device.
Page 28 of 129
User's Guide
7. After the device is added, the Device Families Pane will be updated with a new node represented by the IP address of that device.
8. If you decide not to continue adding the device, click on the
5.2 LOADING
DEVICE DEFINITIONS FROM A COMMA SEPARATED VALUE (CSV) FILE
An alternative way of adding or updating multiple devices is by pre-defining them in a Comma Separated Value (CSV) file. AlliedView-UM then imports the definitions contained in this file and adds them to the specified device group.
The format of a CSV device definition is as follows:
IP_Address, login_name, password, system_name, system_description, SNMP_read_community, SNMP_timeout, SNMP_retry, device_group, configuration_file
During the operation, AlliedView-UM will check if the IP_Address field of an entry is already defined in the Device Family Tree. If the entry is already defined, then AlliedView-UM will update the existing device definition with the values from the CSV file entry. Otherwise, if the entry does not exist in the Device Family Tree, then AlliedView-UM will create a new Device Definition.
The system_name, system_description and configuration_file fields may be set to the following values:
<value> - If a value is provided, then AlliedView-UM will use that value for the device definition.
button.
<blank> - When importing a device definition, if the field is blank (no value), then AlliedView-UM
will retrieve the value from the target device. When updating an existing device definion, if the field is blank, then AlliedView-UM will not update the corresponding field in the device definition.
"*" (asterisk) - When updating a device definition, if the field is set to "*", then AlliedView-UM will
retrieve the value from the target device. When importing a device defintion, if this field is set to "*", then AlliedView-UM will also retrieve the value from the target device.
The following is a sample of a typical CSV file:
192.168.10.9, manager, friend, Main, Used by QA Group, public, 10, 3, Security, tomato.cfg
PN 613-000381 Rev B
192.168.10.11, manager, friend, , ,public,10,3,Security,lab.cfg
192.168.10.30, manager, friend, , , , , , 8400_Group,
192.168.10.31, manager, friend, , , , , , 8400_Group,*
Page 29 of 129
User's Guide
1. To load device definitions from a CSV file, click on File->Import/Update Devices on the menu.
2. Specify the file to import and click on the import the CSV format device definition entries it contains.
PN 613-000381 Rev B
button. AlliedView-UM will then open that file and
Page 30 of 129
Loading...
+ 99 hidden pages