Skip Headers
StorageTek Tape Analytics Installation and Configuration Guide
Release 2.0.1
E41585-03
  Go To Table Of Contents
Contents
Go To Index
Index

Previous
Previous
 
Next
Next
 

4 Library Configuration Process

This chapter describes the process for configuring libraries to send proper data to STA. Before configuring the libraries, you may need to prepare service requests for Oracle Support. See "Prepare Service Requests for Oracle Support."


Note:

This chapter assumes you will use the recommended SNMP v3 protocol for communications between the library and STA server. For more information, see "SNMP Communication".

4.1 SNMP Configuration Worksheet

Before starting the library configuration process, you can fill out Table 4-1 to define the parameters you will use to configure SNMP on both the library and STA server.

Table 4-1 SNMP Configuration Parameters

Parameter Description Value

SNMP v2c community

SNMP v2c User Community string, commonly set to public. This string is required for the initial handshake between the library and STA server, even when using the SNMP v3 protocol.

Can only contain alphanumeric characters (a-z, A-Z, 0-9). Special characters are not allowed.


SNMP v3 user name

The STA server listens for traps sent by this user. It is also the v3 recipient name used when creating trap recipients. Must be the same on all libraries.


SNMP v3 user authorization password

Authorization password you assign to the SNMP v3 user.

Must be at least eight characters in length, and cannot contain commas, semicolons, or equal signs.


SNMP v3 user privacy password

Privacy password you assign to the SNMP v3 user.

Must be at least eight characters in length, and cannot contain commas, semicolons, or equal signs.



4.2 Library Configuration Script (Optional)

You can use the library configuration script to display library CLI commands. It will step you through the library configuration process, request data to be entered, and then display commands that can be copied and pasted into the library CLI. To execute the script, issue the following command within a terminal session on the STA server:

# sh /Oracle/StorageTek_Tape_Analytics/common/bin/STA-lib-config-steps.sh

Note:

Be sure to read and understand the library configuration steps in this chapter before executing the script.

For additional information about the script and to see example usage, issue the following command:

# sh /Oracle/StorageTek_Tape_Analytics/common/bin/STA-lib-config-steps.sh -? | more

4.3 Library Configuration Overview

You must complete all tasks listed in Table 4-2 for your library model, in the presented order.


Caution:

Before starting the library configuration process, review the information in the STA Requirements Guide.

4.4 Library Configuration Tasks

For SL500, SL3000, and SL8500 libraries, many tasks allow you to choose which interface to use — CLI or SL Console. For SL150 libraries, you exclusively use the browser-based user interface.

Task 1   Log In to the Library
With the CLI (all libraries except SL150)
  1. Establish an SSH connection to the library using the IP address or DNS alias.

  2. Log in to the CLI using the admin username and password.

With the SL Console (all libraries except SL150)
  1. Start the SL Console application.

  2. Click the About button to display the current SL Console version and verify that it meets the library firmware minimum requirements.

  3. Click Close to return to the Login screen.

  4. Log in using the admin user name, password, and library IP address or DNS alias.

    For SL3000 and SL8500 libraries with the Redundant Electronics feature, you can only log in to the active controller.

With the SL150 User Interface
  1. Browse to the hostname or IP address of the SL150 library.

  2. Log in with your user ID and password. The user ID must have the role of administrator.

Task 2   Verify the Library Firmware Version

Use this procedure to verify that the library firmware meets or exceeds the minimum requirements stated in the STA Requirements Guide. If it does not, contact Oracle Support to upgrade the firmware. For SL8500 libraries, Oracle Support must record the network connection settings before performing a firmware upgrade, as these settings may need to be re-entered or updated after the upgrade.

With the CLI (all libraries except SL150)Foot 1 

Execute the following command:

SL500> version print
Library Hardware Information
 Library Vendor: STK
...
 Firmware Version: xxxx (x.xx.xx)

Note:

