emc networker module for documentum - nsrd.info networker module for documentum release 1.2...

EMC CorporationCorporate Headquarters:

Hopkinton, MA 01748-9103

1-508-435-1000www.EMC.com

EMC® NetWorker®

Module for Documentum®

Release 1.2Multiplatform Version

Command Reference GuideP/N 300-004-573

REV A01

EMC NetWorker Module for Documentum Release 1.2 Multiplatform Version Command Reference Guide2

Copyright © 2003 - 2007 EMC Corporation. All rights reserved.

Published September, 2007

EMC believes the information in this publication is accurate as of its publication date. The information is subject to change without notice.

THE INFORMATION IN THIS PUBLICATION IS PROVIDED “AS IS.” EMC CORPORATION MAKES NO REPRESENTATIONS OR WARRANTIES OF ANY KIND WITH RESPECT TO THE INFORMATION IN THIS PUBLICATION, AND SPECIFICALLY DISCLAIMS IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

Use, copying, and distribution of any EMC software described in this publication requires an applicable software license.

For the most up-to-date listing of EMC product names, see EMC Corporation Trademarks on EMC.com.

All other trademarks used herein are the property of their respective owners.

Preface

As part of an effort to improve and enhance the performance and capabilities of its product lines, EMC periodically releases revisions of its hardware and software. Therefore, some functions described in this document may not be supported by all versions of the software or hardware currently in use. For the most up-to-date information on product features, refer to your product release notes.

If a product does not function properly or does not function as described in this document, please contact your EMC representative.

Audience This document is part of the EMC NetWorker Module for Documentum (NMD) documentation set. The guide is intended for use by professional services consultants and the Documentum administrators who are responsible for maintaining the Documentum Content Server and database server backup and restore system. Operators who monitor the Documentum data backups may also find this administration guide useful.

Readers of this document are expected to be familiar with the following topics:

◆ Documentum and relevant database terminology and concepts, especially those related to backups and restores

◆ Backup and restore procedures on a Documentum Server◆ Disaster recovery procedures on a Documentum Server

Relateddocumentation

Documentation related to the use of this product can be found on the EMC Powerlink website, http://Powerlink.EMC.com, including:

◆ The NetWorker Module for Documentum release 1.2 documentation set:• Administration guide• Installation guide• Release notes• Best practices guide• Command reference guide

◆ The NetWorker documentation set:• Administration guide• Installation guide• Release notes• Command reference guide• Disaster recovery guide

◆ Appropriate versions of the following documentation sets:• NetWorker Module for DB2• NetWorker Module for Microsoft SQL Server• NetWorker Module for Oracle

EMC NetWorker Module for Documentum Release 1.2 Multiplatform Version Command Reference Guide 3

http://powerlink.emc.com

Preface

• NetWorker Module for Sybase• NetWorker SnapImage Module

◆ Other EMC documentation:• Software Compatibility Guide• UNIX man pages

The following additional documentation may be useful:

◆ Documentum Content Server documentation

◆ Appropriate database (IBM DB2, Microsoft SQL Server, Oracle, or Sybase) backup and recovery documentation

Where to get help EMC support, product, and licensing information can be obtained as follows.

Product information — For documentation, release notes, software updates, or for information about EMC products, licensing, and service, go to the EMC Powerlink website (registration required) at:

http://Powerlink.EMC.com

Technical support — For technical support, go to EMC Customer Service on Powerlink. To open a service request through Powerlink, you must have a valid support agreement. Please contact your EMC sales representative for details about obtaining a valid support agreement or to answer any questions about your account.

Your comments Comments and suggestions about our product documentation are always welcome.

To provide feedback:

1. Go to:

http://Powerlink.EMC.com

2. Click the Feedback link.


http://powerlink.emc.com

http://softwaresupport.EMC.com

nsrnmdcr(1m)

Maintenance Procedures nsrnmdcr(1m)

NAMEnsrnmdcr - NetWorker Module for Documentum query command, for querying customized Documentum Server file reports. The results of the query can be used to recover the files using recover -t.

SYNOPSISnsrnmdcr -B repository_name -A sa_name [-E report_name] | [[-P report_dir][-T report_time]] [-N max_entries_returned] [-F output_path] [-V] [-O][-R [-C nsr_client] [-S nsr_server] [-D reloc_dir] [-I {nNyYrR}] ] [-f folder_name][-d document_name] [-u user_name] [-c client_name] [-v document_version][-r org | mod ] [-o orig_docname] [-m doc_format] [-t doc_save_date]

DESCRIPTIONThe nsrnmdcr command options in brackets ([ ]) are optional. Do not include the brackets when entering the command.

Note: The repository name must be specified through the -B option. If the repository name is not specified, the file report browsing fails.

