Database Scanning Plug-In Notes


Contents

Plug-In Prerequisites

Installing the Plug-In Registration Wizard

Using the Plug-In Registration Wizard

Unregistering a Database

Updating Database Registration Information

Editing Scan Proxy Information

Uninstalling the Plug-In

 

Plug-In Prerequisites

Software

Install Capacity Reporter Agent

The Capacity Reporter 5.0.1 (or later) Windows NT/Windows 2000 Agent must be installed on the computer that you want to act as the Capacity Reporter proxy agent.

Install and configure database vendor PC client

Sybase 12 PC Client

NOTE: A typical Sybase 12 PC Client installation can require up to 30 MB of disk space. Consult the appropriate Sybase PC Client documentation for more information on disk space requirements.

  1. Install the database vendor PC client on the same computer on which you installed the Capacity Reporter Agent.

    From menu 1 choose Customized Install, and select the following components:

  2. Configure the Sybase 12 PC client by populating the database server definition file (SQL.INI). Get this information from the database administrator.
Oracle 8.1.5, 8.1.6, 8.1.7, or 9i PC Client

  1. Install the database vendor PC client on the same computer on which you installed the Capacity Reporter Agent.

    Select one of the four installation options: Administrator, Programmer, Application User, or Custom.

    1. If you select Administrator, Programmer, or Application User, no additional selections are needed.

    2. If you select Custom, you must choose the following subsets: "Net8 Client" and "Oracle Programmer Development Tools".

  2. Configure the PC client by populating the database server definition file (TNSNAMES.ORA). Get this information from the database administrator.
     
    Note:  If you use a directory service to resolve service names, instead of using TNSNAMES.ORA, configure the Oracle PC client according to Oracle documentation.

  3. If you install the Oracle PC client on the proxy machine, reboot the proxy machine before scanning. Failure to do so may cause database scans to hang.
Note:   When you upgrade an existing Oracle 8.1.6.0, or 8.1.7.0 PC client's ODBC driver to the 8.1.6.4 or 8.1.7.2 (or later) driver , the installation converts existing data source definitions for the "Oracle ODBC Driver" to the name of the newly installed driver (for example: "Oracle in OraHome81"). You must reregister your current databases in Sun StorEdge SRM, so that they are properly defined with the new ODBC driver.

Back to Contents

Create a database login account to be used for database scanning

Create an account that can be used by some or all databases on the server. Sun StorEdge SRM uses this account to scan the databases. Follow the instructions below for the database vendor whose software you use.

NOTE: A database administrator typically performs this task.

To create a database account for Sybase 12 databases:
  1. Create a database login account whose default database is Master:

    USE master
    go
    EXEC sp_addlogin 'SRMdbUser','password','master','us_english',"SRMdbUser"
    go

  2. Grant the login account access to each database that will be scanned:

    USE db1
    go
    EXEC sp_adduser 'SRMdbUser','SRMdbUser','public'
    go

    Repeat this step for each database that will be scanned.

  3. To add the login account to each database that you want to register for scanning, execute sp_adduser.

    Note: For your convenience, a sample SQL command file that performs these steps is located at:

    <SRM-install-directory>\PlugIns\DBScanner\AccountTemplates\Sybase\SybaseDefaultAccountTemplate.sql

To create a database account for Oracle 9i:

  1. Create the database account in a database with nonsystem tablespace as default tablespace and temporary tablespace as temp tablespace.

  2. Grant the database account select_catalog_role role and connect role privileges.

    Sample user creation commands:

    create user srmdbuser identified by password
    default tablespace tools
    temporary tablespace temp;
     
    grant select_catalog_role, connect to srmdbuser;

    Note: For your convenience, a sample SQL command file that performs these steps is located at:

    <SRM-install-directory>\PlugIns\DBScanner\AccountTemplates\Oracle\OracleDefaultAccountTemplate.sql

To create a database account for Oracle 8i (8.1.x) in Oracle 8.1 compatibility mode:

  1. Create the database account in a database with nonsystem tablespace as default tablespace and temporary tablespace as temp tablespace.

  2. Grant the database account select_catalog_role role and connect role privileges.

    Sample user creation commands:

    create user srmdbuser identified by password
    default tablespace tools
    temporary tablespace temp;
     
    grant select_catalog_role, connect to srmdbuser;

    Note: For your convenience, a sample SQL command file that performs these steps is located at:

    <SRM-install-directory>\PlugIns\DBScanner\AccountTemplates\Oracle\OracleDefaultAccountTemplate.sql

To create a database account for Oracle 8i (8.1.x) or Oracle 8.0 (8.0.x) in Oracle 8.0 compatibility mode:

  1. Sun recommends that you create the database account in the TOOLS tablespace, and that this database have a 5 MB quota permission. The TOOLS tablespace is the tablespace normally used for third-party applications.

  2. Grant the database account select_catalog_role role, connect role, and create table privileges.

    Sample user creation commands:

    create user srmdbuser identified by password
    default tablespace tools
    temporary tablespace temp
    quota 5M on tools;

    grant select_catalog_role, connect, create table to srmdbuser;

    Note:

To create a database account for Oracle 7.3.4:

  1. Sun recommends that you create the database account in the TOOLS tablespace, and that this database have a 5 MB quota permission. The TOOLS tablespace is the tablespace normally used for third-party applications.

  2. Grant the database account connect role, create table privilege, and select access to several SYS views that Sun StorEdge SRM scans, including:

    Sample user creation commands:

    create user srmdbuser identified by password
    default tablespace tools
    temporary tablespace temp
    quota 5M on tools;

    grant connect, create table to srmdbuser;

    grant select on v_$mystat to srmdbuser;
    grant select on v_$process to srmdbuser;
    grant select on v_$session to srmdbuser;
    grant select on v_$version to srmdbuser;
    grant select on v_$database to srmdbuser;
    grant select on v_$sga to srmdbuser;
    grant select on v_$rollstat to srmdbuser;
    grant select on v_$rollname to srmdbuser;
    grant select on v_$parameter to srmdbuser;
    grant select on v_$logfile to srmdbuser;
    grant select on v_$log to srmdbuser;
    grant select on dba_data_files to srmdbuser;
    grant select on dba_rollback_segs to srmdbuser;
    grant select on dba_free_space to srmdbuser;
    grant select on dba_tablespaces to srmdbuser;

    Note:

Back to Contents

Ensure adequate scanner account workspace on the database server

Back to Contents

Capacity Reporter proxy server reminder (Sybase only)

Do not set up two different Capacity Reporter proxy servers to scan databases on the same database server instance. This may cause a temporary database deadlock situation, which could result in Sybase terminating the connection, thereby causing a scan failure.

Also, check the SQL.INI files on the Capacity Reporter agent proxy computers for aliases or typing mistakes, which are causing scanning of databases in the same database server instance from different proxy machines. You can also use the Capacity Reporter Modify Scan Settings for Database page to verify that the same proxy machine is being used for all databases in a particular database server instance.

Back to Contents

Installing the Plug-In Registration Wizard

Install the Capacity Reporter for Database Scanning Plug-In on the computer that you want to act as the Capacity Reporter proxy agent. This should be the same computer on which you installed the Capacity Reporter Agent that scans the databases.

On the software's CD, double-click on \PlugIns\Database\databasescannerplugin.exe to start the installation procedure.

  1. Enter the password and click Next. (The password is documented in the beta test cover letter you received.)

  2. Accept the default destination location, or browse to choose another location. Click Next.

  3. You are now ready to install the plug-in. Click Next to begin installation.

  4. If the installation is successful, the Installation Complete window is displayed. From this window, you can select the checkbox to open the Sun StorEdge SRM for Database Servers Registration Wizard and begin registering databases.

Back to Contents

Using the Plug-In Registration Wizard

The Plug-In Registration Wizard is self-explanatory.  The following notes merely clarify the information you enter or explain the task being performed.  

  1. Start the Plug-In Registration Wizard. From the Start menu, select Programs -> Storage Resource Manager Plug-In Registration -> Register Database for Scanning.

  2. Registration Function screen
    1. Click Register... to register or update managed database information

  3. Required Registration Information screen (1)
    1. The Server Name is not editable on this screen. You can edit this field by clicking Back.

    2. Enter the name of the Capacity Reporter Agent that you want to perform the scan and relay scan information to the Capacity Reporter Server.

      Reminder for Sybase database servers: Do not set up two different Capacity Reporter proxy servers to scan databases on the same database server instance. This may cause a temporary database deadlock situation, which could result in Sybase terminating the connection, thereby causing a scan failure.

    3. Load... -- Click to load a pre-existing registration settings file.

    4. Save As... -- Lets you save this information as an .SVR file, which you can use later as a pre-existing registration file.

    5. Optional Information -- Takes you to the Optional Registration Information screen, where you can enter additional information and hyperlinks that will display on reports.

  4. Required Registration Information screen (2)
    1. Select the database type from dropdown list, or type to overwrite.

      For Oracle databases only:  To select more than one database at a time, select the Select All check box.

    2. The list of database server names is read from the server definition file for the database. If the dropdown list is empty, possible causes include:

      • You did not configure the Sybase PC client, or the SQL.ini file contains no server definitions.

      • You did not configure the Oracle PC client, or the TNSNAMES.ORA file contains no server definitions.

      • You are using a directory service to resolve Oracle service names. In this case, you must type in the server name yourself.

    3. The Database Server Host Computer field is initialized with the TCP/IP host name or address of the server selected in the previous step. This value is used to cross-link between database reports and other Sun Capacity Reporter reports. To properly cross-link between the reports, this value must match the Capacity Reporter managed computer name (this assumes that a Capacity Reporter Agent is installed on the database server host computer). Edit the Database Server Host Computer Name, if it does not exactly match the Capacity Reporter managed computer name.

      Note:   If you selected the Select All check box, this field is disabled.

    4. Enter the database user account to use when scanning the database. This account was set up on the database server, typically by the database administrator.

      If you have not yet created the database login account, see Create a database login account to be used for database scanning.

    5. Enter the password for the database user account.

    When you click Next:

  5. Required Registration Information screen (3)

    For Sybase databases, a list of databases is displayed on this screen.

    For Oracle databases, a list of database servers is displayed on this screen.

    1. Select the databases to register. You can select multiple databases by click-and-drag or by holding down the Shift key. Click Add or Remove to modify the list of selected databases to be registered.

  6. Required Registration Information screen (4)

    This step registers the databases with the Capacity Reporter server:

  7. Registration Command Output

    A registration status box is displayed, confirming whether or not the databases were registered successfully. Registration is successful only when both the Validation and the Registration Status columns display OK.

    The Validation column indicates Capacity Reporter's success or failure while attempting to connect to the datbase server using the account and password specified. Capacity Reporter also checks that the correct privileges are set to allow scanning.

    The Registration Status column indicates the Registration Wizard's success or failure when actually registering the database with the Capacity Reporter Server.