If the screen displays SYNTAX ERROR!!, the library firmware is down-level. Contact Oracle Support to upgrade the firmware.

With the SL Console (All libraries except SL150)
  1. From the menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select Properties > Library Controller.

    The firmware version is displayed under the Code Version section.

With the SL150 User Interface

Select Firmware from the navigation menu on the left side of the interface.

The firmware version is displayed under the Library Firmware section. Alternately, you can click the About button in the lower-right corner of the screen to obtain the firmware version.

Task 3   Retrieve the Library IP Address

Use this procedure to retrieve and record the library IP address, which you will use to configure the connection with the library. For SL3000 or SL8500 libraries, choose the method that matches your configuration for Dual TCP/IP, Redundant Electronics, or neither feature. For more information, see "Dual TCP/IP and Redundant Electronics (SL3000 and SL8500 Only)".

SL500 IP Address
  1. From the SL Console menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select Properties > General.

    The library IP address is listed under the Library Interface TCP/IP section.

  4. Record the library IP address as the primary library IP address. (This address corresponds to the 1B port.)

SL3000 or SL8500 IP Addresses — Dual TCP/IP Support
  1. From the SL Console menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select Properties > General.

    The IP address information is displayed in the Host Interface TCP/IP 2B and Host Interface TCP/IP 2A sections.


    Note:

    If the library also includes the Redundant Electronics feature, the IP addresses displayed are for the active controller card only.

  4. Record the primary IP address (2B section) and secondary IP address (2A section).

SL3000 or SL8500 IP Addresses — Redundant Electronics Support
  1. From the SL Console menu, select Tools > System Detail.

  2. In the left panel, select the Redundant Electronics folder.

    If this folder is not listed, the Redundant Electronics feature is not available on the library.

  3. In the Device State field, verify that one library controller shows Duplex: software ready, switch possible (this is the active card) and the other shows Standby: software ready (this is the standby card).

    These statuses indicate that the controller cards are functioning normally. If you do not see these statuses, contact Oracle Support.

  4. Expand the Redundant Electronics folder, and then select the active controller card.

  5. Record the IP address of the 2B port.

  6. Repeat Step d and Step e for the alternate (standby) controller card.

SL3000 or SL8500 IP Addresses — No Dual TCP/IP nor Redundant Electronics
  1. From the SL Console menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select Properties > General.

    The IP address information is displayed in the Host Interface TCP/IP 2B section. There is no IP address information in the 2A section.

  4. Record the IP address as the primary library IP address.

SL150 IP Address

In the SL150 user interface, select Configuration from the navigation menu on the left side of the screen.

The library IP address is displayed in the Settings > Network > Network Port 1 Settings section. (The Network Port 2 Settings section is reserved for service use.)


Note:

The Configure IPxx field value must be Static. If it is not, click the Configure button, and then select Configure Network Settings to specify a static IP address.

Task 4   Verify the Drive Controller Card Version (SL3000 and SL8500 Only)

Use the SL ConsoleFoot 2  to verify that a high-memory drive controller (HBT) card is installed in the library. For more information, see the STA Requirements Guide. Contact Oracle Support if you do not have a high-memory HBT card.

  1. From the menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select Properties > Drive Controller.

    The screen displays details about the active drive controller (HBT) card.

  4. Verify that High Memory HBT indicates true.

  5. If you have an SL3000 (FRS 4.x) or an SL8500 (FRS 8.x) library with Redundant Electronics, expand the Redundant Electronics folder, and then select each HBT card (hbta, hbtb). Both should indicate True for High Memory HBT.


    Note:

    Both the active and standby HBT cards must be installed and communicating, and both must have high memory.

Task 5   Enable ADI on the Library (All Libraries Except SL150)

If your library contains LTO drives, use this procedure to ensure that the ADI drive interface is enabled on the library. For more information, see "Drive ADI Interface".

