Adaptec Storage Examiner. Installation and User Guide

Transcription

1 Adaptec Storage Examiner MAN UG Revision th November 2003 Adaptec, Inc., Clonshaugh Industrial Estate, Clonshaugh, Dublin 17. IRELAND This document may be subject to change without prior notice

2 Table of Contents 1 INTRODUCTION INSTALLATION WINDOWS LINUX SOLARIS PRODUCT OVERVIEW SUPPORTING RAID SYSTEMS Windows Unix Managing RAID systems ADAPTEC ENCLOSURE MONITORING AGENT WINDOWS IMPLEMENTATION UNIX IMPLEMENTATION CONFIGURATION PROPERTIES Launching General Notification Event Log SNMP Local File Console Script Event Filtering Advanced DISABLING THE MONITORING AGENT ADAPTEC ENCLOSURE MANAGEMENT AGENT WINDOWS IMPLEMENTATION UNIX IMPLEMENTATION CONFIGURATION PROPERTIES ADAPTEC STORAGE EXAMINER WINDOWS IMPLEMENTATION UNIX IMPLEMENTATION MENU OPTIONS File Edit Tools Help CONFIGURATION PROPERTIES General Firmware Download Client/Server DOWNLOADING FIRMWARE CLIENT SERVER SUPPORT CONNECTING TO A REMOTE HOST AUTHENTICATION RULES DISCONNECTING FROM A REMOTE HOST LIMITATIONS DEVICE DRIVERS Adaptec, Inc. All rights reserved. Page 2 of 16

3 1 Introduction Adaptec Storage Examiner is a suite of software tools that allows System Administrators to install, manage and monitor JBOD storage enclosures attached to the host system. Further information about this release can be found in the Release Notes that accompany it. These are available in HTML format on the original media (docs folder). They are also installed with the product and can be viewed by selecting the Release Notes icon from the Adaptec Storage Examiner Program Folder on a Windows system. 2 Installation On all supported operating systems (see Release Notes) you must be a user with Administrative/root privileges to install and use this software. If a previous version of this software is already installed on your system then it must be removed before installing this version. 2.1 Windows Run the setup.exe program from the win folder on the distribution media and follow the instructions thereafter. 2.2 Linux The software is distributed in RPM format for Linux. To install it, use the command(s) below: # rpm -ihv /mnt/cdrom/linux/ase-2.1-<bb>.i386.rpm This will install a package called ASE into /usr/local/ase. To uninstall the software, use the command(s) below: # rpm e ASE 2.3 Solaris The software is distributed in package format for Solaris. To install it use the command(s) below: # pkgadd -d /cdrom/ase_v20_<bb>/solaris/ase-2.1-<bb>.pkg This will install a package called ASE into the location of your choice. The default folder is /usr/local/ase. Depending on how the installation media was mounted, the names of the folders and files on it may appear in ISO format (8.3). In this case the installation command above will need to be adjusted accordingly. To uninstall the software, use the command(s) below: # pkgrm ASE 2003 Adaptec, Inc. All rights reserved. Page 3 of 16

4 3 Product Overview There are four main features in Adaptec Storage Examiner: - Adaptec Enclosure Monitoring Agent (Monitoring Agent) Adaptec Enclosure Management Agent (Management Agent) Adaptec Storage Examiner (Configuration GUI) Device Drivers Each of these is discussed in more detail in the later sections of this document. 3.1 Supporting RAID systems Whilst Adaptec Storage Examiner is intended for use on JBOD enclosures only, it does contain limited support for some RAID subsystems whereby the RAID controller can be bypassed and the enclosures within the RAID subsystem can be managed/monitored as if the RAID controller were not there. Currently, only SANbloc 2500 products are supported. This functionality is normally disabled but can be enabled as follows: Windows Create a file called jbod.raid in the directory referenced by the TEMP environment variable and restart the software. NOTE Because the Monitoring and Management agents run as services on Windows, their TEMP environment variable will be the SYSTEM TEMP variable and not the one belonging to the logged on user. This means that the jbod.raid file must be placed in the directory referenced by the SYSTEM TEMP variable for the agents to detect the RAID system(s). This is usually \WINNT\Temp Unix In addition, the directory referenced by the TEMP variable of the logged on user must be used so that the Configuration GUI will detect the RAID system(s). This is usually \Documents and Settings\<user>\Local Settings\Temp Create a file called jbod.raid in the /tmp directory and restart the software. The name of the file will be case-sensitive Managing RAID systems Adaptec Storage Examiner does not currently support the management of RAID systems. This must be done using one of the other Adaptec storage management products: Adaptec Storage Manager Adaptec Storage Director Adaptec RAIDWatch 2003 Adaptec, Inc. All rights reserved. Page 4 of 16