The -A option specifies the search of file reports for a particular storage area. This option is recommended for narrowing the search. Either -E or -P can be used to specify the file report location. The -E option specifies the pathname of a single file report. The -P option specifies a directory pathname, for searching all the file reports in the directory. If -P is used with -A or -T, the file reports searched are those for a particular storage area or those created at a specified time. For example, with the options -A filestore_01 and -T "20041122", the file reports searched are the those for the filestore_01 storage area that were created on November 11, 2004.

The options -F and -V are recommended. The -F option specifies the pathname of the file to contain the command results. The -V option produces the most detailed results, which enables the user to verify that the expected documents were reported. It is the user’s responsibility to verify the results of the nsrnmdcr command.

The options -c, -d, -f, -m, -o, -r, -t, -u, and -v are all optional search criteria, used to search for specific documents that are listed in the file reports. The option values can include regular expression in quotes. However, the search performance improves when regular expressions contain fewer expansion symbols such as *. For more information on regular expressions, refer to the regexp man page.

Note: All option values are case-insensitive.

OPTIONS

-A storage_area_name

Specifies the name of the storage area searched for in the file reports. A separate file report is generated for each storage area in a backup. This option is recommended, to narrow the search of the file reports.

-B repository_name

Specifies the name of the repository searched for in the file reports. This option is mandatory.

-C nsr_client

Specifies the name of the NetWorker client to use for restore. Within a distributed storage area configuration, nsr_client must be the primary host or the remote storage area host, and the restore is performed to that host. If no name is provided, within a distributed storage area configuration, the host of the storage area will be used; otherwise, the local host will be used. This


nsrnmdcr(1m)

option is valid only with the -R option.

-c client_name

Specifies the client name to search for. This represents the client name that the documents were committed under.

-d document_name

Specifies the document name to search for in the file reports.

-D reloc_dir

Specifies the directory to restore the file to. This directory must exist and have write permissions. If this option is not specified the file(s) will be restored to the original location. This option is valid only with the -R option.

-E file_report_path

Specifies the full pathname of a specific file report file to search. Do not specify this option with the -P option for the same nsrnmdcr command.

-F output_path

Specifies the path and filename of where the results of the query should go.

-f folder_name

Specifies the folder name to search for in the file reports.

-I {nNyYrR}

Specifies the initial default overwrite response to use when recovering existing files. Only one letter may be specified. This option is the same as the uasm -i option when running in recover mode. See the uasm(1m) man page for a detailed explanation of this option.

-m document_format

Specifies the document formats to search for in the file reports. Standard document formats as represented in the Documentum Server Admin Guide are accepted.

-N max_entries

Specifies the maximum number of entries from the file reports that are displayed. For example, with N=10, the nsrnmdcr command will display a list of the 10 documents found first that match the search criteria.

-O

Specifies that user prompting is turned off, which causes all the files that match the search criteria to be searched automatically. By default, user prompting is turned on and the search process prompts the user before each file is searched.

-o original_document_name

Specifies the original name (<set_client>) of the document to search for in the file reports. The original name is the filename of the physical file on the host, which was used in the check-in.

-P file_report_directory

Specifies the directory containing all the file reports to search. Do not specify this option with the -E option for the same nsrnmdcr command.

-R

Specifies that the files found during the query should be recovered. This option can be used together with -S, -C, -D and -I options. After a matched file is found, the recovery process will restore each file one by one. If the recover list is too great (ex. More than 500 files), it is recommended to use nsrnmdcr -F <output_result> and recover -I <input_file> instead (where <output_result> = <input_file>).


nsrnmdcr(1m)

-S nsr_server

Specifies the name of the NetWorker server to use for restore. If no name is provided the local host will be used. This option is valid only with the -R option.

-r org | mod

Specifies the type of renditions to display, according to the option value. The value org displays only the original rendition of each content file. The value mod displays all the renditions of each content file.

-T file_report_time

Specifies the time when a file report was created in the form YYYYMMDDHHMMSS where: YYYY is the year as a four-digit number, MM is the month as a one or two-digit number and DD is the day of the month as a one or two-digit. HH is the hour as a one- or two-digit number. MM is the minute as a one- or two-digit number. SS is the second as a one- or two-digit number. Partial times are supported. For example, "2007112211" represents any time between 11 a.m. and noon on November 22, 2007. If -T is not specified, the latest file report in the directory specified by -P is used.

-t document_save_time

Specifies the time of the document creation to search for in the file reports. The time must be in the form MM/DD/YY [HH:MM] where: MM is the month as a number from 1 to 12, DD is the day as a number from 1 to 31, YY is the year as a number from 00 to 99 (from 2000 to 2099). HH is the (optional) hour from 00 to 12. MM is the (optional) minute from 00 to 59.

-u user_name

Specifies the document user name to search for in the file reports.

-V

Specifies verbose mode, which causes the detailed form of the file report information to be displayed. This option is recommended, to provide the most detailed information about the content files.

-v document_version

Specifies the document version to search for in the file reports.

