EN LAS ENTIDADES NO LUCRATIVAS
IV. 2.- ESTUDIO DEL MODELO PRESUPUESTARIO
A template of the NML configuration file is provided by the NML installation process in the directory where the NML software is installed:
◆ On UNIX and Linux:
/usr/bin/nsrnml_config.template or /usr/sbin/nsrnml_config.template
◆ On Windows:
%SystemDrive%\Program Files\Legato\nsr\bin\
nsrnml_config.template
You can copy this template file to any location on the Domino or Notes host, and customize the parameter settings as required for the specific NML configuration. The NML configuration file must be set by the Notes user.
CAUTION
!
Ensure that the NML configuration file is stored in a secure location, and is accessible by privileged users only. If possible, make this file readable and writeable by only the Notes user that performs the operation.
For Lotus data recovery, the NML configuration file must be located on the destination client where the database files are to be recovered.
You must set the required parameters in the NML configuration file for use by the following:
◆ The nsrnotesv program during an NML backup of Domino or Notes data in a Domino database.
◆ The nsrnotesrc program during an NML restore of Domino or Notes data to a Domino database.
◆ The nsrdocrc command during an NML restore of deleted documents to a Notes database.
Task 8: Set up the NML configuration file 2-13 To specify the pathname of the NML configuration file, use the -z
option with the following commands as appropriate:
◆ nsrnotesv for backup
◆ nsrnotesrc for restore
◆ nsrdocrc for document-level restore CAUTION
!
A nsrnotesv, nsrnotesrc, or nsrdocrc command option takes precedence over the corresponding parameter setting in the NML configuration file for the same backup or restore operation.
A parameter setting in the NML configuration file takes precedence over a corresponding environment variable.
Overview of the configuration file
The NML configuration file has a main Lotus section that contains specific parameter settings and starts with the keyword LOTUS.
During an NML backup or restore of Domino or Notes data, the software uses the parameter settings (or default values of parameters that are not set) in the Lotus section of the NML configuration file.
The parameter values provide configuration information that is used by the NML backup or restore commands and procedures.
Note: For an NML backup or restore of Domino or Notes data, it is preferable to specify only the -z option with the nsrnotesv, nsrnotesrc , or nsrdocrc command. Specify other settings through the parameters in the Lotus section of the configuration file, rather than through the command options. The command options other than -z correspond to specific parameters.
CAUTION
!
Do not set any extra parameters in the Lotus section of the NML configuration file.
For an NML backup operation, do not set any Lotus restore parameters in the Lotus section of the file.
For an NML restore or recovery operation, do not set any Lotus backup parameters in the Lotus section of the file.
The following sections provide more information on the parameters to set in the Lotus section of the configuration file:
◆ “Lotus backup parameters” on page 2-14
◆ “Lotus restore parameters” on page 2-20
Lotus backup parameters
The Lotus section of the NML configuration file (starting with keyword LOTUS) contains settings of the Lotus backup parameters.
These parameters are used by the NML software during an ad hoc or scheduled backup of the Domino or Notes data.
The following Lotus backup parameters are mandatory in the NML configuration file:
◆ LOTUSUSER — Mandatory for scheduled backups on UNIX and Linux.
◆ Notes_ExecDirectory — Mandatory for all backups.
◆ NSR_BACKUP_LOTUS_DIR or NSR_BACKUP_PATHS — Mandatory for scheduled backups.
◆ NSR_LOTUS_DATA_DIR or PATH (latter set to include the Domino data directory) — Mandatory for all backups on UNIX or Linux.
◆ NSR_RESOURCE_DIR — Mandatory for all backups on UNIX and Linux.
◆ PATH — Mandatory for scheduled backups.
All other Lotus backup parameters are optional in the configuration file. The following sections provide more information on specifying parameters for the different types of Lotus backups:
◆ “Parameters for ad hoc backups” on page 3-2
◆ “Parameters for scheduled backups” on page 4-2
Appendix A, “NML Configuration File” provides details on the syntax rules for the configuration file, and a complete list of all the Lotus backup parameters.
The following examples describe the Lotus parameter settings for different types of NML backup operations.
Task 8: Set up the NML configuration file 2-15 Example 2-1 Lotus backup parameter for the backup catalog file
The backup catalog file contains information about each file backed up during an NML backup. The catalog file is stored on the Domino or Notes host. To specify the catalog file for a backup, ensure that the NML configuration file contains the NSR_CATALOGFILE parameter setting:
NSR_CATALOGFILE = pathname_of_catalog_file
where pathname_of_ catalog_file is the complete pathname of the backup catalog file to include detailed information about each file that is backed up.
◆ If the specified catalog file does not yet exist, it is created.
◆ If the specified catalog file already exists, the information is appended to the file.
◆ If the specified catalog file cannot be accessed, the backup still proceeds as usual. At the end of the backup, an error message appears for the failed catalog file operation.
The backup catalog file contains the following information about the backup:
◆ General information about the backup, such as the server name, client name, and volume pool used for the backup.
◆ The name of each file that is selected for backup.
◆ The status of each file (in integer format), where the status includes skipped and backed-up.
◆ The name of the save set that each file belongs to.
◆ The size of each file that is backed up.
◆ The total number of files backed up and total size of the backup.
◆ The names of all the transaction logs backed up.
For example, the following backup catalog file provides information from a full database backup:
Summary of NML Backup Server: ca-william Client: ca-william
Saveset: notes_ca-william Status: 0
Level: 0
EndDate: Thu Aug 25 09:18:21 2005 Pool: Default
Group: Default Compression: FALSE Encryption: FALSE AES Encryption: FALSE No. Items: 145
No. TransactionLogs: 0
Saveset: notes_ca-william.legato.com_0 Size: 94 MB NumFiles: 31 Date: Thu Aug 25 09:17:59 2005
Item: /space31/domino651/data/activity.ntf Status: 0 Size: 1237 KB(1266688) Time: Thu Aug 25 09:18:00 2005 Item: /space31/domino651/data/brasil.dic Status: 0 Size:
1251 KB(1280512) Time: Thu Aug 25 09:18:00 2005
Item: /space31/domino651/data/cluster.ncf Status: 210 Size: N/A Time: N/A (File not backed up).
Item: /space31/domino651/data/csrv50.ntf Status: 0 Size:
1064 KB(1089536) Time: Thu Aug 25 09:18:00 2005 (…)
Saveset: notes_ca-william.legato.com_1 Size: 106 MB NumFiles: 56 Date: Thu Aug 25 09:17:59 2005
Item: /space10/dzak/tmp.dic Status: 0 Size: 1 KB(6) Time: Thu Aug 25 09:17:59 2005
(…)
Total Files: 144, Skipped Files: 1, Txn Logs: 0 Skipped Txn Logs: 0
Example 2-2 Lotus backup parameter for backup of databases or directories Use the NSR_BACKUP_PATHS parameter setting to specify the complete pathnames of one or more Lotus database files or directories for an NML backup. “Using wildcards” on page B-2 provides information on using wildcards in pathnames with the parameter.
The following parameter settings in the NML configuration file specify the backup of a single Lotus database:
◆ On UNIX or Linux:
NSR_BACKUP_PATHS = /lotusdata/accounting.nsf
◆ On Windows:
NSR_BACKUP_PATHS = c:\Lotus\Domino\data\accounting.nsf
Task 8: Set up the NML configuration file 2-17 The following parameter settings in the NML configuration file
specify the backup of a single Lotus directory:
◆ On UNIX or Linux:
NSR_BACKUP_PATHS = /lotusdata
◆ On Windows:
NSR_BACKUP_PATHS = c:\Lotus\Domino\data
Example 2-3 Lotus backup parameter for backup of the Domino data directory The following parameter setting in the NML configuration file specifies the backup of all the databases under the Lotus data directory:
NSR_BACKUP_LOTUS_DIR = TRUE
Example 2-4 Lotus backup parameter for the comfort span
A comfort span is a value that determines whether NML backs up a logged database in full before it backs up transaction logs during an incremental backup. The comfort span value denotes the acceptable span of logs (number of kilobytes of logs) that can be applied during the recovery of the backup.
To specify the comfort span for a database during an incremental backup, ensure that the NML configuration file contains the NSR_COMFORT_SPAN parameter setting:
NSR_COMFORT_SPAN = comfort_span_value
where comfort_span_value must be an integer value between 65536 and 65536000, inclusive.
Note: To enable the use of the NSR_COMFORT_SPAN parameter, transaction logging must be enabled in archive mode on the Domino server.
For example, the NML configuration file contains the following parameter settings for an incremental database backup with the comfort span option:
NSR_BACKUP_LEVEL = incr NSR_COMFORT_SPAN = 196608
If NML determines that more than 196608 KB of logs need to be applied to recover the specified database, NML performs a full backup of the database before backing up the logs. A full backup
reduces future recovery time. Fewer transaction logs are required to recover the logged database.
Example 2-5 Lotus backup parameters for crossing mount points
To enable backups of Lotus databases that cross mount points, ensure that the NML configuration file contains the
NSR_CROSS_MOUNT_POINTS parameter setting:
NSR_CROSS_MOUNT_POINTS = TRUE
For example, the NML configuration file contains the following settings for a backup of all the databases under the Lotus data directory, including the directory’s mount points:
NSR_BACKUP_LOTUS_DIR = TRUE NSR_CROSS_MOUNT_POINTS = TRUE
Example 2-6 Lotus backup parameters for encryption
For a Lotus data backup, specify either the default NetWorker encryption method or 256-bit AES encryption.
◆ To specify that the default NetWorker encryption method is used during a backup, ensure that the NML configuration file contains the NSR_ENCRYPTION parameter setting:
NSR_ENCRYPTION = TRUE
◆ To specify that 256-bit AES encryption is used during a backup, ensure that the NML configuration file contains the
NSR_AES_ENCRYPTION parameter setting:
NSR_AES_ENCRYPTION = TRUE CAUTION
!
The 256-bit AES encryption method is supported only if all the computers involved in the backup contain NetWorker release 7.3 or later client and server software. If NetWorker software earlier than release 7.3 is installed, the default NetWorker encryption method is used instead without a warning message, and the resulting backup cannot be considered secure.
Keep a record of all pass phrases used for 256-bit AES encryption.
Be careful when you change the pass phrase on the NetWorker 7.3 server. If the pass phrase on the server is changed and you cannot
Task 8: Set up the NML configuration file 2-19 remember the pass phrase used for an NML backup, the encrypted data cannot be recovered. The NetWorker, Release 7.3,
Administration Guide provides more information on pass phrases.
Example 2-7 Lotus backup parameter for exclude lists
To specify the name of a file that contains a list of paths to be excluded from an NML backup, ensure that the NML configuration file contains the NSR_EXCLUDE_FILE parameter setting:
NSR_EXCLUDE_FILE = pathname_of_exclude_file
where pathname_of_exclude_file is the complete pathname of a file that contains a list of the filenames to exclude.
Example 2-8 Lotus backup parameter for parallelism
The NML parallelism level controls the number of concurrent save streams that the NML client can send to the NetWorker server during a backup.
To specify the parallelism level of the client, ensure that the NML configuration file contains the NSR_PARALLELISM parameter setting:
NSR_PARALLELISM = parallelism_level
For example, the NML configuration file contains the following setting for a backup with the parallelism level of two:
NSR_PARALLELISM = 2
Example 2-9 Lotus backup parameter for a transaction log backup
To specify the type of transaction log backup to perform during a full NML backup, ensure that the NML configuration file contains the NSR_BACKUP_LOGS_MODE parameter setting:
NSR_BACKUP_LOGS_MODE = log_backup_level where log_backup_level is either 1 or 2.
◆ If the value is 1, NML backs up new transaction logs and marks them as reusable.
◆ If the value is 2, NML marks transaction logs as reusable without backing them up.
Note: The NSR_BACKUP_LOGS_MODE parameter is not supported for incremental backups.
CAUTION
!
Use the setting NSR_BACKUP_LOGS_MODE = 2 with extreme caution. With this setting, the transaction logs are not backed up and will be recycled by the Domino server.
Lotus restore parameters
The Lotus section of the NML configuration file (starting with keyword LOTUS) contains settings of the Lotus restore parameters.
These parameters are used by the NML software during a recovery of the data in a Domino or Notes database.
CAUTION
!
For Lotus data recovery, the NML configuration file must be located on the destination client where the database files are to be recovered.
The only Lotus restore parameter that is mandatory in the NML configuration file is Notes_ExecDirectory. All other restore parameters are optional.
Appendix A, “NML Configuration File” provides details on the syntax rules for the configuration file, and a complete list of all the Lotus restore parameters.
The following examples describe the Lotus parameter settings for different types of NML restore operations.
Example 2-10 Lotus restore parameter for encryption phrases
By default, if the NSR_ENCRYPTION_PHRASES parameter is not set, the NML software obtains the encryption phrase from the NetWorker server for decrypting an encrypted backup during a Lotus restore.
Task 8: Set up the NML configuration file 2-21 The NSR_ENCRYPTION_PHRASES parameter must be set if both of the following are true:
◆ The Lotus data being restored was backed up with 256-bit AES encryption.
◆ The encryption phrase on the NetWorker server has changed since the Lotus data was backed up.
If both of these conditions are true, ensure that the NML configuration file contains the following
NSR_ENCRYPTION_PHRASES parameter setting:
NSR_ENCRYPTION_PHRASES = original_encryption_phrase where original_encryption_phrase is the encryption phrase used to originally back up the Lotus data that is to be restored.
CAUTION
!
The decryption of data that was backed up with 256-bit AES encryption is supported only if all the computers involved in the restore contain NetWorker release 7.3 or later client or server software. If NetWorker software earlier than release 7.3 is installed, the default NetWorker decryption method is used instead.
Example 2-11 Lotus restore parameter for not applying logs
By default, the NML software applies the transaction logs after restoring a Lotus backup. To specify that the transaction logs are not applied after a Lotus restore, ensure that the NML configuration file contains the following NSR_APPLY_LOGS parameter setting:
NSR_APPLY_LOGS = FALSE
Example 2-12 Lotus restore parameter for parallelism
The NML parallelism level controls the number of concurrent save streams that the NML client can send to the NetWorker server during a restore.
To specify the parallelism level of the client, ensure that the NML configuration file contains the NSR_PARALLELISM parameter setting:
NSR_PARALLELISM = parallelism_level
For example, the NML configuration file contains the following setting for a restore with the parallelism level of two:
NSR_PARALLELISM = 2