C H A P T E R  2

Installing the Common Array Manager Software

This chapter describes how to install the management software using a graphical user interface (GUI). It contains the following sections:


Installation and Upgrading to a New Release

This chapter describes two types of full installation of Common Array Manager software:

These procedures apply equally to installing on a new host or a new release of the software on a host already running an earlier version of the software. When you proceed to upgrade an existing management host to a new release, you run the install program exactly as described for a fresh installation. The install script searches to see if there is an earlier version of the software present on the system and if so, updates and adds only those files that require change. Existing settings and other data are preserved, and after the upgrade, normal operations can resume. Normally it is not necessary to manually uninstall or re-register devices, redefine users, or reset other system parameters.

Experienced users who want to install software using the CLI can refer to Installing the CAM Software Using a CLI Script.

Any release-specific considerations, including those pertaining to upgrades, are provided in the Sun StorageTek Common Array Manager Software Release Notes.


About the Software Installation CD

The Sun StorageTek Common Array Manager Installation Software CD provides three installation-related wizards:

To simplify the installation process for new users, this chapter will present the GUI Install Option. See Appendix B for CLI options.


Installing From a Downloaded File

You can also download the latest version of the Common Array Manager software from System Administration/Storage Management category on: http://www.sun.com/download.

The current URL is: http://www.sun.com/download/index.jsp?cat=Systems%20Administration&tab=3&subcat=Storage%20Management

Scroll down to StorageTek Common Array Manager software and download the most recent revision listed.

Solaris and Linux Downloads

If installing from a downloaded file on Solaris or Linux, do the following to unpack the file and run the install program:

1. Unpack the file:

tar xvf filename.tar

2. Change to the directory where the install files are unpacked, for example:

cd /install_dir/Host_Software_6.x.x.x

3. Begin the applicable installation procedure at Step 3.

Windows Downloads

1. Unzip the host_sw_windows_6.x.x.x file using a Windows zip application.

2. Change to the directory where the install files are unpacked, for example:

Host_Software_6.x.x.x

3. Begin the Windows installation procedure at Step 3.


Checking the Installation Requirements

Before installing the management software, do the following:

Check that the installation space requirements are met, as listed in TABLE 2-1. (The installation script verifies these requirements. If a requirement is not met, the script informs you.)


TABLE 2-1 Installation Space Requirement s - Full Installation

OS

Total Space

Directory Space

Solaris

860 megabytes

root - 5 megabytes

 

/tmp - 175 megabytes

/usr - 40 megabytes

/var - 110 megabytes

/opt - 530 megabytes

Linux

805 megabytes

root - 5 megabytes

 

 

/tmp - 120 megabytes

 

 

/usr - 155 megabytes

 

 

/var - 115 megabytes

 

 

/opt - 410 megabytes

Windows

965 megabytes

On system drive (usually C:)


TABLE 2-1, Installation Space Requirements, shows the amount of directory space, in megabytes, required for the program directories on Solaris, Linux, and Windows hosts.

Note - These space requirements are for a full installation, including Java Web Console. (You sign into the JAVA Web Console to access the CAM software.) If Java Web Console Version 3.02 and JDK are pre-installed on the system, the required space is smaller by approximately 150 megabytes. On Solaris this is in /opt; on Linux, this is in /usr; on Windows this is on the system drive.


They are NOT added to the system by the CAM installer. They are default users with storage and guest roles and are required to be present in order to use them to log into CAM.

Two roles (storage and guest) are defined in CAM. The storage role has write privileges in CAM, while the guest role can read-only. By default, the root user, or the administrative user in Windows, has the storage role, the storage user has the storage role, and the guest user has the guest role.

Additional users should be added to the storage or guest roles by using the CAM User Management interface. The password for these accounts is the password for the user on the operating system. For more information, see Adding Users And Assigning Roles.

Solaris and Linux: Uninstall all versions of the Sun StorageTek Configuration Service management software prior to the Common Array Manager 5.0.1.1 release. Later versions do not have to be removed.

Windows: Uninstall all versions of the Sun StorageTek Configuration Service management software prior to the Common Array Manager 5.1.0.10 release. Later versions do not have to be removed.



Note - If a version of Sun Java Web Console prior to 2.2.5 is installed, the script prompts you to upgrade to the current version of the Sun Java Web Console. If you choose not to upgrade, the script exits and you cannot install the software.