EXAMPLESThe following nsrnmdcr command searches file reports for the storage area filestore_01 of the repository babilon. The file reports searched are those created on December 22, 2007. The search looks for document names containing the (case-insensitive) string "mobile", with the folder name mobilitydocs and version number 1.0. The documents were checked in from the client waterloo. Execute from the command line:

nsrnmdcr -B babilon -A filestore_01 -P "F:\Documentum\stores\FileReports" -T "20071222" -V -c "waterloo" -d "mobile" -f "mobilitydocs -v "1\.0"

Note: In the regular expression -v "1\.0" , the escape character is included before the dot.

SEE ALSOnsrnmdsv(1m), nsrnmdnx(1m), nsrnmdcr(1m), nsr_getdate(3), nsr_service(5), nsr(1m), nwrecover(1m)


nsrnmdcr(1m)


nsrnmdde(1m)

Maintenance Procedures nsrnmdde(1m)

NAMEnsrnmdde - NetWorker Module for Documentum Content Server operations command

SYNOPSISnsrnmdde -o query [SA_FULL_LIST | SA_INCR_LIST] [-n number_of_subdirectories][-F number_of_listing_files -P location] [-M MD] [FTI_LIST] [-C] [-D]

nsrnmdde -o quiesce_backup | -o quiesce_recover | -o unquiesce_backup |-o unquiesce_recover [-a suspend] [-a shutdown] [-a RO] [-f ALL] [SA_FULL_LIST][-T timeout]

where:SA_FULL_LIST is -s name | -s ALLSA_INCR_LIST is -t storage_area_name:start_ticket:end_ticketFTI_LIST is -f name | -f ALL

DESCRIPTIONThe nsrnmdde command queries Documentum Content Server repository storage areas, full-text indexes, and installation and configuration files information, as well as the underlying database name and type. It also provides options to quiesce and unquiesce storage areas and full-text indexes for both backup and recovery operations.

This command is used by the nsrnmdsv and nsrnmdrs commands.

DM_HOME, DOCUMENTUM, DOCUMENTUM_SHARED, CLASSPATH, PATH and NMDDE_DM_DOCBASE must be set in the environment before this command can be invoked. NMDDE_DM_DOCBASE must point to the name of the repository. The user name and password required to connect to the repository can be set by using NMDDE_DM_USER and NMDDE_DM_PASSWD environment variables.

OPTIONS

-o query

Queries the corresponding Documentum Content Server components, and their subdirectories and files.

-o quiesce_backup

Quiesces the storage area or full-text indexes for the backup.

-o unquiesce_backup

Unquiesces the storage area or full-text indexes in quiesce state for the backup.

-o quiesce_recover

Quiesces the storage area or full-text indexes for the recovery.

-o unquiesce_recover

Unquiesces the storage area or full-text indexes in quiesce state for the recovery.

-s name

Specifies the name of a storage area.

-s ALL

Specifies all the storage areas in the given repository.

-t storage_area_name:start_ticket:end_ticket

Specifies all the subdirectories and/or files of storage area changed within the interval between start_ticket and end_ticket.


nsrnmdde(1m)

-f name

Specifies the name of a full-text index.

-f ALL

Specifies all the full-text indexes in the given repository.

-n number_of_subdirectories

Specifies the approximate number of subdirectories of the storage area that should be returned when querying a storage area.

-F number_of_listing_files

Specifies the maximum number of listing files for each storage area query.

-P location

Specifies the directory path that the listing files will be stored.

-M MD

Generates the file reports for the storage areas specified by -s or -t options.

-C

Queries the installation and configuration file locations.

-D

Queries the type and name of the database.

-a RO

Puts the storage area in read-only mode for the quiesce. Use it with caution.

-a suspend

Suspends the corresponding storage area or full-text index Documentum jobs for the quiesce.

-a shutdown

Disable the full-text engine for the quiesce.

-T timeout

Specifies the timeout value in seconds.

DIAGNOSTICSExit codes

0

Normal exit.

<>0

Abnormal exit. The nsrnmdde command failed.

SEE ALSOnsrnmdsv(1m), nsrnmdnx(1m), nsrnmdrs(1m), nsrnmdcr(1m)


nsrnmdnx(1m)

Maintenance Commands nsrnmdnx(1m)

NAMEnsrnmdnx - NetWorker Module for Documentum index reporting command

SYNOPSISnsrnmdnx -B repository_name -T backup_tag [-c client_name] [-D debug_level][-s server_name] [-v]

nsrnmdnx -B repository_name [-L lower_bound_time] [-l backup_level] [-M backup_scope][-U upper_bound_time] [-c client_name] [-D debug_level] [-n count] [-s server_name] [-v]

where backup_scope is ALL | DB | DB_LOG | FTI [-a object_name] | FTI_ALL | ICF |SA [-a object_name] | SA_ALL

