2 Installation and Configuration

Prerequisites for Installation

To install Local Delete, upgrade all components of the DIVArchive System to the proper release.

  • At least two (one local and one remote) DIVArchive Managers (release 6.5 or later) must be installed and properly configured.

  • DIVAnet (Legacy DIVAnet, DIVAnet 2.0, or DIVAnet 2.1) must be installed and properly configured to operate with at least two DIVArchive Managers.

  • To run in Delayed mode, DIVAnet must be running on DIVArchive release 7.3 or later.

Configuring Local Delete

You must complete the following steps before starting Local Delete.

  1. Open the DIVAnet Configuration File (router.xml) and verify that it contains the following:

    <message class=".DeleteInstanceMessage" messageProcessorClass=".SelectiveRoutingMessageProcessor" instance="instance"/>

  2. Navigate to the directory containing the Local Delete configuration files (%DIVA_HOME%\Program\conf\lynxLocalDelete\).

  3. Create a Local Delete configuration file. The format is different depending on the desired mode:

Configuring ASAP Purge Mode

  1. Rename the lynxLocalDelete.conf.ASAP file to lynxLocalDelete.conf.

  2. Open the lynxLocalDelete.conf file and enter the correct values for each of the configuration parameters (see ASAP Configuration Parameters).

    Note:

    The parameters and values for this mode are case-sensitive.
  3. Restart the Local Delete service.

ASAP Configuration Parameters

The following table describes the lynxLocalDelete.conf.ASAP configuration parameters. See Appendix A for a sample configuration file.

ASAP Parameter Description Default Value Required
DIVANET_IP=Address Address is IP address used for the DIVAnet connection. 127.0.0.1 Yes
DIVANET_PORT=Num Num is a positive integer, which indicates the Port used for the DIVAnet connection. 9500 Yes
DIVANET_USER_NAME=UserName UserName is the username used for the DIVAnet connection. admin Yes
DIVANET_USER_PASSWORD=Password Password is the password for the DIVAnet connection. none No
LOCAL_DIVARCHIVE_NAME=LocalName LocalName is a string, which indicates the name of the Local Delete DIVArchive System used in DIVAnet. none Yes
LYNX_DIVARCHIVE_NAME=DisRecName DisRecName is a string, which indicates the name of the disaster recovery DIVArchive system used in the DIVAnet. Only one disaster recovery name may appear. none Yes
DIVANET_SYNC_DELAY=Num Num is an integer (1 to MAX_VALUE), which is a hidden parameter that defines the delay in minutes for syncing site through DIVAnet.

DIVAnet needs time to synchronize its object instances information on the different DIVArchive sites. Until it does, DeleteInstance requests from Local Delete may be rejected.

To avoid this situation, Local Delete checks objects for the MODIFIED_SINCE value to verify that it is greater than the DIVANET_SYNC_DELAY parameter.

20 No
CHECK_START_TIME=
MM/DD/YYYY
MM/DD/YYYY is the date in US standard format. The application will check only those objects which were modified in the lynxDR system since that date.

If a -1 value is provided, the application will use its start time as the initial date.

If a 0 value is provided, the application will check all objects in system.

1/1/2000 Yes
CHECK_END_TIME=MM/DD/YYYY MM/DD/YYYY is the date in US standard format. The application will check only those objects which were modified in the disaster recovery system before that date. none No
CHECK_INTERVAL=Minutes Minutes is a positive integer, which indicates the interval (in minutes) between 2 consecutive Local Delete checks. 2 Yes
CATEGORY_TEMPLATE.#=Category # is an integer, which starts at 1 and increments by 1 for each additional category template.

Category is a string. Wildcards (asterisks *) are allowed. To use all categories, provide only an asterisk (*) for the value.

The category template parameters create the Category List handled by the Local Delete workflow. Ensure the format is compatible with the getObjectDetailsList parameter.

Example: CATEGORY_TEMPLATE.1=News,Post,Movie*,Film?

* Yes
LYNX_INSTANCES_COUNT=Num Num is a positive integer, which indicates the number of object instances to be created on the disaster recovery systems before the local object instance is marked for deletion. 2 Yes
LOCAL_MEDIA_TYPE=Type Type can be DISK or ALL, which defines the local instances to delete when content has been successfully replicated to the disaster recovery system.