The following table, Windows Service Pack Requirements, shows the required Windows service packs by Windows OS.

Installation Command Summary

TABLE 2-2 summarizes the commands you need to install the management software using CAM’s GUI installation wizard.

 
TABLE 2-2 Common Array Manager Software Installation Commands

Installation Task

Graphical User Interface

Install the management software.

 

 

RunMe.bin (Solaris, Linux)

RunMe.bat (Windows)

or click on the RunMe button if using a file manager

Uninstall the management software.

 

Note: The Add/Remove Programs feature in Windows is supported

 

uninstall

Force a complete cleanup and removal of an installation.

Not Available

Appendix B describes the uninstall -f command line option to force a complete cleanup



Installing the Software

The following covers installing the management software either locally on a data host or on a central management server, as described in the following sections:

Installing on the Solaris OS

You can install the Common Array Manager software on a SPARC, X86, or X64 system running the Solaris Operating System.

The array installation files and installers are provided in a compressed .bin file on the CD.

The process unpacks the contents of the file on the host and then proceeds with the installation.



Note - The Common Array Manager software installs a Sun GUI framework called Sun Web Console (also known as Lockhart). Some advanced users might install Lockhart separately. For Solaris 10, do not attempt to run the Lockhart setup script when logged into the local zone. (The software installation prevents this.) Either install Lockhart into a whole root zone or install/upgrade Lockhart in the global zone before installing the Common Array Manager software into the local zone.


Proceed to To Install CAM on a Local Data Host: or To Install CAM on a Central Management Server and a Proxy Agent on the Data Host.

Installing on the Linux OS

You can install the Common Array Manager software on a host system running the Red Hat or SUSE Linux Operating System.

The array installation files and installers are provided in a compressed .bin file on the CD.

The process unpacks the contents of the file on the host and then proceeds with the installation.

Proceed to To Install CAM on a Local Data Host: or To Install CAM on a Central Management Server and a Proxy Agent on the Data Host.

Installing on a Windows OS

You can use a wizard to install the Common Array Manager software on a system running Windows 2003, 2008, or XP.

Windows Installer 3.1 must be installed and the service packages listed in TABLE 2-3 are required:


TABLE 2-3 Windows Service Pack Requirements

Windows OS

Required Service Pack Version

Windows 2003

SP1 or higher

Windows 2008

SP1

Windows XP

SP2 or higher


If needed, download the files from the Microsoft Download site.

You must be logged in to the Windows system as an administrative user. For information on setting up administrative users and root users on Windows, see Adding Users And Assigning Roles.

The array installation files and installers are provided in a compressed file on the CD.

The process unpacks the contents of the file on the host and then proceeds with the installation.

After the installation on a Windows platform, you will need to configure the Windows firewall on each host to allow an exception for port 6789 as noted in Step 10.

Proceed to To Install CAM on a Local Data Host: or To Install CAM on a Central Management Server and a Proxy Agent on the Data Host.


procedure icon  To Install CAM on a Local Data Host:

1. Log in to the data host OS as root (Solaris, Linux) or as an administrative user (Windows).

2. Load the software from either a download or CD-ROM installation:

a. Solaris and Linux - run tar filename to unpack the file

tar xvf filename.tar

b. Windows - Unzip the host_sw_windows_6.x.x.x file using a Windows zip application.

c. Change to the Host_Software_6.x.x.x directory where the files were unpacked.

If the compressed installation files do not appear in a directory window:

a. Change to the cd-rom directory:

Solaris /cdrom/cdrom0

Linux /media/cdrom

Windows <system drive>: (Example: C:)

b. Display the contents of the CD:

Solaris and Linux ls -l

Windows - click the directory

3. Review the README.txt file for the latest information on the product and the installation process.

4. To begin unpacking the contents of the compressed installation file, perform one of the following:

a. Solaris and Linux - enter the following command or click the RunMe icon if using a file manager:

RunMe.bin

The files are unpacked in the default directory - /var/opt/CommonArrayManager.

b. Windows - double click on the following icon:

RunMe

The files are unpacked in the default directory path:

<system drive>:\Sun\CommonArrayManager\Host_Software_6.x.x.x\bin.

5. Review the README.txt file for the latest information on the product and the installation process.