DESCRIPTIONThe nsrnmdnx command is used to search for and display information about NetWorker Module for Documentum backups. The command searches the NetWorker indexes for records of the backups. Searches can be performed based on the options -B (repository name), -T (backup tag), -L and -U (save times), -M (backup scope), and -l (backup level). Together these options are called the search criteria. The other options -c, -D, -n, -s, and -v affect the display of the backup information.

The -B option specifies the repository name. It is a mandatory option. All the other search criteria are optional. If only the repository name is set, the nsrnmdnx command returns the records for every backup of the repository, starting with the most recent and ending with the oldest.

The NetWorker Module assigns each backup a unique tag, which is an integer that identifies the specific backup. If the tag of a backup is known, the search can be performed by using the -T option. This is the most efficient type of search. When the -T option is used, do not specify other search criteria except for the -B option.

The -L and -U options specify the save time criteria. If the -L option is set, the nsrnmdnx command reports only the backups that occurred after the -L time. The report starts with the oldest backup and ends with the most recent. If the -U option is set the nsrnmdnx command reports only the backups that occurred before the -U time. The report starts with the most recent backup and ends with the oldest. If both the -L and -U options are set the nsrnmdnx command searches for all the backups that occurred between the -L and -U times. This is called a range search. For a range search, the nsrnmdnx command reports the most recent backup first and the oldest backup last. The time values specified with the -L and -U options are in nsr_getdate(3) format.

The -M option specifies the backup scope criteria. The option value can be ALL, DB, DB_LOG, FTI, FTI_ALL, ICF, SA or SA_ALL. The scope ALL is a system backup that backs up the database, (optionally) database logs, all the full-text indexes, (optionally) install and configuration files, and all the storage areas. The scope DB is a database backup, and DB_LOG is a backup of the database logs. The scope FTI is a backup of a specific full-text index. The scope FTI_ALL is a backup of all the full-text indexes. The scope ICF is a backup of the install and configuration files. The scope SA is a backup of a specific storage area. The scope SA_ALL is a backup of all the storage areas. If SA or FTI is specified, the additional option -a can also be set to specify the name of the object (storage area or full-text index) that was backed up.

The -l option specifies the backup level criteria. The backup level can be full or incr (for incremental).


nsrnmdnx(1m)

OPTIONS

-a object_name

Specifies the name of the backed-up object (storage area or full-text index) to search for. This option is only used when -M is set to SA or FTI.

-B repository_name

Specifies the name of the repository in the backup record.

-c client_name

Specifies the hostname of the NetWorker client whose index contains the backup information. If the -c option is not specified the local hostname is used.

-D debug_level

Specifies an integer value from 0 to 10 that determines the amount of debug information to print. A higher number produces more information. The default value is 0.

-L lower_bound_time

Specifies the time that is used as the lower boundary in a range search.

-l backup_level

Specifies the level of the backup to search for. The level can be full or incr.

-M backup_scope

Specifies the scope of the backup to search for. The scope can be ALL, DB, DB_LOG, FTI, FTI_ALL, ICF, SA, or SA_ALL.

-n count

Specifies the number of backup records to print.

-s server_name

Specifies the hostname of the NetWorker server to search for the backup records. If the -s option is not specified the local host is used as the server.

-T backup_tag

Specifies the unique tag that identifies a specific backup.

-U upper_bound_time

Specifies the time that is used as the upper boundary in a range search.

-v

Specifies that the long or verbose form of the backup records are to be printed.

EXAMPLES1. To search on the server jupiter for all the backup records for the repository foo that belong to the client mars, enter the following nsrnmdnx command:

nsrnmdnx -B foo -c mars -s jupiter

2. To search for all the backup records for the repository foo that have the scope SA_ALL and occurred before yesterday, enter the following nsrnmdnx command:

nsrnmdnx -B foo -M SA_ALL -U yesterday

3. To search for all the backup records for the repository foo that have scope ALL and occurred after the last week, enter the following nsrnmdnx command:

nsrnmdnx -B foo -M ALL -L "last week"

4. To search for all the backup records for the repository foo that have the scope FTI_ALL and occurred between last week and yesterday, enter the following nsrnmdnx command:

nsrnmdnx -B foo -M FTI_ALL -L "last week" -U yesterday


nsrnmdnx(1m)

5. To search for all the incremental backups of the storage area named bar in the repository foo, enter the following nsrnmdnx command:

nsrnmdnx -B foo -M SA -a bar -l incr

SEE ALSOnsrnmdsv(1m), nsrnmdcr(1m), nsrnmdrs(1m), nsrnmdde(1m), nsr_getdate(3)


nsrnmdnx(1m)


nsrnmdrs(1m)

Maintenance Procedures nsrnmdrs(1m)

NAMEnsrnmdrs - NetWorker Module for Documentum restore command, for restoring Documentum Server storage areas, full-text indexes, and installation files.