For SL3000 or SL8500 Libraries
  1. Use the following command to display the status of the ADI interface:

    drive adiEnable print
    
  2. If "Attributes Adi Status" is true, you can quit this task. If it is false, proceed to the next step.

  3. Use the following command to enable the ADI interface.

    drive adiEnable on
    
  4. Reboot the library to activate the change.

For SL500 Libraries
  1. Use the following command to display the status of the ADI interface:

    enableADI print
    
  2. If "enableADI set to" is on, you can quit this task. If it is set to off, proceed to the next step.

  3. Use the following command to enable the ADI interface:

    enableADI on
    
  4. Reboot the library to activate the change.

Task 6   Enable SNMP on the Library

Use this procedure to enable SNMP on the library public port.

With the CLI
  • For SL3000 and SL8500 libraries, enable SNMP on port 2B. If the library includes the Dual TCP/IP feature, this command also enables SNMP on port 2A.

    snmp enable port2b
    
  • For SL500 libraries, enable SNMP on port 1B.

    snmp enable port1B
    
With the SL Console (SL500 only)
  1. From the menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select SNMP > Port Control.

  4. Complete the Port Control section as follows:

    Port: Select Public (1B).

    Command: Select Enable.

  5. Click Apply.

With the SL150 User Interface
  1. Select SNMP from the navigation menu on the left side of the interface.

  2. If SNMP shows as disabled, select Enable SNMP.

  3. In the confirmation window, click OK.

Task 7   Ensure an SNMP v2c User

A v2c user is required for the initial handshake between the library and STA server. It is also required if you intend to use v2c for STA communication. For more information, see "SNMP Configuration". Before starting the procedure, note the following:

  • There must be only one v2c user on the library.

  • The community string can only contain alphanumeric characters (a-z, A-Z, 0-9). Special characters are not allowed.

  • An existing v2c user is commonly set to the public community, but may be defined in another community name.

  • You should not remove an existing v2c public user without consulting Oracle Service. In some cases, a v2c public user is required for Oracle Service Delivery Platform (SDP).

With the CLI (All libraries except SL150)
  1. Use the following command to determine whether a v2c user already exists:

    snmp listUsers
    
  2. If a v2c user is already defined, as in the following example, you can quit this task. If not, proceed to the next step.

    SL500> snmp listUsers
     ...
     Attributes Community public
     Index 1
     Version v2c
     Object Snmp snmp
     ...
    
  3. Use the following command to add the SNMP v2c user:

    snmp addUser version v2c community community_name
    

    Where community_name is public, or another name. For example:

    SL3000> snmp addUser version v2c community public
    
  4. List the SNMP users again to verify that the v2c user has been added correctly.

    snmp listUsers
    
With the SL Console (SL500 only)
  1. From the menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select SNMP > Add Users.

  4. If a v2c user already exists in the Users section, you can quit this task. If not, proceed to the next step.

  5. To add the SNMP v2c user, complete the Add Users tab as follows:

    Version: Select v2c.

    Community: Specify a community string (for example, public).

  6. Click Apply.

With the SL150 User Interface

By default, the SL150 ships without a v2c user defined. If you plan to use v2c for STA communications, create a v2c user as follows.

  1. Select SNMP from the navigation menu on the left side of the interface.

  2. Under the SNMP Users section (or tab), select Add SNMP User.

  3. In the Add SNMP User screen, complete the information as follows:

    Version: Select v2c.

    Community Name: Specify a community string (for example, public).

  4. Click OK.

Task 8   Create an SNMP v3 User

All SNMP traps and MIB (management information base) data are sent to the STA server through the v3 user. Make a note of the username and passwords you specify, as you will use this information later in the configuration process. Note the following:

  • The authorization method must be SHA (Secure Hash Algorithm), and the privacy method must be DES (Data Encryption Standard).

  • All libraries monitored by a single STA server must have the same v3 user name. You should create a new, unique user for this purpose.

  • Authorization and privacy passwords must be at least eight characters in length, and cannot contain commas, semicolons, or equal signs.

  • To avoid entry errors in the CLI, you can first type the command in a text file, and then copy and paste it into the CLI. For help with CLI commands, type help snmp.