The Host_Software_6.x.x.x directory is unpacked into the default directory. The unpacking process takes a couple of minutes. The contents of this directory includes:

- bin/tools

- bin/iam

- bin/uninstall

- components/

- util/

If the wizard screen is not redisplayed or if you receive an error message, recheck that the host requirements listed in Checking the Installation Requirements.

6. Click Next.

Summary information about the installation is displayed.


Screenshot showing the first Common Array Manager installation screen. Click Next to continue.

7. Click Next to display the license agreement screen.


 The screenshot shows the Common Array Manager License Agreement Screen. Click the radio button to accept the license agreement, and then click Next to continue the host installation.

8. Click the radio button to accept the license agreement, and then click Next to display the Installation Type screen.


9. Choose Typical to install the full management software on the data host.

10. Click next to display the Review Selections Screen.


The screen should show that the software to be installed is the Full Install.

The screenshot shows the Common Array Manager Windows Review Selections Screen. It shows the installation type that you selected.

11. To continue, click the Install button.



Note - During the software installation, the progress indicator reflects 0% for a significant portion of the installation process. This is the expected progress indication for the typical installation process.


When the host installation is complete, the View Results screen is displayed.

For information on installation logs, refer to Reviewing the Installation Logs.


Your software installation on the data host is complete.

12. Eject the CD and remove it from the drive.

13. Windows Only - After the installation on a Windows platform, you will need to configure the Windows firewall on the data host.

Set the Windows firewall to allow an exception for port 6789.

Since a proxy agent was not installed or activated with this installation option, there is no need to open port 8653 for a proxy.

Some firewall programs prompt for your agreement to allow new programs to communicate through the firewall, and set the port for you. Refer to your firewall documentation for instructions on how to open a port through the firewall.


procedure icon  To Install CAM on a Central Management Server and a Proxy Agent on the Data Host

1. Log in to the management host OS as root (Solaris, Linux) or as an administrative user (Windows).

2. Load the software from either a download or CD-ROM installation:

a. Solaris and Linux - run tar filename to unpack the file

tar xvf filename.tar

b. Windows - Unzip the host_sw_windows_6.x.x.x file using a Windows zip application.

c. Change to the Host_Software_6.x.x.x directory where the files were unpacked.

If the compressed installation files do not appear in a directory window:

a. Change to the cd-rom directory:

Solaris /cdrom/cdrom0

Linux /media/cdrom

Windows <system drive>: (Example: D:)

b. Display the contents of the CD:

ls -l

3. Review the README.txt file for the latest information on the product and the installation process.

4. To begin unpacking the contents of the compressed installation file, perform one of the following:

a. Solaris and Linux - enter the following command or click the RunMe icon if using a file manager:

RunMe.bin

The files are unpacked in the default directory - /var/opt/CommonArrayManager.

b. Windows - double click on the following icon:

RunMe

The files are unpacked in the default directory path:

<system drive>:\Sun\CommonArrayManager\Host_Software_6.x.x.x\bin.

5. Review the README.txt file for the latest information on the product and the installation process.

The Host_Software_6.x.x.x directory is unpacked into the default directory. The unpacking process takes a couple of minutes. The contents of this directory includes:

- bin/tools

- bin/iam

- bin/uninstall

- components/

- util/

If the wizard screen is not redisplayed or if you receive an error message, recheck that the host requirements in Check the installation space requirements. are met.

6. Click Next.

Summary information about the installation is displayed.


Screenshot showing the first Common Array Manager installation screen. Click Next to continue.

7. Click Next to display the license agreement screen.


 The screenshot shows the Common Array Manager License Agreement Screen. Click the radio button to accept the license agreement, and then click Next to continue the host installation.

8. Click the radio button to accept the license agreement, and then click Next to display the Installation Type screen.


9. Choose Typical to install the full management software on the management host.

10. Click next to display the Review Selections Screen.


The screen should show that the software to be installed is the Full Install.

The screenshot shows the Common Array Manager Windows Review Selections Screen. It shows the installation type that you selected.

11. To continue, click the Install button.



Note - During the software installation, the progress indicator reflects 0% for a significant portion of the installation process. This is the expected progress indication for the typical installation process.


When the host installation is complete, the View Results screen is displayed.

For information on installation logs, refer to Reviewing the Installation Logs.


Your software installation on the management host is complete.

