C H A P T E R B

Reference Pages

This appendix provides reference topics for each page in the Sun StorageTek Backup Manager user interface. It contains the following sections:

Tape Library page

Backup page

Admin Login page

Admin page

Tape Library page

From this page, you can review a list of all the global tape libraries managed by Sun StorageTek Backup Manager.

The following table describes the buttons and fields on the Tape Library Status page.

Field	Indicates
Library ID	ID number for the library. For example, StorageTek-SL500-52200000065
Library Type	The supported library model. See the Release Notes for the latest listing of supported libraries.
Library Status	There are three possible library states: Online--tape library is active Offline--tape library is not currently active Unknown--the status is not known at this time
Drive Status (# Up Drives / Total Drives)	Provides status of the tape library drives and the total number of drives in the library. There are four possible drive status states: Online --all drives in the library are up. For example, Online 5/5. Degraded--one or more drives in the library are down. For example, Degraded 2/5 means two of the five drives are down. Offline--all drives in the library are down. For example, Offline 5/5. Unknown--the status is not known at this time
CAP Status (# Up Drives / Total CAPs)	Provides status of the Cartridge Access Ports (CAPs) and the total number of CAPs in the library. There are four possible CAP states: Online--all ports in the library are up. For example, Online 5/5. Degraded--one or more ports in the library are down. For example, Degraded 2/5. Offline--all ports in the library are down. For example, Offline 5/5. Unknown--the status is not known at this time

Displaying Tape Library Details

1. Click the Library ID link for the tape library you want to learn more about.

The Tape Library Details page displays. The Status tab displays by default.

2. Click the appropriate tab to display details about the selected tape library.

Click this tab...	To display this...
Status tab	Status for each drive in the selected library
Statistics tab	Statistics over the course of one week for the selected library
Configuration tab	Utilization and configuration information for the selected library

3. To review details of another tape library, close the window and repeat steps 1 and 2.

Tape Library Details page

From this page, you can review status, statistics, and configuration information for each drive in the selected tape library.

To review details about a specific tape library, click the appropriate tab.

Click this tab...	To display this...
Status tab	Status for each drive in the selected library
Statistics tab	Statistics over the course of one week for the selected library
Configuration tab	Utilization and configuration information for the selected library

Tape Library Details: Status page

From this page, you can review individual drive status for each drive in the selected library.

The following table describes the buttons and fields on the Tape Library Details: Status page.

Field	Indicates
Global Status
Library Status	There are three possible library states: Online--tape library is active Offline--tape library is not currently active Unknown--the status is not known at this time
CAP Status (# Up Drives / Total CAPs)	Provides status of the Cartridge Access Ports (CAPs) and the total number of CAPs in the library. There are four possible CAP states: Online--all ports in the library are up. For example, Online 5/5. Degraded--one or more ports in the library are down. For example, Degraded 2/5. Offline--all ports in the library are down. For example, Offline 5/5. Unknown--the status is not known at this time
Drive Status
Drive ID	Device number. For example, "1" indicates one row per interface.
Model	Drive model number for the library extracted from the vendor code. For example, HP-LTO-2.
Vendor	Name of the drive vendor. For example, HP.
Serial #	Drive serial number. For example, HUPFK00C78.
F/W Rev.	Drive firmware revision number. This is vendor-specific and not always available. Note: This field is not populated for the ACSLS.
Status	Individual drive status (vendor-specific). For more information, refer to the vendor documentation.

Tape Library Details: Statistics page

From this page, you can review bar charts for library operations over a predefined 1-week time frame.

Note - The graphs are empty if the device is monitored by the ACSLS agent.

The following chart types are available:

Chart Type	Indicates
Library Activity	There are three types of statistics collected: Resets--Initialization of a library Moves--Successful tape put/get to and from a standard slot Empty Reads--Attempt to read tape was unsuccessful
Mounts and Dismounts	There are two types of statistics collected: Mounts--Loading a tape into a drive Dismounts--Unloading a tape from a drive
Label Reads	There are three types of statistics collected: Retries Failures Reads
Target Reads	There are three types of statistics collected: Retries Failures Reads
Media Retrieval Activity	There are three types of statistics collected: Retries Failures Retrieval--removal of a tape from any slot
Media Insertion Activity	There are three types of statistics collected: Retries Failures Insertions--insertion of a tape from any slot

Tape Library Details: Configuration page

From this page, you can review utilization and configuration information for the selected library.

The Library Allocation pie chart displays the number of active cells (or slots) and free cells.

Active cells contain media such as a tape.

Free cells do not contain media and are not being used.

The key for the Library Allocation chart provides library and drive configuration information.

The following table describes fields on the Tape Library Details: Configuration page.

Field	Indicates
Drive ID	Drive identification number within the library. For example, "1" indicates one row per interface.
Model	Drive model number for the library extracted from the vendor code. For example, HP-LTO-2.
Vendor	Name of the drive vendor. For example, HP.
Serial #	Drive serial number. For example, HUPFK00C78.
F/W Rev.	Drive firmware revision number. This is vendor-specific and not always available. Note: This field is not populated for the ACSLS.
WW Port Name	World Wide Port Number (if available). For example, 50060B0002E6D2C The port name is only valid for Fibre connection. Note: This field is not populated for the ACSLS.
Interface Address	Interface Address as reported by the device. Note: This field is not populated for the ACSLS.
Interface Type	Interface type of the device: Fibre or SCSI. Note: This field is not populated for the ACSLS.

Backup page

From this page, you can review job information for each backup master server that Sun StorageTek Backup Manager supports.

You can specify the start date for the Backup Jobs and Error information. See Selecting the Start Date and Time for Backup Reports.

The following table describes the fields on the Backup Jobs Status page.

Field	Indicates
Master Server	Backup master server
Backup Product	The supported backup products are: NBU--Veritas NetBackup TSM--IBM Tivoli Storage Manager (TSM) LEG--EMC NetWorker (also known as Legato NetWorker)
Successful Jobs	Jobs reported as successful by the backup agent.
Failed Jobs	Jobs reported as failed by the backup agent.
Partial Jobs	(Only applies to NetBackup) Jobs reported as partially finished by the NetBackup agent. (Status code is 1.)
Total Jobs	Total number of jobs reported by the backup agent.

Displaying Backup Jobs Details

After you review the job information for the all master servers managed by Sun StorageTek Backup Manager, you can review additional details about the jobs on a specific master server.

1. Click the Master Server link.

2. Click the appropriate tab to display details about the backup jobs.

To review job information for the selected master server, click the Jobs tab.

To review error distribution for the selected master server, click the Errors tab.

3. To review details of another master server, close the window and repeat steps 1 and 2.

Backup Job Details page

From this page, you can review Backup details, using the following tabs:

Jobs tab -- takes you to the Backup Job Details: Jobs page where you can review a job summary for the master server's backup clients.

Errors tab -- takes you to the Backup Job Details: Errors page where you can review the distribution of errors for a specific master server.

Backup Job Details: Jobs page

From this page, you can review job information for each backup master server and client.

You can specify the start date for the Backup Jobs and Error information. See Selecting the Start Date and Time for Backup Reports.

The following table describes the buttons and fields on the Jobs page.

Field	Indicates
Jobs Starting from:	Select the date and time of the reports you want to display and click Refresh.
Successful Jobs	Jobs reported as successful by the backup agent.
Failed Jobs	Jobs reported as failed by the backup agent.
Partial Jobs	(Only applies to NetBackup) Jobs reported as partially finished by the NetBackup agent. (Status code is 1.)
Total Jobs	Total number of jobs reported by the backup agent.
Client Job Summary
Client	Name of the backup client. Click on a client name to go to the Client Jobs Details page.
Successful Jobs	Jobs reported as successful by the backup agent.
Failed Jobs	Jobs reported as failed by the backup agent.
Partial Jobs	(Only applies to NetBackup) Jobs reported as partially finished by the NetBackup backup agent. (Status code is 1.)
Total Jobs	Total number of jobs reported by the backup agent.

Displaying Backup Client Jobs Details

After you review the summary job information for the master server, you can review additional details about the jobs on a specific Backup client.

1. Click the Client link.

2. To review details of another backup client, close the window and click another Client link.

Client Jobs Details page

From this page, you can review job-specific information for each job on the selected backup client. You can change the sort order by clicking the arrows in column heading.

You can specify the start date for the Backup Jobs and Error information. See Selecting the Start Date and Time for Backup Reports.

The following table describes the buttons and fields on the Client Jobs Details page.

Field	Indicates
Job ID	ID for each job supplied by the vendor. For example, 27660.
Job Type	The job type: Backup.
Status	The status of the backup job. Success, failed, or partial (reported for NetBackup only).
Status Code	Vendor-supplied status code for jobs that are started, for example: 219. Refer to the vendor documentation for more information.
Schedule	Backup schedule defined in the vendor's backup software by the Backup Administrator.
Start Date	Job start date.
End Date	Job end date.
Duration	Duration of the job, reported in seconds.
File System	The file system or directory where information is being backed up for this backup job.
MB	Number of megabytes transferred by this job.
MB/Sec	Transfer speed or throughput of the backup job.

Backup Job Details: Errors page

From this page, you can review the distribution of errors for the selected master server.

The Error Distribution pie chart displays the number of occurrences for each type of error.

You can specify the start date for the Backup Jobs and Error information. See Selecting the Start Date and Time for Backup Reports.

The following table describes the fields on the Backup Job Details: Errors page.

Field	Indicates
Jobs Starting from:	Select the date and time of the errors you want to view and click Refresh.
Error Code	Error codes reported by the application. You can use this information to troubleshoot the types of problems you are experiencing on a given backup master server. The Sun StorageTek Backup Manager application standardizes the Job Status numerical values for the following states: success, failure, and partial. 0 = Success 1 = Partial > 1 = Failure (general error message) Each backup product provides specific error information. Legato 9100 = Failed 9200 = Never Started NBU and TSM Sun StorageTek Backup Manager reports the status code and error message exactly as it is supplied by the backup product. For more information, see the vendor documentation.
# of Occurrences	Number of times the error occurs.

Field

Indicates

Jobs Starting from:

Select the date and time of the errors you want to view and click Refresh.

Error Code

Error codes reported by the application. You can use this information to troubleshoot the types of problems you are experiencing on a given backup master server.

The Sun StorageTek Backup Manager application standardizes the Job Status numerical values for the following states: success, failure, and partial.

0 = Success
1 = Partial
> 1 = Failure (general error message)

Each backup product provides specific error information.

Legato
9100 = Failed
9200 = Never Started
NBU and TSM
Sun StorageTek Backup Manager reports the status code and error message exactly as it is supplied by the backup product. For more information, see the vendor documentation.

# of Occurrences

Number of times the error occurs.

Admin Login page

This page enables you to provide an administrator password and log in securely to the Admin tab.

The default password is storage.

Admin page

Once you provide your password and login, the Data Acquisition page displays by default.

Note - The Admin pages are password protected. You must log in to use these pages.

The tasks the backup administrator can perform include:

Configuring Agents

Configuring the Backup Cycle

Changing the Administrator Password

Refresh report data

Admin Tasks: Configure Agents page

From this page, you can configure agent settings.

There are two types of agents: Infrastructure agents and Data Acquisition agents.

There are five data acquisition agents:

Sun ACSLS Library Agent

Sun NetBackup Agent

Sun Legato Agent

Sun STK Library Agent

Sun TSM Agent

The following table describes the buttons and fields on the Admin Tasks: Configure Agents page.

Field	Indicates
Name	Name of the agent.
Location	IP address for the agent. For example, 10.8.205.52.
Port	Physical port the Sun StorageTek Backup Manager agent is listening on. The range for ports is in the 17000.
Status	The status of the agent. There are three states: Up--The agent is active and running. Unknown--The application is having difficulty connecting to the agent, it may be down or restarting. Down--The agent is not active and not running. At this time the application cannot contact the agent. If Sun StorageTek Backup Manager is in the process of restarting the agent infrastructure, it will appear as though it is down.
Configuration Status	The configuration status of the agent. There are three states: Configured--The agent is configured. Not configured--The agent is not yet configured. In process--The agent is in the process of being configured You can review agent configuration details. See Removing a Backup Master Server or Tape Library.

Agent Configuration page

From this page you can review and configure the data acquisition agents.

You must configure the agent before you can begin using the reporting and monitoring functions of the Sun StorageTek Backup Manager application.

For each agent there are standard buttons and fields you can interact with on the page. You'll notice specific device-level settings, global settings for all servers or libraries, and advanced settings.

An asterisk (*) indicates a required field. The pound sign (#) indicates an advanced field.

Note - The advanced settings are reserved for Sun support personnel who are troubleshooting problems.

The following table describes the buttons on the Agent Configuration page.

Button	Action
Show Advanced Settings	Displays the advanced settings for the agent. You can toggle between showing and hiding this information.
Save	Saves the current values to the database.
Reset	Reverts any changes you made back to the previously saved configuration values.
Close	Exits the page without saving the changes to the database.

The following tables describe the fields on the Agent Configuration page.

Advanced Field Descriptions (Common to All Agents)

ACSLS Agent Field Descriptions

STK Agent Field Descriptions

Legato NetWorker Agent Field Descriptions

NetBackup Agent Field Descriptions

TSM Agent Field Descriptions

TABLE 4-3 Advanced Field Descriptions (Common to All Agents)
Field	Optional	Advanced	Description	Default Value
Log Severity	N	Y	Lowest severity level for error messages that will be logged to the message log.	Info
Maximum Size of Log	N	Y	In Megabytes, maximize size for log file.	12
Size of Trimmed Log	N	Y	In Megabytes, size of log file after it is trimmed.	8
Enable Local Manager Registration	N	Y	Select True to enable; False to disable.	true
Local Manager Host	N	Y	Host name or IP address for local manager.	127.0.0.1
Local Manager Port	N	Y	Port for local manager.	17146
Masquerade As IP	Y	Y	IP address to use on a machine with multiple IP addresses.

TABLE 4-4 ACSLS Agent Field Descriptions
Field	Optional	Advanced	Description	Default Value
Cache Refresh Interval For Configuration Data	N	Y	In minutes, how often to refresh the agent's configuration data.	240
Cache Refresh Interval For Status Data	N	Y	In minutes, how often to refresh the agent's status data.	30
Statistics and Events Collection Interval	N	Y	In seconds, how often to refresh the agents statistics and event data.	1800
Statistics Retention Period	N	Y	In seconds, how long a single statistical reading should be kept by the agent.	21600
ACSLS Connection	N	N	Indicate whether you want to configure an ACSLS server.	ACSLS Server
ACSLS Server	N	N	Host name or IP address of the ACSLS server.
ACSAPI Packet Version	N	Y	Version of packet.	4
ACSLS Response Timeout	N	Y	In seconds, allowable time for the completion of an ACSAPI request.	120
SSI Executable Path	N	Y	Fully qualified path for the SSI executable.	/opt/sbm/agents/acslsAgent/bin/ssi
SSI Process Timeout	N	Y	In seconds, allowable time for the SSI helper process to start.	60
Agent Port	N	Y	TCP port the agent listens on.	17157

TABLE 4-5 STK Agent Field Descriptions
Field	Optional	Advanced	Description	Default Value
Cache Refresh Interval For Configuration Data	N	Y	In minutes, how often to refresh the agent's configuration data.	240
Cache Refresh Interval For Status Data	N	Y	In minutes, how often to refresh the agent's status data.	30
Statistics and Events Collection Interval	N	Y	In seconds, how often to refresh the agents statistics and event data.	1800
Statistics Retention Period	N	Y	In seconds, how long a single statistical reading should be kept by the agent.	21600
Report CAP statistics	N	Y	Select True to enable; False to disable.
Ignore Out-Of-Range CAP Statistics	N	Y	Select True to enable; False to disable.
Tape Library Address	N	N	Host name or IP address of the tape library
SNMP Port	N	N	SNMP port number of the tape library.	161
SNMP Community String	N	N	SNMP community string of the tape library	public
Agent Port	N	Y	TCP port the agent listens on.	17155

TABLE 4-6 Legato NetWorker Agent Field Descriptions
Field	Optional	Advanced	Description	Default Value
Cache Refresh Interval	N	Y	In minutes, how often to refresh the agent's data.	240
Command Execution Timeout	N	Y	In seconds, how long an agent will wait for the successful execution of a CLI command and the retrieval of the resulting data.	600
Agent Port	N	Y	TCP port the agent listens on.	17149
Remote Connection	N	N	Type of connection, local or remote, used to connect to this device.	True
Remote Host	N	N	Host name or IP address of the remote machine.
Remote Operating System	N	N	Operating system installed on the remote machine e.g. unix, win.	unix
Remote Shell Command Path On Sun StorageTek Backup Manager Server	N	N	Fully qualified path to the remote shell command on Sun StorageTek Backup Manager server used to connect to the remote machine.	/usr/bin/ssh
Remote User Name	Y	N	User name to be used when logging onto the remote machine.
Remote User Password	Y	Y	User password to use when logging onto the remote machine. Depending on the connection setup, this value maybe optional.
Remote Login Port	Y	Y	Port number to use when logging onto the remote machine. If no value is supplied, the standard port is used.
Networkers Messages Log File Name	N	N	Name of NetWorker's messages log file including the fully qualified path location.
Networker's CLI Executable Path	N	N	Fully qualified path to NetWorker's CLI commands.	/usr/sbin
Look Back Search Time Interval	Y	Y	In hours, the look back period used when searching the messages log file	24
Stopped Collection Table Groups	Y	Y	Comma separated list of table group(s) indicating that data collection is stopped indefinitely for all tables in the specified group(s). Possible groups are: jobs, media, schedule, tsmoptional.	tsmoptional, media, schedule
Suspended Collection	Y	Y	Select True to enable; False to disable.
Suspended Collection Table Groups	N	Y	Comma separated list of table group(s) indicating that data collection is stopped indefinitely for all tables in the specified group(s). Possible groups are: jobs, media, schedule, tsmoptional.	ALL
Suspension Start Time	N	Y	Start time of the non-collection window using a 24-hour format hh:mm:ss.	22:00:00
Suspension End Time	N	Y	End time of the non-collection window using a 24-hour format hh:mm:ss.	5:00:00

TABLE 4-7 NetBackup Agent Field Descriptions
Field	Optional	Advanced	Description	Default Value
Cache Refresh Interval	N	Y	In minutes, how often to refresh the agent's data.	240
Command Execution Timeout	N	Y	In seconds, how long an agent will wait for the successful execution of a CLI command and the retrieval of the resulting data.	600
Agent Port	N	Y	TCP port the agent listens on.	17133
Remote Connection	N	N	Type of connection, local or remote, used to connect to this device.	True
Remote Host	N	N	Host name or IP address of the remote machine.
Remote Operating System	N	N	Operating system installed on the remote machine e.g. unix, win.	unix
Remote Shell Command Path On Sun StorageTek Backup Manager Server	N	N	Fully qualified path to the remote shell command on Sun StorageTek Backup Manager server used to connect to a remote machine.	/usr/bin/ssh
Remote User Name	Y	N	User name to be used when logging onto the remote machine.
Remote User Password	Y	Y	User password when logging onto the remote machine. This parameter maybe optional depending on connection setup.
Remote Login Port	Y	Y	Port number to be use when logging onto the remote machine.
NetBackup Command Path	N	N	Fully qualified path to NetBackup's CLI commands.	/usr/openv/NetBackup
Volume Manager Command Path	N	N	Fully qualified path to NetBackup's Volume Manager.	/usr/openv/volmgr
Report Activity Period	N	N	Number of hours of NetBackup activity to report on.	72
Stopped Collection Table Groups	Y	Y	Comma separated list of table group(s) indicating that data collection is stopped indefinitely for all tables in the specified group(s). Possible groups are: jobs, media, schedule, tsmoptional.	tsmoptional, media, schedule
Suspended Collection Period	Y	Y	Select True to enable; False to disable.
Suspended Collection Table Groups	N	Y	Comma separated list of table group(s) indicating that data collection is stopped indefinitely for all tables in the specified group(s). Possible groups are: jobs, media, schedule, tsmoptional.	ALL
Suspension Start Time	N	Y	Start time of the non-collection window using a 24-hour format hh:mm:ss.	22:00:00
Suspension End Time	N	Y	End time of the non-collection window using a 24-hour format hh:mm:ss	5:00:00
Device Date Format	Y	Y	Date format used on the device. This field uses the same formatting sequences as the UNIX `date` command. For example, "%a %b %d %T %Y" is a valid date format string.

TABLE 4-8 TSM Agent Field Descriptions
Field	Optional	Advanced	Description	Default Value
Serialize Cache Updates	N	Y	Select True to enable; False to disable.
Cache Refresh Interval	N	Y	In minutes, how often to refresh the agent's data.	240
Command Execution Timeout	N	Y	In seconds, how long an agent will wait for the successful execution of a CLI command and the retrieval of the resulting data.	600
Agent Port	N	Y	TCP port the agent listens on.	17156
TSM ODBC DSN	N	N	ODBC data source name.
TSM Server Name Prefix	Y	N	Prefix to be added to the TSM server name to guarantee server name uniqueness.
TSM Server User Name	N	N	Name of the TSM user account when logging onto the TSM server.
TSM Server User Password	N	N	TSM user password when logging onto the TSM server.
TSM Server Look Back Period	N	N	In hours, the look back period when performing historical queries on the TSM server.	24
Stopped Collection Table Groups	Y	Y	Comma separated list of table group(s) indicating that data collection is stopped indefinitely for all tables in the specified group(s). Possible groups are: jobs, media, schedule, tsmoptional.	tsmoptional, media, schedule
Suspended Collection	Y	Y	Select True to enable; False to disable.
Suspended Collection Table Groups	N	Y	Comma separated list of table group(s) indicating that data collection is stopped indefinitely for all tables in the specified group(s). Possible groups are: jobs, media, schedule, tsmoptional.	ALL
Suspension Start Time	N	Y	Start time of the non-collection window using a 24-hour format hh:mm:ss.	22:00:00
Suspension End Time	N	Y	End time of the non-collection window using a 24-hour format hh:mm:ss	5:00:00

Agent Events Report page

From this page, you can review a list of events for the last 24 hours.

Note - The Agent event reports are used by Sun support personnel for troubleshooting purposes.

The following table describes the fields on the Agents Events Report page.

Field	Indicates
Agent Name	Name of the agent you are viewing events for.
Event Time	Date and time the event occurred.
Status Code	Numeric code for the event: 0 = unknown 1 = critical 2 = error 3 = warning 4 = informational 5 = debug
Event Description	Describes the event.

Refresh Report Data page

Because the system collects data automatically, you will use this tool only for special cases. For example, refresh report data during initial installation or any time you change the configuration.

When you need to refresh report data, click the button only once and wait for new report data to be displayed. Clicking the button multiple times affects system performance.

Admin Tasks: Configure Backup Cycle page

This page displays the currently configured time of day when the backup report starts. The default time is midnight.

You can modify the backup cycle start time. Sun StorageTek Backup Manager uses the backup time you specify as the default time frame for backup reports.

Admin Tasks: Change Password page

This page enables you to change the current Backup Administrator password.

The default password is storage.

You must enter text in these fields correctly. If the New Password and Confirm New Password fields do not match, a message displays when you click the Change button and you must start again.

When you correctly enter text in all fields and click the Change button, a message displays confirming the change.