SYNOPSISnsrnmdrs [-B repository_name] -f config_file_path[-T backup_tag] | [-L lower_bound_time_stamp] | [-U upper_bound_time_stamp]-M ALL | -C SA [-a storage_area_name] | -C FTI [-a full_text_index_name] | -C ICF[-c client_name] [-D debug_level] [-d relocation_dir] [-i {nNyYrR}] [-p parallelism] [-P] [-s server_name]

DESCRIPTIONThe nsrnmdrs command browses the NetWorker Module for Documentum (NMD) backup index and restores selected components from a specified backup. The NetWorker Module for Documentum assigns each backup a unique tag, which is an integer that identifies the specific backup. The -T option can be used to restore a specific backup by its tag. If the -T is not used, the -L or -U options can specify a time (in nsr_getdate(3) format) for narrowing the search of backup records. If -T, -L and -U are not used, the latest backup that matches the criteria specified (with the -M or -C options) is presented for restore. The NMD index is created in the repository index namespace when files are saved with nsrnmdsv(1m). By default the restore is done in interactive mode. The user is presented with a view of matched Documentum components, and is given the option to proceed with the restore. To restore components without prompting, the -P option should be used. Either the -B option or the configuration file parameter NMDDE_DM_DOCBASE must be used to specify the Documentum repository to restore. The mandatory -f option must be used to specify the configuration file, which must be the same configuration file used for the backup with the nsrnmdsv command. The nsrnmdrs variables that are not specified on the command line will be read from the configuration file.

OPTIONS

-B repository_name

This optional option specifies the name of the Documentum repository to restore.

-f config_file_path

Specifies the full path to the configuration file name. This file contains NMD parameters and is required. Please see the NMD Administrators guide for the list of parameters that must be set in the configuration file.

-T unique_tag

Specifies a unique backup tag that NetWorker Module for Documentum assigns to a backup. The nsrnmdnx(1m) command must be used to determine a backup tag value.

-L lower_bound_time_stamp

Specifies the time to use as the lower boundary time. The restore process searches for the latest backup (matching the search criteria) that occurred between this boundary time and one day after the time. The time value must be in nsr_getdate(3) format, which includes most human readable date formats. For example, if -L "9/9/2007" is specified, the restore searches for the latest matching backup that occurred between 9/9/2007 and 9/10/2007 (see nsr_getdate(3) format). For example, if an NMD backup was taken on 9/9/2007, the option -L "9/9/2007" will find the NMD backup matching the criteria, as a backup that occurred between 9/9/2007 and 9/10/2007.

-U upper_bound_time_stamp

Specifies the time to use as the upper boundary time. The restore process searches for the latest backup (matching the search criteria) that occurred before this boundary time. The time value must be in nsr_getdate(3) format, which includes most human readable date formats. For example, if -U "9/10/2007"


nsrnmdrs(1m)

is specified, the restore searches for the latest matching backup that occurred before 9/10/2007.

-M ALL

Specifies that the restore process should seek an NMD backup of scope ALL (containing all storage areas and all full-text indexes). If such a repository record is found in the NetWorker indexes, all storage areas and all full-text indexes are restored to the default location or the location specified with the -d option.

-C SA [-a storage_area_name]

This option specifies that the restore process should seek an NMD backup for storage area(s). If the -a option is not specified (ie. -C SA), this will attempt to locate a repository backup record that contains all storage areas (Scope: ALL and SA_ALL). If however the -T unique_time_stamp option is used together with-C SA, the restore process will seek and restore all storage area(s) contained in the record. If the -a option is specified, this will attempt to locate a repository backup record that contains the particular storage area uniquely identified by the name.

-C FTI [-a full_text_index_name]

This option specifies that the restore process should seek an NMD backup for full-text index(es). If the -a option is not specified (ie. -C FTI), this will attempt to locate a repository backup record that contains all full-text indexes (Scope: ALL and FTI_ALL). If however the -T unique_time_stamp option is used together with -C FTI, the restore process will seek and restore all full-text indexes contained in the record. If the -a option is specified, this will attempt to locate a repository backup record that contains the particular full-text index uniquely identified by the name.

-C ICF

This option specifies that the restore process should proceed to seek and restore an NMD backup that contains installation and configuration Files.

-s server_name

Selects which NetWorker server to use. The server name may also be specified by the configuration file parameter NSR_SERVER.

-c client_name

client_name is the name of the machine that was originally specified for the backup, either through the -c option of the nsrnmdsv command or through the NSR_CLIENT parameter setting in the configuration file of the Content Server host -- for a distributed storage area configuration, the host is the primary host. The client_name may also be specified by the configuration file parameter NSR_CLIENT.

-D debug_level

Sets the debug level. The debug level may also be specified by the configuration file parameter NSR_DEBUG_LEVEL.

-d relocation_dir