5 4 Adaptec Enclosure Monitoring Agent This is an application that monitors the attached enclosures, looking for faults and other events such as temperature changes etc. It runs in the background all of the time (agent). It can be configured to report any events in a variety of different mechanisms including: , Event Log, SNMP, Local File, Console, Script It runs as a service on Windows and as a daemon on Unix systems. When running on a Windows system, a special icon will be shown in the System Tray that will indicate the status of the agent. Follow the instructions below to use this application on your system: 4.1 Windows Implementation A Windows Service called Adaptec Enclosure Monitoring Agent will be installed (and automatically started) as part of the installation of this software. This service can be controlled in a number of ways: 1. Select the appropriate icon from the "Adaptec Storage Examiner, Monitoring Agent" program folder. 2. Select the service from the Windows Services control panel and control it from there. The service will be configured to run automatically at system boot. If you do not want this to happen, you can change the startup mode of the service from the Windows Control Panel to "Manual". 4.2 Unix Implementation The agent runs as a daemon called asemonitor on Unix and can be controlled by a script called asemon. It will be started automatically during the installation of the product. Follow the steps below to control this daemon on your system: # cd /usr/local/ase/bin #./asemon start The asemon script can also be used to stop, restart and configure the daemon as well as examining its current run status. This daemon will be configured to start/stop automatically when the system boots/shuts down. If you do not want this to happen, you should remove or modify the file(s) in the folder(s) below on your system: O/S Startup Shutdown Solaris /etc/rc2.d/s99ase /etc/rcs.d/k99ase Linux (Redhat) /etc/rc.d/rc5.d/s99ase /etc/rc.d/rc1/d/k99ase Linux (SuSE) /etc/init.d/rc5.d/s99ase /etc/init.d/rc5.d/k99ase Please note that removing this file will affect the operation of the Adaptec Enclosure Management Agent (section 5). 4.3 Configuration Properties A graphical application is provided to allow the user to configure the properties of the Enclosure Monitoring Agent. The properties are divided into a number of different tabs for clarity Launching The properties panel can be launched in a number of ways as follows: Windows 1. Double-click on the System Tray icon 2. Right-click the System Tray icon and select Properties 2003 Adaptec, Inc. All rights reserved. Page 5 of 16

6 3. Select the Configure Properties icon from the Monitoring Agent program folder. Unix 1. Run the command asemon configure from /usr/local/ase/bin Any changes made to these properties will be take place automatically once they have been applied General The following properties are shown in the General Tab. Polling Interval This specifies the number of seconds/minutes/hours to wait between each hardware status update (poll). The minimum value is 5 seconds and the maximum value is 24 hours. Temperature Changes This specifies the number of degrees Centigrade by which a Temperature Sensor needs to change before a suitable event will be generated. It is used to allow temperature fluctuations to be filtered out of the monitoring process. The minimum value is 1 degree and the maximum value is 20 degrees. Monitor Disk Defects This specifies whether the agent should check the Disk Drives in each enclosure for defects. If enabled, the agent will check the Grown Defects each of Disk Drive once per day, at a specified time (see below). If the number of Grown Defects is greater than zero then a Warning event will be generated. Disk Defects Check Time This specifies the time at which the agent will check for Disk Drive defects. If the Disk Defect Monitoring setting above is set to No, then this setting will have no effect. The default checking time is 06:00. Show Temperature In This allows the temperature values reported in temperature related events to be shown in degrees Centigrade or Fahrenheit or both. Show Icon in System Tray This setting only applies to Windows systems and controls whether an icon representing the status of the monitoring agent will be shown in the bottom right-hand corner of the screen (System Tray) Notification The Notification Tab is where the Event Notification properties are configured. A brief description of each supported notification mechanisms are shown below along with the properties of each mechanism If configured, Notification will send an message to one or more Internet addresses when an appropriate event is generated. The available settings for Notification are: Enabled Whether or not notification should take place. Mail Server The name (or address) of an SMTP-compatible server on the network. Anonymous SMTP access must be enabled on this system. Recipients 2003 Adaptec, Inc. All rights reserved. Page 6 of 16