Back to Contents

Unregistering a Database

You can unregister only one database at a time.

  1. Start the Capacity Reporter for Database Registration Wizard, and select Unregister....

  2. Enter the Capacity Reporter display name of the database you want to unregister. If you cannot remember the display name, use Capacity Reporter to obtain a list of managed databases and their Capacity Reporter display names.

  3. Click Finish to complete the process. A registration status box is displayed, confirming whether or not the database was unregistered successfully.

Back to Contents

Updating Database Registration

You can update database registration information using Capacity Reporter or using the Capacity Reporter for Database Registration Wizard. Performing this task through Capacity Reporter is more restrictive, because you cannot change all the information.

NOTE: Changes to database registration information do not appear until after the database is scanned successfully.

Updating Database Registration using the Capacity Reporter for Database Registration Wizard

When you update the registration information for a database, you are, in effect, registering a new database. You cannot edit existing information; you must reenter it as though you were registering a new database:

  1. Start the Sun StorEdge SRM for Database Registration Wizard, and select Register....

  2. Follow the instructions under Using the Plug-In Registration Wizard . To minimize retyping, you can launch Capacity Reporter and view a Capacity Reporter Managed Database Report, so that you can cut-and-paste the database information (which will be lost when you reregister the database) from the browser window into the Registration Wizard window.

  3. Click Finish to complete the process. A registration status box is displayed, confirming whether or not the database was unregistered successfully.

Updating Database Registration using Capacity Reporter

You can edit only the following information when you update database registration information using Sun Capacity Reporter:

To update database registration information using Capacity Reporter:

  1. Launch Capacity Reporter in a browser.

  2. Click Options in the SRM banner frame. The Options main page is displayed.

  3. Click Scans. The Select Scan page is displayed.

  4. From the left-hand navigation frame, click Select Proxy. The Select Proxy page is displayed.

  5. In the Select Proxy page, click the Database Modify button. The Modify Scan Settings for Database page is displayed.

  6. Select the Capacity Reporter display name of the database whose information you want to edit. The rest of the fields on the screen display the current information for the selected database.

  7. You can change the Capacity Reporter Agent that runs scans for this database, although Sun recommends that you do not do so, because:

  8. Enter a new database server name, if necessary.

  9. Enter a new database login account, if necessary.

  10. Enter a new database login account password, if necessary.

  11. Enter a new Sun StorEdge SRM managed computer name, if necessary.

  12. Click Submit.

Back to Contents

Editing Scan Proxy Information

Using Capacity Reporter, you can change the Capacity Reporter Agent computer used to scan a registered database.

Follow the instructions under Updating Database Registration using Sun StorEdge SRM.

Back to Contents

Uninstalling the Plug-In

If you want to remove the plug-in from a computer, use the Add/Remove Programs applet in Windows Control Panel to do so. You must do this on the computer where you installed the plug-in.

To uninstall the plug-in:

  1. Click Start, and then click Settings -> Control Panel.

  2. Double-click Add/Remove Programs. The Add/Remove Programs Properties dialog box is displayed.

  3. Select Sun StorEdge SRM Plug-In for Database Scanning from the list, and click Add/Remove. The Uninstall Wizard launches.

  4. Click Next, and then click Finish. The plug-in files are removed from the computer.

Note: If you uninstall the Capacity Reporter 5.0.1 Agent from a computer, it automatically removes all plug-ins installed on that computer.

Back to Contents