Specifies the destination directory to relocate recovered files. Relative paths are interpreted relative to the current working directory. The relocation directory may also be specified by the configuration file parameter NSR_RELOCATION. For a full-text index restore, should include both the directory path and the full-text index name as the subdirectory.

-i {nNyYrR}

Specifies the initial default overwrite response when restoring an existing file. Only one of the letters n, N, y, Y, r, and R must be specified; if not specified the option defaults to N. This option is the same as the -i option of uasm in recover mode, where a lowercase letter value is mapped to uppercase. For more information, see uasm(1m). The initial default overwrite response may also be specified by the configuration file parameter NSR_CONFLICT_PROMPT.


nsrnmdrs(1m)

-p parallelism

Number of parallel sessions that will be used to perform the restore. The parallelism may also be specified by the configuration file parameter NSR_PARALLELISM.

-P

Turns propmting off. By default, user prompting is turned on.

EXAMPLES1. To restore the latest backup that contains all the storage areas for the repository docora10, enter the following command:

nsrnmdrs -B docora10 -f /space10/home/dmuser/nmd.cfg -C SA

2. To restore a specific storage area from the latest backup that occurred between 12/12/07 and 12/13/07 and relocate the storage area to the directory /space2/sa_dec12, enter the following nsrnmdrs command:

nsrnmdrs -B docora10 -f /space10/home/dmuser/nmd.cfg -L "12/12/07" -C SA-a filestore_01 -d /space2/sa_dec12

3. To restore all full-text indexes from the latest backup that occurred before today, enter the following nsrnmdrs command:

nsrnmdrs -B docora10 -f /space10/home/dmuser/nmd.cfg -U "today" -C FTI-d /space2/docora10_ftindex

4. To restore a specific full-text index from the latest backup, enter the following nsrnmdrs command:

nsrnmdrs -B docora10 -f /space10/home/dmuser/nmd.cfg -C FTI -a docora10_ftindex_01-d /space2/docora10_ftindex_01

5. To restore the installation and configuration files from the latest backup that occurred between 9/9/07 and 9/10/07, enter the following nsrnmdrs command:

nsrnmdrs -B docora10 -f /space10/home/dmuser/nmd.cfg -L "9/9/2007" -C ICF

SEE ALSOnsrnmdsv(1m), nsrnmdnx(1m), nsrnmdcr(1m), nsr_getdate(3), nsr_service(5), nsr(1m), nwrecover(1m)


nsrnmdrs(1m)


nsrnmdsv(1m)

Maintenance Procedures nsrnmdsv(1m)

NAMEnsrnmdsv - NetWorker Module for Documentum backup command

SYNOPSISnsrnmdsv -f config_file [-B repository] [-I client_name][-M ALL | SA_ALL | FTI_ALL | ICF | DB | DB_LOG] [-D debug_level] [save_options]

nsrnmdsv -f config_file [-B repository] [-M SA | FTI -a name] [-D debug_level] [save_options]

nsrnmdsv -P PASSWD_text [-M FTI] -f config_file

where save_options is [-c client] [-s server] [-l level] [-m tag_name] [-b pool][-g group] [-p parallelism] [-N saveset_name] [-q] [-v] [-w browse_time][-y retention_time] [savegrp_internal_options]

DESCRIPTIONThe nsrnmdsv command backs up the Documentum Content Server repository storage areas, full-text indexes, and installation and configuration files. It also provides options to back up the underlying database systems (e.g. Oracle, Sybase, and Microsoft SQL Server).

The nsrnmdsv command uses both the command line options and the parameters set in the configuration file, which is specified by the -f option. The same backup option can be specified either in the command line or in the configuration file. For example, either the -M command line option or the NMD_SCOPE parameter in the configuration file determines which repository components to be backed up in the given backup session.

Once the backup options are set, nsrnmdsv starts the backup workflow. If the storage areas and full-text indexes are included in the backup, the nsrnmdsv command first quiesces them by using nsrnmdde(1m) if they are included in the backup. The quiesce operation inactivates certain repository jobs and suspends the full-text index engine accordingly. After the quiesce is done, nsrnmdsv performs the backups of the repository components to NetWorker volumes by using the NetWorker save(1m) or nsrndmp_save(1m) command. If snapshot backups are enabled with the configuration file parameter NMD_USE_SNAPIMAGE, the nsrndmp_save(1m) command is used to perform snapshot-based backups of the repository storage areas through the NetWorker SnapImage Module. Once the backup of storage areas, database, and full-text indexes is completed, the nsrnmdsv command unquiesces the corresponding components by using nsrnmdde(1m). Documentum Content Server installation and configuration files can be backed up separately, or as a part of whole system backup.

OPTIONS

-f config_file

Specifies the configuration file pathname. The file must be created before the nsrnmdsv command is used. The configuration file contains the configuration parameters of NetWorker Module for Documentum. Refer to the NetWorker Module for Documentum Administrator's Guide for the full list of mandatory and optional configuration parameters.

