Dell Storage Manager 2020 R1 Administrator's Guide

PDF

NDMP Environment Variables

NDMP environment variables control the behavior of the NDMP server for each backup and restore session.

To determine whether the DMA server supports setting these environment variables, refer to the documentation for your DMA server. If the DMA server cannot set a particular environment variable, the NDMP server operates with the default value.

The following table summarizes the supported environment variables.


Environment Variable	Description	Used In	Default Value
TYPE	Specifies the type of backup and restore application. The valid values are: dump – NDMP server generates inode-based file history tar – NDMP server generates file-based file history	Backup and Restore	dump
FILESYSTEM	Specifies the path to be used for the backup. The path must be a directory.	Backup	None
LEVEL	Specifies the dump level for the backup operation. The valid values are 0 to 9.	Backup	0
HIST	Specifies how file history is to be generated. The valid values are: d – Specifies that node/dir-format file history will be generated f – Specifies that file-based file history will be generated y – Specifies that the default file history type (which is the node/dir format) will be generated n – Specifies that no file history will be generated	Backup	y
DIRECT	Specifies whether the restore is a Direct Access Retrieval. The valid values are Y and N.	Backup and Restore	Y
UPDATE	Specifies whether the dump level and dump time for a backup operation should be updated on the NDMP server so that subsequent backups can reference the dump level from previous backups. The valid values are Y and N.	Backup	Y
EXCLUDE	Specifies a pattern for matching to directory and file names that are not to be backed up. This environment variable is a list of strings separated by commas. Each entry is matched against nodes encountered during backup. The string can contain an asterisk (*) as the wildcard character, but the asterisk must be the first or last character of the pattern. A maximum of 32 comma-separated strings are supported.	Backup	No exclude pattern is specified by default
RECURSIVE	Specifies whether the restore should be recursive. The valid values are Y and N. If this environment variable is set to N, only files that are the immediate children of the restore target are restored.	Restore	Y
RESTORE_OVERWRITE	Specifies whether the restore operation should overwrite existing files with the backup data. The valid values are Y and N.	Restore	Y
LISTED_INCREMENTAL	Specifies whether an additional directory listing is added to the backup stream during incremental backup so that the restore operation can handle files and directories deleted between the incremental backups. This environment variable controls behavior similar to the listed incremental option of the tar application. The valid values are Y and N. During backup, if this variable is set to Y, an additional directory listing is added to the backup data stream. Because of the additional processing required, this option could impact the backup data stream size and performance. During restore, if this variable is set to Y and the backup data stream was generated with this variable set to Y, the NDMP server will handle deleting files and directories that are deleted between incremental backups. Setting this variable to Y requires additional processing time and increases the backup data stream size (the size of the increase depends on the number of elements in the backup data set). If this feature is not important in your environment, this variable should not be set.	Backup and Restore	N
BASE_DATE	Specifies whether a token-based backup is performed. Token-based backup is used by Tivoli Storage Manager as an alternative to backups using the LEVEL environment variable. The valid values are: -1 – Specifies that token-based backup is disabled 0 – Specifies that a token-based backup is performed. After the backup completes, a token can be retrieved by using the DUMP_DATE environment variable. This token can then be passed in a subsequent backup as the value of BASE_DATE. The backup performed in this case will be an incremental backup relative to the time when the token was generated.	Backup	-1
DEREF_HARD_LINK	Specifies whether hard link files’ data content is backed up for all instances of the same file. The valid values are Y and N.	Backup	N