With the CLI (All libraries except SL150)
  1. Use the following command to create a v3 user:

    snmp addUser version v3 name name auth SHA authPass auth_password priv DES privPass priv_password
    

    name: SNMP v3 user name

    auth_password and priv_password: Authorization password and privacy password.


    Note:

    For SL3000 and SL8500 libraries, enclose all variables in single quotes (Example 4-1).

    Example 4-1 Create SNMP v3 User on SL3000 or SL8500

    SL3000> snmp addUser version v3 name 'STAsnmp' auth SHA authPass 'authpwd1' priv DES privPass 'privpwd1'
    

    Example 4-2 Create SNMP v3 User on SL500

    SL500> snmp addUser version v3 name STAsnmp auth SHA authPass authpwd1 priv DES privPass privpwd1
    
  2. List the SNMP users to verify that the v3 user has been added correctly.

    snmp listUsers
    
With the SL Console (SL500 libraries only)
  1. From the menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select SNMP > Add Users.

  4. Complete the Add Users tab as follows:

    Version: Select v3.

    UserName: The name of the SNMP v3 user.

    Auth: Select SHA.

    AuthPass: Specify an authorization password.

    Priv: Select DES.

    PrivPass: Specify a privacy password.

  5. Click Apply.

With the SL150 User Interface
  1. Select SNMP from the navigation menu on the left side of the interface.

  2. Under the SNMP Users section (or tab), select Add SNMP User.

  3. For Version, select v3, and then complete the information as follows:

    User Name: The name of the SNMP v3 user.

    Authentication Protocol: Select SHA.

    Authentication Passphrase: Specify an authorization password.

    Privacy Protocol: Select DES.

    Privacy Passphrase: Specify a privacy password.

  4. Click OK.

Task 9   Retrieve the Library SNMP Engine ID (All Libraries Except SL150)

Use one of the following CLI commands to display the library's SNMP engine ID (for example, 0x81031f88804b7e542f49701753). Save the engine ID to a text file for use in later configuration tasks.

  • For SL3000 and SL8500 libraries:

    snmp engineId print
    
  • For SL500 libraries:

    snmp engineId
    
Task 10   Create an SNMP v3 Trap Recipient

Use this procedure to define the STA server as an authorized recipient of SNMP traps, and to define the traps that the library will send. Note the following:

  • Separate trap levels with commas.

  • To avoid duplicate records, do not define the STA server as a trap recipient in multiple instances. For example, do not create both a v3 and v2c trap recipient definition for the STA server.

  • Trap level 13 (Test Trap) and 14 (Health Trap) are new for STA 2.0.x. Trap level 4 may not be supported by older library firmware versions; however, it can always be specified when creating a trap recipient.

  • To avoid entry errors in the CLI, you can first type the command in a text file, and then copy and paste it into the CLI. For help with CLI commands, type help snmp.