7 A list of Internet addresses to which the appropriate message may be sent. When an address is added, one or more event severities (Information, Warning or Critical) can be specified for that address. This allows events with differing severities to be sent to different addresses. NOTE The Event Filtering screen (section 4.3.4) will override the severity level(s) configured for an recipient. Therefore, if Notification is disabled for Warning events in the Event Filtering screen, this will prevent an recipient that has been configured to receive Warning events from receiving that event notification. If you are planning on specifying different addresses for different event severities, then it is recommended that the Event Filtering settings for Notification are enabled for all event severities. Include Text File The name of a file on the local system that should included in the body of each message sent by the agent. The file must already exist on the system. Reply-To Address Allows the user to configure an alternative Reply-To address for the messages being sent by this software. If this is not specified, the software will automatically generate one based on the name of the host system. Reply-To Name Allows the user to configure an alternative real name for the sender of the messages being sent by this software. If this is not specified, the software will automatically generate one Event Log If configured, Event Log Notification will insert an entry into the event log system on the local host system when an appropriate event is generated. On Windows, all events will be logged to the Application section of the event log and can be viewed using the Event Viewer application. On Unix, all events should be sent to the daemon message facility of the syslog daemon. The following levels should be used: Severity Syslog Level Syslogd.conf Information LOG_INFO daemon.info Warning LOG_WARNING daemon.warn Critical LOG_CRIT daemon.crit The available settings for Event Log Notification are: Enabled Whether or not Event Log notification should take SNMP If configured, SNMP Notification will send an SNMP Trap message to an SNMP Management Station when an appropriate event is generated. The available settings for SNMP Notification are: Enabled Whether or not SNMP notification should take place. Management Stations A list of addresses (IP or host names) of an SNMP Management Stations on the network that are listening for SNMP Traps on the Trap Port below Adaptec, Inc. All rights reserved. Page 7 of 16

8 Trap Port This should be the port number on which the SNMP Trap(s) should be sent. The default value will be 162 as this is the world wide recognized port number for SNMP Traps. Trap Version This should specify the SNMP Version to use when the trap is being sent. The following versions will be supported: SNMPv1, SNMPv2. The default version will be SNMPv1. Community String This should specify the Community String to be used when sending the trap. The default value will be public Local File If configured, Local File Notification will append information to a file on the local system when an appropriate event is generated. The available settings for Local File Notification are: Enabled Whether or not Local File notification should take place. Local File Name The name (and path) of a file on the local system Console If configured, Console Notification will send a message to the console of the system where the agent is running when an appropriate event is generated. On Windows, this will result in a modal dialog box appearing at the system console whether or not any users are logged in at the time. On Unix, this will result in a message being sent to /dev/console. The available settings for Console Notification are: Enabled Whether or not Console notification should take place Script If configured, Script Notification will execute a program on the local system when an appropriate event is generated. The first argument to this program will be a string containing the details of the event. The available settings for Script Notification are: Enabled Whether or not Script notification should take place. Script Name The name (and path) of an executable program on the local system Event Filtering The Event Filtering Tab is where the filtering of events of different severities can be controlled. This allows the user to specify the type(s) of notification that should be carried out for each of the 3 different types of severities - Information, Warning and Critical Adaptec, Inc. All rights reserved. Page 8 of 16