Installing the J4000 Proxy Agent on the Data Host

Next you have to install the proxy agent on the data host attached to the array.

1. Log in to the data host as root.

2. Complete Steps 2 to 7 on the data host.

The Installation Type screen displays.


3. Choose Custom to reveal other installation options.

4. Click Next and proceed to the next step.


5. Choose the third radio button, Command Line Only, to install the proxy agent on the data host.



Note - The other options are explained in Appendix B, but are not needed by new users using the recommended installation.


6. When you have made your selection, click Next to proceed.

The Review Selection screen displays, showing the Command Line Only selection.

The Proxy for Remote Access screen will display.


7. Select the Enable button to enable remote access to the array via the proxy agent.

The proxy agent receives out-of band communication from the management software over Ethernet and delivers the information over an in-band SAS connection between the data host and the array. The communication path uses https on port 8653.

a. Enter and confirm a proxy agent password of up to 15 characters for remote access to this host.

Be sure to remember the password. You will need to enter the proxy agent password when registering the hosts which will serve as proxies to the J4000 arrays.

b. When done, click Next to display the Finish screen.

When the host installation is complete, the View Results screen is displayed, showing that you installed the CLI Only software and Local CLI.

The screenshot shows the Common Array Manager Windows Review Selections Screen. It shows the installation type that you selected.

8. Click the Install button to proceed.

Your proxy agent installation on the data host is complete.

9. Eject the CD and remove it from the drive.

10. Windows Only - After the installation on a Windows platform, you will need to configure the Windows firewall on both the management host and the data host.

Set the Windows firewall to allow an exception for port 6789. If you have a proxy agent, also allow an exception to port 8653. Some firewall programs prompt for your agreement to allow new programs to communicate through the firewall, and set the port for you. Refer to your firewall documentation for instructions on how to open a port through the firewall.


Starting the Management Software

The Sun StorageTek Common Array Manager provides a browser interface for accessing the management software from any host that is connected to the site LAN. The web-based browser interface is the primary interface for configuring, managing, and monitoring the system.

Two command-line interfaces options are also provided. For more information, experienced users should refer to Appendix B.

Logging In Using the Browser Interface

You can start the management software on any system that is connected to the network. Before you log in, you need to set up a storage role or group in your OS and assign users to it. See Adding Users And Assigning Roles.

1. Open a supported web browser.



Note - For information about supported web browsers, see the Sun StorageTek Common Array Manager Release Notes.


2. Enter the IP address of the management host using this format:

https://cam-management-host:6789

cam-management-host is the IP address or hostname of the host where you installed the Sun StorageTek Common Array Manager software.

The login page is displayed.


 [ D ]

3. Login with the root or administrator name.

You need root and storage users on the system. For more information about user names and roles, see Adding Users And Assigning Roles.

For Solaris and Linux, root already exists for the machine on which you installed the software.Later, you may want to add a user accounts with the storage role.

For Windows, you can initially login with any user account with Windows administrative privileges. Later, you may want to add a user accounts with the storage role. For more information about adding users and roles to Windows, see Adding New Users in Windows.

4. Click Log In.

The Java Web Console page is displayed.

At this point, you are logged into the system.



Note - The connection closes automatically if there is no activity for approximately 15 minutes.



5. Select Sun StorageTek Common Array Manager from the Storage section of the Sun Java Web Console page.


Installation Troubleshooting

You can verify the installation by bringing up the Sun StorageTek Common Array Manager browser, as discussed in Starting the Management Software of the next chapter.

In the browser, you can click the Version button to verify the release version information.

Reviewing the Installation Logs

You can also verify the success of the installation by reviewing the installation logs. Note that the installation logs are mainly intended for debugging by developers. By scrolling to the end of the installation log, you can verify the successful installation message or any error messages.

If an error occurs, review the requirements in Check the installation space requirements.. Also, review the Readme.txt file located in the installation directory (see Locating Files and Logs) for late-breaking information and attempt a reinstallation.

The installation logs are located:

/var/sadm/install/se6000/se6000_Host_SW.log

/var/opt/cam/

\Program Files\Common Files\Sun Microsystems\se6000

For Windows, verify that you made the firewall changes after you finished the installation as noted in Step 13.


Next Steps

You are now ready to log in to the browser interface, discover arrays, install the array firmware baseline, and set up arrays.