DISK triggers the automatic deletion of disk-only local instances.

ALL triggers the automatic deletion of all local instances on both disk and tape.

DISK Yes
DELETE_REQUEST_PRIORITY=Num Num is an integer (1 to 100), which defines the priority used for delete requests. 50 No
SIMULATENEOUS_DELETE_OPERATIONS=Num Num is an integer (1 to 10), which defines the maximum simultaneous delete operations allowed. 3 Yes
MAX_OBJECTS_PER_CYCLE=Num Num is a positive integer, which indicates the maximum number of objects to check per cycle. 1000 No
EXCLUDE_MEDIA_TYPE=MediaType MediaType is a string, which specifies a media type (Tape Group or Disk Array name).

If the object has an instance of the specified media type, the object will not be deleted.

none No

Configuring Delayed Purge Mode

  1. Rename the lynxLocalDelete.conf.delayed file to lynxLocalDelete.conf.

  2. Open the lynxLocalDelete.conf file and enter the correct values for each of the configuration parameters (see Delayed Purge Mode Configuration Parameters).

    Note:

    The parameter names for this mode are not case-sensitive, but the values are case-sensitive.
  3. Restart the Local Delete service.

Delayed Purge Mode Configuration Parameters

The following tables describe the lynxLocalDelete.conf.delayed configuration parameters. See Appendix B for a sample configuration file.

Top Level Configuration Parameters

Top Level Parameter Description Default Value Required
PurgeMode=Mode Mode can be ASAP or delayed, which indicates the purge mode in effect. Only one mode can be in effect at a time. ASAP, but use delayed to select the Delayed Purge Mode. No
DeleteRequestPriority=Num Num is an integer (1 to 100), which indicates the DIVArchive delete request priority. 50 No
SimultaneousDeleteOperations
=Num
Num is an integer, which indicates the number of simultaneous deletes that can be processed by the application. none Yes

Site Verification Criteria Configuration Parameters

Site verification is optional. The parameters specify what to verify before purging. You can provide multiple criteria by creating criteria groups.

Note:

You can only specify one of the following per criteria group: media, numTapeInstance, or numInstances.

Creating a Criteria Group:

The criteria group number distinguishes one group of related parameters from another. For instance:

   SiteToVerify.1.sitename=lynxDR
   SiteToVerify.1.numTapeInstances=1

   SiteToVerify.2.sitename=local
   SiteToVerify.2.media=remoteArray

In the previous example, the SiteToVerify.1 parameters are in a criteria group, while the SiteToVerify.2 parameters are in another group. Local Delete will verify there is one tape instance on the disaster recovery site and one instance on a local array called remoteArray.

Site Verification Parameter Description Default Value Required
SiteToVerify.#.sitename=Site # is the criteria group number.

Site is a string, which indicates the DIVArchive sitename. This is DIVAnet sitename of a remote DIVA site or local to indicate the local site.

None No
SiteToVerify.#.media=
MediaType
# is the criteria group number.

MediaType is a string. If specified, an instance with this media must be present on the site.

None No
SiteToVerify.#.numTapeInstances=Num # is the criteria group number.

Num is an integer (1 to 100). If specified, the site must contain at least this many tape instances of the object.

None No
SiteToVerify.#.numInstances=Num # is the criteria group number.

Num is an integer (1 to 100). If specified, the site must contain at least this many total instances of the object.

None No

Site to Purge Configuration Parameters

You must specify the site name and array name to purge from. The site number distinguishes one group of related parameters from another. For DIVArchive 7.4, only one array may be monitored, therefore the site number would be 1 (for example SiteToPurge.1.sitename=local).

Site to Purge Parameter Description Default Value Required
SiteToPurge.#.sitename=Site # is the site number

Site is a string, which indicates the DIVAnet sitename of the local DIVArchive system.

none Yes
SiteToPurge.#.watermarkedArrayName=ArrayName # is the site number

ArrayName is a string, which indicates the name of the array to monitor and purge from.

none Yes
SiteToPurge.#.highWatermark=Num # is the site number

Num is an integer (1 to 100), which indicates the percentage an array must be full to start the purge process.

none Yes
SiteToPurge.#.lowWatermark=Num # is the site number