9 For instance, if you decided that you did not want to receive an for Information events, you could configure that from this screen. Please note that changes made to the Notification in this screen can affect the sending of s to certain recipients. Refer to section for further details Advanced The following properties are shown in the Advanced Tab. Agent Enabled This specifies whether the agent should be enabled or disabled. When the agent is enabled, a normal hardware status update will be carried out at each poll interval. When the agent is disabled, a status update will not take place. Refer to section 4.4 for further details. Multiple Hosts Connected This setting controls the amount of data that is read from the attached hardware during each status update. If only one host system is attached to the hardware being monitored, then this setting should be No, which will result in Short SES Reads being performed (better performance). If more than one host system is attached to the hardware being monitored then this setting should be Yes. Otherwise only one of the attached hosts will detect status changes in the hardware. Application Tracing This is currently reserved for engineering use only. 4.4 Disabling the Monitoring Agent It is possible to dynamically change the behaviour of the monitoring agent so that it does not actually communicate with the attached hardware when it is time to perform a status update. This feature is useful when exclusive access to system bandwidth is required by other applications. This can be done in a number of ways: 1. Change the Enable Agent setting to No in the Properties panel for the Monitoring Agent (see section 4.3 above) and apply the changes. 2. Select View, Options from Adaptec Storage Examiner (see below), change the Disable Monitoring Agent setting to Yes and apply the changes. 3. Perform the following steps (manually or automatically from another application) on the system where the agent is running: Windows Change the registry value below to a positive, non-zero number: HKEY_LOCAL_MACHINE\SOFTWARE\Adaptec\Adaptec Storage Examiner\SuspendESPoll The value will be used as the new polling interval for the agent and will determine how often it will check to see if it has been enabled once again. Unix Create the following file on your system (case-sensitive name): /tmp/espoll.suspend The contents of this file do not matter. It is the existence of the file that causes the agent to be disabled. The new polling interval in this case will be 10 seconds Adaptec, Inc. All rights reserved. Page 9 of 16

10 5 Adaptec Enclosure Management Agent This is an application that allows the attached enclosures to be managed by a remote system. It runs in the background all of the time (agent) and allows a user running Adaptec Storage Examiner on a remote system to connect to this system and manage the storage attached to it. It runs as a service on Windows and as a daemon on Unix systems. Other than at startup, it does not communicate with the attached storage unless instructed to do so by a client system. It is not dynamic. Follow the instructions below to use this application on your system: 5.1 Windows Implementation A Windows Service called Adaptec Enclosure Management Agent will be installed (and automatically started) as part of the installation of this software. This service can be controlled in a number of ways:- 1. Select the appropriate icon from the "Adaptec Storage Examiner, Management Agent" program folder. 2. Select the service from the Windows Services control panel and control it from there. The service will be configured to run automatically when the system boots. If you do not want this to happen, you can change the startup mode of the service from the Windows Control Panel to "Manual". 5.2 Unix Implementation The agent runs as a daemon called asemanager on Unix and can be controlled by a script called asemgr. It will be started automatically during the installation of the product. Follow the steps below to control this daemon on your system: # cd /usr/local/ase/bin #./asemgr start The asemgr script can also be used to start, stop and restart the daemon as well as examining its current run status. This daemon will be configured to start/stop automatically when the system boots/shuts down. If you do not want this to happen, you should remove or modify the file(s) in the folder(s) below on your system: O/S Startup Shutdown Solaris /etc/rc2.d/s99ase /etc/rcs.d/k99ase Linux (Redhat) /etc/rc.d/rc5.d/s99ase /etc/rc.d/rc1/d/k99ase Linux (SuSE) /etc/init.d/rc5.d/s99ase /etc/init.d/rc5.d/k99ase Please note that removing this file will affect the operation of the Adaptec Enclosure Monitoring Agent (section 4). 5.3 Configuration Properties This agent should be configured from the Configuration GUI on the system where it is installed. Refer to section below for further details Adaptec, Inc. All rights reserved. Page 10 of 16

