Variables available in the task scripts for the backup operation
-
PDF of this doc site
- Administration for UNIX
- Installation and Setup for Windows
Collection of separate PDF docs
Creating your file...
SnapManager provides context information in the form of environment variables related to the backup operation that is being performed. For example, your script can retrieve the name of the original host, the name of the retention policy, and the label of the backup.
The following table lists the environment variables that you can use in your scripts:
Variables | Description | Format |
---|---|---|
SM_OPERATION_ID |
Specifies the ID of the current operation |
string |
SM_PROFILE_NAME |
Specifies the name of the profile used |
string |
SM_SID |
Specifies the system identifier of the database |
string |
SM_HOST |
Specifies the host name of the database |
string |
SM_OS_USER |
Specifies the operating system (OS) owner of the database |
string |
SM_OS_GROUP |
Specifies the OS group of the database |
string |
SM_BACKUP_TYPE |
Specifies the type of the backup (online, offline, or auto) |
string |
SM_BACKUP_LABEL |
Specifies the label of the backup |
string |
SM_BACKUP_ID |
Specifies the ID of the backup |
string |
SM_BACKUP_RETENTION |
Specifies the retention period |
string |
SM_BACKUP_PROFILE |
Specifies the profile used for this backup |
string |
SM_ALLOW_DATABASE_SHUTDOWN |
Specifies if you want to start up or shut down the databaseIf required you can use the -force option from the command-line interface. |
boolean |
SM_BACKUP_SCOPE |
Specifies the scope of the backup (full or partial) |
string |
SM_BACKUP_PROTECTION |
Specifies if backup protection is enabled |
boolean |
SM_TARGET_FILER_NAME |
Specifies the target storage system name Note: If more than one storage system is used, then the storage system names must be separated by commas. |
string |
SM_TARGET_VOLUME_NAME |
Specifies the target volume name Note: The target volume name must be prefixed with storage device name, for example, SM_TARGET_FILER_NAME/SM_TARGET_VOLUME_NAME. |
string |
SM_HOST_FILE_SYSTEM |
Specifies the host file system |
string |
SM_SNAPSHOT_NAMES |
Specifies the Snapshot list Note: Name of the Snapshot copies must be prefixed with the storage system name and volume name. Names of the Snapshot copies are separated by commas. |
string array |
SM_ASM_DISK_GROUPS |
Specifies the ASM Disk group list |
string array |
SM_ARCHIVE_LOGS_DIRECTORY |
Specifies the archive logs directory Note: If the archive logs are located in more than one directory, then the names of those directories are separated by commas. |
string array |
SM_REDO_LOGS_DIRECTORY |
Specifies the redo logs directory Note: If the redo logs are located in more than one directory, then the names of those directories are separated by commas. |
string array |
SM_CONTROL_FILES_DIRECTORY |
Specifies the control files directory Note: If the control files are located in more than one directory, then the names of those directories are separated by commas. |
string array |
SM_DATA_FILES_DIRECTORY |
Specifies the data files directory Note: If the data files are located in more than one directory, then the names of those directories are separated by commas. |
string array |
user_defined |
Specifies additional parameters defined by the user. User-defined parameters are not available for plug-ins that are used as policies. |
user-defined |