Each line in the configuration file must have the following format: <parameter_name>=<parameter_value>

For example:#Configuration file parametersDM_HOME=/space12/documentum/product/5.3SP3


nsrnmdsv(1m)

DOCUMENTUM=/space12/documentumDB_FULL_BACKUP_CMD=/space10/home/dmuser/dbfullcmdDB_INCR_BACKUP_CMD=/space10/home/dmuser/dbincrcmd

The command line options take precedence over the configuration file parameters.

-B repository

Specifies the repository name. If this option is not specified on the command line, it must be specified in the configuration file by the NMDDE_DM_DOCBASE parameter setting. The backup fails if this option is not set in either location.

-I client_name

Used only for a SnapImage mode scheduled backup of the storage area; it is ignored by the nsrnmdsv command.

-M ALL | SA_ALL | FTI_ALL | ICF | DB | DB_LOG | SA|FTI

Specifies the backup scope. If this option is not specified on the command line, it must be be specified in the configuration file by the NMD_SCOPE parameter setting. The backup fails if this option is not set in either location.

The scope ALL is a system backup that backs up all the storage areas, full-text indexes, and database. In other words, the scope ALL includes the scopes SA_ALL, FTI_ALL and DB. A system backup may include installation and configuration files if the ICF_INCLUDED parameter is set in the configuration file.

The scope SA_ALL backs up all the storage areas in the given repository.

The scope FTI_ALL backs up all the full-text indexes in the given repository.

The scope ICF backs up all the installation and configuration files of the given repository.

The scope DB backs up the database through the command specified by the configuration file parameter NMD_DB_<level>_BACKUP_CMD. If the parameter NMD_DB_LOG_BACKUP_CMD is set, the scope DB also runs the NMD_DB_LOG_BACKUP_CMD command after the NMD_DB_<level>_BACKUP_CMD command. Depending on the type of underlying database system, the user must create the script or batch file that performs the backup of the corresponding database.

The scope DB_LOG backs up the database transaction logs through the command specified by the configuration file parameter NMD_DB_LOG_BACKUP_CMD.

The scope SA backs up a single storage area, whose name is provided by the -a option or the configuration file parameter NMD_OBJECT_NAME.

The scope FTI backs up a single full-text index, whose name is provided by the -a option or the configuration file parameter NMD_OBJECT_NAME.

-a name

Specifies the storage area or full-text index name depending on the backup scope. This option or the configuration file parameter NMD_OBJECT_NAME must be set if the backup scope is SA or FTI.

-D debug_level

Specifies the debug level. The default level (0) does not produce any debug messages. The debug level may also be specified using the configuration file parameter NSR_DEBUG_LEVEL.

-P PASSWD_text [-M FTI]

Without the -M FTI option, specifies the password of a repository user to connect to the Documentum Content Server. The password is encrypted by the nsrnmdsv command, and appended to the configuration file. The corresponding parameters NMDDE_DM_USER and NMDDE_DM_PASSWD are mandatory.


nsrnmdsv(1m)

With the -M FTI option, specifies the password of the full-text index user for quiesce and unquiesce operation during a backup of a remote full-text index. The password is encrypted by the nsrnmdsv command, and appended to the configuration file as the value of parameter NMD_FTI_PASSWD. This option and -M FTI are mandatory for setting the parameter NMD_FTI_PASSWD.

The nsrnmdsv command does not support the setting of NMDDE_DM_PASSWD and NMD_FTI_PASSWD as clear text. Only the -P option may be used to set NMDDE_DM_PASSWD and NMD_FTI_PASSWD in the configuration file. Each parameter must not appear more than once in the configuration file.

-c client

Specifies the hostname of the NetWorker client for starting the save session. For more information, refer to save(1m) and nsrndmp_save(1m). The client name may also be specified by the configuration file parameter NSR_CLIENT.

-s server

Specifies the hostname to use as the NetWorker server. For more information, refer to save(1m) and nsrndmp_save(1m). The server name may also be specified by the configuration file parameter NSR_SERVER.

-l level

Specifies the backup level for the NetWorker Module for Documentum. The supported backup levels are full, incr, and skip. A NetWorker backup level may also be specified with this option, but it will be converted to the corresponding NetWorker Module for Documentum backup level. The backup level incr only applies to storage area backups. The backup level may also be specified by the configuration file parameter NSR_BACKUP_LEVEL.

-m tag

For a scheduled backup only, specifies the tag to precede the summary line in the summary information generated.

-b pool

Specifies a NetWorker pool. For more information, refer to save(1m) and nsrndmp_save(1m). The pool may also be specified by the configuration file parameter NSR_DATA_VOLUME_POOL. The manual backups fails if this option is not set in either location.

-g group

Specifies a NetWorker group. For more information, refer to save(1m) and nsrndmp_save. The group may also be specified by the configuration file parameter NSR_GROUP. The manual backups fail if this option is not set in either location.