With the CLI (All libraries except SL150)
  1. Use the following command to create a v3 SNMP trap recipient:

    snmp addTrapRecipient trapLevel 1,2,3,4,11,13,14,21,25,27,41,45,61,63,65,81,85,100 host STA_server_IP version v3 name recipient_name auth SHA authPass auth_password priv DES privPass priv_password engineId library_engineID
    

    STA_server_IP: IP address of the STA server.

    recipient_name: SNMP user name you created in Task 8.

    auth_password and priv_password: Authorization and privacy passwords you created in Task 8.

    library_engineID: Library engine ID you displayed in Task 9, including the 0x prefix.


    Note:

    For SL3000 and SL8500 libraries, enclose recipient_name, auth_password, and priv_password in single quotes (Example 4-3).

    Example 4-3 Create SNMP v3 Trap Recipient on SL3000 or SL8500

    SL3000> snmp addTrapRecipient trapLevel 1,2,3,4,11,13,14,21,25,27,41,45,61,63,65,81,85,100 host 192.0.2.20 version v3 name 'STAsnmp' auth SHA authPass 'authpwd1' priv DES privPass 'privpwd1' engineId 0x00abcdef000000000000000000
    

    Example 4-4 Create SNMP v3 Trap Recipient on SL500

    SL500> snmp addTrapRecipient trapLevel 1,2,3,4,11,13,14,21,25,27,41,45,61,63,65,81,85,100 host 192.0.2.20 version v3 name STAsnmp auth SHA authPass authpwd1 priv DES privPass privpwd1 engineId 0x00abcdef000000000000000000
    
  2. List the trap recipients, and verify the recipient has been added correctly.

    snmp listTrapRecipients
    
With the SL Console (SL500 libraries only)
  1. From the menu, select Tools > System Detail.

  2. In the left panel, select Library.

  3. In the right panel, select SNMP > Add Trap Recipients.

  4. Complete the Trap Recipients screen fields as follows:

    Host: The IP address of the STA server.

    TrapLevel: Comma-separated list of trap levels the library should send to STA: 1,2,3,4,11,13,14,21,25,27,41,45,61,63,65,81,85,100.

    Version: Select v3.

    TrapUserName: SNMP user name you created in Task 8.

    Auth: Select SHA.

    AuthPass: Authorization password you created in Task 8.

    Priv: Select DES.

    PrivPass: Privacy password you created in Task 8.

    EngineID: Library engine ID you displayed in Task 9. Do not enter the 0x prefix.

  5. Click Apply.

With the SL150 User Interface
  1. Select SNMP from the navigation menu on the left side of the interface.

  2. Under the SNMP Trap Recipients section (or tab), select Add Trap Recipient.

  3. Complete the fields as follows:

    Host Address: IP address of the STA server.

    Trap Level: Comma-separated list of trap levels the library should send to STA: 1,2,3,4,11,13,14,21,25,27,41,45,61,63,65,81,85,100.

    Version: Select v3.

    Trap User Name: SNMP user name you created in Task 8.

    Authentication Protocol: Select SHA.

    Authentication Passphrase: Authorization password you created in Task 8.

    Privacy Protocol: Select DES.

    Privacy Passphrase: Privacy password you created in Task 8.

    Engine ID: This field will auto-populate. Do not modify the value.

  4. Click OK.

Task 11   Set the SL500 Volume Label Format

Use the following CLI commands to ensure that volume serial numbers (volsers) are formatted correctly in SNMP data sent to the STA server. Before starting this procedure, see "Volume Label Formatting Requirements (SL500 and SL150 Only)" in the STA Requirements Guide.


Note:

Oracle recommends that you quiesce all activity to the library before changing these parameters. Tape applications and/or hosts may require configuration changes after changing these parameters.

  1. Display the current setting of the orientlabel flag.

    SL500> orientlabel print
    Host: (left8) Window left-justified with 6 character label
    Op Panel: (left8) Window left-justified with 8 character label
    
  2. ”Host” must be set to ”left6”. To do so, use the following command:

    SL500> orientlabel host left6
    New settings were accepted...Setting are now in effect.
    
  3. Display the setting again to verify that it was updated correctly.

    SL500> orientlabel print
    Host: (left6) Window left-justified with 6 character label
    Op Panel: (left8) Window left-justified with 8 character label
    
  4. Display the current setting of the STA config flag.

    SL500> staConfig print
    STA mode is disabled
    
  5. STA mode must be enabled. To enable the flag, use the following command:

    SL500> staConfig on
    
  6. Display the flag setting again to verify that it was updated correctly.

    SL500> staConfig print
    STA mode is enabled
    
Task 12   Set the SL150 Volume Label Format and Drive Element Addressing Mode