11 6 Adaptec Storage Examiner This application takes the form of a local desktop GUI and can be used to manage the attached enclosures. Such management activities include: Asset Information (Part Numbers and Serial Numbers) Firmware Download (ES Module, IO Module, Disk Drive) Component Identification (Disk Drive, Fan, Power Supply) Mute Buzzer This application does not automatically monitor (poll) the attached hardware (it is not dynamic). This is the job of the Monitoring Agent. If the user wishes to update the status of all attached hardware then they must select the Update Status option at either the host level or an individual enclosure level. Follow the instructions below to use this application on your system: 6.1 Windows Implementation Select the Adaptec Storage Examiner icon from the Adaptec Storage Examiner program folder. 6.2 Unix Implementation The application can be launched using a script as follows: # cd /usr/local/ase/bin #./ase Be sure that your DISPLAY environment variable is set appropriately. 6.3 Menu Options File The following options are shown in the File menu. Update Status Allows the user to update the status of the storage enclosures attached to every host in the network. The hot-key for this menu option is <Ctrl>-U Mute Local Buzzers Allows the user to mute all buzzers in all storage enclosures attached to the local host system. This menu will not be available if there are no locally attached storage enclosures. The hot-key for this menu option is <Ctrl>-M Connect To Allows the user to connect to a remote host and manage the storage enclosures attached to that system. The hot-key for this menu option is <Ctrl>-H Exit Allows the user to exit from the application Edit The following options are shown in the Edit menu. Undo 2003 Adaptec, Inc. All rights reserved. Page 11 of 16

12 Allows the user to undo the last screen operation. This option is not yet implemented and is present only for consistency purposes. The hot-key for this menu option is <Ctrl>-Z Cut Allows the user to remove the selected items from the screen and copy them onto the system clipboard. The hot-key for this menu option is <Ctrl>-X Copy Allows the user to copy the selected items from the screen to the system clipboard. The hot-key for this menu option is <Ctrl>-C Paste Allows the user to insert items they have previously copied or cut into the selected location. The hot-key for this menu option is <Ctrl>-V Select All Allows the user to select every selectable item in the current screen. This option is not yet implemented and is present only for consistency purposes. The hot-key for this menu option is <Ctrl>-A Tools The following options are shown in the Tools menu. Resynchronize View Causes the application to redraw to currently selected screen using data contained within the application (cache). This option will not cause the application to fetch status information from the attached hardware. The "Update Status" option from the appropriate tree node/level must be used to do this. The hot key for this menu option is <F5> Options Allows the user to view/change the configuration properties for this application. Refer to section 6.4 for further information Help The following options are shown in the Help menu. Supported Hardware Allows the user to view a table of hardware products supported by Adaptec Storage Examiner. About Allows the user to view detailed product information (including Version/Build number, Copyright etc.) 6.4 Configuration Properties The configuration properties of the GUI can only be accessed using the Tools, Options menu from the GUI itself. The properties are divided into a number of different tabs for clarity General The following properties are shown in the General Tab. Confirm Program Exit Allows the user to specify whether they wish to be prompted to confirm that they wish to exit from the application. Confirm Status Update operations 2003 Adaptec, Inc. All rights reserved. Page 12 of 16