-p parallelism

Specifies the maximum number of concurrent NetWorker save sessions. The parallelism may also be specified by the configuration file parameter NSR_PARALLELISM.

-N saveset_name

Specifies the symbolic name of the save set. The save set name may also be specified by the configuration file parameter NSR_SAVESET_NAME.

-q

Specifies quiet mode, which displays only summary information and error messages for save(1m) or nsrndmp_save(1m). For more information, refer to save(1m) and nsrndmp_save(1m). The quiet mode may also be specified by the configuration file parameter NSR_QUIET.

-v

Specifies verbose mode, which causes the save program to provide great detail about the save as it proceeds. For more information, refer to save(1m) and nsrndmp_save(1m). The verbose mode may also be specified by the configuration file parameter NSR_VERBOSE.


nsrnmdsv(1m)

-w browse_time

Specifies the date (in nsr_getdate(3) format) after which this save set will no longer be browsable. By default, the server determines the browse date for the save set based on the browse policies in effect. For more information, refer to save(1m) and nsrndmp_save(1m). The browse time may also be specified by the configuration file parameter NSR_SAVESET_BROWSE.

-y retention_time

Specifies the date (in nsr_getdate(3) format) when the saved data will become recyclable. By default, the server determines this date for the save set based on the retention policies in effect. For more information, refer to save(1m) and nsrndmp_save(1m). The retention time may also be specified by the configuration file parameter NSR_SAVESET_RETENTION.

savegrp_internal_options

These options are used internally by the savegrp command.

EXAMPLES1. Create the configuration file with the following mandatory parameter settings:

cat /space10/home/dmuser/scripts/nmd.cfg

DOCUMENTUM=/space12/documentumDOCUMENTUM_SHARED=/space12/documentum/shared/5.3SP3 DM_HOME=/space12/documentum/product/5.3SP3NMDDE_DM_USER=dmuserNSR_SERVER=birdman.legato.comNSR_GROUP=NMD_groupNSR_DATA_VOLUME_POOL=NMD_poolCLASSPATH=/usr/sbin/nsrnmdde.jar:/space12/documentum/shared/5.3SP3/dctm.jar:/space12/documentum/product/5.3SP3/bin:/space12/documentum/shared/5.3SP3/dfc/dfc.jarLD_LIBRARY_PATH=/space12/documentum/product/5.3SP3/binPATH=/space12/documentum/product/5.3SP3/bin:/space12/documentum/dba:/usr/local/bin:/usr/sbin:/usr/ucbJAVA_PATH=/space12/documentum/shared/5.3SP3/java/1.4.2_11/binNMD_DB_FULL_BACKUP_CMD=/space10/home/dmuser/scripts/dbfullcmdNMD_DB_INCR_BACKUP_CMD=/space10/home/dmuser/scripts/dbincrcmd

Set the NMDDE_DM_PASSWD parameter in the configuration file by entering the following nsrnmdsv command:

nsrnmdsv -f /space10/home/dmuser/scripts/nmd.cfg -P password_of_dmuser

Set the NMD_FTI_PASSWD parameter in the configuration file by entering the following nsrnmdsv command:

nsrnmdsv -f /space10/home/dmuser/scripts/nmd.cfg -P password_of_ftiuser -M FTI

2. Perform a full system backup of the repository docora10 by entering the following nsrnmdsv command:

nsrnmdsv -f /space10/home/dmuser/nmd.cfg -B docora10 -M ALL -l full

3. Perform an incremental system backup of the repository docora10 by entering the following nsrnmdsv command:

nsrnmdsv -f /space10/home/dmuser/nmd.cfg -B docora10 -M ALL -l incr

4. Perform an incremental backup of the storage area filestore_01 of the repository docora10 by entering the following nsrnmdsv command:

nsrnmdsv -f /space10/home/dmuser/nmd.cfg -B docora10 -M SA -a filestore_01 -l incr

Note: The first time an incremental backup is performed for a given backup scope (for example, the backup scope SA), the backup is performed as a full backup by default.


nsrnmdsv(1m)

DIAGNOSTICSExit codes

0

Normal exit. The NetWorker Module for Documentum successfully completed the backup to the NetWorker server. If file report generation is enabled but fails at the end of the backup, nsrnmdsv still returns the 0 exit code but generates warning messages accordingly.

<>0

Abnormal exit. The NetWorker Module for Documentum backup failed fully or partially.

SEE ALSOnsrnmdde(1m), nsrnmdnx(1m), nsrnmdrs(1m), save(1m), nsrndmp_save(1m), savegrp(1m)

LOGSThe nsrnmdsv command generates a debug log file if the NSR_DEBUG_FILE parameter is set in the configuration file and the debug level is greater than 0.


nsrnmdsv(1m)


emc networker module for documentum - nsrd.info networker module for documentum release 1.2...

Documents