Use this procedure to ensure that volume serial numbers (volsers) are formatted correctly in SNMP data sent to the STA server, and to set the Drive Element Addressing ModeFoot 3  so that empty drive bays are included in the data sent to STA. Before starting this procedure, see "Volume Label Formatting Requirements (SL500 and SL150 Only)" in the STA Requirements Guide.


Note:

Oracle recommends that you quiesce all activity to the library before changing these parameters. Tape applications and/or hosts may require configuration changes after changing these parameters.

  1. Select Configuration from the navigation menu on the left side of the SL150 browser interface.

  2. Select the Configure button.

  3. In the Configuration Wizard window, select the Configure Library Settings check box, and then click Next.

  4. Set the following parameters accordingly:

    • Drive Element Addressing Mode: Address All Drive Slots (Recommended)

    • Library Volume Label Format: Trim last two characters (Default)


    Note:

    After changing the Drive Element Addressing Mode, you should wait at least 10 minutes before configuring SNMP in STA (see Chapter 5).

  5. Click Next.

  6. On the Summary of Configuration Changes screen, select the Accept all changes check box, and then click Apply.

  7. In the Apply Configuration Changes screen, select the Set the Library back Online after applying the changes check box, and then click OK.

  8. When you see All configuration changes have been applied successfully, click Close.

Task 13   Set the Drive Cleaning Warning (SL3000 and SL8500 Only)

Use this optional CLI procedure to check the current setting of the drive cleaning warning flag on the library and change it if necessary. The drive cleaning warning flag indicates whether a drive warning should be issued whenever a drive needs cleaning. This flag is set at the library level, so the same setting applies to all drives in a library.

  • When the flag is set to ”on”, each drive will show a warning health status whenever it needs cleaning. This will also cause the top-level health status of the library to be degraded in the STA monitor.

  • When the flag is set to ”off”, each drive's status will not be affected by the need for cleaning. Therefore, the library top-level status in STA will not be degraded.

If you have a large number of drives in the library, you may want to set this flag to ”off” so that the library top-level condition is not degraded whenever one of them needs cleaning.

  1. Use the following command to display the current setting of the drive cleaning warning flag:

    SL3000> cleaning driveWarning get
     ...
     Object Drive Cleaning Warning true
     ...
    
  2. If you want to set the flag to ”false” (off), use the following command:

    cleaning driveWarning set off
    
Task 14   Ensure the Correct Library Complex ID (SL8500 Only)

Use this procedure to ensure the correct library complex ID information for each SL8500 library. Before starting this procedure, see "Complex ID Requirements (SL8500 Only)" in the STA Requirements Guide.

  1. For each SL8500 library that will be monitored by STA, use the following command to display the complex ID currently assigned:

    SL8500> config complexId print
     ...
     Complex Id 3
     ...
    
  2. Verify that each standalone library and each library complex has a unique complex ID, and that all libraries in each library complex share the same complex ID.

    If you need to change the complex ID of a standalone library, continue this procedure.


    Caution:

    If you need to change the complex ID of a library in a library complex, contact Oracle Support. Do not continue with this procedure.

  3. Place the library offline, and then wait for all transactions to complete.

  4. Use the following command to change the complex ID of a standalone library, where complex_ID is a number, 1–127:

    config complexId set complex_ID
    

    Example 4-5 Change standalone SL8500 complex ID

    SL8500> config complexId set 5
     ...
     Complex Id 5
     Success true
     Done
     ...
     Note: TCP/IP stack reset may take a few seconds
     after command completion.
    

    Note:

    All TCP/IP connections are terminated when executing this command. You may have to log back in to the library.



Footnote Legend

Footnote 1: Not applicable to SL3000 libraries below FRS 4.x.
Footnote 2: For SL8500 FRS 8.x and SL3000 FRS 4.x, you can also use the CLI config print command to display HBT card information.
Footnote 3: Only applicable to SL150 firmware 2.xx and above.