13 Allows the user to specify whether they wish to be prompted to confirm that they wish to perform Status Update operations. Display warning when no local enclosures found Specifies whether a warning appears at startup when no enclosures were found on the local system. Turn this off if the system being used will function mainly as a client system. Disable Monitoring Agent This specifies whether the Adaptec Enclosure Monitoring Agent should be enabled or disabled. Refer to section for further details. Show Temperature In This allows the temperature values displayed in this application to be shown in degrees Centigrade or Fahrenheit or both Firmware Download The following properties are shown in the Firmware Download Tab. Block Size This specifies the number of bytes that should be sent in each block of data sent during a firmware download operation. Block Delay This specifies the number of milliseconds that a firmware download procedure should delay between sending each block of data. It is necessary to have this delay so that the module being reprogrammed has enough time to program the previous block of data sent. Firmware Location This allows the user to specify a location where firmware images are kept so that the software automatically looks in that location when commencing a firmware download. Force Download This setting specifies whether firmware should be forcefully downloaded to modules that already contain the same version of firmware. This is mainly for engineering use Client/Server The following properties are shown in the Client/Server Tab. These settings configure the Adaptec Enclosure Management Agent (section 5). Port Number This specifies the port number that remote clients should use to connect to the Management Agent on this system. Authentication Required This specifies whether clients connecting from a remote location will have to authenticate themselves in order to manage the storage attached to this system. Force Remote Poll Upon Connection This specifies whether a full hardware update should be carried out on all enclosures attached to a server system each time a remote client connects to it. 6.5 Downloading Firmware The recommended mechanism for downloading firmware to the Enclosure Services Modules in an enclosure is to select the Download Firmware option from the appropriate enclosure level. This will ensure that each module within the selected enclosure will be upgraded Adaptec, Inc. All rights reserved. Page 13 of 16

14 If the module(s) being upgraded already contain the firmware being downloaded, then the software will return immediately with a message that the download completed successfully. To override this, change the Force Download option in the Firmware Download tab to Yes and repeat the download operation. The Monitoring Agent will automatically be disabled for the duration of the download Adaptec, Inc. All rights reserved. Page 14 of 16

15 7 Client Server Support The ability to manage storage enclosures at a remote location was introduced in Version 2.0 of this product. This allows a user running the Configuration GUI to connect to a remote system and carry out management tasks such as Spin Up/Down Disk Drives, Mute Buzzer etc. It will also allow the user to configure the Monitoring Agent on the remote system so that new addresses can be added etc. 7.1 Connecting to a Remote Host To connect to a remote host, select the "Connect To" option from the Network level in the Configuration GUI. Then, enter the address (IP or host name) of the remote system and press OK 7.2 Authentication Rules If the remote system has been configured to request authentication, a login dialog will appear. The user must supply a username, password and domain (Windows) that has Administrative/Super-user privileges on the remote system as follows: Windows The username, password and domain supplied must be a member of the local Administrators group on the remote host. Unix The username and password supplied must be a member of either the bin or adm group on the remote host. NOTE This software relies on the use of crypt password encryption by the server system. If the password for the username specified is not stored using this type of encryption, connections from remote clients may be refused. Some Linux systems now use PAM to manage user passwords. This new style of password management uses md5 encryption and has restricted user authentication on some systems. To work around this problem, change the type of password encryption used for the intended user as follows: 1. Become a super-user (su -) 2. Edit the PAM password configuration file # vi /etc/pam.d/system-auth 3. Locate the line containing the text below: Password **** /lib/security/pam_xxxx.so nullok use_authtok md5 shadow 4. Change md5 to crypt and save the file 5. Change/reassign the password of the desired user. It will now be stored using crypt encryption, which should resolve any Adaptec Storage Examiner login problems. 6. If required, change the configuration file back to normal. Once you have been authenticated, all of the data from the remote host will be fetched across the network and shown as if the storage were locally attached. 7.3 Disconnecting from a Remote Host To disconnect from a remote host, select the Disconnect option from the appropriate Host node in the tree. 7.4 Limitations Certain features are not yet available in remote mode. They are: Firmware Download It is not currently possible to download new firmware to a device at a remote location. This must be done locally. Agent Restart It is not currently possible to restart any of the agents on a remote host Adaptec, Inc. All rights reserved. Page 15 of 16

16 8 Device Drivers Some operating systems require a device driver for the Enclosure Services Modules in SCSI-based JBOD products. If one is not provided, the operating system may look for it each time the system is booted. Such operating systems include Windows 2000/XP/2003. The distribution media for this software provides a Windows 2000 driver for the SCSI-based products. This driver is located in the 'drivers\win2000' folder on the distribution media. This driver has been certified and digitally signed by Microsoft Adaptec, Inc. All rights reserved. Page 16 of 16