This chapter explains how to install Oracle Secure Backup on hosts that run the Windows operating system.
This chapter contains these sections:
Perform these preliminary steps before you begin installation of Oracle Secure Backup software:
If you are installing Oracle Secure Backup on host that will be used as a media server, physically attach each tape library and tape drive that you intend to make available for use by Oracle Secure Backup. If prompted, restart the computer.
Disable any system software that scans and opens arbitrary SCSI targets before installing Oracle Secure Backup. If Oracle Secure Backup has to contend with other system software (such as monitoring software) for access to tape libraries and drives, then unexpected behavior can result.
If you are installing Oracle Secure Backup on a host that will be used as a media server, follow the steps in "Disabling Removable Storage Service on Windows Media Servers" to prevent conflicts between Oracle Secure Backup and other software on your system.
If you are installing Oracle Secure Backup in an Oracle Real Application Clusters (Oracle RAC) environment, then you must install Oracle Secure Backup on each node in the cluster.
The Removable Storage service is used to manage removable media, drives, and libraries. On Windows hosts configured for the media server role, this service must be disabled for the Oracle Secure Backup device driver to correctly control a tape device.
To disable the Removable Storage service:
You use the Oracle Secure Backup Windows Installer to install Oracle Secure Backup on Windows.
If you are installing Oracle Secure Backup in an Oracle RAC environment, then you must install Oracle Secure Backup on each node in the cluster.
To install Oracle Secure Backup on Windows:
Complete the planning tasks described in "Preparing to Install Oracle Secure Backup".
Ensure that the prerequisites described in "Prerequisites for Installing Oracle Secure Backup on Windows" are satisfied.
If you are installing the administrative server or media server role, verify that this host meets the physical and network security requirements discussed in "Choosing Secure Hosts for the Administrative and Media Servers".
Log on to the host as either the Administrator user or as a user that is a member of the Administrators group.
Select one of these install options:
If you are installing Oracle Secure Backup from a CD-ROM, then insert the CD-ROM. If AutoPlay is enabled, then the setup.exe program starts automatically and opens the Oracle Secure Backup Setup Wizard.
If Windows AutoPlay is not enabled, then open the drive containing the installation CD-ROM using Windows Explorer and run the setup.exe program.
If you are installing Oracle Secure Backup from an Oracle Technology Network (OTN) download, then run the
setup.exe program from the folder into which the download Zip file contents were extracted in "Acquiring Oracle Secure Backup Installation Media".
The Oracle Secure Backup Setup Wizard starts and the Welcome screen appears.
Click Next to continue.
If you have uninstalled Oracle Secure Backup software before beginning this installation, or if you have never installed it on this computer, then the Clean Install page appears.
If an earlier version of the Oracle Secure Backup software was installed on the host, then the installer detects this and prompts for the next step. If the version is 10.4.0.3 or later, you can use the installer to upgrade this version to 12.2. For versions earlier than release 10.4.0.3, you must first upgrade to 10.4.0.3 and then upgrade from release 10.4.0.3 to release 12.2.
Enter your customer information as follows:
Enter a user name in the User Name field.
Enter the name of your company in the Organization field.
Select one of these options:
Anyone who uses this computer
This option allows anyone who has access to this computer to use Oracle Secure Backup.
Only for me
This option limits use of Oracle Secure Backup to you.
Click Next to continue.
The Oracle Secure Backup Setup screen appears as displayed in Figure 4-1.
Figure 4-1 Oracle Secure Backup Setup Page
A single host can have multiple roles, which are additive rather than exclusive. You have the following options when choosing roles:
Every installation of Oracle Secure Backup on Windows includes software installation for the client and media server roles.
To install the Windows host as client or media server:
(Optional) To modify the values of configuration parameters, select Display advanced settings and click Next.
The Client Advanced Settings screen appears. Use this screen to specify configuration parameters as described in "Configuring Advanced Installation Settings for Windows".
The Adding Host Initiator Name page appears.
Enter the IP address or Fully Qualified Domain Name (FQDN) of the Oracle Secure Backup domain host that will use the mkhost command to initiate the request to add a client. This is usually the administrative server.
The specified IP address or FQDN is stored in the
C:\Program Files\Oracle\Backup\db\obconfig.txt file. It is used in the initial handshake between the client and the domain host that initiated the request to add the client, to verify the source of the request.
To omit the server IP address verification at the time of installing the client, use the
ADD_HOST_INITIATOR_ENABLE option when invoking the Oracle Secure Backup installer from the command line.
msiexec /i "Oracle Secure Backup.msi" INSTALL_ROLE="Client" ADD_HOST_INITIATOR_ENABLE="No"
Click Next and continue with Step 16.
To install the Windows host as an administrative server, select Administrative Server from the dropdown menu and then select This feature will be installed on local hard drive.
Selecting this option removes the X from the administrative server icon and includes the administrative server role in the installation.
Select Change to specify the name of the directory into which Oracle Secure Backup software is installed. The default directory is
In addition to the options described in step 7, you can perform the following actions in the Oracle Secure Backup Setup screen:
Click Help for detailed descriptions of the installation options.
Click Change to change the destination folder for the installation.
Click Space to display the disk space required for the installation.
(Optional) To modify the values of installation parameters, select Display advanced settings.
The Admin Host Advanced Settings page is displayed. Follow the steps described in "Configuring Advanced Installation Settings for Windows" to configure installation parameters.
Click Next to display the Encryption Wallet Password page.
Enter a password for the Oracle Secure Backup encryption wallet in the Password for encryption wallet field.
Enter the password again in the Re-type password for verification field.
The Oracle Secure Backup Admin User Password screen appears.
Enter a password for the Oracle Secure Backup
admin user in the Password for 'admin' user field. This field is encrypted.
Enter the password again in the Re-type password for verification field. Click Next to display the E-mail configuration Options page.
The default length for user passwords is 8. If you modify the minimum password length while customizing installation parameters in Step 10, then the length of the password must be at least the length of the new value.
Oracle recommends that you choose an administrative user password that contains a mixture of alphabetic and numeric characters.
On the Admin Server Configuration Details page, enter an e-mail address in the Email address for 'admin' user: field as shown in Figure 4-2.
Entering an email address for the
admin user enables Oracle Secure Backup to send notifications of important events. Setting this field is optional.
In the configuration information for the email server in the following fields:
SMTP Server: Name of the host to which Oracle Secure Backup sends e-mail notifications about the administrative domain.
SMTP Port: TCP/IP port number to which Oracle Secure Backup sends e-mail notifications about the administrative domain.
Figure 4-2 Admin Server Configuration Details Page
The default from address for e-mails generated by Oracle Secure Backup is
fqdn, where fqdn is the fully qualified domain name of the Oracle Secure Backup administrative server. You can change this default from address while configuring installation parameters. See Oracle Secure Backup Reference for more information.
Click Next to display the Web Server Account Details page.
In the Web Server Account field, enter the Windows account that is used to launch the Apache daemon. Specify a value in the form of
In the Password for Oracle Secure Backup Web server account field, enter a password for the Apache Web user account. Re-enter the password in the Re-type password for verification field.
If the installer cannot log on to your Web server account, the Oracle Secure Backup will present an error and halt the installation process.
If you do not have a Web server account, you can choose to select the checkbox that will use your Local System Account credentials for the installation.
Click Next to display the Ready to Install the Program screen appears.
Click Install to start copying files.
A progress bar appears. When the files are copied the InstallShield Completed screen appears.
The Oracle Secure Backup software installation on this Windows host is complete.
A log file
osb_intsall.log of the installation is stored in the Windows temporary directory. An additional Windows log is created in the same directory if you have enabled Windows Installer logging.
To view the contents of the temporary directory, enter the following text at command line:
"Enabling Installer Logging on Windows" for more information on how to enable Installer logging on Windows
You can use the Windows Installer logging to help assist in troubleshooting issues while installing Oracle Secure Backup.
To enable Windows Installer logging:
Open the Windows registry with
Regedit.exe and create the following path and keys:
Select the required logging mode. Table 4-1 lists the letters that can be entered, in any order, in the value field to enable the specified logging options.
Table 4-1 Windows Installer Logging Values
Initial UI parameters
All error messages
Start up of actions
Out-of-memory or fatal exit information
Append to existing file
Flush each line to the log
Extra debugging information. The
Wildcard, log all information except for the
This should be used only for troubleshooting purposes and should not be left on because it will have adverse effects on system performance and disk space. Each time you use the Add/Remove Programs tool in Control Panel, a new
Msi*.log file is created.
Advanced settings enable you to customize the values of parameters used during the Oracle Secure Backup installation. Default values are provided for each parameter and, if you do not explicitly modify the value of a parameter, then Oracle Secure Backup uses the default value.
To customize installation parameters:
The parameters displayed depends on the role that you are installing on the host. If you are installing the client role, then the only parameters that you can configure are the Oracle Secure Backup temporary directory and whether to start Oracle Secure Backup service automatically.
Temporary directory: Specifies the name of the directory that stores transient files used during Oracle Secure Backup operations.
Minimum User Password Length: Specifies the minimum length for Oracle Secure Backup user passwords.
Security Certificate Keysize: Specifies the key size of identity certificates.
An Oracle Secure Backup user with the rights of the
oracle class, whose purpose is to facilitate Oracle Database backup and restore operations with Recovery Manager (RMAN), is created.
The default name for the preauthorized user is
oracle. You can modify this name.
You are required to create the
oracle user only if you plan to use Oracle Secure Backup with RMAN.
If you intend to use Oracle Secure Backup to perform one-time, RMAN-initiated, or unprivileged backup operations on Windows clients, then you must modify the Oracle Secure Backup
oracle users to assign them Windows credentials (a domain, user name and password) that are valid at the client with required privileges after you complete the Oracle Secure Backup installation. Otherwise, Oracle Secure Backup cannot perform the backup operation. This requirement applies regardless of the platform that acts as the administrative server.
The installer assigns a random password to the
oracle user. In most cases you are not required to change the assigned password, because it is not usually necessary to log in to Oracle Secure Backup using this user account.
Before electing to create an Oracle Secure Backup
oracle user, be aware that this choice involves a trade-off between convenience and security.
Oracle Secure Backup Reference for more information about the
Preauthorized user account
The default name for the preauthorized user is
oracle. You can modify by name by providing a different name in this field.
To backup a database on a Linux/UNIX host, provide the following information:
Preauthorized User: Name of the Linux/UNIX user to which the preauthorized user is mapped.
Preauthorized Group: Name of the Linux/UNIX group to which the preauthorized user is mapped.
To backup a database on a Window host, in the Preauthorized Account field, enter the domain user account to which the preauthorized user is mapped.
Windows contains a built-in Windows Firewall which, in the default configuration, blocks inbound traffic on ports used by Oracle Secure Backup.
If your Windows host is protected by a firewall, then the firewall must be configured to permit Oracle Secure Backup daemons on the host to communicate with the other hosts in your administrative domain. Oracle Secure Backup includes daemon components that listen on port 400, port 10000, and other dynamically assigned ports.
Because the dynamically assigned ports used by Oracle Secure Backup span a broad range of port numbers, your firewall must be configured to allow executables for the Oracle Secure Backup daemons to listen on all ports.
The Oracle Secure Backup Windows installation provides a sample batch script called
obfirewallconfig.bat in the bin directory under the Oracle Secure Backup home.
This script contains commands that make the required configuration changes for the Windows Firewall, the built-in firewall released with Windows. Review the script to determine whether it is suitable for your environment. You can run the script after the installation completes.
For details on configuration of other firewalls, see the documentation provided by the vendor. You can refer to the sample script for the Windows Firewall to determine the names of executables that need permission to listen on ports.
My Oracle Support note
727528.1 for more information on how to configure firewall ports for use with Oracle Secure Backup. My Oracle Support is available at