Num is an integer (1 to 100), which indicates the percentage an array must be full to stop a purge process that is already active.

none Yes

Categories Configuration Parameters

Specifying categories is optional. This parameter specifies the categories of objects to consider for deletion. If not specified, the default is all categories.

Categories Parameter Description Default Value Required
CategoryIncludeFilter.#
=Category
# is an integer, which starts at 1 and increments by 1 for each additional filter.

Category is a string. Any purged object must match one of these categories. Wildcards (asterisks *) are allowed.

All Yes

DIVAnet Configuration Parameters

This information is required to connect to DIVAnet.

DIVAnet Parameter Description Default Value Required
Divanet.address=Address Address is the IP address of the DIVAnet server. none Yes
Divanet.port=Num Num is a positive integer, which indicates the port of the DIVAnet server. none Yes
Divanet.user=UserName UserName is the user name for the DIVAnet API connection., none Yes
Divanet.password=Password Password is the password for the DIVAnet API connection. none Yes

DIVAnet Database Configuration Parameters

This information is required to connect to the DIVAnet database.

DIVAnet Database Parameter Description Default Value Required
DivanetDb.address=Address Address is the IP address of the DIVAnet database. none Yes
DivanetDb.port=Num Num is a positive integer, which indicates the port of the DIVAnet database. 1521 No
DivanetDb.user=UserName UserName is the user name for the DIVAnet database. none Yes
DivanetDb.password=Password Password is the password for the DIVAnet database. none Yes
DivanetDb.sid=Database_sid Database_sid is the SID of the DIVAnet database. lib5 No

Local DIVArchive Database Configuration Parameters

This information is required to connect to the local DIVArchive database.

Local DIVA Database Parameter Description Default Value Required
LocalDivaDb.address=Address Address is the IP address of the local DIVArchive database (the Manager database). none Yes
LocalDivaDb.port=Num Num is a positive integer, which indicates the port of the local DIVArchive database. 1521 No
LocalDivaDb.user=UserName UserName is the user name for the local DIVArchive database. none Yes
LocalDivaDb.password=Password Password is the password for the local DIVArchive database. none Yes
LocalDivaDb.sid=Database_sid Database_sid is the SID of the local DIVArchive database. lib5 No

Running Local Delete Using the Batch File

All Windows batch files (.bat) have corresponding shell scripts (.sh) in Linux. You must substitute Windows paths with Linux paths when operating on Linux. For example, the Windows path C:\DIVA\Program will be /home/diva/DIVA/Program when running under Linux.

Note:

Linux commands, paths and file names are case-sensitive.

The command line console must remain open while Local Delete is running. Closing the window will stop Local Delete.

  1. Open a Windows command prompt or Linux terminal.

  2. Change to the following folder:

    cd %DIVA_HOME%\Program\Utilities\bin (in Windows)

    cd /home/diva/DIVA/Program/Utilities/bin (in Linux)

  3. Execute the batch file without any command line parameters to start Local Delete.

    lynxLocalDelete.bat

  4. If you see Local Delete Utility is running, the module started successfully.

Installing or Uninstalling Local Delete as a Service

Oracle recommends installing Local Delete as a service. lynxLocalDelete.bat supports the installation and uninstallation of the Local Delete service using the -i and -u options, respectively.

Refer to the Linux installation instructions in the Oracle DIVArchive Installation and Configuration Guide in the Oracle DIVArchive 7.4 Core Documentation library for Linux-specific directions concerning running DIVArchive components as services under Linux.

Note:

The Local Delete service will be installed using the configuration file found in the %DIVA_HOME%\conf\lynxlocaldelete\ folder in Windows, or in the /home/diva/DIVA/conf/lynxlocaldelete/ directory in Linux.

If you use a configuration file other than the default, specify the file with the -conf or -f options.

  1. Open a Windows command prompt or Linux terminal.

  2. Change to the following folder:

    cd %DIVA_HOME%\Program\Utilities\bin (in Windows)

    cd /home/diva/DIVA/Program/Utilities/bin (in Linux)

  3. Execute the batch file with the -i option (to install) or -u option (to uninstall). For example, to install Local Delete as a service:

    lynxLocalDelete.bat -i (in Windows)

    lynxLocalDelete.sh -i (in Linux)