Contents

Dell NetWorker 19.1 Software Command Reference Guide PDF

1 of 624
1 of 624

Summary of Content for Dell NetWorker 19.1 Software Command Reference Guide PDF

Dell EMC NetWorker Version 19.1.x

Command Reference Guide 302-005-694

Rev 02

August 2019

Copyright 1990-2019 Dell Inc. or its subsidiaries. All rights reserved.

Dell 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. DELL 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 DELL SOFTWARE DESCRIBED

IN THIS PUBLICATION REQUIRES AN APPLICABLE SOFTWARE LICENSE.

Dell Technologies, Dell, EMC, Dell EMC and other trademarks are trademarks of Dell Inc. or its subsidiaries. Other trademarks may be the property

of their respective owners. Published in the USA.

Dell EMC Hopkinton, Massachusetts 01748-9103 1-508-435-1000 In North America 1-866-464-7381 www.DellEMC.com

2 Dell EMC NetWorker Command Reference Guide

Preface

As part of an effort to improve product lines, periodic revisions of software and hardware are released. Therefore, all versions of the software or hardware currently in use might not support some functions that are described in this document. The product release notes provide the most up-to-date information on product features.

If a product does not function correctly or does not function as described in this document, contact a technical support professional.

Note: This document was accurate at publication time. To ensure that you are using the latest version of this document, go to the Support website https:// www.dell.com/support.

Purpose

This document contains information about NetWorker command usage.

Audience

This document is intended for use by system administrators.

Revision history

The following table presents the revision history of this document.

Table 1 Revision history

Revision Date Description

02 August 14, 2019 Updated for the NetWorker 19.1.1 release.

01 May 20, 2019 First release of this document for NetWorker 19.1.

Related documentation

The NetWorker documentation set includes the following publications, available on the Support website:

l NetWorker E-LAB Navigator Provides compatibility information, including specific software and hardware configurations that NetWorker supports. To access E-LAB Navigator, go to https://elabnavigator.emc.com/eln/elnhome.

l NetWorker Administration Guide Describes how to configure and maintain the NetWorker software.

l NetWorker Network Data Management Protocol (NDMP) User Guide Describes how to use the NetWorker software to provide data protection for NDMP filers.

l NetWorker Cluster Integration Guide Contains information related to configuring NetWorker software on cluster servers and clients.

l NetWorker Installation Guide Provides information on how to install, uninstall, and update the NetWorker software for clients, storage nodes, and servers on all supported operating systems.

Dell EMC NetWorker Command Reference Guide 3

l NetWorker Updating from a Previous Release Guide Describes how to update the NetWorker software from a previously installed release.

l NetWorker Release Notes Contains information on new features and changes, fixed problems, known limitations, environment and system requirements for the latest NetWorker software release.

l NetWorker Command Reference Guide Provides reference information for NetWorker commands and options.

l NetWorker Data Domain Boost Integration Guide Provides planning and configuration information on the use of Data Domain devices for data deduplication backup and storage in a NetWorker environment.

l NetWorker Performance Optimization Planning Guide Contains basic performance tuning information for NetWorker.

l NetWorker Server Disaster Recovery and Availability Best Practices Guide Describes how to design, plan for, and perform a step-by-step NetWorker disaster recovery.

l NetWorker Snapshot Management Integration Guide Describes the ability to catalog and manage snapshot copies of production data that are created by using mirror technologies on storage arrays.

l NetWorkerSnapshot Management for NAS Devices Integration Guide Describes how to catalog and manage snapshot copies of production data that are created by using replication technologies on NAS devices.

l NetWorker Security Configuration Guide Provides an overview of security configuration settings available in NetWorker, secure deployment, and physical security controls needed to ensure the secure operation of the product.

l NetWorker VMware Integration Guide Provides planning and configuration information on the use of VMware in a NetWorker environment.

l NetWorker Error Message Guide Provides information on common NetWorker error messages.

l NetWorker Licensing Guide Provides information about licensing NetWorker products and features.

l NetWorker REST API Getting Started Guide Describes how to configure and use the NetWorker REST API to create programmatic interfaces to the NetWorker server.

l NetWorker REST API Reference Guide Provides the NetWorker REST API specification used to create programmatic interfaces to the NetWorker server.

l NetWorker 19.1 with CloudBoost 19.1 Integration Guide Describes the integration of NetWorker with CloudBoost.

l NetWorker 19.1 with CloudBoost 19.1 Security Configuration Guide Provides an overview of security configuration settings available in NetWorker and Cloud Boost, secure deployment, and physical security controls needed to ensure the secure operation of the product.

l NetWorker Management Console Online Help Describes the day-to-day administration tasks performed in the NetWorker Management Console and the NetWorker Administration window. To view the online help, click Help in the main menu.

Preface

4 Dell EMC NetWorker Command Reference Guide

l NetWorker User Online Help Describes how to use the NetWorker User program, which is the Windows client interface, to connect to a NetWorker server to back up, recover, archive, and retrieve files over a network.

Online help for commands

Help for commands is also available from the command line.

l The information available in this document is also available from the command line for any platform except Windows. To access this help from the command line, type man command_name, for example: man recover

Note: The optional package, LGTOman must be installed to access help using the man command. The operating system path environment variable must also include the location of the man pages, otherwise, you must run the man command from the installed location of the man pages

l To access basic help for any NetWorker command on any platform, type command_name -help from the command line, for example: recover -help

Note: Basic help is limited to a list of the commands arguments, options, and parameters. More complete information is contained in this document.

Special notice conventions that are used in this document

The following conventions are used for special notices:

NOTICE Identifies content that warns of potential business or data loss.

Note: Contains information that is incidental, but not essential, to the topic.

Typographical conventions

The following type style conventions are used in this document:

Table 2 Style conventions

Bold Used for interface elements that a user specifically selects or clicks, for example, names of buttons, fields, tab names, and menu paths. Also used for the name of a dialog box, page, pane, screen area with title, table label, and window.

Italic Used for full titles of publications that are referenced in text.

Monospace Used for:

l System code

l System output, such as an error message or script

l Pathnames, file names, file name extensions, prompts, and syntax

l Commands and options

Monospace italic Used for variables.

Monospace bold Used for user input.

[ ] Square brackets enclose optional values.

Preface

Dell EMC NetWorker Command Reference Guide 5

Table 2 Style conventions (continued)

| Vertical line indicates alternate selections. The vertical line means or for the alternate selections.

{ } Braces enclose content that the user must specify, such as x, y, or z.

... Ellipses indicate non-essential information that is omitted from the example.

You can use the following resources to find more information about this product, obtain support, and provide feedback.

Where to find product documentation

l https://www.dell.com/support

l https://community.emc.com

Where to get support

The Support website https://www.dell.com/support provides access to product licensing, documentation, advisories, downloads, and how-to and troubleshooting information. The information can enable you to resolve a product issue before you contact Support.

To access a product-specific page:

1. Go to https://www.dell.com/support.

2. In the search box, type a product name, and then from the list that appears, select the product.

Knowledgebase

The Knowledgebase contains applicable solutions that you can search for either by solution number (for example, KB000xxxxxx) or by keyword.

To search the Knowledgebase:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Knowledge Base.

3. In the search box, type either the solution number or keywords. Optionally, you can limit the search to specific products by typing a product name in the search box, and then selecting the product from the list that appears.

Live chat

To participate in a live interactive chat with a support agent:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Contact Support.

3. On the Contact Information page, click the relevant support, and then proceed.

Service requests

To obtain in-depth help from Licensing, submit a service request. To submit a service request:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Service Requests.

Preface

6 Dell EMC NetWorker Command Reference Guide

Note: To create a service request, you must have a valid support agreement. For details about either an account or obtaining a valid support agreement, contact a sales representative. To get the details of a service request, in the Service Request Number field, type the service request number, and then click the right arrow.

To review an open service request:

1. Go to https://www.dell.com/support.

2. On the Support tab, click Service Requests.

3. On the Service Requests page, under Manage Your Service Requests, click View All Dell Service Requests.

Online communities

For peer contacts, conversations, and content on product support and solutions, go to the Community Network https://community.emc.com. Interactively engage with customers, partners, and certified professionals online.

How to provide feedback

Feedback helps to improve the accuracy, organization, and overall quality of publications. You can send feedback to DPAD.Doc.Feedback@emc.com.

Preface

Dell EMC NetWorker Command Reference Guide 7

Preface

8 Dell EMC NetWorker Command Reference Guide

NetWorker 19.1.1 4

Maintenance Commands nsrd ( 1m )

NAME nsrd daemon providing the NetWorker service

SYNOPSIS nsrd

ansrd [ commentary ]

DESCRIPTION The nsrd daemon provides an RPC-based save and recover service. This service allows users to save, query for, and recover their les across a network. The RPC program number provided by nsrd is 390103.

Normally nsrd is invoked from a startup shell script (for example rc.local , rc.boot) at boot-time, and should never need to be started directly by a user. After it is started, nsrd starts up the other daemons it needs to provide the NetWorker service. Starting with NetWorker version 9.0, nsrctld starts NetWorker services and nsrd is spawned by nsrctld.

The nsrd command must be run on a machine with appropriate resources. Required resources include both devices, such as tape drives, and sufcient disk space for the index daemons, (see nsrindexd(1m) and nsrmmdbd(1m)). The devices are controlled by multiplexor software (see nsrmmd(1m)), and the disk space is used to maintain the index of saved user les and volumes with corresponding les.

Each time a backup, recover, or another session begins, nsrd starts the program, ansrd, to process the requested session. The ansrd program is called an agent . The agent is in charge of monitoring that backup, recover, or another session, and automatically exits when a session completes. Using ps(1) or another process monitoring tool, you can inspect the subsequent parameters of ansrd to see what kind of session it is moni- toring. If necessary, agents can be forcibly terminated to abort a backup or recover session. Agents cannot be run directly; they can only be started by nsrd.

FILES /nsr/logs/daemon.raw The le to which nsrd and other NetWorker daemons send information about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

/nsr/res/nsrdb Information describing the NetWorker service and its resources (See nsr_service(5)).

SEE ALSO nsr(1m), nsr_service(5), nsr_render_log(1m), nsrmmd(1m), nsrmmdbd(1m), nsrindexd(1m), ps(1), rc(1m)

NetWorker 19.1.1 5

Maintenance Commands ascdcode ( 1m )

NAME ascdcode print error message for ASC/ASCQ error codes

SYNOPSIS ascdcode [ -o vendor id [ p product id ] ] ASC ASCQ

DESCRIPTION The ascdcode program interprets Additional Sense Code (ASC) and Additional Sense Code Qualier (ASCQ) data and returns an appropriate error message. The ascdcode program returns interpreted ASC/ASCQ data either for the named vendor and pro- duct IDs (with the -o and -p options), or for all libraries or devices as dened in the SCSI-3 Specications (http://www.ncits.org) or individual vendors. For unimple- mented ASC/ASCQ codes, the ascdcode program will return the message Not imple- mented.

OPTIONS o vendor id Checks to see if the vendor is an OEM and looks up the ASC/ASCQ error codes dened original vendor for the library or device. If the p option is not specied, ascdcode will return vendor specic information for the vendor id specied with this option. The vendor id should be identical to the vendor string reported when you run the inquire program. For a complete list of ven- dor ID assignments, see the web page: http://www.t10.org/lists/vid-alph.htm. This option is only applicable to vendor specic ASC/ASCQ codes of value(s) greater than 0x7f.

p product id Use with o to provide a library or device type with the OEM vendor. The product id should be identical to the library or device string reported when you run the inquire program.

The ASC argument should be the rst of the pair of ASC/ASCQ error codes reported by the library or device. You may specify the value as a hexadecimal number by preceding the value with 0x . The default value is assumed to be a decimal value.

The ASCQ argument should be the latter of the pair of ASC/ASCQ error codes reported by the library or device. You may specify the value as a hexadecimal number by preceding the value with 0x . The default value is assumed to be a decimal value.

FILES /INSTALL_PATH/lgtovendors The directory where the vendor specic les are installed.

/INSTALL_PATH/lgtovendors/OEM_MAP The le that maps OEM vendors and their corresponding products to origi- nal vendors. See the le for a description on how to add entries for new OEM vendors and products.

SEE ALSO libscsi(1m)

LIMITATIONS The ascdcode program always uses the installed vendor specic les to look up ven- dor specic error messages. Formatting convention of ASC/ASCQ error codes and their corresponding error text in these les are of the form:

0x[ASC], 0x[ASCQ], [error message]

NetWorker 19.1.1 6

Maintenance Commands cdi_block_limits ( 1m )

NAME cdi_block_limits query block size limits on a tape device

SYNOPSIS cdi_block_limits f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_block_limits program queries block size limits on a tape device. The cdi_block_limits program returns the block size limits for the named SCSI device (with the -f option). Note that a devices block size limits may be larger than the operating systems limits. This program specically returns the devices block size lim- its.

OPERANDS f device Species the device to obtain block size information from.

OPTIONS t Use the t option to specify the method of tape functions to use to query block size limits. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) man- page for a complete list of access methods currently supported by the cdi_block_limits program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_block_limits -f /dev/rmt/2cbn

Block size limits returned from accessed through /dev/rmt/2cbn maximum block size allowed is 16776128 minimum block size allowed is 61301

cdi_info.drivestat is: status = 1, DRIVE_STATUS_NO_ERROR msg = Drive reports no error - but state is unknown

SEE ALSO libcdi(1m)

NetWorker 19.1.1 7

Maintenance Commands cdi_bsf ( 1m )

NAME cdi_bsf issue a backward space le SCSI command to a tape device

SYNOPSIS cdi_bsf f device n count [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_bsf program issues a backward space le (bsf) SCSI command to a tape dev- ice. The cdi_bsf program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the bsf SCSI command to.

n count The le count for the bsf SCSI command. The "-n count" parameter is required.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the bsf SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_bsf program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_bsf -f /dev/rmt/2cbn -n 2

CDI_BSF 2 successful. elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 8

Maintenance Commands cdi_bsr ( 1m )

NAME cdi_bsr issue a backward space record command to a tape device

SYNOPSIS cdi_bsr f device n count [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_bsr program issues a backward space record (bsr) SCSI command to a tape device. The cdi_bsr program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to which to send the bsr SCSI command.

n count The record count for the bsr SCSI command.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the bsr SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_bsr program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_bsr -f /dev/rmt/2cbn -n 2 -v

CDI_GET_VERSION returns 1 CDI_BSR 2 successful.

elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 9

Maintenance Commands cdi_eod ( 1m )

NAME cdi_eod send an end of data SCSI command to a tape device

SYNOPSIS cdi_eod f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_eod program sends an end of data (eod) SCSI command to a tape device. The cdi_eod program also returns the status of the named SCSI device (with the -f option).

OPERANDS f device Species the device to issue the eod SCSI command to. The f option is a required option.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the eod SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for a complete list of access methods currently supported by the cdi_eod program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_eod -f /dev/rmt/2cbn

CDI_EOD successful. elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 10

Maintenance Commands cdi_lemark ( 1m )

NAME cdi_lemark issue a write lemark/setmark command to a tape device

SYNOPSIS cdi_lemark f device [ a ] [ n count ] [ s ] [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_lemark program issues a write lemark/setmark SCSI command to a given device. The cdi_lemark program also returns the status of the named SCSI device (specied by the -f option). The default behavior is to write a single lemark to the specied device.

OPERANDS f device Species the device to send the write lemark SCSI command to.

OPTIONS a Use asynchronous I/O for the operation. Rather than blocking till completion, the program will return immediately. The default is synchronous I/O.

n count The lemark count for the write lemark SCSI command. The default count is 1.

s Write a setmark instead of a lemark for the operation.

t Use the t option to specify the method of tape functions to use for the write lemark SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently sup- ported by the cdi_lemark program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_lemark -f /dev/rmt/2cbn -n 2 -v

CDI_GET_VERSION returns 1 CDI_WRITE_FILEMARKS 2 successful.

elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 11

Maintenance Commands cdi_fsf ( 1m )

NAME cdi_fsf issue a forward space le SCSI command to a tape device

SYNOPSIS cdi_fsf f device n count [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_fsf program issues a forward space le (fsf) SCSI command to a tape device. The cdi_fsf program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the fsf SCSI command to. The f option is a required option.

n count The le count for the fsf SCSI command.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the fsf SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_fsf program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_fsf -f /dev/rmt/2cbn -n 2

CDI_FSF 2 successful. elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 12

Maintenance Commands cdi_fsr ( 1m )

NAME cdi_fsr issue a forward space record command to a tape device

SYNOPSIS cdi_fsr f device n count [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_fsr program issues a forward space record (fsr) SCSI command to a tape dev- ice. The cdi_fsr program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the fsr SCSI command to.

n count The record count for the fsr SCSI command.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the fsr SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_fsr program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_fsr -f /dev/rmt/2cbn -n 2 -v

CDI_GET_VERSION returns 1 CDI_FSR 2 successful.

elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 13

Maintenance Commands cdi_get_cong ( 1m )

NAME cdi_get_cong - get conguration information on a tape device

SYNOPSIS cdi_get_cong f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_get_cong program obtains conguration information on a tape device. The data output from this command is collected from the SCSI Mode Sense disconnect/reconnect, data compression and device conguration pages.

OPERANDS f device Species the device to obtain conguration information from.

OPTIONS t Use the t option to specify the method of tape functions to use to query the device for conguration information. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for a complete list of access methods currently supported by the cdi_get_cong program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_get_cong -f /dev/rmt/2cbn -v

CDI_GET_VERSION returns 1 SCSI cong info for via /dev/rmt/2cbn:

active_format 000d active_partition 00b8 write_full_ratio 0000 read_empty_ratio 007e write_delay_time c950 ags 000000009cef2080

Parameters Savable Change Active Format Data Buffer Recovery Block Identiers Supported Report Setmarks Stop On Consecutive Filemarks: Stop On 3 Consecutive Filemarks Recover Buffer Order Report Early Warning EOD dened: Reserved (4) Enable EOD Generation Sync at Early Warning Soft Write Protection

buffer_size_early_warning 00b80000 data_compress_algorithm 0000 discon_buffer_full 00ad discon_buffer_empty 00b8 discon_bus_inactive 007e discon_time_limit c950 discon_connect_time_limit ef75 discon_max_burst_time 9eb8 compression_algorithm 007ec950 decompression_algorithm ef759eb8

NetWorker 19.1.1 14

Maintenance Commands cdi_get_cong ( 1m )

cdi_info.drivestat is: status = 1, DRIVE_STATUS_NO_ERROR msg = Drive reports no error - but state is unknown

SEE ALSO libcdi(1m)

NetWorker 19.1.1 15

Maintenance Commands cdi_get_status ( 1m )

NAME cdi_get_status get status information from a tape device

SYNOPSIS cdi_get_status f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_get_status program obtains status information from a tape device. The data returned include tape density and block position.

OPERANDS f device Species the device to obtain status information from.

OPTIONS t Use the t option to specify the method of tape functions to use to query the device for status information. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for a complete list of access methods currently sup- ported by the cdi_get_status program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output from cdi_get_status:

% cdi_get_status -f /dev/rmt/2cbn

CDI_GET_STATUS returns: DRIVE_STATUS_READY current density code = 00 position is absolute block number 0

SEE ALSO libcdi(1m)

NetWorker 19.1.1 16

Maintenance Commands cdi_inq ( 1m )

NAME cdi_inq get inquiry information from a tape device

SYNOPSIS cdi_inq f device [ v ] [ t{ s t g n m i } ]

DESCRIPTION The cdi_inq program obtains inquiry information from a tape device. The data returned include Vital Product Data (VPD) pages. Note that the inquire (1m) com- mand can be used for a more comprehensive output of the serial number identiers.

OPERANDS f device Species the device to obtain inquiry information from.

OPTIONS t Use the t option to specify the method of tape functions to use to query the device for inquiry information. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for a complete list of access methods currently sup- ported by the cdi_inq program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output from cdi_inq:

% cdi_inq -f /dev/rmt/2cbn

Standard Inquiry data: Vendor: Product: Rev:

VPD pages supported: Pages

cdi_info.drivestat is: status = 1, DRIVE_STATUS_NO_ERROR msg = Drive reports no error - but state is unknown

% cdi_inq -f /dev/rmt/0cbn

Standard Inquiry data: Vendor: QUANTUM Product: DLT8000 Rev: 0232

VPD pages supported: Pages 00 80 83 c0 c1

Serial number page (80): CX940P2410

Device ID page (83): IENN:00E09E600006A114

Non-standard pages displayed only with -v parameter cdi_info.drivestat is:

status = 1, DRIVE_STATUS_NO_ERROR msg = Drive reports no error - but state is unknown

NetWorker 19.1.1 17

Maintenance Commands cdi_inq ( 1m )

SEE ALSO libcdi(1m)

NetWorker 19.1.1 18

Maintenance Commands cdi_load_unload ( 1m )

NAME cdi_load_unload load or unload a tape device

SYNOPSIS cdi_load_unload f device { l u } [ a ] [ e ] [ r ] [ v ] [ t{ s t g n m i } ]

DESCRIPTION The cdi_load_unload program loads or unloads medium into or from a tape device.

OPERANDS f device Species the device on which to perform the load/unload operation.

{ l u } Perform a load (-l) or unload (-u) medium operation.

OPTIONS a Use asynchronous I/O for the operation. Rather than blocking till completion, the program will return immediately. If this ag is set and CHECK CONDI- TION status is returned for the load/unload operation, the load or unload operation will not be performed. The default is synchronous I/O.

e Position to end-of-medium before unloading the medium. If this ag is specied with the l ag (i.e., load medium), the SCSI device will return CHECK CONDITION status and the sense key will be set to ILLEGAL REQUEST in the sense data.

r Apply the correct tension to the medium. Not all devices have the capability to re-tension media. Please refer to the specic device manuals to conrm whether the re-tension function is available for the device.

t Use the t option to specify the method of tape functions to use to load/unload medium. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for a complete list of access methods currently supported by the cdi_load_unload program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output from cdi_load_unload:

% cdi_load_unload -l -f /dev/rmt/2cbn

cdi load unload succeeds for via /dev/rmt/2cbn: elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 19

Maintenance Commands cdi_locate ( 1m )

NAME cdi_locate position to a given block on a tape mounted on a tape device

SYNOPSIS cdi_locate f device n block [ a ] [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_locate program positions to a given block on a tape mounted on a tape device.

OPERANDS f device Species the device to which to position.

n block Specify the block on a mounted tape to which to position.

OPTIONS a Use asynchronous I/O for the operation. Rather than blocking till completion, the program will return immediately. The default is synchronous I/O.

t Use the t option to specify the method of tape functions to use to position to a given block on tape. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for a complete list of access methods currently supported by the cdi_locate program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output from cdi_locate:

% cdi_locate -f /dev/rmt/2cbn -n 300

CDI_GET_STATUS returns: locate successful: position to block 300 took 0 seconds

cdi_info.drivestat is: status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 20

Maintenance Commands cdi_ofine ( 1m )

NAME cdi_ofine issue an ofine SCSI command to a tape device

SYNOPSIS cdi_ofine f device [ v ] [ t{ s t g n m i } ]

DESCRIPTION The cdi_ofine program issues an ofine SCSI command to a tape device. The cdi_ofine program also returns the status of the named SCSI device (specied by the -f option). This operation is synonymous to issuing a load with no re-tension, and rewind to the beginning of tape SCSI command.

OPERANDS f device Species the device to send the ofine request to. The f option is a required option.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the ofine SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_ofine program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_ofine -f /dev/rmt/2cbn

CDI_OFFLINE successful. elapsed time for command was 11 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = null

SEE ALSO libcdi(1m)

NetWorker 19.1.1 21

Maintenance Commands cdi_pr ( 1m )

NAME cdi_pr issue SCSI persistent reservation commands to a tape device

SYNOPSIS cdi_pr f device [ v ]

plus one of:

r { k r } c

plus one of:

r k key [ A ]

i k key [ A ]

c k key

p k new K old t { e E A w W a } a k key K old t { e E A w W a }

E k key

R k key t { e E A w W a } Q

DESCRIPTION The cdi_pr program issues various SCSI Persistent Reservation commands to a tape device. It is mainly intended as a tools for exploring the behavior of Persistent Reserve and should not normally be used for day-to-day operations.

You may also specify a persistent reservation key. This key is used to identify the host you are running on to the tape drive, and may be an 8 character text string (e.g. NetWorkr) or a text representation of a 64-bit hex number (e.g. 0x123456789abcdef0). The default reservation key is NetWorkr. This utility will always use the "exclusive access" type of persistent reservation.

The cdi_pr program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the reserve request to.

Subcommands:

r {r k} Read a drives current reservations ( r ) or keys ( k ) using Persistent Reserve In SCSI command.

c r k key [ A] Send a Persistent Reserve Out register command, with option APTPL bit.

c i k key [ A] Send a Persistent Reserve Out register command with ignore, with option APTPL bit.

c c k key Send a Persistent Reserve Out clear key command.

c p k key K oldkey t { e E a w W A } Send a Persistent Reserve Out preempt command to preempt the reservation held by key oldkey and replace it with a reservation for key key of type specied by t.

NetWorker 19.1.1 22

Maintenance Commands cdi_pr ( 1m )

a p k key K oldkey t { e E a w W A } Send a Persistent Reserve Out preempt and abort command to preempt the reservation held by key oldkey and replace it with a reservation for key key of type specied by t and abort any currently running tape command.

c r k key [ A] Send a Persistent Reserve Out Register command for key , with optional APTPL bit.

E k key Persistent Reserve Out Release command with specied key (confusing, isnt it?)

R k key t { e E A w W a } Persistent Reserve Out Reserve command with specied key and reservation type

Q Query the devices Persistent Reserve capabilities. (side effect is to clear any existing reservations and keys).

Parameters:

k persistent reserve key Species the key to use for a persistent reservation.

K persistent reserve key to preempt Species the key to preempt with this persistent reservation.

A persistent reservation key is a 64-bit value. This can hold 8 text characters or a 64-bit number. Specify either for this parameter. If the key entered starts with 0x (zero x) then it is assumed to be a 64-bit number, otherwise it will be treated as an 8 character text string. The default value if you do not specify a key is NetWorkr.

t reservation type Species the type of reservation to be made. Allowed values are:

a write exclusive - all registrants

A exclusive access - all registrants

e exclusive access - registrants only

E exclusive access

w write exclusive - registrants only

W write exclusive

For information on those allowed values, consult a SCSI-3 specication such as ANSI NCITS 351-2001 (SPC-2) or SPC-3 working draft T10/1416-D.

Options

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

NetWorker 19.1.1 23

Maintenance Commands cdi_pr ( 1m )

Query different drives for their Persistent Reserve capabilities

cdi_pr -f /dev/rmt/1cbn -Q

Device /dev/rmt/1cbn (HP Ultrium 2-SCSI ): supports Persistent Reserve but NOT Activate Persist Through Power Loss bit

cdi_pr -f /dev/rmt/0cbn -Q

Device /dev/rmt/0cbn (HP Ultrium 1-SCSI ): does not seem to support Persistent Reserve at all

Register from this host with the key "Solaris"

cdi_pr -c r -k Solaris -f /dev/rmt/1cbn

CDI_PR command Register succeeds Key "Solaris " was successfully registered cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

Read the keys from this drive

cdi_pr -f /dev/rmt/1cbn -r k

CDI_PR command Read Keys succeeds Read keys returns:

generation = 12 data length = 16 Keys:

"Solaris " "Windows "

cdi_info.drivestat is: status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

Reserve this drive using the previously registered key of "Solaris" with reservation type of Exclusive

cdi_pr f /dev/rmt/1cbn R k Solaris t E

CDI_PR command Reserve succeeds Reserve of type Exclusive Res only (3) with key "Solaris " was successful cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

NetWorker 19.1.1 24

Maintenance Commands cdi_pr ( 1m )

Read the reservations from this drive

cdi_pr -f /dev/rmt/1cbn -r r

CDI_PR command Read Reservations succeeds Read reservations returns:

generation = 12 data length = 16 Reservations:

Key: "Solaris ", type: Exclusive Res only (3), scope: LU, scope address: 0

cdi_info.drivestat is: status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

Release the reservation of this drive that was made using the key "Solaris" of type Exclusive

cdi_pr f /dev/rmt/1cbn E k Solaris t E

CDI_PR command Release succeeds Release with key "Solaris" was successful cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

If the drive is reserved by another host, you should see something like this:

cdi_pr -f /dev/rmt/1cbn -r r

CDI_PR command Read Reservations succeeds Read reservations returns:

generation = 12 data length = 16 Reservations:

Key: "Windows ", type: Exclusive Res only (3), scope: LU, scope address: 0

cdi_info.drivestat is: status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

cdi_pr f /dev/rmt/1cbn R k Solaris t E

CDI_PR command Reserve failed. cdi_info.status = CDI_RESERVATION_ERROR (c) cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

NetWorker 19.1.1 25

Maintenance Commands cdi_pr ( 1m )

SEE ALSO libcdi(1m), cdi_release(1m), cdi_reserve(1m)

NetWorker 19.1.1 26

Maintenance Commands cdi_release ( 1m )

NAME cdi_release issue a SCSI release command to a tape device

SYNOPSIS cdi_release f device [ T{ s p } ] [ k persistent reserve key ] [ v ] [ t{ s t g n

m i } ]

DESCRIPTION The cdi_release program issues a SCSI release command to a tape device. This will either be a "simple" SCSI release (default or T s ) or a persistent reservation release if you specify T p.

If you specify Persistent , you may also specify a persistent reservation key. This key is used to identify the host you are running on to the tape drive, and may be an 8 character text string (e.g. NetWorkr ) or a text representation of a 64-bit hex number (e.g. 0x123456789abcdef0 ). The default reservation key is NetWorkr. The key used (whether specied on the command line or the default) must match the key that was used to create the reservation. You can see any keys and persistent reservations for a particular drive using the cdi_pr utility. This utility will always use the "exclusive access" type of persistent reservation.

The cdi_release program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the release request to.

T type Species the type of the release command that you wish to issue. Use s or S for simple reserve, or p or P for persistent reservation release. The default is simple if you do not supply this operand.

k persistent reserve key Species the key to use for a persistent reservation release. A persistent reser- vation key is a 64-bit value. This can hold 8 text characters or a 64-bit number. You can specify either for this parameter. If the key entered starts with 0x (zero x) then it is assumed to be a 64-bit number, otherwise it will be treated as an 8 character text string. The default value if no key is specied is NetWorkr.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the release SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Refer to the libcdi (1m) man page for the complete list of access methods currently supported by the cdi_release program.

v Run the program in verbose mode. This option prints the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

CDI_RELEASE successful. cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

NetWorker 19.1.1 27

Maintenance Commands cdi_release ( 1m )

If the drive is reserved by another host, you should see something like this:

CDI_RELEASE failed. cdi_info.status = CDI_RESERVATION_ERROR (c) cdi_info.drivestat is:

status = 0, DEVICE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m), cdi_reserve(1m), cdi_pr(1m)

NetWorker 19.1.1 28

Maintenance Commands cdi_reserve ( 1m )

NAME cdi_reserve - issue a SCSI reservation command to a tape device

SYNOPSIS cdi_reserve f device [ T { s p } ] [ k persistent reserve key ] [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_reserve program issues a SCSI reservation command to a tape device. This will either be a "simple" SCSI reserve (default or T s ) or a persisitent reservation if you specify T p.

If you specify Persistent , you may also specify a persistent reservation key. This key is used to identify the host you are running on to the tape drive, and may be an 8 character text string (e.g. NetWorkr) or a text representation of a 64-bit hex number (e.g. 0x123456789abcdef0). The default reservation key is NetWorkr. This utility will always use the "exclusive access" type of persistent reservation.

The cdi_reserve program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the reserve request to.

T type Species the type of the reservation command that you wish to issue. use s or S for simple reserve, or p or P for persistent reserve. The default is simple if you do not supply this operand.

k persistent reserve key Species the key you wish to use for a persistent reservation. A persistent reser- vation command is a 64-bit value. This can hold 8 text characters or a 64-bit number. You can specify either for this parameter. If the key entered starts with 0x (zero x) then it is assumed to be a 64-bit number, otherwise it will be treated as an 8 character text string. The default value if you do not specify a key is NetWorkr.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the reserve SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_reserve program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

CDI_RESERVE successful. cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

If the drive is reserved by another host, you should see something like this:

CDI_RESERVE failed. cdi_info.status = CDI_RESERVATION_ERROR (c) cdi_info.drivestat is:

NetWorker 19.1.1 29

Maintenance Commands cdi_reserve ( 1m )

status = 0, DEVICE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m), cdi_release(1m), cdi_pr(1m)

NetWorker 19.1.1 30

Maintenance Commands cdi_rewind ( 1m )

NAME cdi_rewind - issue a rewind SCSI command to a tape device

SYNOPSIS cdi_rewind f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_rewind program issues a rewind SCSI command to a tape device. The cdi_rewind program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to which to send the rewind request.

OPTIONS t Use the t option to specify the method of tape functions to use to issue the rewind SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi(1m) page for the complete list of access methods currently supported by the cdi_rewind program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_rewind -f /dev/rmt/2cbn

CDI_REWIND successful. elapsed time for command was 2 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 31

Maintenance Commands cdi_set_359x_eod ( 1m )

NAME cdi_set_359x_eod - sets or clears IBM 3590, 3592 and TS1120 tape drives Disable Crossing EOD bit

SYNOPSIS cdi_set_359x_eod f device [ r ][ t {s t g n m i} ]

DESCRIPTION The cdi_set_359x_eod program uses mode sense and mode select commands to set a vendor-specic bit in IBM 3590, 3592 and TS1120 tape drives. These drives normally allow a program to read past the typical end of data marks on a tape which may allow a program to recover possibly overwritten data. However, this behavior confuses NetWorkers scanner utility, on some platforms causing a locked-up tape device which may require rebooting or power cycling to restore to normal operation.

If you are going to be using scanner on an IBM 3590, 3592 or TS1120 tape drive you should rst run cdi_set_359x_eod to tell the tape drive that it should not allow reading past the end of data.

To restore the default state of the tape drives, you can run cdi_set_359x_eod with the r ag which will reset (clear) the Disable Crossing EOD bit. Normal NetWorker operations do not seem to be affected by this bit either being set or cleared, so it is not really necessary to reset the bit after using scanner on a particular tape drive.

OPERANDS f device Species the device to perform the mode sense and mode select commands on. cdi_set_359x_eod will check the devices inquiry data to make sure that it is an IBM 3590, 3592 or TS1120 tape drive. If it is not, the command will exit with a message that includes the inquiry data retrieved from the specied device.

OPTIONS r Tells cdi_set_359x_eod to reset the Disable Crossing EOD bit back to the default (cleared) state.

t Use the t option to specify the method of tape functions to use to issue the SCSI mode sense and mode select commands. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi (1m) manpage for the complete list of access methods currently supported by the cdi_mode_sense program.

EXAMPLES % cdi_set_359x_eod -f /dev/rmt/47cbn 359x Mode Page 0x25 Disable Crossing EOD bit succesfully SET

% cdi_set_359x_eod -f /dev/rmt/47cbn -r 359x Mode Page 0x25 Disable Crossing EOD bit successfully

Reset to default value

% cdi_set_359x_eod -f /dev/rmt/11cbn The drive you are working with (EXABYTE Mammoth2) is not

an IBM 3590, 3592 or TS1120.

SEE ALSO libcdi(1m), cdi_mode_sense(1m), cdi_mode_select(1m)

NetWorker 19.1.1 32

Maintenance Commands cdi_set_compression ( 1m )

NAME cdi_set_compression - set or unset compression on a tape device

SYNOPSIS cdi_set_compression f device [ v ] [ c {Yes y 1 No n 0} ] [ t { s t g n

m i } ]

DESCRIPTION The cdi_set_compression program sets or unsets compression on a tape device. This program is functional only on NT. On all other OS platforms, the program does noth- ing but returns SUCCESS.

OPERANDS f device Species the device to perform the SCSI command operation. The f option is a required option.

OPTIONS c [Yes y 1 No n 0] Specify whether to set or unset compression on the tape device. Use Yes , y , or 1 to set compression on the tape device. Use No , n , or 0 to unset compression on the tape device. The default is to unset compression on a tape device.

t Use the t option to specify the method of tape functions to use to set/unset device compression. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi(1m) page for the complete list of access methods currently supported by the cdi_set_compression program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output from the cdi_set_compression program:

% cdi_set_compression -f /dev/rmt/2cbn -c 1

CDI_SET_COMPRESSION 0 successful.

% cdi_set_compression -f /dev/rmt/0cbn -c No

CDI_SET_COMPRESSION 0 successful.

SEE ALSO libcdi(1m)

NetWorker 19.1.1 33

Maintenance Commands cdi_space ( 1m )

NAME cdi_space - provides a variety of tape positioning functions.

SYNOPSIS cdi_space f device T { b f sf eod sm ssm } n count [ v ] [ t {s t g n m i} ]

DESCRIPTION The cdi_space program provides a variety of tape positioning operations to the user. The cdi_space program accepts block, lemark, setmark as valid tape positioning units. The cdi_space program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to perform the tape positioning operation on.

n count The unit count for the space SCSI command. If a count of 0 is specied, there will be no change in the tape position. If the count value is greater than 0, the tape positioning will be in the forward direction. A negative value for the count ag will cause the tape positioning to move backwards. This ag and its value are ignored if the tape positioning unit type is eod (end-of-data).

OPTIONS T { b f sf eod sm ssm } Specify the type of space positioning unit to use. Valid types of units are:

SYMBOL UNIT TYPE b block f lemark sf sequential lemark eod end-of-data sm setmark ssm sequential setmark

The default type is block.

t Use the t option to specify the method of tape functions to use to issue the space SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi(1m) page for the complete list of access methods currently supported by the cdi_space program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_space -f /dev/rmt/2cbn -T b -n 2

CDI_SPACE 2 successful. elapsed time for command was 0 seconds cdi_info.drivestat is:

status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 34

Maintenance Commands cdi_ta ( 1m )

NAME cdi_ta - get TapeAlert information from or set TapeAlert on a tape device

SYNOPSIS cdi_ta f device [ d ] [ i interval ] [ l ] [ m MRIE ] [ n testag ] [ s ] [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_ta program gets from or sets TapeAlert information on a tape device. The cdi_ta program also returns the status of the named SCSI device (specied by the -f option). Note that not all devices support the TapeAlert feature. If the device does not support the TapeAlert feature or the TapeAlert data returned by the device is invalid, cdi_ta will return the status CDI_IOCTL_ERROR (11). The set TapeAlert operation is currently not functional.

OPERANDS f device Species the device to send the ta SCSI command to.

OPTIONS d Set the DExcept eld to 1. If set to 1, disable all informational exception opera- tions and ignore the MRIE eld. The software must poll the TapeAlert log page. The default value for the DExcept eld is 0.

i interval Set the interval timer for reporting exception conditions. If interval is set to 0, report informational exception conditions only once. The default value for the interval timer is 0.

l Set what types of exception conditions are logged. If set to 0, which is the default, log only vendor specic exception conditions. This ag sets the log error condition to 1. The default is 0. Currently, only the values 0 and 1 are supported.

m MRIE Dene the method used to report informational exception conditions. Values of 0x0 through 0x5 for the MRIE are dened as:

VALUE METHOD 0x0 No reporting 0x1 Asynchronous event reporting 0x3 Conditionally generate recovered error 0x4 Unconditionally generate recovered error 0x5 Generate no sense 0x6 Only report informational exception conditions on request

Currently, only value 0x0 is supported. The default value for the MRIE eld is 0.

n testag Set or clear the TapeAlert test ag in the log page. If testag is between the values 1 and 64, set the TapeAlert ag in the log page to the value of testag. If testag is between the values -1 and -64, clear the TapeAlert ag in the log page to the value of testag. If testag is equal to 32727 (0x7FFF), set all TapeAlert ags in the log page. The default value for testag is 0.

s Set TapeAlert data. If this ag is not specied, the program will get TapeAlert data.

t Use the t option to specify the method of tape functions to use for the get/set TapeAlert SCSI command. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the

NetWorker 19.1.1 35

Maintenance Commands cdi_ta ( 1m )

libcdi(1m) page for the complete list of access methods currently supported by the cdi_ta program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_ta -f /dev/rmt/2cbn

CDI Get_TapeAlert returns (only ags that are SET will be shown):

Tape Critical ags:

Tape Warning ags:

Tape Information ags:

Changer Critical ags:

Changer Warning ags:

Changer Information ags: _info.drivestat is:

status = 1, DRIVE_STATUS_NO_ERROR msg = Drive reports no error - but state is unknown

SEE ALSO libcdi(1m)

NetWorker 19.1.1 36

Maintenance Commands cdi_tapesize ( 1m )

NAME cdi_tapesize - report tape capacity on a tape device

SYNOPSIS cdi_tapesize f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_tapesize program reports tape capacity on a tape device. The cdi_tapesize program also returns the status of the named SCSI device (specied by the -f option). Note that not all tape devices have the capability to report tape capacity. Please refer to the specic device manuals to conrm whether tape capacity reporting is available for the device.

OPERANDS f device Species the device to obtain tape capacity information from.

OPTIONS t Use the t option to specify the method of tape functions to use to to obtain tape capacity information. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi(1m) page for the complete list of access methods currently supported by the cdi_tapesize program.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_tapesize -f /dev/rmt/2cbn cdi_cmd failed - cdi_info.status = CDI_UNSUPPORTED_CMD (5) errormsg = command is not supported by the selected target

cdi_info.drivestat is: status = 1, DRIVE_STATUS_NO_ERROR msg = Drive reports no error - but state is unknown

SEE ALSO libcdi(1m)

NetWorker 19.1.1 37

Maintenance Commands cdi_tur ( 1m )

NAME cdi_tur - send a test unit ready SCSI command to a tape device

SYNOPSIS cdi_tur f device [ v ] [ t { s t g n m i } ]

DESCRIPTION The cdi_tur program sends a test unit ready SCSI command to a tape device. The cdi_tur program also returns the status of the named SCSI device (specied by the -f option).

OPERANDS f device Species the device to send the SCSI command to.

OPTIONS t Use the t option to specify the method of tape functions to use to to perform the operation. If the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions. Please refer to the libcdi(1m) page for the complete list of access methods currently supported by the cdi_tur pro- gram.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% cdi_tur -f /dev/rmt/2cbn CDI_TUR successful.

cdi_info.drivestat is: status = 0, DRIVE_STATUS_READY msg = The tape drive is ready for use

SEE ALSO libcdi(1m)

NetWorker 19.1.1 38

Maintenance Commands changers ( 1m )

NAME changers list SCSI autochangers attached to the system

SYNOPSIS changers [ dpv ] [ a b.t.l f lename ] [ l ]

DESCRIPTION The changers program lists all of the SCSI autochangers (jukeboxes) connected to the current system.

OPTIONS a b.t.l Selects a specic ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI logical unit number (LUN) on that target. See libscsi(1m).

f lename Species an explicit device le name for changers to use on platforms that support direct use of device le names for jukeboxes.

At this time those platforms are Solaris 10+, AIX and Linux

d Determines the names and addresses of the autochangers media elements (for example, tape drives).

l Performs a complete LUN search for all SCSI adapters in the system. This argument is accepted on all systems, but does not have any effect on HP-UX systems. Due to the method used to scan for available devices on HP-UX sys- tems, all accessible devices are always shown, and the l option has no addi- tional effect. On all other platforms, the normal behavior is to start checking at LUN 0 for SCSI devices. The rst empty LUN found will end the search for a given target ID. With the l option, all LUN present on all target IDs for all SCSI busses in the system will be checked for devices. This can take a very long time and should therefore only be used when necessary. For example, a Fibre Channel adapter can support 126 target IDs, each of which may have 80 or more LUNs. Checking all LUNs on this single adapter may take over 10 minutes.

p Tells changers to use persistent device names for jukeboxes on platforms where persistent names are supported. Currently only linux has such support.

v Lists more detailed information about each autochanger. The details indicate how many media transports (MT, for example, robot arm), storage transports (ST, for example, slot), import/export elements (IE, for example, mail slot), and data transport (DT) elements the autochanger contains. The v option also pro- vides information about the element movement matrix supported by the auto- changer.

EXAMPLE Sample output is shown below: hal$ changers -dv -a 0.2.0 scsidev@0.2.0:Vendor <SPECTRA>, Product <4000> Data Transfer Element at address 80 is scsidev@0.5.0

Device:Vendor <HP>, Product <C1533A> Type:Tape

System Name: /dev/rmt2.1 Data Transfer Element at address 81 is scsidev@0.6.0

Device:Vendor <HP>, Product <C1533A> Type:Tape

System Name: /dev/rmt3.1

1 MT Element starting at address 79 60 ST Elements starting at address 1

NetWorker 19.1.1 39

Maintenance Commands changers ( 1m )

1 IE Element starting at address 0 2 DT Elements starting at address 80

Element Movement Matrix

->DT, ->IE, ->ST, ->MT MT->DT,MT->IE,MT->ST,______ ST->DT,ST->IE,ST->ST,ST->MT IE->DT,______,IE->ST,IE->MT DT->DT,DT->IE,DT->ST,DT->MT ______,______,______,______ ______,______,______,______ ______,______,______,______ ______,______,______,______

SEE ALSO libscsi(1m)

NetWorker 19.1.1 40

Maintenance Commands dasadmin ( 1m )

NAME dasadmin ADIC/EMASS/Grau silo administrative utility libstlemass shared library for communication to

ADIC/EMASS/Grau silo

SYNOPSIS dasadmin command [options] [parameters] dasadmin.exe command [options] [parameters] (NT only) libstlemass.so (Solaris) libstlemass.so.a (AIX) libstlemass.sl (HPUX) libstlemass.so.1 (SGI) libstlemass.so (DECAXP) libstlemass.dll (NT i386)

DESCRIPTION dasadmin This is not a complete listing of all possible dasadmin commands, but does include those commands that are of use with NetWorker. For a complete dis- cussion, see the DAS Installation and Administration guide provided by ADIC, EMASS or Grau.

mo[unt] [ t type ] volser [ drive-name ] Mounts the tape with the barcode label of volser into either the rst available drive (if drive-name is not specied) or into the drive specied by drive-name. If the tape is not the type dened by DAS_MEDIUM or ACI_MEDIA_TYPE, you can use the t type option to get the tape mounted. If the type of the tape and the dened type for the drive do not match, the silo will not load the tape. Note that the drive you are attempting to use must be allocated for your use before you can mount or dismount tapes. See listd and allocd below.

dism[ount] [ t type ] volser d drive-name Dismounts the tape that is either specied by volser or whatever is in the drive specied by drive-name. If the tape or drive are of a different type than your default, use the t type parameter. As with mount, you must have the drive allocated to you to use this command.

ej[ect] [ c ] [ t type ] volser-range area-name Ejects one or more tapes to the specied eject area. As with other commands, if the type of the tape you are ejecting is different from that dened by DAS_MEDIUM or ACI_MEDIA_TYPE, you will need the t type option. The c species a complete ejection for the specied volsers. A complete ejection removes the entry for that volser from the silo controllers internal database. A NON-complete ejection will eject the tape, but the volsers entry in the database will remain, and the volsers state will be set to ejected. This is useful if you anticipate replacing the tape in the silo soon.

in[sert] area-name Moves all tapes that are currently in the specied insert area-name from the insert area to the normal storage locations for tapes.

inventory Starts a full inventory of the silo. USE WITH CAUTION! An inventory of this sort can take a very long time! An inventory of a silo with 180 slots takes over 20 minutes.

view [ t type ] volser Displays the current status of volser, including the volser, type, attribute, and coordinate.

all[ocd] drive-name UP DOWN clientname The allocd command is used to allocate and deallocate drives for different

NetWorker 19.1.1 41

Maintenance Commands dasadmin ( 1m )

clients. Before you can use a tape drive, the drive must be allocded UP for your system. If it is currently allocded UP for a different client, it must rst be allocded DOWN for that client before being allocded UP for your system. You cannot allocd DOWN a drive that has a tape in it. The tape must be dismounted rst.

l[ist]d listd or ld shows the current state of all the tape drives dened in the silo. The information presented will include the drive-name, the amu drive (the location in the silo), status (UP or DOWN), type, client the drive is allocated to, and the volser of any loaded tape.

show op ac client-name Shows the operational or access parameters for the specied client-name. You must include either ac if you wish to see access parameters, or op if you wish to see operational parameters for the client-name. Access parameters include volser ranges and drive ranges that the client-name is allowed to use. Operational parameters include whether the client-name has complete access, dismount privileges along with the IP address entered for client-name.

list client-name Lists any outstanding requests that have been made by client-name. If there are any, they are shown, along with the request number and type.

can[cel] request-id Allows you to cancel an outstanding request, assuming that you have the necessary privileges. Use the request-id that was shown by the list command.

qversion Shows the version of the DAS server that you are connected to and the ver- sion of the ACI protocol you are using to talk to DAS.

qvolsrange beginvolser endvolser count [ clientname ] qvolsrange is the way to obtain a list of the volsers that are available in the silo. beginvolser and endvolser are volsers of the form "123456". To use the rst available or the last available, you can use "". count species the maximum number of volsers you wish to see.

ENVIRONMENT VARIABLES

These environment variables affect the operation of the silo, and since the processes that are using them include both the commands the user will enter and the processes that are spawned from nsrd, they need to be set in a location where they will be in place when nsrd is started. The three DAS_ variables are used by libstlemass, while dasadmin uses ACI_MEDIA_TYPE instead of DAS_MEDIUM.

For Solaris, the denitions should be placed in /etc/rc.2/S95networker.

For AIX, the denitions should be placed in /etc/rc.nsr.

For HPUX, the denitions should be placed in /sbin/rc2.d/S900networker.

DAS_SERVER This is either the network name or the IP address of the system that is running DAS. For a single silo, this will usually be the silo controller system. In larger ins- tallations, there will probably be only one DAS server for the whole network. It is case-sensitive.

DAS_CLIENT This is the network name of the system that NetWorker is running on. It is case- sensitive.

DAS_MEDIUM This variable is used by libstlemass. It should be the same as ACI_MEDIA_TYPE. This is the type of tape drive you are connected to. If this is not specied, the default value of DLT will be used.

NetWorker 19.1.1 42

Maintenance Commands dasadmin ( 1m )

ACI_MEDIA_TYPE This variable is used by dasadmin. It should be the same as DAS_MEDIUM. This is the type of tape drive you are connected to. If this is not specied, the default value of DLT will be used. Acceptable values are the same as those listed under DAS_MEDIUM.

EXAMPLES NOTE on ranges: The dasadmin utility will accept volser ranges for some commands. There are three acceptable variations for these ranges: single volser: "000635" multiple volsers: "000635, 000789, 098732" true range: "000610 - 000745"

NOTE on area-name and drive-name : area-names usually consist of a letter and 2 digits. The letter corresponds to whether you are referring to an insert area ("I") or an eject area ("E"). You will need to get the correct values from your silo administrator before using them. drive-names are essentially free-form labels created by whomever installed the silo. They may or may not have any relevance to physical reality, so you will need to see the silo admin to get the correct names. If the silo admin is not available, you can get the same information using dasadmin listd along with dasadmin show op client-name followed by dasadmin show ac client-name commands.

To set up the environment variables necessary for silo operations: setenv DAS_SERVER emask setenv DAS_CLIENT aurora setenv DAS_MEDIUM DLT setenv ACI_MEDIA_TYPE DECDLT

To see a listing of all volsers available in the silo: dasadmin qvolsrange "" "" 10000

To see the current status of the drives in the silo: dasadmin listd

To change the allocation of a drive from client a4 to client aurora: dasadmin allocd DLT1 DOWN a4 dasadmin allocd DLT1 UP aurora

SEE ALSO nsrjb(1m), jbcong(1m), libstlstk(1m), mini_el(1m), ssi(1m), libstlibm(1m)

DIAGNOSTICS The only available diagnostic information is error messages that might be printed out by dasadmin and libstlemass in the course of normal operations.

NetWorker 19.1.1 43

Maintenance Commands ddmgr ( 1m )

NAME ddmgr device detection manager that manages auto-detection on local and remote storage nodes

SYNOPSIS ddmgr [ S ] [ M ] [ i ] [ d ] [ q ] [ v ]

DESCRIPTION ddmgr is the main daemon for auto-detection that runs on the NetWorker server machine. It spawns child processes (of dvdetect) for each storage node on which dev- ices are to be detected.

It starts the child processes with the help of the nsrmon(1m) process, and depends on nsrmon to report on the success or failure of the remote dvdetect process.

Once dvdetect on a storage node has nished its work of detecting devices, ddmgr takes up the task of creating resources for these detected devices, and in case of jukeboxes, tries to nd out the device mapping (element id to device path) by spawn- ing another process, dtbind. dtbind determines the device mapping by loading each drive in the jukebox that was detected and then trying to access it via various device paths till it nds the right one. This might take a long time depending on the type of the jukebox.

ddmgr is invoked by the nsrd process and is not to be invoked on the command-line.

OPTIONS d Tells ddmgr to detect and create device resources but not to enable them.

i This option tells ddmgr to look for silos.

M This option tells ddmgr that it has been invoked by the server and to direct messages to the daemon log.

q This option tells ddmgr to run in the quiet mode without printing any mes- sages.

v This option is used to run ddmgr in the verbose mode for more debug mes- sages.

EXIT STATUS Exits with 0 on success and 1 on error. See error messages for more detail on errors.

SEE ALSO nsrmon(1m), nsr_render_log(1m)

DIAGNOSTICS Most, if not all, of ddmgr error reports is preceded by the phrase "Detection process for host X reports", followed by the actual error message. This error message is based on the error reported by the nsrmon process monitoring the dvdetect process, or in cases where nsrmon itself cannot be started, about the nsrmon process. The following are the error messages that ddmgr might produce along with their implications and possible solutions.

remote dvdetect exec failure. Errno 76 The remote storage node was unable to start the dvdetect process on the remote storage node. This could happen for various reasons, like the dvdetect binary not having execute permissions, or more commonly, the remote storage node not being congured to service requests from this server.

remote auto-detect feature not supported Auto-detect was being performed on a host that does not support this feature. The client/storage-node should be 6.x or higher.

dvdetect process failed on signal The remote dvdetect process was killed by a signal. This could happen even when the process encounters a memory fault. Check for core les in the nsr/cores directory.

NetWorker 19.1.1 44

Maintenance Commands ddmgr ( 1m )

dvdetect terminated due to timeout The dvdetect process was terminated because of its inactivity for a certain period of time. The timeout is set by default to 15 minutes. This is not user congurable. dvdetect process exited on signal The local dvdetect process was killed by a signal. This could happen even when the process encounters a memory fault. Check for core les in the nsr/cores directory.

dvdetect exec failure The ddmgr process was unable to start the dvdetect process on the server. Check for execute permissions on the dvdetect binary.

nsrmon exec failure The ddmgr process was unable to start the nsrmon process on the server. Check for execute permissions on the nsrmon binary.

nsrmon process exited on signal The nsrmon process exited on a signal. This could even happen when the pro- cess encounters a memory fault. Check the nsr/cores directory for a core le.

dvdetect failed with unknown error ddmgr was unable to determine the cause of the failure of the dvdetect pro- cess.

nsrmon failed. No info in the resdb The nsrmon process exited without loggin any information about either the remote dvdetect process or itself. Ddmgr is unable to verify status of both.

nsrmon failed. Invalid request or hostname The nsrmon process was started with an invalid option or hostname. Check if the remote storage node is reachable from the server.

nsrmon failed. Authorization failure The nsrmon process could not get authorization from the NetWorker server to talk to the remote storage node.

nsrmon exited on resdb access failure The nsrmon process encountered errors in reading the NetWorker RAP data- base.

nsrmon exited on memory failure The nsrmon process ran out of physical memory while processing. Add more memory.

nsrmon failed. Invalid request value The nsrmon process was asked to perform a request it is not familiar with.

process exited with error There was a problem with the detection process but ddmgr could not deter- mine the exact cause of the failure.

RPC error Remote systems The nsrmon process was unable to connect to the remote host. This could be because of network problems, or if the NetWorker processes were not installed on the remote system.

NetWorker 19.1.1 45

Maintenance Commands EMASS_silo ( 1m )

NAME dasadmin ADIC/EMASS/Grau silo administrative utility libstlemass shared library for communication to

ADIC/EMASS/Grau silo

SYNOPSIS dasadmin command [options] [parameters] dasadmin.exe command [options] [parameters] (NT only) libstlemass.so (Solaris) libstlemass.so.a (AIX) libstlemass.sl (HPUX) libstlemass.so.1 (SGI) libstlemass.so (DECAXP) libstlemass.dll (NT i386)

DESCRIPTION dasadmin This is not a complete listing of all possible dasadmin commands, but does include those commands that are of use with NetWorker. For a complete dis- cussion, see the DAS Installation and Administration guide provided by ADIC, EMASS or Grau.

mo[unt] [ t type ] volser [ drive-name ] Mounts the tape with the barcode label of volser into either the rst available drive (if drive-name is not specied) or into the drive specied by drive-name. If the tape is not the type dened by DAS_MEDIUM or ACI_MEDIA_TYPE, you can use the t type option to get the tape mounted. If the type of the tape and the dened type for the drive do not match, the silo will not load the tape. Note that the drive you are attempting to use must be allocated for your use before you can mount or dismount tapes. See listd and allocd below.

dism[ount] [ t type ] volser d drive-name Dismounts the tape that is either specied by volser or whatever is in the drive specied by drive-name. If the tape or drive are of a different type than your default, use the t type parameter. As with mount, you must have the drive allocated to you to use this command.

ej[ect] [ c ] [ t type ] volser-range area-name Ejects one or more tapes to the specied eject area. As with other commands, if the type of the tape you are ejecting is different from that dened by DAS_MEDIUM or ACI_MEDIA_TYPE, you will need the t type option. The c species a complete ejection for the specied volsers. A complete ejection removes the entry for that volser from the silo controllers internal database. A NON-complete ejection will eject the tape, but the volsers entry in the database will remain, and the volsers state will be set to ejected. This is useful if you anticipate replacing the tape in the silo soon.

in[sert] area-name Moves all tapes that are currently in the specied insert area-name from the insert area to the normal storage locations for tapes.

inventory Starts a full inventory of the silo. USE WITH CAUTION! An inventory of this sort can take a very long time! An inventory of a silo with 180 slots takes over 20 minutes.

view [ t type ] volser Displays the current status of volser, including the volser, type, attribute, and coordinate.

all[ocd] drive-name UP DOWN clientname The allocd command is used to allocate and deallocate drives for different

NetWorker 19.1.1 46

Maintenance Commands EMASS_silo ( 1m )

clients. Before you can use a tape drive, the drive must be allocded UP for your system. If it is currently allocded UP for a different client, it must rst be allocded DOWN for that client before being allocded UP for your system. You cannot allocd DOWN a drive that has a tape in it. The tape must be dismounted rst.

l[ist]d listd or ld shows the current state of all the tape drives dened in the silo. The information presented will include the drive-name, the amu drive (the location in the silo), status (UP or DOWN), type, client the drive is allocated to, and the volser of any loaded tape.

show op ac client-name Shows the operational or access parameters for the specied client-name. You must include either ac if you wish to see access parameters, or op if you wish to see operational parameters for the client-name. Access parameters include volser ranges and drive ranges that the client-name is allowed to use. Operational parameters include whether the client-name has complete access, dismount privileges along with the IP address entered for client-name.

list client-name Lists any outstanding requests that have been made by client-name. If there are any, they are shown, along with the request number and type.

can[cel] request-id Allows you to cancel an outstanding request, assuming that you have the necessary privileges. Use the request-id that was shown by the list command.

qversion Shows the version of the DAS server that you are connected to and the ver- sion of the ACI protocol you are using to talk to DAS.

qvolsrange beginvolser endvolser count [ clientname ] qvolsrange is the way to obtain a list of the volsers that are available in the silo. beginvolser and endvolser are volsers of the form "123456". To use the rst available or the last available, you can use "". count species the maximum number of volsers you wish to see.

ENVIRONMENT VARIABLES

These environment variables affect the operation of the silo, and since the processes that are using them include both the commands the user will enter and the processes that are spawned from nsrd, they need to be set in a location where they will be in place when nsrd is started. The three DAS_ variables are used by lib- stlemass, while dasadmin uses ACI_MEDIA_TYPE instead of DAS_MEDIUM.

For Solaris, the denitions should be placed in /etc/rc.2/S95networker.

For AIX, the denitions should be placed in /etc/rc.nsr.

For HPUX, the denitions should be placed in /sbin/rc2.d/S900networker.

DAS_SERVER This is either the network name or the IP address of the system that is running DAS. For a single silo, this will usually be the silo controller system. In larger ins- tallations, there will probably be only one DAS server for the whole network. It is case-sensitive.

DAS_CLIENT This is the network name of the system that NetWorker is running on. It is case- sensitive.

DAS_MEDIUM This variable is used by libstlemass. It should be the same as ACI_MEDIA_TYPE. This is the type of tape drive you are connected to. If this is not specied, the default value of DLT will be used.

NetWorker 19.1.1 47

Maintenance Commands EMASS_silo ( 1m )

ACI_MEDIA_TYPE This variable is used by dasadmin. It should be the same as DAS_MEDIUM. This is the type of tape drive you are connected to. If this is not specied, the default value of DLT will be used. Acceptable values are the same as those listed under DAS_MEDIUM.

EXAMPLES NOTE on ranges: The dasadmin utility will accept volser ranges for some commands. There are three acceptable variations for these ranges: single volser: "000635" multiple volsers: "000635, 000789, 098732" true range: "000610 - 000745"

NOTE on area-name and drive-name : area-names usually consist of a letter and 2 digits. The letter corresponds to whether you are referring to an insert area ("I") or an eject area ("E"). You will need to get the correct values from your silo administrator before using them. drive-names are essentially free-form labels created by whomever installed the silo. They may or may not have any relevance to physical reality, so you will need to see the silo admin to get the correct names. If the silo admin is not available, you can get the same information using dasadmin listd along with dasadmin show op client-name followed by dasadmin show ac client-name commands.

To set up the environment variables necessary for silo operations: setenv DAS_SERVER emask setenv DAS_CLIENT aurora setenv DAS_MEDIUM DLT setenv ACI_MEDIA_TYPE DECDLT

To see a listing of all volsers available in the silo: dasadmin qvolsrange "" "" 10000

To see the current status of the drives in the silo: dasadmin listd

To change the allocation of a drive from client a4 to client aurora: dasadmin allocd DLT1 DOWN a4 dasadmin allocd DLT1 UP aurora

SEE ALSO nsrjb(1m), jbcong(1m), libstlstk(1m), mini_el(1m), ssi(1m), libstlibm(1m)

DIAGNOSTICS The only available diagnostic information is error messages that may be printed out by dasadmin and libstlemass in the course of normal operations.

NetWorker 19.1.1 48

Maintenance Commands erase ( 1m )

NAME erase erase a tape

SYNOPSIS erase [ -sr ] -a b.t.l

DESCRIPTION The erase program will send the SCSI ERASE command to the named device, using the LONG erase option unless the optional -s argument is specied.

OPTIONS s Uses the SHORT erase option, rather than the LONG option. LONG is used by default.

r sends a REWIND command to the named device prior to issuing an erase com- mand.

a This is a required argument, and must be used to select a specic ordinal SCSI address (see libscsi(1m)) for the device that has the tape.

WARNINGS Be careful! This command destroys data! It does not prompt you to see whether you are sure you want to do this.

SEE ALSO libscsi(1m)

NetWorker 19.1.1 49

Maintenance Commands generate_test_tape ( 1m )

NAME generate_test_tape - perform generates a test tape for diagnostic purposes.

SYNOPSIS generate_test_tape f device [ z blocksize ] [ s lesize ] [ b maxblocks ] [ m maxles ] [ v ]

DESCRIPTION The generate_test_tape program generates a test tape mounted on a device for diag- nostic purposes. 32 KB blocks are rst written to the tape mounted on the device, with a lemark at every N number of blocks it has completed writing the total number of blocks specied by the user, or till it reaches end of tape.

OPERANDS f device Species the device to generate the test tape on.

OPTIONS b maxblocks Use the b option to specify the maximum number of blocks to write to tape. The value of maxblocks must be greater than 0. If the b and the m options are not specied, the program will write to the end of tape or till a write error is encountered.

m maxles Use the m option to specify the maximum number of les to write to tape. The value of maxles must be greater than 0. If the b and the m options are not specied, the program will write to the end of tape or till a write error is encountered.

s lesize Use the s option to specify the le size (in number of blocks) to write to tape. The value of lesize must be greater than 0. The default le size is 1000 32KB blocks.

sz blocksize Use the s option to specify the block size (in number of 1KB) to write to tape. The value of blocksize must be greater than 0. The default block size is 1000 32KB.

v Run the program in verbose mode. This option will print out the version number of the CDI library used by the program.

EXAMPLES Sample output including drive status information:

% generate_test_tape -f /dev/rmt/3cbn -b 20 -s 2 -v ready to ll tape on QUANTUM DLT7000

using device le /dev/rmt/2cbn each tape record will be 32768 bytes a lemark will be written every 2 records the process will end when 20 total records have been written to the tape

block = 1. Buffer = 1 1 1 1

FM block = 2. Buffer = 2 2 2 2 block = 3. Buffer = 3 3 3 3

FM block = 4. Buffer = 4 4 4 4 block = 5. Buffer = 5 5 5 5

FM block = 6. Buffer = 6 6 6 6 block = 7. Buffer = 7 7 7 7

NetWorker 19.1.1 50

Maintenance Commands generate_test_tape ( 1m )

FM block = 8. Buffer = 8 8 8 8 block = 9. Buffer = 9 9 9 9

FM block = 10. Buffer = a a a a block = 11. Buffer = b b b b

FM block = 12. Buffer = c c c c block = 13. Buffer = d d d d

FM block = 14. Buffer = e e e e block = 15. Buffer = f f f f

FM block = 16. Buffer = 10 10 10 10 block = 17. Buffer = 11 11 11 11

FM block = 18. Buffer = 12 12 12 12 block = 19. Buffer = 13 13 13 13

FM

SEE ALSO libcdi(1m)

NetWorker 19.1.1 51

Maintenance Commands gstclreport ( 1m )

NAME gstclreport NetWorker Management Console command-line reporting utility

SYNOPSIS gstclreport r reportname u username [ P password ] [ a chartselector ] [ c charttype ] [ f lename ] [ n fontfamily ] [ o orientation ] [ v viewtype ] [ x exporttype ] [ C parameter_name parameter_value ]

DESCRIPTION gstclreport provides a command-line interface for running reports. The required option -u must specify a valid NetWorker Management Console user name. The report will be run using this users login credentials and is subject to any permission restric- tions placed on this user. The optional -P option can be used to specify the password for this user. If the -P option is omitted, then gstclreport will prompt for the password at the command line.

The reports that ship with NetWorker Management Console are called canned reports. They cannot be deleted. Users may create their own versions of these reports using the Console UI. Reports created by users appear under the canned report they were created from and are called custom reports. Custom reports are privately owned by users, and can be shared with others via the share command in the UI. Use the -r option to specify which report will be ran.

The nal result of running gstclreport will be the exported output of the report. Vari- ous command line options can be used to congure the output. If an argument to an option contains a white space character, then that argument must be enclosed in quotes. For example, the -c option can be used to set the type of chart in a chart report. In order to get a stacked bar chart the option must be specied -c "stacking bar".

When running a canned report, optional options that are omitted will assume a default value. For instance the default value for viewtype in the -v option is table. When a cus- tom report is run, values will be pulled from the custom report instead.

OPTIONS -r reportname This required option species the name of the report to run. This may be either a canned report, or a custom report created by a user. Drill down reports of either kind cannot be run from gstclreport. If this is a custom report, then the user specied in the -u option must have permission to view this report. Permission is granted either because that user owns the report, or because that report has been marked as shared.

The name of the report must be the full path name to the report from the report hierarchy in the UI. For example:

"/Reports/Users/User Audit/West Coast Admins".

Rather than specify the full path report name, the user may elect to specify just the report name. If there is more than one report of that name in the system, we will run the rst report we nd of that name. For example, "West Coast Admins".

-u username This required option species the name of a NetWorker Management Console user. The report will be run as this user and is subject to any permission restrictions placed on that user. Users may only run reports they have permission to see either because they own the report, or the report is marked as shared.

When the report is run it is also subject to any host permission

NetWorker 19.1.1 52

Maintenance Commands gstclreport ( 1m )

restrictions place upon the specied user. Thus two different users with differing permissions may run the same report and get different results because of restrictions.

-P password This option should contain the password of the user specied in the -u option. If the -P option is omitted, then gstclreport will prompt for the password at the command line in order to continue.

-a chartselector This option species a comma-separated list of the Y axis to display when viewing a chart report. The values in the list should match the values found in the Chart Selector input of the chart report in the UI for the par- ticular report being run. These values will differ depending upon which report.

-c charttype This option species the type of chart to display for chart reports. Valid values are bar, pie, plot, and "stacking bar". The default chart type is bar. If this option is specied and no -v option is specied we will default to a chart view.

-f lename This option species the lename of the exported report output. This can be a full path lename, or a lename relative to the current directory. If this option is omitted, then the lename will be generated by taking the name of the report from the -r option and replacing all white space char- acters with underscore. The lename will have the correct le type exten- sion added if it is missing.

When exporting chart reports to html, besides the html le generated we also create a directory which contains the chart image les. This directory name is created by taking the name of the lename without the extension and appending "_images" to it.

-n fontfamily This option species the name of a font family to override the default font used in this report. This font name should match a name from the View->Font->Font Name selector in the UI.

-o orientation This option species the page orientation to use when exporting the report. Valid options are portrait and landscape. The default orientation is portrait.

-v viewtype This option species the type of view for this report. Valid options are table and chart. The default view type is table.

-x exporttype This option species the export format of the report. Valid options are pdf, postscript, html, csv, and print. The default export type is pdf.

-C parameter_name parameter_value A report may have associated with it a set of conguration parameter options. These options match the Parameters found on the Congure tab of the report. Each report will have a different set of conguration parameters and thus a different set of conguration parameter options.

The -C option contains two parts. The parameter_name should contain the name of a conguration parameter from the reports congure tab. The parameter_value should contain the input to the parameter option. The for- mat of the parameter_value will vary on the type of control used in the UI. You can get further clarication by running the -h option to see all avail- able -C options and their input types.

There are 3 possible types of inputs, either a single value, a comma-

NetWorker 19.1.1 53

Maintenance Commands gstclreport ( 1m )

separated list of values, or a date range. The date range may contain either one or two dates. If only one date is specied, it is assumed to be the from date. If there are two dates the rst is the from date, and the second is the to date. The rst date can be the special string "epoch" which indicates that the from date should be left empty.

Date parsing is performed in the current locale. A best attempt will be made to parse dates. Dates contain both a date and time portion, the time portion is optional. In the US locale, the following date portions will always be supported:

Format Example -------------------------------------------------------------- MM/DD/YY 07/25/04 MMM D, YYYY Jul 25, 2004 MMMM D, YYYY July 25, 2004 EEEE, MMMM D, YYYY Sunday, July 25, 2004

Each locale will have a different set of supported formats. A best attempt has been made to support some variation of the MM/DD/YY format for each locale. For this format, some locales may have the day eld before the month eld. Others may choose to use "-" as the date eld separator.

The time portion will either be in 24 hour time or 12 hour time depend- ing upon locale. For the US locale, the following time formats will be sup- ported:

Format Example --------------------------------------------------------------- h:mm a 11:27 AM h:mm:ss a 11:27:03 AM h:mm:ss a Z 11:27:03 AM PST

Each locale will have a different set of supported formats.

Instead of an absolute date, the from or to dates may contain a relative date. A relative date consists of a number greater than or equal to 0 fol- lowed by one of the following strings: hours, days, weeks, months, or years. The actual date is then derived by taking the current date and sub- tracting the indicated number of relative time.

-h When this option is used no report output is generated. Instead a usage statement is output to the command line. If this option is used along with the -u and -r options and either the -P option or a valid password is entered at the command prompt, then it will also output the set of conguration parameter options available through the -C option for this report.

EXAMPLES The example below shows how gstclreport is used to output a full usage statement to the command line for a report including parameter options.

NetWorker 19.1.1 54

Maintenance Commands gstclreport ( 1m )

% gstclreport -u username -P password -r "Server Summary" -h usage: gstclreport [-h] -r reportname -u username [-P password] [-a chartselector] [-c chartype] [-f filename] [-n fontfamily] [-o orientation] [-v viewtype] [-x exporttype] [-C "Backup Type" argument] [-C Level argument] [-C "Save Time" argument] [-C "Server Name" argument]

where: -h Print this help message -r reportname The full path of the report to run like

"/Reports/Users/User List" -u username Log into GST server with given name -P password Log into GST server with given password -a chartselector The set of Y axis to display in a chart -c chartype The chart type [bar | pie | plot | "stacking

bar"] -f filename The name of the export file -n fontfamily A font family to override the default -o orientation The orientation [portrait | landscape] -v viewtype The view type [table | chart] -x exporttype The type of export [ pdf | postscript | html

| csv | print] -C "Backup Type" argument Where argument is a comma-separated

list of Backup Types -C Level argument Where argument is a comma-separated

list of Levels -C "Save Time" argument Where argument is a From and To date -C "Server Name" argument Where argument is a comma-separated

list of Server Names

The next example shows how to use gstclreport to run a canned report. The Client Summary report will be displayed as a table. The report will be congured to be run over a set of groups and from a certain date. The name of the output le has been derived from the name of the report.

% gstclreport -u username -P password -r "/Reports/NetWorker Backup Statistics/Client Summary" -C "Group Name" "Default, Nightly, Marketing, Building A, Building B" -C "Save Time" "01/01/2003 01:00 AM"

Generated Report "/Reports/NetWorker Backup Statistics/Client Summary" as file Client_Summary.pdf

The next example shows how to use gstclreport to run a custom report. Also note that we are using the relative date format input to the Save Time option. This means that the report will be run over a date range starting from 1 day ago up until right now. The report output will be a pie chart exported to html. The html output will be an html le named DailyGroups.html, and a directory named DailyGroups_images which will contain the chart images.

% gstclreport -u username -P password -r "/Reports/NetWorker Backup Statistics/Group Summary/Daily

Group Report" -v chart -c pie -x html -f "DailyGroups" -C "Save Time" "1 day"

Generated Report "/Reports/NetWorker Backup Statistics/Group

NetWorker 19.1.1 55

Maintenance Commands gstclreport ( 1m )

Summary/Daily Group Report" as le DailyGroups.html

Command line options are checked to ensure they have legal values. This includes values passed into the -C option. This example shows a -C "Group Name" option. The gstclreport program will check to ensure that the group names listed not only exist, but that the current user has access to the NetWorker server that they exist on. All improper values will be ignored in generating the report, and these values will be printed in an informational message. In this example, the user does not have permis- sion to view the NetWorker server containing the Marketing group, and the group Blah does not exist.

% gstclreport -u username -P password -r "Group Summary" -C "Group Name" "Default, Nightly, Marketing, Blah"

These configuration values were ignored: Group Name : Marketing, Blah

Generated Report "Group Summary" as file Group_Summary.pdf

Custom Reports are subject to user restrictions on their conguration parameters. Each custom report can contain conguration parameters that come from the Conguration tab of the report when the report is saved. These parameters values are checked against the user permissions of the user running the current report. If some of these requested parameter values belong to a NetWorker server the current user does not have permission for, then the report will be generated, but these values will not be used in generating the report. In this situation an informational message will be printed to the command line as in the example below.

% gstclreport -u username -P password -r "Other Group Summary" Some report results were not displayed due to user restrictions Generated Report "Other Group Summary" as file Other_Group_Summary.pdf

EXIT STATUS If a fatal error occurs, the exit status is non-zero. If no fatal errors occur, the exit status is zero.

NetWorker 19.1.1 56

Maintenance Commands gstd ( 1m )

NAME gstd GST server daemon

SYNOPSIS gstd [ m module_path ] [ n ]

DESCRIPTION gstd is the Generic Services Toolkit (GST) server program. It provides an RPC-based messaging server for NetWorker Management Console and related applications. The RPC program number provided by gstd is 390402.

Normally gstd is invoked from a startup shell or systemd script (for example, /etc/init.d/gstor/etc/systemd/system/gst.service) at boot time, and should never need to be started directly by a user.

gstd must be run on a machine with appropriate resources. In the context of Net- Worker Management Console, the program will acquire connections to NetWorker servers on the network. The process of managing and collecting report data for any number of servers requires a proportionate level of network bandwidth, CPU time and disk space.

OPTIONS m module_path A list of semicolon (;)-separated directories containing GST loadable modules is specied in module_path.

n Remain in the foreground connected to the controlling terminal. Without this option, the default behavior is to disconnect from the controlling terminal and to run in the background as a daemon pro- cess.

FILES <product install dir>/etc/gstd.conf The master GST conguration le.

EXIT STATUS 0 Successful completion.

>0 An error occurred.

SEE ALSO recoverpsm(1m), savepsm(1m)

NetWorker 19.1.1 57

Maintenance Commands gstdbunload ( 1m )

NAME gstdbunload NMC database dump utility.

DESCRIPTION gstdbunload is used to migrate from sybase database to the postgres database.

1.Stop GST Service

2.Copy gstdbunload binary to NMC bin Directory and run it.

3.Run gstdbunload command to dump NMC sybase database contents into directory called unload directory. (The unload directory must already exist and accesible for writing)

gstdbunload command read the gstd.conf le to gure out the syabase data base path using "current_db_dir" paramter from gstd.conf le and read the password using "current_db_cred" parameter.

gstdbunload command excute the command as dbunload -c UID=lgtogst;PWD=password;DBF=lgto_gst.db;ENG=gst_on_ -V -y -d -xi -o path/to/reload.log -r path/to/reload.sql ./unload

This unload directory will be picked during NMC package installation or conguration.

USAGE -D Debug level

FILES <product install dir>/etc/gstd.conf

<NMC install dir>/etc/gstd_db.conf

EXIT STATUS 0 Successful completion.Once the database is successfully unloaded, gstdbunload will create dbunloaded.tag le. This indicates the dbunload operation is com- pleted successfully.

>0 An error occurred.

SEE ALSO gstd(1m), savepsm(1m)

NetWorker 19.1.1 58

Maintenance Commands gstmodconf ( 1m )

NAME gstmodconf NetWorker Management Console command to add or delete managed nodes

SYNOPSIS gstmodconf i le l login [ P password ] [ f function ] [ s server ] [ k ] [ p port ]

DESCRIPTION gstmodconf provides a command-line interface for adding or deleting managed nodes from a list of hostnames in an input le. This le is specied with the -i option. Only one hostname may be listed on each line of the le. Hosts are added or deleted at the base level of the Enterprise Hierarchy, as NetWorker managed nodes with all features enabled (Managed Events and Reporting Data).

If a node already exists anywhere in the Enterprise Hierarchy, it will not be added by this command. For deletion, nodes at the base level will be deleted, regardless of existing copies. This means that copies of nodes cannot be added with this command, but copies can be deleted.

If one prefers to place a newly created node into a folder of the Enterprise Hierarchy, the node can be moved there from within the Enterprise task, after logging into Net- Worker Management Console from a browser.

Within the input le, blank lines and lines starting with a pound sign (#) are treated as comments and are ignored. Hostnames within the le must be newline-separated. This means that non-comment lines that contain more than one space-separated or tab-separated hostname are interpreted as an error.

By default, gstmodconf stops after an error is encountered. If one prefers to continue processing the list of hostnames after an error, use the -k option.

OPTIONS -i le This option is used to specify the le that contains a list of hostnames. It is a required option.

-l login Specify the name of the NetWorker Management Console user which should be used to log in to the server. This option is required.

-P password Specify the password for the login name specied in the -l option.

-f function This option species the type of function that is performed by the com- mand. Valid values are "add" or "delete". If this option is not specied, the "add" function is assumed.

-s server This option species the NetWorker Management Console server that gstmodconf will connect to. If this option is not specied, it is assumed that the server is on the same host where the command runs.

-k Continue reading and processing hostnames from the input le, ignoring errors that may be encountered when attempting to dene previous managed nodes in the le.

-p port This option may be used to specify an alternate port where a NetWorker Management Console server is listening. The default port is 9001. If this option is not specied, and a non-default port is being used by the server, this command will attempt to locate the correct port. If this attempt is not successful, this option must be used.

NetWorker 19.1.1 59

Maintenance Commands gstmodconf ( 1m )

EXAMPLES The example below shows how gstmodconf is used to create managed nodes from a list of hosts in the le host_list. In this example, the NetWorker Management Console server name is gstserver and host_list contains:

host1 host2

% gstmodconf -s gstserver -i host_list -l administrator Password: Trying 137.69.1.111... connected. processing file host_list

adding host host1 successfully added host host1

adding host host2 successfully added host host2

// Closing connection...

The next example shows how using gstmodconf for a host that is already dened as a managed node produces an error.

% gstmodconf -s gstserver -i host_list -l administrator Password: Trying 137.69.1.111... connected. processing file host_list

adding host host1 // Error! {

string object_type = "gterror"; int severity = 16; int reason = 23; list msg = {

int level = 1; string text = "Host name already exists";

}; }failed to add host host1

// Closing connection...

EXIT STATUS If a fatal error occurs, the exit status is non-zero. If no fatal errors occur, the exit status is zero. When the -k option has been specied, the exit status will reect the last non- comment line that was processed.

NetWorker 19.1.1 60

Maintenance Commands IBM_silo ( 1m )

NAME libstlibm shared library for communication to IBM 3494 silos

SYNOPSIS libstlibm.so (Solaris) libstlibm.so.a (AIX)

DESCRIPTION libstlibm.xxx is a shared library that handles the communication between nsrjb and the IBM silo driver (on AIX) or daemon (on Solaris). The IBM driver/daemon then handles the communication over the network to the silo. There are no options, param- eters or environment variables that affect the operation of libstlibm. The correct path to this le should be entered when an IBM silo is congured using jbcong. The default values specied by jbcong match the default locations chosen for the installa- tion program, and in most cases can be accepted.

For NetWorker to work with the 3494, you must have rst installed IBMs Automated Tape Library support.

On AIX, you will need to install a driver called atldd (Automated Tape Library Device Driver). You may also require the IBMtape driver (Enhanced Tape and Medium Changer Device Driver) if you are using 3590 drives in your 3494.

On Solaris, you will need to install the lmcpd package, (IBM Automated Tape Library Daemon) to use the silo. Again, if you are using 3590 drives, you will also need to install the IBMtape driver. Note that when you are using IBMtape, there will be two sets of device les that will access a given tape drive. There will be the standard Solaris style /dev/rmt/Xmbn type, and there will be the IBMtape supported les of the type /dev/rmt/Xstbn. You should use the IBM supported device les for proper opera- tion of your tape drives.

Note: EMC cannot supply these IBM drivers. They may be available on an IBM Device Driver ftp site (208.200.29.244), but this is not necessarily a long-term IBM committed site.

SEE ALSO nsrjb(1m), jbcong(1m), dasadmin(1m), libstlemass(1m), ssi(1m), mini_el(1m), libstlstk(1m)

DIAGNOSTICS Errors in communication between the NetWorker server and the IBM 3494 silo are difcult to diagnose. The best method is to use the IBM supplied utility mtlib to ver- ify that you have properly congured the 3494 to communicate with your host, and that the entire pathway from either the lmcp driver (on AIX) or the lmcpd daemon (on Solaris) is functioning properly. If mtlib does not work, then there is no chance that NetWorker will work.

If there are any questions about the connection between your host and the 3494, it is best to consult IBM, as they support the connection between the host and the silo. IBM supports both network and serial cable connections to the silo. Since the nature of the connection is hidden from NetWorker by the driver/daemon, there is no differ- ence to NetWorker between the two. Customers have successfully used both.

NetWorker 19.1.1 61

Maintenance Commands ielem ( 1m )

NAME ielem initialize element status

SYNOPSIS ielem [ a b.t.l ] [ r eladdr.nel ]

DESCRIPTION The ielem program sends an INITIALIZE ELEMENT STATUS command to the named device.

Some changers support the ability to initialize element status for a range of elements. The command used for this is the Vendor Unique EXABYTE changer command:

INITIALIZE ELEMENT STATUS (with range) (command opcode 0xE7).

OPTIONS a b.t.l Selects a specic ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI logical unit number (LUN) on that target. See libscsi(1m). This is a required option.

r eladdr.nel Species the range of elements, where eladdr is the starting decimal address (in the autochangers numbering) of the element to start from, and nel is the number of status elements to read. This option can be used if your auto- changer supports the Vendor Unique EXABYTE autochanger INITIALIZE ELE- MENT STATUS command.

SEE ALSO libscsi(1m)

NetWorker 19.1.1 62

Maintenance Commands inquire ( 1m )

NAME inquire - list devices available

SYNOPSIS inquire [ -a b.t.l ] [ clp ] [ N NDMPhost ] [ -s ] [ -T [ -t ] ]

DESCRIPTION The inquire program lists SCSI devices available. The inquire program returns INQUIRY data either for the named SCSI device (with the -a option), or for all SCSI devices attached to the system. In addition to the standard SCSI inquiry data, inquire now returns serial number information obtained from the Vital Product Data (VPD) pages supported by the devices that are being queried. There may be anywhere from zero to eight different identiers for each device, depending on which of the VPD pages that particular device supports.

In NetWorker 7.2.1 and higher, the support of LUS was discontinued for Solaris 10 and higher. This means that after installation inquire might not necessarily show any devices meant to be used by NetWorker. If this is the case, the Solaris Server might not be congured correctly.

A quick check is to run cfgadm -lav to see what is listed. Looking at the cfgadm output and if the devices are listed, make sure that the /dev/rmt path is used for the devices. This is the preferred NetWorker path and it is created automatically by the

Solaris st driver. If the devices are not listed; please refer to the NetWorker Adminis- tration Guide, SUN Administration Guide and Manufacturers Manual.

Sample output including serial number information:

scsidev@0.0.0:SEAGATE ST34371W SUN4.2G7462 Disk, /dev/rdsk/c0t0d0s2 S/N: JDY217500LUW5N

scsidev@0.1.0:QUANTUM ATLAS IV 36 SCA 0B0B Disk, /dev/rdsk/c0t1d0s2 S/N: 363009430963 ATNN:QUANTUM 363009430963

scsidev@0.6.0:TOSHIBA XM5701TASUN12XCD2395 CD-ROM, /dev/rdsk/c0t6d0s2 scsidev@4.0.0:SONY TSL-11000 L1 Tape, /dev/rmt/0cbn

S/N: 0001100158 ATNN:SONY TSL-11000 0001100158

scsidev@4.0.1:SONY TSL-11000 L1 Autochanger (Jukebox) S/N: 3761633968 ATNN:SONY TSL-11000 3761633968

scsidev@4.2.0:IBM ULTRIUM-TD1 0CE0 Tape S/N: 6811004028 ATNN:IBM ULTRIUM-TD1 6811004028

scsidev@4.3.0:HP Ultrium 1-SCSI N16D Tape, /dev/rmt/1cbn S/N: GB81A00316 ATNN:HP Ultrium 1-SCSI GB81A00316

scsidev@4.4.0:IBM ULTRIUM-TD1 0CE0 Tape S/N: 6811003960 ATNN:IBM ULTRIUM-TD1 6811003960

scsidev@4.5.0:EXABYTE Exabyte 221L 2.4 Autochanger (Jukebox) S/N: 99999999

Lines starting with S/N: represent the devices serial number as returned by VPD page 80 hex.

NetWorker 19.1.1 63

Maintenance Commands inquire ( 1m )

Lines that start with a four character prex plus a colon are those returned in SCSI-3 format on VPD page 83 hex. The four character prex tells which of the various SCSI- 3 Device Identiers it represents.

ATNN: ASCII Text identier of unspecied format describing the device itself (usually Vendor, Product, Serial number)

ATPN: ASCII Text identier of unspecied format describing the port that you are connected to the device through (not com- monly used)

VENN: An ASCII vendor specic identier of unknown uniqueness describing the device itself

VEPN: An ASCII vendor specic identier of unknown uniqueness describing the port you are connected through

VBNN: A binary vendor specic identier of unknown uniqueness describing the device itself

VBPN: A binary vendor specic identier of unknown uniqueness describing the port you are connected through

IENN: An IEEE 64-bit identier (EUI-64) describing the device itself (shown in hexadecimal format)

IEPN: An IEEE 64-bit identier (EUI-64) describing the port you are connected through (shown in hexadecimal format)

WWNN: A Fibrechannel identier (World Wide Node Name) describing the device itself (shown in hexadecimal format)

WWPN: A Fibrechannel identier (World Wide Port Name) describing the port you are connected through (shown in hexadecimal for- mat)

PORT: The relative port number that you are connected through. Port "A" would return a value of 1, Port "B" a value of 2...

RESV: The device returned a combination of Association and Identier Type bits that was reserved at the time this code was written.

UNKN: The device returned information that this program was unable to decipher

The HP UX 11iv3 system supports two different addressing modes, LEGACY and AGILE. Different Device Special les (DSFs) are used based on the addressing mode. The AGILE addressing mode is the default addressing mode on the HP UX 11iv3 sys- tem and it creates DSFs based on the device type, for example, /dev/rtape/tape106_BESTnb. For the LEGACY addressing mode, the HP UX 11iv3 system creates additional DSFs based on B.T.L notation for backward compatibility with previous version, for example, /dev/rmt/c0t0d0. Addressing modes can be switched with the insf L (install special device le) program or the rmsf L (remove special device le) program on the HP UX 11iv3 system. The inquire program lists

NetWorker 19.1.1 64

Maintenance Commands inquire ( 1m )

devices using the B.T.L notation for the LEGACY addressing mode, for example, scsidev@B.T.L. For the AGILE addressing mode, it lists devices using the DSF nota- tion, for example, /dev/rtape/tape106_BESTnb.

[ NOTICE ]

1. In the LEGACY addressing mode, the HP UX 11iv3 system has a limitation to sup- port devices:

256 SCSI bus instances. 16 targets per bus instance. 8 logical unit number per target. Eq, it can support max 128 tapes per bus with the LEGACY addressing mode.

2. Changing addressing mode can make a problem: Access failure for the congured jukebox library on the NetWorker. Check the verifycong(1m) man page for more information.

The inquire program output for the LEGACY addressing mode on the HP UX 11iv3 system:

scsidev@0.0.0:HP Virtual LvDisk 0.04 Disk, /dev/rdsk/c0t0d0 S/N: 00000000000000 00000 ATNN=HP /dev/vg01/rvPar0002

scsidev@0.1.0:HP Virtual FileDVD 0.04 CD ROM, /dev/rdsk/c0t1d0 S/N: 00000000000000 00001 VENN=/opt/ISO/DC OE_11i_v3_DVD_BA931 10010.iso

scsidev@0.2.0:STK L180 2.21 Autochanger (Jukebox), /dev/rac/c0t2d0 S/N: 18JYA0021B ATNN=STK L180 18JYA0021B Virtual device

scsidev@0.3.0:HP Ultrium 3 SCSI G27D Tape, /dev/rmt/c0t3d0BESTnb S/N: 18JYA0021G ATNN=HP Ultrium 3 SCSI 18JYA0021G WWNN=500630323147AAAA WW2N=50060B000029AAAA Virtual device

scsidev@0.4.0:HP Ultrium 3 SCSI G27D Tape, /dev/rmt/c0t4d0BESTnb S/N: 18JYA0021H ATNN=HP Ultrium 3 SCSI 18JYA0021H WWNN=500630323148AAAA WW2N=50060B000029AAAA Virtual device

The inquire program output for the AGILE addressing mode on the HP UX 11iv3 system:

/dev/rchgr/autoch1:STK L180 2.21 Autochanger (Jukebox), /dev/rchgr/autoch1 S/N: 18JYA0021B ATNN=STK L180 18JYA0021B Virtual device

/dev/rtape/tape1_BESTnb:HP Ultrium 3 SCSI G27D Tape, /dev/rtape/tape1_BESTnb S/N: 18JYA0021G ATNN=HP Ultrium 3 SCSI 18JYA0021G WWNN=500630323147AAAA WW2N=50060B000029AAAA Virtual device

/dev/rtape/tape3_BESTnb:HP Ultrium 3 SCSI G27D Tape, /dev/rtape/tape3_BESTnb S/N: 18JYA0021H ATNN=HP Ultrium 3 SCSI 18JYA0021H

NetWorker 19.1.1 65

Maintenance Commands inquire ( 1m )

WWNN=500630323148AAAA WW2N=50060B000029AAAA Virtual device

/dev/rdisk/disk2:HP Virtual FileDVD 0.04 CD ROM, /dev/rdisk/disk2 S/N: 00000000000000 00001 VENN=/opt/ISO/DC OE_11i_v3_DVD_BA931 10010.iso

/dev/rdisk/disk3:HP Virtual LvDisk 0.04 Disk, /dev/rdisk/disk3 S/N: 00000000000000 00000 ATNN=HP /dev/vg01/rvPar0002

OPTIONS a b.t.l Selects a specic ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI logical unit number (LUN) on that target. This option is not compatible with -N. See libscsi(1m).

c (NOTE: USE WITH CAUTION) This ag sends the SCSI inquiry command directly to the device and may cause unforeseen errors when there is other activity on the bus.

l Performs a complete LUN search for all SCSI adapters in the system. This argument is accepted on all systems, but does not have any effect on HP-UX systems because the method used to scan for available devices on HP-UX sys- tems always shows all accessible devices. For systems other than HP-UX, the normal behavior is to start checking at LUN 0 for SCSI devices. The rst empty LUN found will end the search for a given target ID. With the l option, all LUNs present on all target IDs for all SCSI busses in the system will be checked for devices. This can take a very long time and should therefore only be used when necessary. For example, a Fibre Channel adapter can sup- port 126 target IDs, each of which may have 80 or more LUNs. Checking all LUNs on this single adapter may take over 10 minutes. This option has no affect when -N present.

p Tells inquire to display persistent device names for devices on platforms where persistent names are supported. If persistent names do not exist for any par- ticular device then the normal device name will be shown. Currently only linux has such support. Specifying p on a platform that does not have NetWorker-recognized persistent names will have no effect.

N NDMPhost Performs a device discovery on the NDMP Tape Server NDMPhost. User will be prompted for the NDMP user name and password. NDMP proto-

col exports only Jukeboxes and Tape Devices. No other device types will be discovered. When NDMP Tape Server is running at version 3 or higher and supports NDMP_CONFIG_GET_SCSI_INFO and NDMP_CONFIG_GET_TAPE_INFO interfaces, inquire will display the INQUIRY data for all the available Jukeboxes and Tape Devices. In all other cases, inquire will prompt for Jukebox handle and get the INQUIRY data for that Jukebox. This option is not compatible with -a. See -T for more details.

Sample output with NDMP Tape Server running at V3 and supporting of SCSI and TAPE CONFIG interfaces:

# inquire -N server-2 Enter NDMP user name: ? ndmp Enter ndmp password on NDMP host server-2 (characters will not be echoed):

Communicating to devices on NDMP Server server-2, this may take a while...

NetWorker 19.1.1 66

Maintenance Commands inquire ( 1m )

scsidev@178.0.0:QUALSTARTLS-6110 2.09 Autochanger (Jukebox), c178t0l0 S/N: 44B43014

scsidev@178.0.1:QUANTUM DLT8000 0119 Tape, c178t0l1 S/N: CX938P2489 IENN:0000000000000000

Sample output with NDMP Tape Server running at V2:

# inquire -N molokai Enter NDMP user name: ? root Enter root password on NDMP host molokai (characters will not be echoed):

Communicating to devices on NDMP Server molokai, this may take a while...

NDMP Tape Server molokai does not support of auto-discovery of SCSI and TAPE Devices. Will perform the operation on a single Jukebox in which you are interested.

Enter NDMP Jukebox handle: ? mc1

scsidev@-1.2.0:EXABYTE Exabyte 215 2.3 Autochanger (Jukebox) S/N: 71000073

s Suppresses the collection of serial number information by inquire, so that inquire returns the same output that it did before the serial number informa- tion was added. This option is primarily added so that any scripts that rely on the former output behavior of inquire can be used with only minor modication.

T This option is only valid when -N is present else it is ignored. The option will display the NDMP Tape Devices in a non standard format. The Device Model and Device Handle(s) will be displayed. This option is useful on NDMP Tape Servers that do not support NDMP_SCSI_OPEN interface on Tape Devices (For example, NetApp).

Sample output with -T option on NetApp Filer.

# inquire -N molokai -T Enter NDMP user name: ? root Enter root password on NDMP host molokai (characters will not be echoed):

Communicating to devices on NDMP Server molokai, this may take a while...

scsidev@0.2.0:EXABYTE Exabyte 215 2.3 Autochanger (Jukebox), mc1 S/N: 71000073

scsidev@0.3.0:QUANTUM Powerstor L200 0022 Autochanger (Jukebox), mc0 S/N: JF83801878

Model Device Handle --------- ------------------

Quantum DLT7000 nrst0l nrst0m

NetWorker 19.1.1 67

Maintenance Commands inquire ( 1m )

nrst0h nrst0a

Exabyte Mammoth-2 8mm nrst2l nrst2m nrst2h nrst2a

t This option is only valid when -T is present else it is ignored. The option will display the vendor specic NDMP Tape Devices Attributes for each tape dev- ice handles that are displayed with option -T.

Sample output with -t option on NetApp Filer.

# inquire -N rainbow -T -t Enter NDMP user name: ? root Enter root password on NDMP host molokai (characters will not be echoed):

Communicating to devices on NDMP Server molokai, this may take a while...

scsidev@0.3.0:QUANTUM Powerstor L200 0022 Autochanger (Jukebox), mc0 S/N: JF83801878

Model Device Handle Attributes -------- ---------------- --------------

Quantum DLT7000 nrst0l DENSITY -- 81633 bpi 40 GB (w/comp) ELECTRICAL_NAME -- 0b.4 SERIAL_NUMBER -- CX902S0678 WORLD_WIDE_NAME -- ALIAS 0 -- st0

nrst0m DENSITY -- 85937 bpi 35 GB ELECTRICAL_NAME -- 0b.4 SERIAL_NUMBER -- CX902S0678 WORLD_WIDE_NAME -- ALIAS 0 -- st0

nrst0h DENSITY -- 85937 bpi 50 GB (w/comp) ELECTRICAL_NAME -- 0b.4 SERIAL_NUMBER -- CX902S0678 WORLD_WIDE_NAME -- ALIAS 0 -- st0

nrst0a DENSITY -- 85937 bpi 70 GB (w/comp) ELECTRICAL_NAME -- 0b.4 SERIAL_NUMBER -- CX902S0678 WORLD_WIDE_NAME -- ALIAS 0 -- st0

NetWorker 19.1.1 68

Maintenance Commands inquire ( 1m )

SEE ALSO libscsi(1m)

WARNINGS Use this command with caution. The inquire command sends the SCSI inquiry com- mand to all devices it detects on all SCSI buses. Running inquire during normal dev- ice operations may cause unforeseen errors. Data loss may result.

LIMITATIONS The inquire program always uses the built-in system drivers to test SCSI devices. The device type or path name printed by the inquire program may be incorrect for devices that require special, third-party drivers.

You must be logged in as the superuser (root) on Unix systems when running inquire. If not, the output may be erroneous.

NetWorker 19.1.1 69

Maintenance Commands jbcong ( 1m )

NAME jbcong jukebox resource conguration tool

SYNOPSIS jbcong [ s server ] [ -lp ]

DESCRIPTION The jbcong program provides an interactive script for conguring a jukebox (Media Autochanger Device) for use with a NetWorker server. The script pauses periodically for you to enter a response to a prompt. If you want to accept the default choice displayed in braces, press [RETURN] or [ENTER].

Starting with NetWorker 7.2.1 and above; the support of LUS was discontinued for Solaris 10 and above. If jbcong reports that it cannot nd any autochangers after ins- tallation, run inquire to make sure it is able to see the devices. Please refer to the inquire(1m) man page for more information. Sometimes, on an ill-congured server, an autochanger is seen but its drives are not mapped to the /dev/rmt path but to the /dev/scsi/sequential path instead. jbcong will congure the autochanger using this path. The problem here is that a drive using the /dev/scsi/sequential path is assumed to be standalone drive. This means the autochanger will not work correctly.

After the jukebox is congured, use the nsrcap(1m) command or the Registration win- dow to enter the enabler code for your Autochanger Software Module. You must have a separate enabler code for each jukebox you want to use with NetWorker.

OPTIONS s server Species the controlling server, when jbcong is being used from a storage node. To dene a jukebox resident on a storage node, the jbcong command must be run on the storage node. See nsr_storage_node(5) for additional infor- mation on storage nodes.

l Performs a complete LUN search for all SCSI adapters on the system when performing Autodetection. This argument is accepted on all systems, but does not have any effect on HP-UX systems. Due to the method used to scan for available devices on HP-UX systems, all accessible devices are always shown, and the l option has no additional effect. On all other systems, the normal behavior is to start checking at LUN 0 for SCSI devices. The rst empty LUN found will end the search for a given target ID. With the l option, all LUNS present on all target IDs for all SCSI busses in the system will be checked for jukeboxes. This can take a very long time and should therefore only be used when necessary. For example, a Fibre Channel adapter can support 126 target IDs, each of which may have 80 or more LUNs. Checking all LUNs on this single adapter may take over 10 minutes.

p Use persistent names for all automatically detected devices where available. This will affect the control ports used for autodetected SCSI Jukeboxes and device le names for tape drives that jbcong is able to automatically detect and congure for you. If a given device does not have a persistent device name then jbcong will use the normal device name for that device. Currently only linux persistent device names are automatically found and used by NetWorker. Specifying this ag on other platforms will have no effect.

CONFIGURATION DIALOGUE

The rst question jbcong will ask you, is to select a type of jukebox to install.

1) Congure an Autodetected SCSI Jukebox. 2) Congure an Autodetected NDMP SCSI Jukebox. 3) Congure an SJI Jukebox. 4) Congure an STL Silo. 5) Exit.

NetWorker 19.1.1 70

Maintenance Commands jbcong ( 1m )

What kind of Jukebox are you conguring? [1]

Enter the number corresponding to the jukebox type you are installing. The default selection is 1. Selection 5 exits immediately.

An Autodetected SCSI Jukebox is any SCSI (Small Computer System Interface) based jukebox connected to a system that NetWorker can automatically detect.

Autodetected NDMP SCSI Jukebox is any SCSI (Small Computer System Interface) based jukebox, connected directly to a Network Data Management Protocol (NDMP) Server that NetWorker will automatically detect. To use this option, the NDMP host- name, user-id, user-password, and jukebox handle must be provided (see example).

An SJI Jukebox is a Standard Jukebox Interface compliant jukebox. This is a list of well known SCSI based jukeboxes, plus any additional third party jukebox devices that adhere to this protocol that you may have added to the system.

A silo tape library (STL) is a peripheral that usually contains many storage devices. This is a list of supported Silo types to be congured. Silos are often shared between programs and as such some slots may not be available for NetWorker use.

The Exit selection will cause jbcong to exit without making any changes to the jukebox conguration.

If you select the rst choice (Install an Autodetected SCSI Jukebox), jbcong will print out a list of jukeboxes it detects on the system.

For example: These are the SCSI Jukeboxes currently attached to your system:

1) scsidev@0.2.0: other, Vendor , Product 2) scsidev@2.2.0: DLI Libra Series 3) scsidev@1.4.1: ARC-DiamondBack

Which one do you want to install?

When this message appears, enter the number corresponding to the jukebox that you wish to congure. Note that if jbcong was able to detect only one SCSI jukebox on the system, it will go ahead and select that jukebox as the one to be congured without waiting for the user to make the selection. This also applies to situations where there are multiple SCSI jukeboxes on the system and all but one are already congured in NetWorker. Even in this case jbcong goes ahead and automatically selects the one that has not yet been congured without waiting for the user to make a selection.

If you choose to install an SJI compliant jukebox, jbcong will print a list of known SJI Jukeboxes and will prompt you for the appropriate type that you want to congure.

For example: Enter the number corresponding to the type of jukebox you are installing:

1) ADIC-1200c/ADIC-1200d 2) ADIC-VLS 3) ARC-DiamondBack 4) Breece Hill 5) DLI Libra Series 6) Quantum DLT/Digital DLT 7) EXB-10e/EXB-10h 8) EXB-10i 9) EXB-60 10) EXB-120

NetWorker 19.1.1 71

Maintenance Commands jbcong ( 1m )

11) EXB-210 12) EXB-218 13) EXB-400 Series 14) HP-C1553A/Surestore 12000e 15) Metrum (SCSI) 16) Qualstar 17) Spectralogic 18) STK-9704/Lago 340 19) STK-9708/Lago 380 (SCSI) Datawheel 20) IBM 7331/IBM 9427 21) ATL/Odetics SCSI 22) HP-Optical 630MB/1.3GB 23) other

Choice?

When this message appears, enter the number corresponding to the appropriate model, for example, if you are installing an HP optical jukebox select the number "22".

For all jukebox types, jbcong prompts you for the name you want to call this jukebox. This is a convenient way for you to identify the jukebox for yourself and NetWorker, for example, Engineering Autochanger. NetWorker will store this name as a Net- Worker resource (see nsr_resource(5)). When dening a jukebox attached to a storage node, jbcong prexes the hostname of the storage node to the beginning of the names using the remote device syntax ("rd=hostname:"). See nsr_storage_node(5) for additional information on storage nodes.

For all jukebox types, jbcong prompts you for a description of this jukebox. This is another convenient way for you to identify the jukebox for yourself, for example, Engineering 4 Drive DLT Autochanger on Rack #2.

For SJI jukebox types, jbcong prompts you for the name of the control port associ- ated with the jukebox being congured. For silos, this could be the name of the host running the silo software (for ACSLS & DAS) or the name of the 3494, depending on the type of Silo. For Autodetected SCSI jukeboxes, jbcong detects the correct name and goes ahead with the conguration. This name is in the form of libscsi devices (see libscsi(1m)). For SJI compliant jukeboxes, no such detection is done. The name you enter should either be the device name for the jukebox as described in any third party SJI compliant driver installed, or the format used for autodetected jukeboxes. A list of attached autochangers can be obtained by running the changers(1m) command.

Once a control port is entered, jbcong will check to see if the model selected is a SCSI or SJI based jukebox. If the jukebox model is a SCSI or SJI based jukebox, jbcong will attempt to query the jukebox about various internal parameters (for example, number of slots and drives). If this query fails, it is possible that there is a device driver installation problem or a hardware problem.

Next, if the jukebox contains tape devices, you are asked if automated cleaning of dev- ices in the jukebox should be turned on. If automated cleaning is enabled, the jukebox and all devices in the jukebox are congured for automated cleaning. On successful installation, the information that pertains to device cleaning for the jukebox and all its devices are displayed. Note that with the introduction of the Common Device Interface (CDI), NetWorker now has two events that will cause an automatic cleaning to occur: schedule-based cleaning, with devices being cleaned after a certain (congurable) amount of time has elapsed, and on-demand cleaning, where cleaning is initiated by TapeAlert warnings issued by the devices. Schedule-based cleaning is always active when autocleaning is enabled. On-demand cleaning is used when the CDI attribute for a tape device is set to anything other than Not Used in the device resource. If on- demand cleaning is being used, you should set the Cleaning Interval for the device

NetWorker 19.1.1 72

Maintenance Commands jbcong ( 1m )

itself to a large time, such as 6 months, so that NetWorker does not clean the device unnecessarily. See nsr_device(5) for a more detailed explanation of CDI, TapeAlert, and Cleaning Interval.

At this point, the user has an option of either going ahead with automatic con gura- tion of the jukebox, accepting all detected information and default choice s as correct, choosing to custom congure some or all aspects of the congurat ion, including conguring devices as NDMP or shared devices, conguring drives that were not detected by jbcong, or changing the model type of any of the de tected

devices. The user can choose to go the custom conguration route by answ ering yes to the following question:

Do you want to change the model(s) or congure them as shared or NDMP drives? (yes / no) [no]

If the user chooses the custom conguration option, the user is given a choice of conguring the drives as NDMP and/or shared drives. Answering yes to either of the prompts will take the user to other relevant questions about NDMP and/or shared drive conguration.

If the user chose yes to conguring NDMP devices, jbcong proceeds to prompt the user for this information. NDMP devices require a user name and password to be entered for each device. The user name and password correspond to the entries set in the NDMP server.

If the user chose yes to conguring shared drives, the user is prompted for multiple device paths for each physical drive in the jukebox. These device paths would typically be located on different storage nodes within a data zone, under the control of one Net- Worker Server. Drives or device paths on remote nodes are to be entered in the "host: " form. Its not necessary that all drives in a jukebox be shared drives; entering a null response to a prompt for additional device paths for a drive skips that drive and takes you to the next step in the conguration. A unique hardware-id of the form - is automatically assigned to each shared instance of a drive. The hardware-id is how NetWorker keeps track of shared devices. See nsr_ device(5) for a description of the hardware-id attribute.

Next, jbcong prompts the user for the model of the drives being congured. In case jbcong has been able to detect the model type(s), it will display this information and ask for conrmation. If not, it lets the user congure the model for each drive.

If you selected Autodetected SCSI jukeboxes, NetWorker determines the name of each media device by sending inquiries for information to the jukebox. Not all jukeboxes support this capability, but many do (for example, the Exabyte 210). This inquiry does not take place when the owning host is different than where jbcong is running.

If conguring devices on a remote storage node, jbcong asks the user if s/he wants to congure the node on which the device is being congured as a Dedicated Storage Node (DSN). A DSN is a node which allows only data from the local host to be backed up to its devices. See nsr_device(5) for more details on DSN. The question is of the form:

A Dedicated Storage Node can backup only local data to its devices. Should helium be congured as a Dedicated Storage Node? (yes / no) [no]

Earlier versions of jbcong used to prompt the user for information about bar code readers in jukeboxes and whether volume names should match bar code labels. With NetWorker 7.0 and later, jbcong tries to set these attributes either by querying the jukebox for information or making intelligent guesses. For Silos, the bar code reader and match bar code labels attributes in the jukebox resource are set to yes by

NetWorker 19.1.1 73

Maintenance Commands jbcong ( 1m )

default. If it is a jukebox, jbcong queries the jukebox for this information. If both features are supported by the jukebox, it sets both elds to yes. If both features are not supported, it sets both elds to no. However, if the jukebox reports that it can handle volume tags, but has no bar code reader, jbcong still sets both elds to yes, since some jukeboxes with bar code readers tend to report this way. At the end of the installation jbcong prints out this information and the user can use NetWorker Management Console to edit the jukebox resource to set the elds to No if he so desires.

If the above two elds are set, the label templates will not be used by the jukebox, and each media volume must have a readable bar code label. Note that on some small jukeboxes, like the HP 1557A or the SONY TSL_A500C, setting bar code reader to yes may cause problems with the labeling. The solution is to set the appropriate attributes to No as described above.

If the jukebox has been congured successfully you will see the following message:

Jukebox has been added successfully

The following conguration options have been set:

followed by a list of options that have been set by default.

JBCONFIG FILE The le /nsr/jbcong is the jukebox models conguration le. This le can be used to congure a non-standard list of jukebox models. VECTOR-TYPE MODEL-NAME<NEWLINE>, where VECTOR-TYPE is either SJI (the Standard Jukebox Interface) or ATL (RS232-based devices speaking the IGM-ATL serial communications protocol). The MODEL-NAME can be any string.

EXAMPLES (User entries are in italics).

Example 1)

# jbcong 1) Congure an Autodetected SCSI Jukebox. 2) Congure an Autodetected NDMP SCSI Jukebox. 3) Congure a SJI Jukebox. 4) Congure a STL Silo.

What kind of Jukebox are you conguring? [1] 1 <RETURN> These are the SCSI Jukeboxes currently attached to your system:

1) scsidev@0.6.0: EXB-210 2) scsidev@3.0.0: ADIC

Which one do you want to install? 1<RETURN> Installing an EXB-210 jukebox - scsidev@0.6.0

What name do you want to assign to this jukebox device? Engineering<RETURN>

Turn NetWorker auto-cleaning on (yes/no) [yes]? yes<RETURN>

The following drives have been detected in this auto-changer: 1> 8mm @ 1.1.0 ==> \\.\Tape0 2> 8mm @ 1.2.0 ==> \\.\Tape1 These are all the drives that this auto changer possesses.

Do you want to change the model(s) or congure them as shared or NDMP drives? (yes / no) [no] yes<RETURN>

Is (any path of) any drive intended for NDMP use? (yes / no) [no] yes<RETURN>

NetWorker 19.1.1 74

Maintenance Commands jbcong ( 1m )

Is any drive going to have more than one path dened? (yes / no) [no] yes<RETURN>

You will be prompted for multiple paths for each drive. Pressing on a null default advances to the next drive.

Please enter the device path information in one of the following formats:

\\.\Tape0 --for local path or host:device-path --for remote node or host:drive-letter:directory path --for Windows disk le

Drive 1, element 82, system name = \\.\Tape0, local bus / target / lun value = 1/1/0,

model 8mm Device path 1 ? [\\.\Tape0]

Enter NDMP user name for host happy? [] user1 <RETURN> Enter NDMP password (characters will not be echoed): <RETURN>

Device path 2 ? [] helium:/dev/rmt/1cbn Enter NDMP user name for host helium? [] user3 <RETURN> Enter NDMP password (characters will not be echoed): <RETURN>

Device path 3 ? [] <RETURN>

Drive 2, element 83, system name = \\.\Tape1, local bus / target / lun value = 1/2/0,

model 8mm Device path 1 ? [\\.\Tape1]

Enter NDMP user name for host ableix.emc.com? [] <RETURN> Device path 2 ? [] <RETURN>

Only model 8mm drives have been detected. Are all drives in this jukebox of the same model? (yes / no) [yes] yes <RETURN>

A Dedicated Storage Node can backup only local data to its devices. Should helium be congured as a Dedicated Storage Node? (yes / no) [no] no <RETURN> Jukebox has been added successfully

The following conguration options have been set:

> Jukebox description to the control port and model. > Autochanger control port to the port at which we found it. > Networker managed tape autocleaning on. > At least one drive was dened with multiple paths. All such drives are dened with a hardware identication as well as a path value to avoid confusion by uniquely iden- tifying the drive. The hardware identication for all drives which have one is always autochanger_name - Drive # where "autochanger_name" is the name you gave to the autochanger that was just dened, and the # symbol is the drive numer. > Barcode reading to on. > Volume labels that match the barcodes. > Slot intended to hold cleaning cartridge to 1. Please insure that a cleaning cartridge is in that slot > Number of times we will use a new cleaning cartridge to 12. > Cleaning interval for the tape drives to 6 months.

You can review and change the characteristics of the autochanger and its associated devices using NetWorker Management Console.

NetWorker 19.1.1 75

Maintenance Commands jbcong ( 1m )

Would you like to congure another jukebox? (yes/no) [no] no <RETURN>

Example 2)

Here is an example of conguring a jukebox attached to NDMP Tape Server.

# jbcong

1) Congure an Autodetected SCSI Jukebox. 2) Congure an Autodetected NDMP SCSI Jukebox. 3) Congure a SJI Jukebox. 4) Congure a STL Silo.

What kind of Jukebox are you conguring? [1] 2<RETURN> Enter NDMP Tape Server name: ? molokai<RETURN> Enter NDMP user name: ? root<RETURN> Enter NDMP password (characters will not be echoed): password<RETURN> Communicating to devices on NDMP Server molokai, this may take a while...

These are the SCSI Jukeboxes currently attached to your system: 1) scsidev@0.2.0: Exabyte Jukebox 2) scsidev@0.3.0: Standard SCSI Jukebox, QUANTUM / Powerstor L200

Which one do you want to install? 1<RETURN>

Installing an Exabyte Jukebox jukebox - scsidev1027.2.0.

What name do you want to assign to this jukebox device? netapp_jb<RETURN> Turn NetWorker auto-cleaning on (yes/no) [yes]? yes<RETURN>

The drives in this jukebox cannot be auto-congured with the available information. You will need to provide the path for the drives.

Is (any path of) any drive intended for NDMP use? (yes / no) [no] yes<RETURN> Is any drive going to have more than one path dened? (yes/no) [no] no<RETURN>

Please enter the device path information in one of the following formats:

\.Tape0 --for local path or host:device-path --for remote node or host:drive-letter:directory path --for Windows disk le

After you have entered a device path, you will be prompted for an NDMP user name for that paths host. If this device path is not an NDMP device, press the enter key to advance to the next device path. For NDMP devices,

NetWorker 19.1.1 76

Maintenance Commands jbcong ( 1m )

you need to enter the user name and password the rst time we encounter that NDMP host. Pressing the enter key for the NDMP user name for any subsequent device path on the same host will set the user name and password to those dened the rst time. You will not be prompted for the password in such a case.

Drive 1, element 82 Drive path ? molokai;nrst2l<RETURN>

Enter NDMP user name for host molokai? [] root<RETURN> Enter NDMP password (characters will not be echoed): password<RETURN>

Please select the appropriate drive type number: 1) 3480 18) 9840 34) optical 2) 3570 19) 9840b 35) qic 3) 3590 20) 9940 36) SD3 4) 4890 21) adv_le 37) sdlt 5) 4mm 22) dlt 38) sdlt320 6) 4mm 12GB 23) dlt1 39) SLR 7) 4mm 20GB 24) dlt7000 40) tkz90 8) 4mm 4GB 25) dlt8000 41) travan10 9) 4mm 8GB 26) dst (NT) 42) tz85

10) 8mm 27) dtf 43) tz86 11) 8mm 20GB 28) dtf2 44) tz87 12) 8mm 5GB 29) le 45) tz88 13) 8mm AIT 30) himt 46) tz89 14) 8mm AIT-2 31) logical 47) tz90 15) 8mm AIT-3 32) LTO Ultrium 48) tzs20 16) 8mm Mammoth-2 33) LTO Ultrium-2 49) VXA 17) 9490

Enter the drive type of drive 1? 16<RETURN>

Jukebox has been added successfully

The following conguration options have been set: > Jukebox description to the control port and model. > Autochanger control port to the port at which we found it. > Networker managed tape autocleaning on. > Barcode reading to on. Your jukebox does not report that it has a bar

code reader, but it does report that it can handle volume tags. Some jukeboxes that have barcode readers report this way.

> Volume labels that match the barcodes. > Slot intended to hold cleaning cartridge to 1. Please insure that a

cleaning cartridge is in that slot > Number of times we will use a new cleaning cartridge to 5. > Cleaning interval for the tape drives to 6 months.

NetWorker 19.1.1 77

Maintenance Commands jbcong ( 1m )

You can review and change the characteristics of the autochanger and its associated devices using NetWorker Management Console.

Would you like to congure another jukebox? (yes/no) [no] no<RETURN>

SEE ALSO jbexercise(1m), nsr_device(5), nsr_jukebox(5), nsr_storage_node(5), nsr(5), nsrcap(1m)

DIAGNOSTICS u n k n ow n m od el invalid choice for model (35022) Problem: The NetWorker system does not recognize the model chosen. If you added a /nsr/jbcong le after starting the daemons, you will see this error. Solution: Restart NetWorker.

r oot on computer h ost is not on type: NSRs administrator list Problem: The user root on the storage node host is not on the administrator list of the NetWorker server. Solution: Add such an entry to the NetWorker servers administrator list. Note that the entry can be removed after this com- mand completes.

NetWorker 19.1.1 78

Maintenance Commands jbedit ( 1m )

NAME jbedit add and delete device denitions to and from a NetWorker jukebox.

SYNOPSIS jbedit a f <device path> E <element addr> [ s server ] [ j <jukebox name> ] [ v ]

jbedit a f <device path> S <silo device identier> [ s server ] [ j <jukebox name> ] [ v ] [ F ]

jbedit d f <device path> [ s server ] [ j <jukebox name> ] [ v ]

jbedit h

DESCRIPTION jbedit allows a NetWorker user with "Congure NetWorker" privileges to add or delete drive and device denitions to or from an existing jukebox denition in the NetWorker database. A drive is dened in NetWorker as "the physical backup object, such as a tape drive, disk, or le" and a device as "the access path to the physical drive." Every drive therefore has at least one device associated with it, and every dev- ice has exactly one drive with which it can be associated. The addition of a device, even on an existing storage node, may require changes to the Dynamic Drive Sharing (DDS) licenses.

jbedit complements the recongure library feature available through the Networker Management Console. jbedit can be used as a fallback means of editing library congurations if, for some reason, the recongure library program is limited (for example, the library does not return the drive serial numbers).

jbedit supports all direct attached SCSI/SJI, SAN and NDMP libraries as well as Silos.

If the NSR_JUKEBOX environment variable is set, jbedit uses its value as the name of the jukebox to edit. This behavior may be overridden by the j option. If neither of these options are present, jbedit attempts to retrieve the list of all available jukeboxes on the server, and then prompts for a jukebox to be selected if more than one is avail- able.

To edit the library conguration, the jukebox must be enabled and ready (see nsr_jukebox(5)). jbedit can be run from any storage node, however it requires "Congure NetWorker" privileges.

OPTIONS The following options are supported:

a Add a drive/device.

d Delete a drive/device.

h Display the jbedit options and their usage.

E The drive element address.

This is the data element address of the drive with which the device is associ- ated. When a new drive or device is being added to a jukebox, jbedit needs to know the data element address of the drive/device within the jukebox. The data element address is the "decimal number" that the jukebox assigns to each of its drives. Information about drives, data element addresses and other information associated with a jukebox can be found in relem(1m), changers(1m), sn(1m) and sjisn(1m).

NetWorker 19.1.1 79

Maintenance Commands jbedit ( 1m )

S The drives silo device identier. This is the identier used by the silo con- troller to identify the drive with which the device is associated. Typical silo device identiers are:

ACSLS silos: 0,0,2,4 IBM 3494: 00004040 DAS silos: drive1, sdlt_3, etc.

(DAS administrator dened text up to a couple of hundred characters)

If you get an error like "missing new drive information", it is likely that the silo device identier you entered does not match anything that the silo recog- nizes. You should recheck the value with the silo administrator.

Note that jbedit does not verify that the silo device identier that you entered actually corresponds to the device path that you entered, but only that the silo device identier that you entered exists on the silo in question.

F The FORCE ag can be used when adding devices to a silo to force jbedit to create the NetWorker device for the specied device path.

Note that we prefer you to use the Scan for devices function rather than this option since the scan will collect all of the information needed for proper conguration of Dynamic Drive Sharing.

The FORCE ag will only work if the device you are adding is present on the system that you are running jbedit on.

j Name of the jukebox that is to be edited.

f Device path to be added or deleted.

A new device/drive instance may be added to a library only if the device is auto-detected and available as an uncongured device in the NSR Storage Node resource, or if it is available as a standalone NSR device device. See ddmgr(1m) and nsr_storage_node_resource(5) for more informa- tion on how to detect devices on a storage node.

See EXAMPLES for help on how to add a new device/drive to a jukebox. Also see specic format restrictions when adding an NDMP device path.

s Name of the NetWorker server. If a sever name is not specied, the local storage node is assumed to be the NetWorker server.

v Run in verbose mode. Multiple v options can be specied to increase the level of verbosity. The higher the level, the more verbose the output will be. Currently has a maximum of 5.

EXIT STATUS jbedit exits with a 0 on success and with a non-zero value on failure.

EXAMPLES Adding a drive/device:

To add a new device /dev/rmt/0cbn from this storage node: jbedit -s server -j jbname -a -f /dev/rmt/0cbn -E 82

To add a new ACSLS silo device /dev/rmt/13cbn from this storage node: jbedit -s server -j siloname -a -f /dev/rmt/13cbn -S 0,0,2,3

To add a new device /dev/rmt/0cbn from storage node "sn": jbedit -s server -j jbname -a -f sn:/dev/rmt/0cbn -E 82

NetWorker 19.1.1 80

Maintenance Commands jbedit ( 1m )

To add an NDMP device nrst0l from storage node "ndmpsn": jbedit -s server -j jbname -a -f "ndmpsn:nrst0l (NDMP)" -E 82

Please make sure that the device path ends with " (NDMP)".

Deleting a drive/device:

To delete device /dev/rmt/0cbn from this storage node: jbedit -s server -j jbname -d -f /dev/rmt/0cbn

To delete silo device /dev/rmt/13cbn from this storage node: jbedit -s server -j siloname -d -f /dev/rmt/13cbn

To delete device \\.\tape0 from storage node "sn": jbedit -s server -j jbname -d -f sn:\\.\tape0

To delete an NDMP device nrst0l from storage node "ndmpsn": jbedit -s server -j jbname -d -f "ndmpsn:nrst0l (NDMP)"

FILES /nsr/res/nsrdb The NetWorker resource database.

SEE ALSO ddmgr(1m), changers(1m), jbcong(1m), nsrjb(1m), relem(1m), sjisn(1m), sn(1m), nsr_device(5), nsr_jukebox(5), nsr_storage_node(5), nsr_storage_node_resource(5), EMASS_silo(1m), IBM_silo(1m), STK_silo(1m)

DIAGNOSTICS The following are some messages that jbedit might produce, along with their implica- tions and possible solutions.

cannot connect to NSR service on <server name> jbedit was unable to connect to the NetWorker server on the specied host name. Check that the server is up and running on the server host and that it is reachable from the host on which jbedit is running, and then retry the opera- tion.

User <user name> on <storage node> does not have Congure NetWorker privilege on <server name>

The user does not have privileges to add/remove devices.

No jukeboxes are currently usable. There are no jukeboxes congured on the server or no congured jukeboxes are enabled and ready. Please check nsr_jukebox(5) for more details on the "enabled" and "ready" states.

Cannot nd jukebox <jukebox name> for server <server name> The jukebox name specied with j option is invalid. Please check that the jukebox name is dened on the server.

Cannot nd any jukebox with a device named <device name> for server <server name>

While deleting the device with the d option, either the jukebox name specied with the j option is invalid or the device name specied with the f option is invalid.

Couldnt retrieve NSR Storage Node resource information for <storage node> The nsr_storage_node_resource(5) on which the device is going to be created does not exist on the server. Create a new storage node for and run Scan for devices before adding any new devices from the .

The device <device name> is already part of jukebox <jukebox name> The device name specied with f option already belongs to .

NetWorker 19.1.1 81

Maintenance Commands jbedit ( 1m )

Cannot nd device <device name> in uncongured device names resource The device name specied with f option is not available from nsr_storage_node_resource(5). Please run Scan for devices on the storage node to discover the device. You may also use the F ag to override this error and create a basic NetWorker device if you are using jbedit to add a dev- ice to a silo, although the Scan method is preferred as it collects all the infor- mation necessary to properly congure Dynamic Drive Sharing.

NetWorker 19.1.1 82

Maintenance Commands jbexercise ( 1m )

NAME jbexercise NetWorker jukebox exerciser

SYNOPSIS jbexercise m model c control_port [ V vendor_type ] [ CdsIv ] [ D drive_number ] [ S slot ]

DESCRIPTION The jbexercise command tests the functionality of a jukebox. Before the command can be run, all contents of the jukebox must be emptied except for media loaded in the rst and last slots. These pieces of media will be moved around the jukebox as part of the various tests performed by jbexercise.

There are two major tests of functionality: drives and slots. Normally both the drive and slot tests are run. Individual component types can be tested by using the d (for drives) and s (for slots) options. In addition, specic components can be singled out in the D and S options. When these options are given, the only test run is on that particular component, that is, if a specic slot is named, the drives test is not run. For drives, the logical address of the component should be given. For slots, the physical address should be given.

Upon startup, the program queries the user for the non-rewinding pathnames of the drives, if there are any, found in the conguration of the jukebox. This query is not performed if the user is using a jukebox which does not require media to be ejected from a device, that is, if the device has automatic ejection capabilities.

The rst test moves the media from the rst slot to each of the drives. No operator intervention is required.

The second test loads the media from various slots to the rst drive. The default is to test the media in the rst and last slots in the jukebox. If a specic slot is being tested, the operator must rst load that slot with media.

OPTIONS C Makes jbexercise return the conguration of the jukebox. No tests are run.

c Species the control port which is used to interface with the jukebox (for example, 1.5.0 from scsidev@1.5.0, which could be found by issuing the inquire(1m) command).

d Tests only drives.

D Tests only the drive with the specied drive_number. The logical drive_number starts from 0 for the physical drive 1 in the jukebox.

I Returns only an inventory of the jukebox. No tests are run.

m Species the model of the jukebox. Note that for most jukeboxes, the model Standard SCSI jukebox should be the model used with the -m option. However, there are certain jukeboxes which require special handling. For these, the specic model name should be specied with the -m option. For a list of currently supported jukebox models, run this command without any arguments.

s Tests only slots.

S Tests only the specied slot.

v Verbose mode. Prints more information.

V Species a particular vendor id. This allows the vendor to use the same driver for a number of jukebox models.

NetWorker 19.1.1 83

Maintenance Commands jbexercise ( 1m )

SEE ALSO nsrjb(1m), nsr_jukebox(5)

DIAGNOSTICS Most diagnostic messages are specic to each type of jukebox. General messages include the following:

invalid <component> specied An invalid id for the <component> was given. The id must be within the valid ranges of the jukebox conguration. <component> can be a drive, port or slot.

status incorrect, media present There is media loaded in a component but the component status operation does not indicate this.

status incorrect, invalid slot location The component status operation is giving the incorrect source slot of the loaded media.

no drives found!!! No drives were listed in the conguration.

no slots found!!! No slots were listed in the conguration.

NetWorker 19.1.1 84

Maintenance Commands jbverify ( 1m )

NAME jbverify check jukebox/device congurations in NetWorker.

SYNOPSIS jbverify [ a ] [ d { i u } ] [ D devicename ]... [ f lename ] [ F ] [ h ] [ H hostname ]... [ I Invoker ] [ j ] [ J JB name ]... [ l ] [ M ] [ n ] [ N ] [ P port ] [ q ] [ Q ] [ r no. of retries ] [ R ] [ S slot ] [ s server ] [ t ] [ U ] [ v ]... [ Z ]

DESCRIPTION The jbverify command veries the devices dened in the NetWorker database to ensure that each one is congured properly by checking for accessibility and usability. To do this, jbverify makes use of NetWorker processes and requires that the Net- Worker server (nsrd) be running on the server machine, and that the NetWorker client (nsrexecd) be running on all of the client machines.

By default, jbverify checks all devices in the NetWorker database, but can be instructed to check only jukeboxes, only stand-alone drives, or only local devices by using the j, d, or l options, respectively. Individual jukeboxes and drives can also be checked by using the J and D options. Devices belonging to specic hosts can be checked using the H option.

For jukeboxes, jbverify ensures proper conguration by loading tapes into each drive and unloading them, without performing any write operations. The only exception to this is when the t option is used, as explained below. A slot to be used for the test can be specied by using the S option. If no slot is specied, jbverify goes through all the slots dened as available to NetWorker and loads the rst one available.

Apart from checking for accessibility and usability, jbverify, when used with the t option, can run a series of tests on tapes loaded into the drives being tested by calling on NetWorkers tapeexercise program (see tapeexercise(1m)).

Running tapeexercise involves writing to the tape to determine the tape drives usabil- ity, so when t is specied, any volume that has a NetWorker label on it is immedi- ately rejected as reserved/unusable and the next slot is tried. If there are no non- NetWorker tapes in any of the slots, jbverify exits without doing any tests.

The jbverify command can be run on any storage node, and can be used to test any device on that storage node, provided the device has been congured in NetWorker. When run on the NetWorker server, it can be used to test any device on the network that has been congured in NetWorker. For a storage node that is not a NetWorker server to be able to test devices other than its own, the nsrexecd on the target machine must be started with the s option with the invoking storage node as the argument, or have the invoking storage node listed in the target machines servers le.

For example, if the NetWorker server is node NS, and there are two storage nodes Sto1 and Sto2: for Sto1 to test devices on Sto2, the nsrexecd on Sto2 should be started as "nsrexecd -s NS -s Sto1." Either that, or the servers/rservers le on Sto2 should have Sto1 listed as one of the valid servers.

The jbverify command has extensive verbose messages built into it. In case of error in operation or inexplicable behavior, it is always helpful to use the v option to diag- nose the behavior.

OPTIONS a Tells jbverify to check all devices, even if they are disabled. By default, dis- abled devices are not tested. This option is not supported at present.

d This option tells jbverify to check only stand-alone drives. No jukebox devices are tested.

D This option is used to test a specic drive. The drive name must exactly match

NetWorker 19.1.1 85

Maintenance Commands jbverify ( 1m )

the name specied in the NetWorker drive resource. Multiple drives can be specied by using the D option multiple times. If a jukebox drive is specied using this option, it is treated as a stand-alone drive.

f Used to redirect jbverify output to a le. The argument is the le name to which the output is to be redirected.

F Reserved. This option is used internally by jbverify to indicate that this is a remotely forked jbverify.

h Show the help options.

H Tests the devices on the hostname mentioned. Use this option multiple times to test multiple hosts. Any other option specied on the command line along with H is propagated to the remote host being tested, except for the D and J options. When H is used, only devices belonging to that host are tested and therefore only those D and J options that specify devices belonging to that host are propagated forward.

i Go into interactive mode. Used with d for stand-alone devices. This option is useful when testing stand-alone devices on the local machine. If a particular stand-alone device does not have a tape loaded, the i option prompts the user to load a tape or cancel the operation so that it can skip to the next drive. The l option must be specied with the i option. Cannot be used with jukeboxes.

I Reserved. Used internally by jbverify to specify the name of the invoking host machine to a remote jbverify.

j Check jukebox devices only. The jbverify command checks only jukebox dev- ices dened in the NetWorker database. All other devices are ignored.

J This option is used to test a specic jukebox. The jukebox name should exactly match the name specied in the NetWorker jukebox resource. Multiple jukeboxes can be specied by using the J option multiple times.

l Check only local devices.

M Reserved. Used internally by jbverify to indicate that it is being invoked by a NetWorker process. Messages are sent to the NetWorker server instead of being echoed to the stdout.

n Perform tests in the no-op mode. The jbverify command runs through the motions of testing the devices after duly processing all given options, but does not actually do the tests.

N For a remote jbverify, put nsrexec into the same verbose mode as the jbverify. Usually redundant, but could be useful for debugging.

P Reserved. Used internally by the jbverify process to indicate to a remote jbver- ify the port number on which the server is listening.

q Run both the local and the remote jbverify in quiet mode.

Q Run only the remote jbverify in quiet mode. The results of the remote jbverify operation can still be seen in the nal status report printed out by the local jbverify. If v is used on the command line with Q, the local jbverify runs in verbose mode while the remote jbverify runs quietly. The q and v options are mutually exclusive. Specifying both results in jbverify running in level 1 verbose mode.

r Number of retries on error. Used exclusively for load and unload errors, and jbverify retries the number of times specied if there is an error in operation.

S Slot to be used for jukebox devices. The named slot is used to load tapes into jukebox devices during the test. If multiple jukeboxes are to be tested, ensure that the same slot in each of those jukeboxes has a valid tape. If t is specied,

NetWorker 19.1.1 86

Maintenance Commands jbverify ( 1m )

the tape in the slot must be a non-NetWorker tape or jbverify exits with an error.

s Name of NetWorker server being tested.

t Perform tapeexercise on tapes. See tapeexercise(1m) for details. If t is specied, there must be a non-NetWorker tape in one of the slots in order for the exercise to proceed. If S is specied, the specied slot must contain a non-NetWorker tape.

u Run in unattended mode. Similar to the i option and used for stand-alone devices only. If any device is not loaded with a tape, the u option skips the device and goes to the next one in the list. Either u or i must be specied with the d option.

U Output a UTF-8 encoded le. When used with the f option, the output le will be UTF-8 encoded.

v Run in verbose mode. Multiple v options can be specied to increase the level of verbosity. The higher the level, the more verbose the output. This currently has a maximum level of 5.

Z Reserved.

EXIT STATUS The following are the error numbers with which jbverify could exit: ENWTAPE (51) : Found NetWorker tape when trying to run tapeexercise. ELOADDETECT (52) : Unable to detect loaded state of a device. EMEMORY (53) : Out of memory. ESRCEMPTY (54) : The source slot was empty. EDSTFULL (55) : The destination drive was full. EUNLOAD (56) : Error in unload. EUNKNOWN (57) : Unexpected error. ERDLABEL (58) : Error in read label operation. ESPAWN (59) : Error in spawn operation. EREAP (60) : Error in reaping tapeexercise program. ELOADED (61) : Drive already loaded. ECONNECT (62) : Error in connect operation. ETAPE(40) : Error in tape device in tapeexercise. EBASICTEST(41) : Error in basic test in tapeexercise. EEOTTEST(42) : Error in EOT test in tapeexercise. EFSFTEST(43) : Error in FSF test in tapeexercise.

EXAMPLES Testing all devices without tapeexercise : To test all stand-alone and jukebox devices, run jbverify without options:

jbverify

To test all devices with verbose messages, use the v option the required number of times:

jbverify -v -v -v

Testing only stand-alone devices, in interactive mode: To test only stand-alone devices, use the d option; i sets the interactive mode:

jbverify -d -i -l

The l option must be specied when using the i option, since interactive mode is not supported for remote devices.

Testing only jukebox devices: To test only jukebox devices, use the j option:

NetWorker 19.1.1 87

Maintenance Commands jbverify ( 1m )

jbverify -j -v -v

Redirecting output to a le: To redirect the output of jbverify to a le, use the f option:

jbverify -j -f output.jbv v v v

Testing remote hosts To test all the jukebox devices on hosts A and B, use the H option:

jbverify H A H B j f outputle

This tests only the jukebox devices on both hosts A and B and redirects the output to outputle.

Running in quiet mode To run jbverify in quiet mode, use the q option:

jbverify q

This results in only the nal status report being printed. To run the local jbver- ify in verbose mode, but all remote operations quietly, use the Q option:

jbverify -v -v -v -Q

This results in verbose output for all local operations but none for the remote ones. The status of the remote operations can be seen in the nal status report.

Specifying no. of retries on load/unload operations: To specify a certain number of retries on errors, use the r option:

jbverify j r 10 S 12 v

The above command makes jbverify use slot 12 of the jukebox for load and unload operations and makes it retry 10 times on errors.

Running tapeexercise on tapes: To run tapeexercise on tapes loaded into devices, use the t option:

jbverify j S 12 t v

FILES /nsr/res/nsr.res The NetWorker resource database.

SEE ALSO jbcong(1m), jbexercise(1m), nsrjb(1m), nsr_device(1m), nsr_jukebox(5), nsr_storage_node(5), tapeexercise(1m)

DIAGNOSTICS The following are error messages that jbverify might produce, along with their impli- cations and possible solutions.

Bad resource database le! The jbverify command was unable to get the resource information about dev- ices from the NetWorker RAP database. Check to see whether the NetWorker Server is up and running and if it is reachable from the current host.

Basic Test in tape exercise failed! The Basic Test in tapeexercise failed on the loaded tape. See tapeexercise(1m) for more details.

Cant specify both -i and -u at the same time! The i and the u options are mutually exclusive. Choose one of them and retry operation.

Cannot use slot for stand-alone devices! Ignoring... The S option is useful only for jukeboxes. This is just a warning that the option is being ignored.

Cannot run in interactive mode for remote devices -- use -l! The i option is currently supported only for local devices. Specify l to test only the local devices.

NetWorker 19.1.1 88

Maintenance Commands jbverify ( 1m )

Could not connect to server! Quitting... The remote jbverify could not connect to the main jbverify for some reason. Examine other error messages to establish cause.

Could not establish server socket! Quitting... The jbverify command could not open a socket to receive requests from remote jbverifys. Examine previous error messages for exact cause of prob- lem.

Could not extract control port info. The jbverify command was unable to parse the jukebox resource information it obtained about a jukebox from the RAP database. This might indicate a corrup- tion of the RAP database in NetWorker. Check whether the contents of the jukebox resource can be seen in NetWorker Management Console. Retry opera- tion.

Couldnt nd control port in JB denition! The jbverify command was unable to parse the jukebox resource information it obtained about a jukebox from the RAP database. This might indicate a corrup- tion of the RAP database in NetWorker. Check whether the contents of the jukebox resource can be seen in NetWorker Management Console. Retry opera- tion.

Could not nd enabled drive <name> in database! A device was specied to be tested, but jbverify could not nd this device in the resource database of NetWorker. The most common reason would be an incorrectly specied device name. The device name must exactly match the name given in the NetWorker device resource, including the "rd=..." prex, if any.

Could not nd jukebox <name> in database! A jukebox was specied to be tested, but jbverify could not nd this jukebox in the resource database of NetWorker. The most common reason would be an incorrectly specied jukebox name. The name must exactly match the name given in the NetWorker jukebox resource, including the "rd=..." prex, if any.

Could not get block size for this tape! The jbverify command could not nd the dened blocksize for this tape. A default of 32k is usually assumed.

EOT Test in tape exercise failed! The EOT Test in tapeexercise failed on the loaded tape. See tapeexercise(1m) for details.

Error in checkmedia operation on host <name>! The remote jbverify reported an error in checking the status of the device. See earlier error messages for more information.

Error! Directory <name> doesnt exist! This message is printed when processing a disk le drive if the named direc- tory does not exist.

Error in eject tape from drive <name>! Skipping... There was a problem in ejecting the tape in the named drive. The jbverify command skips testing this device and continues with the next in line.

Error in read label operation! Cannot proceed with test! There was a problem while trying to read data from the loaded tape. Check previous error messages to nd the cause.

Error in resdb_query in getting device info. The jbverify command was unable to get the resource information about

NetWorker 19.1.1 89

Maintenance Commands jbverify ( 1m )

devices from the NetWorker RAP database. Check whether the NetWorker Server is up and running, and whether it is reachable from the current host.

Error in resdb_query in getting JB info. The jbverify command was unable to get the resource information about jukeboxes from the NetWorker RAP database. Check whether the NetWorker Server is up and running, and whether it is reachable from the current host.

Error in unload. Drive <num> (<name>), slot <num> There was an error in the unload operation of the named drive. Check previ- ous error messages for possible cause and error number. Try the operation again in a higher verbose mode.

Error in unloading jukebox drives: <name> There was an error while trying to unload the named drive. Check other error messages for cause.

Error reported in eject tape from drive <name>! Device is ofine. An error was reported by the NetWorker process during the eject operation, but the tape seems to have been ejected; jbverify continues to unload the tape to its slot.

FSF Test in tape exercise failed! The FSF Test in tapeexercise failed on the loaded tape. See tapeexercise(1m) for details.

Failed to create xdr stream! This usually denotes insufcient physical memory in the system. Check earlier error messages for more information.

Failed to detect loaded volume on drive <name> even after <num> tries. Giving up... The jbverify command failed to detect a loaded tape drive after putting a tape into the drive. This could happen if the drive is slow and the delay is too little. Try the operation again with a high number as the argument to the r option or increase the load sleep attribute in the jukebox resource.

Failed to get connection from remote jbverify! errno: <num> The jbverify command started a remote jbverify and is waiting for it to con- nect to it but has timed out without getting a connection request. Examine other error messages to nd the cause. One common cause is that the machine running jbverify does not have the permission to request execution on the remote machine. To obtain permission, the nsrexecd on the remote machine must be started with "-s ." See example in the main sec- tion of this man page for more information.

Failed to get response for check media from remote host <name> The jbverify command failed to get a response from the remote jbverify to a request for checking the status of a device. This could be because the remote jbverify was killed or terminated abnormally, the remote machine went down, or simply due to network problems. Ping the machine to check its status and retry the operation.

Failed to get stat packet! The jbverify command failed to receive an expected status packet from the remote jbverify. This could be because the remote jbverify was killed or ter- minated abnormally, the remote machine went down, or simply due to net- work problems. Ping the machine to check its status and retry the operation.

NetWorker 19.1.1 90

Maintenance Commands jbverify ( 1m )

Failed to read request packet from server! A remote jbverify failed to receive a request packet from the main jbverify. This could be because the main jbverify was killed or terminated abnormally, the machine went down, or simply due to network problems. Ping the machine to check its status and retry the operation.

Failed to redirect output to <name>. Errno <num> A system call failed. Run in verbose mode and contact support with error numbers and messages.

Failed to send FMEDIA on sock <num>! Errno <num> The jbverify command failed to send a request to check device status to the remote jbverify. This could be because the remote jbverify was killed or ter- minated abnormally, the remote machine went down, or simply due to net- work problems. Ping the machine to check its status and retry the operation.

Failed to spawn tapeexer! Failed to exec the NetWorker binary tapeexer. Check whether the binary exists and whether it has adequate permissions. Check other error messages for causes.

Failed to start nsrexec! errno: <num> The jbverify command failed to start the nsrexec process on the local machine. Examine previous error messages for exact cause. Some known causes are a missing nsrexec binary, missing execute permissions, or a corrupt le.

Failed to start remote jbverify on <host>! errno <num> The jbverify command was unable to start jbverify on a remote machine. Check earlier messages for more information. Some of the known causes are that nsrexecd is not running on the remote machine, nsrexecd is of a version prior to 6.1, or jbverify is running on a machine which is not the server and which is not allowed to request execution on the remote machine. The last cause listed can be rectied by running the remote nsrexecd with "-s -s " option where is the NetWorker Server machine and is the machine on which jbverify is running. See the explanation and example in the main section of this man page for more details.

Have to specify -i or -u with -d option. The d option must be specied with either the interactive i mode or the unattended u mode. Choose one of them and retry the operation.

Invalid option specied: <option>. An invalid option was specied. Use the h option to get a list of valid options.

Malloc error The system is out of physical memory. The jbverify command failed to allo- cate the required memory for an operation. Exit some applications and retry the operation or increase the amount of memory on the machine.

NetWorker tape (<label>) in the drive. Cannot proceed with test! The drive contains a tape with the named NetWorker label on it. If jbverify is run with t, it needs a tape without a NetWorker label to run the tapeexercise program successfully on it. If no non-NetWorker tape is in any of the slots, place one into a slot and retry the operation.

No block size found for this device: <name>! The jbverify command could not nd a blocksize dened for the named dev- ice in the NetWorker database. This usually means that a default of 32k is assumed for the device.

NetWorker 19.1.1 91

Maintenance Commands jbverify ( 1m )

No enabled stand alone devices found. The current conguration has no stand-alone device dened. This is simply an informational message.

No enabled jukeboxes found in database. The current conguration has no jukeboxes dened. This is simply an informa- tional message.

No tape in slot <num>. Quitting... If S was specied and there is no tape in the specied slot, jbverify posts this message and quits. Put a tape in the slot or specify another slot with a tape in it and retry the operation.

Query resdb failed, err: <errmsg>. A RAP query to the NetWorker database failed. Ensure that the NetWorker Server is up and running and is reachable from the current host.

Ran out of slots to choose from! Quitting... While trying to load a tape into a jukebox device, jbverify ran out of slots to try. If run with t, jbverify must nd a slot that has a tape without a Net- Worker label on it, since it will not overwrite NetWorker tapes even if they are no longer in the media database.

Received invalid request from server:type: %d The jbverify command received an unexpected request from the main jbver- ify. This could happen if the two machines involved are running different ver- sions of jbverify. Ensure that this is not so. Memory corruption could also be the cause. Retry the operation at verbose level 5 and if the error persists, send the log to customer support at EMC.

Received unknown packet from remote host <name>! The jbverify command received an unexpected packet from the remote jbver- ify. This could mean memory corruption. Retry the operation at verbose level 5 and if the error persists, send the log to customer support at EMC.

SCO postion Test in tape exercise failed! The SCO position Test in tapeexercise failed on the loaded tape. See tapeexercise(1m) for details.

Skipping disabled drive <name> The jbverify command does not currently test drives disabled in NetWorker. In the future, the a option might be enabled to do so.

Skipping to next drive in list... After a load/unload error, jbverify halted the test of a drive and moved to the next one in its list.

Slot <slot num> has Networker tape. The t option was used and the slot from which the drive was loaded con- tained a NetWorker tape. If the S option was used, this is a fatal error. If not, then jbverify will try other slots to see if it can nd a non-NetWorker tape.

Slot needs to be a valid number! The slot specied with the -S option must be a real slot number.

Source slot empty! <slot num> The S option was used, but the specied slot did not contain a tape. Specify a slot that contains a tape. If the t option is also being used, specify a slot with a non-NetWorker tape in it.

Tapeexer executable not found! The tapeexer executable was not found. Ensure that it exists.

Tapeexer exited on signal <num>

NetWorker 19.1.1 92

Maintenance Commands jbverify ( 1m )

The tapeexer process was killed by the given signal.

Tapeexer exited abnormally with exit code <num> The tapeexer process exited abnormally with the given exit code.

Tapexercise on <name> exited without an exit status! The jbverify command was unable to get the exit status of the tapeexer pro- cess. This is a rare case and might never happen unless the OS has a bug.

Unable to authenticate remote process! The jbverify command was unable to authenticate a connection request from the remote process.

Unable to get JB name! Skipping to next... The jbverify command was unable to nd any name specied for the jukebox in the jukebox resource. Check the jukebox resource for corruption and restore the NetWorker resource directory if needed.

Unable to nd any devices in jukebox! The jbverify command was unable to nd any devices congured for the jukebox. This is an error condition, since it is not usually possible to have an enabled jukebox in NetWorker with no dened devices. Check the NetWorker conguration and run jbverify again.

Unable to get device info for <name> The jbverify command could not nd any info for this device in the Net- Worker database. Ensure that the name of the device exactly matches the name dened in the NetWorker resource, including the "rd=..." prex if it is a remote device/jukebox.

Unable to get JB name! Skipping to next... The jbverify command was unable to parse the jukebox resource information it obtained about a jukebox from the RAP database. This might indicate a corrup- tion of the RAP database in NetWorker. See whether the contents of the jukebox resource are visible in NetWorker Management Console. Retry the operation.

Unable to load tape into drive <num> (<name>) as it seems to be loaded! The named drive contains a tape, even though jbverify must have unloaded it before trying the load. This might happen if the drives are not congured in the correct order in the jukebox. Ensure that the drive order is correctly congured in NetWorker.

Unable to to malloc for connlst! errno: <num> The system is out of physical memory. The jbverify command failed to allo- cate the required memory for an operation. Exit some applications and retry the operation or increase the anount of memory on the machine.

Unable to open <name>. Errno: <num> The jbverify command was unable to open the lename specied with the f option. Ensure that you have the proper permissions.

Unable to proceed to test drive <no>(<name>) in JB <name> as device is still loaded! The jbverify command found the named drive to be loaded inspite of having unloaded it before accessing it. Check whether any other application is using this jukebox. Also check (by looking at the error messages or by running in higher verbose mode) whether the previous unload operation by jbverify failed.

NetWorker 19.1.1 93

Maintenance Commands jbverify ( 1m )

Unable to unload drive <num> (<name>)! May not be congured right! The jbverify command was unable to unload the named drive. This might happen if the drives are not congured in the correct order in the jukebox. Ensure that the drive order is correctly congured in NetWorker.

Unknown state. Quitting... The jbverify command cannot determine the status of a load. This might hap- pen with corrupted memory. Try the operation again and contact EMC custo- mer support in case of failure.

NetWorker 19.1.1 94

Maintenance Commands JOBKILL ( 1m )

NAME jobkill NetWorker jobs termination program

SYNOPSIS jobkill [ s server ] [ c <client> ] [ t <job type> ] [ f <output_le> ] [ T <timeout> ]

jobkill [ s server ] [ f <output_le> ] [ T <timeout> ] j <jobid>

jobkill [ s server ] [ c <client> ] [ t <job type> ] [ f <output_le> ] [ T <timeout> ] i <input_le>

DESCRIPTION jobkill utility allows an administrator to kill individual jobs by specifying their jobid, or it will query jobs database for running jobs of a given type and/or on a given client and let an administrator kill them from the interactive prompt. Without arguments jobkill will query for all running jobs. If there are no running jobs fullling the cri- teria, jobkill exits silently.

In all modes, jobkill takes "-s " option to specify the server on which nsrjobd is running, and "-f <le>" to specify the le to which the output should be directed. In the "-i " mode, - is supported for input to be read from stdin. "-w" with no arguments can be used to instruct jobkill to poll nsrjobd for status until all requests have been obeyed by remote jobs.

One must be root to execute jobkill. Operate NetWorker priviledge is required for ter- minating jobs.

jobkill in default behaviour reports success once the termination request is ack- nowledged by nsrjobd. Normally jobkill does not wait for the termination request to complete, due to the asynchronous nature of the termination handling, and lack of a parent-child relationship between jobkill and the job being killed. -w provides an option to poll jobs status to detect the success or failure of actual termination opera- tions, but one needs to remember that it may take several minutes before the job obeys the request. This option is intended to be used in non-interactive mode, especially with the list of jobids provided in an input le. In interactive mode, a user can easily verify that the job had successfully exited using the r (refresh) command at the jobkills prompt.

jobkill can terminate anything that listens on a channel it has with nsrjobd. That means either an entire savegrp or any worker job spawned by nsrjobd. It cannot kill manually started jobs. A job terminated via jobkill will have the attribute "Reason job was terminated:" lled in with "Kill request from jobkill utility"

OPTIONS s server The name of the NetWorker server to contact. Appropriate permissions level (Operate NetWorker) will be enforced.

c client In interactive mode, limit the query to running jobs on specied client only. Can be combined with -t to further narrow down the result list.

j job id Single job id of the job to terminate.

t job type

NetWorker 19.1.1 95

Maintenance Commands JOBKILL ( 1m )

In interactive mode, limit the query to running jobs of the specied type only. Can be combined with -c to further narrow down the result list.

T timeout Timeout in seconds to wait before issuing a forceful shutdown signal (an equivalent of kill -9).

i input le Input le containing the list of job ids to terminate. - indicates stdin.

f output le File to direct the output to.

w Wait for the jobs to terminate before exiting. Due to the asynchronus nature of interaction with nsrjobd, normally jobkill considers it a success when nsrjobd indicates that the signal was sent on the channel without errors. It may take much longer for the job to actually exit. In interactive mode, r (refresh) can be used to check whether the job remains active. Using -w will cause jobkill to poll nsrjobd for status of the jobs until all termination requests have been obeyed. This option is intended for non-interactive mode of operation.

Example usage: 1) to kill an individual job jobkill -j jobid

2) to query nsrjobd and specify the jobid at the prompt jobkill [ -c ] [ -t ]

3) to kill multiple jobs at once using an input le jobkill -i

NetWorker 19.1.1 96

Maintenance Commands JOBQUERY ( 1m )

NAME jobquery NetWorker jobs database query program

SYNOPSIS jobquery [ s server ] [ i le ]

jobquery [ s server ] [ query ]

DESCRIPTION The jobquery command is a command-line based program used to query NetWorker servers jobs database. Its interface is similar to that of nsradmin program.

OPTIONS i le Takes input commands from le instead of from standard input. In this mode, the interactive prompt will not be printed.

s server Opens a connection to the named NetWorker server.

RECORDS Each jobs database entry is made up of a list of named attributes. Each attribute can have zero or more values. The attribute names and values are all represented by print- able strings. Comparisons are case-sensitive, and spaces are ignored except inside the names and values.

The format for specifying attributes and attribute lists is:

a ttr ibute ::= na m e [ : v a lue [ , v a lue ] ] An attribute is a name optionally followed by a colon, followed by zero or more values, with values separated by commas. A comma at the end of a line continues the line.

a ttr ibute list ::= a ttr ibute [ ; a ttr ibute ] An attribute list is one or more attributes separated by semicolons. A semi- colon at the end of a line continues the line. The list is ended by a newline that is not preceded by a comma or semi-colon.

Here is an example of an attribute list:

name: "nyx.lss.emc.com:Probe"; type: savefs job; jobid: 480435;

For more information on attributes and attribute lists see the resource(5), and nsr_resource(5), manual pages.

COMMANDS At each input prompt, jobquery expects a command name and some optional argu- ments. Command names can be shortened to the smallest unique string (for example, p for print). Command arguments are always specied in the form of an attribute list.

all Displays all entries in the jobs database.

help Print usage of all available commands.

print [quer y] Print the resources that match the current query. If a query is specied, it becomes the current query. If a name has been specied for the the current show list, only the attributes for the specied name in the show list will be displayed.

quit Exits jobquery

show [na m e; ...]

NetWorker 19.1.1 97

Maintenance Commands JOBQUERY ( 1m )

If a name list (really an attribute list with no values) is specied, add those names to the show list. Only these attributes will be displayed in subsequent print commands. If no name list is given the show list is cleared, resulting in all attributes being shown.

types Print a list of all known types.

. [quer y] If a query is specied, this command will set the current query without printing the results of the query. Otherwise, it will display the current query, show list, server binding, and options.

EXAMPLES print type:savefs job Print all entries of type savefs job and make this the current query.

show type; name Set the show list to display only the attributes type and name.

SEE ALSO nsr_resource(5), resource(5), nsradmin(1m).

DIAGNOSTICS The following exit status values are meaningful:

0 Program exited normally.

1 There was a usage or other non-query related error.

NetWorker 19.1.1 98

Maintenance Commands lcmap ( 1m )

NAME lcmap determine path-ownership in a cluster

SYNOPSIS lcmap

DESCRIPTION NetWorker software in a clustered environment needs to determine a mapping of a save path (lesystem or raw device) to the proper physical or virtual cluster client. This ensures that the data is saved to the correct NetWorker client name and facilitates recovery of a virtual NetWorker client irrespective of its current physical host. Path- ownership resolution also allows NetWorker server to identify with a virtual service in a cluster with its own conguration directory and become a highly available applica- tion when put under control of the cluster software.

A platform and cluster specic lcmap script is installed when the networker.cluster(1m) script is run in order to congure the NetWorker software as highly available. The lcmap script queries the cluster software and outputs to stdout the path-ownership information in the EMC Resource Administration Platform (RAP) format, which is cluster and platform independent. The lcmap script is called by Net- Worker software whenever the path-ownership information needs to be determined or updated. The format of the output is NetWorker internal and can change between the releases. The script should not be modied manually.

EXAMPLES The following is an example output from lcmap script: type: NSR_CLU_TYPE; clu_type: NSR_LC_TYPE; interface version: 1.0;

type: NSR_CLU_VIRTHOST; hostname: chase; owned paths: /global/chase/nsr;

type: NSR_CLU_VIRTHOST; hostname: hunt; owned paths: /global/hunt/data1, /global/hunt/data2;

SEE ALSO save(1m), savegrp(1m), nsrworkow(1m), pathownerignore(5), networker.cluster(1m) The NetWorker Administration Guide

NetWorker 19.1.1 99

Maintenance Commands ldunld ( 1m )

NAME ldunld load or unload a tape device

SYNOPSIS ldunld { -u -l } [ -a b.t.l ]

DESCRIPTION The ldunld program sends a load or unload command to a specied device.

OPTIONS a b.t.l Selects a specic ordinal SCSI address, where b is the logical SCSI bus, t is the SCSI target, and l is the SCSI logical unit number (LUN) on that target (see libscsi(1m)). This is a required option.

-u Unloads media from the specied device.

-l Loads media to the specied device.

SEE ALSO libscsi(1m)

NetWorker 19.1.1 100

Maintenance Commands lgtolic ( 1m )

NAME lgtolic EMC license utility command

SYNOPSIS lgtolic [ s server ] c enabler_code lgtolic i [ m hostle_dir ] lgtolic [ s server ] l lgtolic [ s server ] u enabler_code a authorization_code lgtolic [ s server ] v enabler_code

DESCRIPTION The lgtolic command is used to manipulate EMC licenses that are stored within a license resource database. The license resource database is administered by an EMC license daemon. For a description of the license daemon, see lgtolmd(1m).

OPTIONS a authorization_code Authorizes a license with the specied authorization code, making the license permanent. Specify the license to be authorized by using the u option with the a option. To obtain authorization codes for this product via the World Wide Web, simply point your web browser to customernet.emc.com in order to enter the enabler code for each authorization code that you request. For more details on product licensing, including other methods to obtain authori- zation codes, refer to the product Installation and Administration Guide and the latest Release Supplement.

c enabler_code Creates the license indicated by the specied enabler code. Enabler codes are listed on the enabler certicates provided to you when you purchased this pro- duct. An authorization code is required to make each license permanent.

i Prints out the hostid of the machine on which this command is running.

l Lists all of the EMC product licenses currently stored within your license resource database. This is the default.

m hostle_dir Species the directory where the hostids le resides. If this option is specied, the program will use the list of hostid(s) in the hostids le that resides in this directory to generate a composite hostid. This option is useful if the licensing manager is installed on a cluster machine or to force the hostid to be IP address-based instead of machine security ID-based on an NT machine. For NetWorker, the typical directory for the hostids le is /nsr/res. For a stand- alone licensing manager running on a machine that does not have the Net- Worker server installed, the typical path is /nsr/lic/res. The format for the list of hostids in a hostids le is: hostid1:hostid2:hostid3 where hostid is a hexade- cimal string. This option must be used to specify a hostid le.

s server Species the hostname, RPC program number, and version for the license dae- mon whose database you are targeting. License daemon information is displayed in the following format:

< hostname >:< rpc_number >:< version > Note: If you do not specify the s server option, lgtolic uses the default values that map to the daemon used by the product shipped. The current default for the hostname is localhost, the default for the RPC program number is 390115, and the default for the RPC version number is 2. You can also use environ- ment variables to change these three defaults. LMD_HOSTNAME changes the default hostname of the machine where the license daemon is running. LMD_PROGNUM changes the default RPC program number used for

NetWorker 19.1.1 101

Maintenance Commands lgtolic ( 1m )

connecting to the license daemon. You should never need to use this. LMD_VERSION changes the default RPC version number used for connecting to the license daemon. The following example uses the default hostname and RPC program number, but uses RPC version number 1 to list all licenses. Example: lgtolic -s "::1" -l To specify a license daemon located on an alternative machine, use the s < hostname > option.

u enabler_code Updates an installed license with the authorization code specied. This option must be used with the a option at the command line.

v enabler_code Deciphers the specied enabler code. The generated output includes informa- tion about the license name, type, serial number, and count.

NOTES The daemon information provided by the s option can also be obtained by using the following environment variables:

LMD_HOSTNAME, The name of the host for the license daemon

LMD_PROGNUM, The program number for the license daemon

LMD_VERSION, The version number for the license daemon

DIAGNOSTICS Program not registered lgtolmd is not running.

Unknown host Either the default hostname is invalid or the hostname specied with the s option is invalid.

SEE ALSO lgtolmd(1m)

NetWorker 19.1.1 102

Maintenance Commands lgtolmd ( 1m )

NAME lgtolmd Legato license daemon

SYNOPSIS lgtolmd p product n version

DESCRIPTION The lgtolmd daemon is an RPC-based licensing service. This service allows applica- tions to store and manipulate license data. The RPC program number provided by lgtolmd is 390115. To support multiple instances of the protocol, the version number is unique to each application. The required parameters are determined by each products installation script.

OPTIONS p product Specify the product that will be interfacing with the license daemon. The currently supported products are gems (for GEMS default install directory /gems), opt/SmartMedia (for SmartMedia default install directory /opt/SmartMedia), and nsr/lic (for NetWorker default install directory /nsr) on UNIX platforms.

n version Specify the version number. Some products use a unique version number. Currently, SmartMedia uses version 2 and GEMS Storage Reporter uses ver- sion 3. Both GEMS and NetWorker use version 1. The future plan is to have all EMC products use the same license manager, that is, version number 1.

FILES /[product]/res/lgtolm.res Attributes describing the license daemons license resources. This le should not be manually removed or modied in any way.

/[product]/res/lictype.res For internal use only. This le should not be manually removed or modied in any way.

/[product]/logs/lgtolmd.log Log le for diagnostic and informational messages on the license daemon. For example, if a license has expired, this information will be printed to this log as well as to the console.

SEE ALSO lgtolic(1m)

NetWorker 19.1.1 103

Maintenance Commands libcdi ( 1m )

NAME libcdi - EMC Common Device Interface Library

SYNOPSIS libcdi

DESCRIPTION The libcdi library is the EMC Common Device Interface Library.

ACCESS METHODS The following access methods are currently supported by the libcdi library. For all CDI test commands, if the t option is not specied, the default method is to use the OS tape driver SCSI passthrough functions.

OPTION ARGUMENT ACCESS METHOD -g Use old style MTIO platform generic functions -i Use iSCSI functions -m Use NDMP passthrough functions -n Use NDMP tape functions -s Use OS tape driver SCSI passthrough functions -t Use OS tape driver IOCTL functions

NetWorker 19.1.1 104

Maintenance Commands libscsi ( 1m )

NAME libscsi SCSI device library

DESCRIPTION The SCSI device library is a private set of interfaces that NetWorker uses to communi- cate with SCSI devices. Important: SCSI devices are named independently of the platform.

There are several functions in this library. The name of a SCSI device is identied as a combination of bus, target, and logical unit number (LUN) (b.t.l), where b is the logical scsi bus, t is the SCSI target, and l is the SCSI LUN on that target. Do not assume that a logical SCSI bus number is related to any specic platform or hardware bus number. Rather, a logical SCSI bus number is a dense positive integer address space that is con- sistent as long as the hardware conguration of the system remains the same. Target and LUN information is based upon the attached SCSI peripheral devices and their set- tings. Some platforms enable dynamic addition and removal of SCSI devices, but may require ushing of cached device information (see lrescan(1m)).

PERMISSIONS Typically, if a device has no system driver, system privileges are not required for users to send commands to this device. If a device has a system driver (for example, a tape drive), then system privileges are required in order to send a command to these dev- ices.

SEE ALSO lrescan(1m)

NetWorker 19.1.1 105

Maintenance Commands libsji ( 1m )

NAME libsji Standard Jukebox Interface (SJI) library

DESCRIPTION The Standard Jukebox Interface (SJI) is a public set of interfaces that NetWorker uses to communicate with jukeboxes. Generally the function of this library is to convert SJI commands, as formed by NetWorker, to the appropriate SCSI commands (since most autochangers are SCSI based). But the underlying attachment to the jukebox is irrelevant to the functioning of this interface.

There are three entry points into this library:

void sji_open ( char devname ) This opens a channel to an SJI compliant jukebox, named devname. A channel token, of type void is returned if the channel is opened successfully, other- wise a channel token of type NULL is returned. The device name devame can be a specic ordinal SCSI address, for example, scsidev@b.t.l, where b is the logical scsi bus, t is the SCSI target, and l is the SCSI logical unit number (LUN) on that target. For platforms that do not use EMC device drivers, the device name can also be a platform-specic style device name, for example, /dev/sjid1u1.

int sji_cmd ( void token, int cmd, void arg ) This sends an SJI command to the device opened by the sji_open command.

void sji_close ( void token ) This closes a channel to the device opened by the call made to the sji_open command.

FILES The location of the SJI library varies from platform to platform.

NetWorker 19.1.1 106

Maintenance Commands libstlemass ( 1m )

NAME dasadmin ADIC/EMASS/Grau silo administrative utility libstlemass shared library for communication to

ADIC/EMASS/Grau silo

SYNOPSIS dasadmin command [options] [parameters]

dasadmin.exe command [options] [parameters] (NT only)

libstlemass.so (Solaris) libstlemass.so.a (AIX) libstlemass.sl (HPUX) libstlemass.so.1 (SGI) libstlemass.so (DECAXP) libstlemass.dll (NT i386)

DESCRIPTION For dasadmin:

This is not a complete listing of all possible dasadmin commands, but does include those commands that are of use with NetWorker. For a complete discussion, see the DAS Installation and Administration guide provided by ADIC, EMASS or Grau.

mo[unt] [ t type ] volser [ drive-name ] Mounts the tape with the barcode label of volser into either the rst available drive (if drive-name is not specied) or into the drive specied by drive-name. If the tape is not the type dened by DAS_MEDIUM or ACI_MEDIA_TYPE, you can use the t type option to get the tape mounted. If the type of the tape and the dened type for the drive do not match, the silo will not load the tape. Note that the drive you are attempting to use must be allocated for your use before you can mount or dismount tapes. See listd and allocd below.

dism[ount] [ t type ] volser d drive-name Dismounts the tape that is either specied by volser or whatever is in the drive specied by drive-name. If the tape or drive are of a different type than your default, use the t type parameter. As with mount, you must have the drive allocated to you to use this command.

ej[ect] [ c ] [ t type ] volser-range area-name Ejects one or more tapes to the specied eject area. As with other commands, if the type of the tape you are ejecting is different from that dened by DAS_MEDIUM or ACI_MEDIA_TYPE, you will need the t type option. The c species a complete ejection for the specied volsers. A complete ejection removes the entry for that volser from the silo controllers internal database. A NON-complete ejection will eject the tape, but the volsers entry in the database will remain, and the volsers state will be set to ejected. This is useful if you anticipate replacing the tape in the silo soon.

in[sert] area-name Moves all tapes that are currently in the specied insert area-name from the insert area to the normal storage locations for tapes.

inventory Starts a full inventory of the silo. USE WITH CAUTION! An inventory of this sort can take a very long time! An inventory of a silo with 180 slots takes over 20 minutes.

view [ t type ] volser Displays the current status of volser, including the volser, type, attribute, and coordinate.

all[ocd] drive-name UP DOWN clientname The allocd command is used to allocate and deallocate drives for different

NetWorker 19.1.1 107

Maintenance Commands libstlemass ( 1m )

clients. Before you can use a tape drive, the drive must be allocded UP for your system. If it is currently allocded UP for a different client, it must rst be allocded DOWN for that client before being allocded UP for your system. You cannot allocd DOWN a drive that has a tape in it. The tape must be dismounted rst.

l[ist]d listd or ld shows the current state of all the tape drives dened in the silo. The information presented will include the drive-name, the amu drive (the location in the silo), status (UP or DOWN), type, client the drive is allocated to, and the volser of any loaded tape.

show op ac client-name Shows the operational or access parameters for the specied client-name. You must include either ac if you wish to see access parameters, or op if you wish to see operational parameters for the client-name. Access parameters include volser ranges and drive ranges that the client-name is allowed to use. Operational parameters include whether the client-name has complete access, dismount privileges along with the IP address entered for client-name.

list client-name Lists any outstanding requests that have been made by client-name. If there are any, they are shown, along with the request number and type.

can[cel] request-id Allows you to cancel an outstanding request, assuming that you have the necessary privileges. Use the request-id that was shown by the list command.

qversion Shows the version of the DAS server that you are connected to and the ver- sion of the ACI protocol you are using to talk to DAS.

qvolsrange beginvolser endvolser count [ clientname ] qvolsrange is the way to obtain a list of the volsers that are available in the silo. beginvolser and endvolser are volsers of the form "123456". To use the rst available or the last available, you can use "". count species the maximum number of volsers you wish to see.

ENVIRONMENT VARIABLES

These environment variables affect the operation of the silo, and since the processes that are using them include both the commands the user will enter and the processes that are spawned from nsrd, they need to be set in a location where they will be in place when nsrd is started. The three DAS_ variables are used by libstlemass, while dasadmin uses ACI_MEDIA_TYPE instead of DAS_MEDIUM.

For Solaris, the denitions should be placed in /etc/rc.2/S95networker.

For AIX, the denitions should be placed in /etc/rc.nsr.

For HPUX, the denitions should be placed in /sbin/rc2.d/S900networker.

DAS_SERVER This is either the network name or the IP address of the system that is running DAS. For a single silo, this will usually be the silo controller system. In larger installations, there will probably be only one DAS server for the whole net- work. It is case-sensitive.

DAS_CLIENT This is the network name of the system that NetWorker is running on. It is case-sensitive.

DAS_MEDIUM This variable is used by libstlemass. It should be the same as ACI_MEDIA_TYPE. This is the type of tape drive you are connected to. If this is not specied, the

NetWorker 19.1.1 108

Maintenance Commands libstlemass ( 1m )

default value of DLT will be used.

ACI_MEDIA_TYPE This variable is used by dasadmin. It should be the same as DAS_MEDIUM. This is the type of tape drive you are connected to. If this is not specied, the default value of DLT will be used. Acceptable values are the same as those listed under DAS_MEDIUM.

EXAMPLES NOTE on ranges: The dasadmin utility will accept volser ranges for some commands. There are three acceptable variations for these ranges: single volser: "000635" multiple volsers: "000635, 000789, 098732" true range: "000610 - 000745"

NOTE on area-name and drive-name : area-names usually consist of a letter and 2 digits. The letter corresponds to whether you are referring to an insert area ("I") or an eject area ("E"). You will need to get the correct values from your silo administrator before using them. drive-names are essentially free-form labels created by whomever installed the silo. They may or may not have any relevance to physical reality, so you will need to see the silo admin to get the correct names. If the silo admin is not available, you can get the same information using dasadmin listd along with dasadmin show op client-name followed by dasadmin show ac client-name commands.

To set up the environment variables necessary for silo operations: setenv DAS_SERVER emask setenv DAS_CLIENT aurora setenv DAS_MEDIUM DLT setenv ACI_MEDIA_TYPE DECDLT

To see a listing of all volsers available in the silo: dasadmin qvolsrange "" "" 10000

To see the current status of the drives in the silo: dasadmin listd

To change the allocation of a drive from client a4 to client aurora: dasadmin allocd DLT1 DOWN a4 dasadmin allocd DLT1 UP aurora

SEE ALSO nsrjb(1m), jbcong(1m), libstlstk(1m), mini_el(1m), ssi(1m), libstlibm(1m)

DIAGNOSTICS The only available diagnostic information is error messages that may be printed out by dasadmin and libstlemass in the course of normal operations.

NetWorker 19.1.1 109

Maintenance Commands libstlibm ( 1m )

NAME libstlibm shared library for communication to IBM 3494 silos

SYNOPSIS libstlibm.so (Solaris) libstlibm.so.a (AIX)

DESCRIPTION libstlibm.xxx is a shared library that handles the communication between nsrjb and the IBM silo driver (on AIX) or daemon (on Solaris). The IBM driver/daemon then handles the communication over the network to the silo. There are no options, param- eters or environment variables that affect the operation of libstlibm. The correct path to this le should be entered when an IBM silo is congured using jbcong. The default values specied by jbcong match the default locations chosen for the installa- tion program, and in most cases can be accepted.

For NetWorker to work with the 3494, you must have rst installed IBMs Automated Tape Library support.

On AIX, you will need to install a driver called atldd (Automated Tape Library Device Driver). You may also require the IBMtape driver (Enhanced Tape and Medium Changer Device Driver) if you are using 3590 drives in your 3494.

On Solaris, you will need to install the lmcpd package, (IBM Automated Tape Library Daemon) to use the silo. Again, if you are using 3590 drives, you will also need to install the IBMtape driver. Note that when you are using IBMtape, there will be two sets of device les that will access a given tape drive. There will be the standard Solaris style /dev/rmt/Xmbn type, and there will be the IBMtape supported les of the type /dev/rmt/Xstbn. You should use the IBM supported device les for proper opera- tion of your tape drives.

Note: EMC cannot supply these IBM drivers. They may be available on an IBM Device Driver ftp site (208.200.29.244), but this is not necessarily a long-term IBM committed site.

SEE ALSO nsrjb(1m), jbcong(1m), dasadmin(1m), libstlemass(1m), ssi(1m), mini_el(1m), libstlstk(1m)

DIAGNOSTICS Errors in communication between the NetWorker server and the IBM 3494 silo are difcult to diagnose. The best method is to use the IBM supplied utility mtlib to ver- ify that you have properly congured the 3494 to communicate with your host, and that the entire pathway from either the lmcp driver (on AIX) or the lmcpd daemon (on Solaris) is functioning properly. If mtlib does not work, then there is no chance that NetWorker will work.

If there are any questions about the connection between your host and the 3494, it is best to consult IBM, as they support the connection between the host and the silo. IBM supports both network and serial cable connections to the silo. Since the nature of the connection is hidden from NetWorker by the driver/daemon, there is no differ- ence to NetWorker between the two. Customers have successfully used both.

NetWorker 19.1.1 110

Maintenance Commands libstlstk ( 1m )

NAME ssi StorageTek silo interface module (UNIX only) mini_el event logger for use with ssi (UNIX only) libstlstk shared library for communication to ssi

SYNOPSIS ssi [ A ACSLS server ] [ a ACSLS port number ] [ S SSI port number ] [ P port number ] [ r retry count ] &

mini_el [ l logle ] [ d ] [ h ] &

libstlstk.so (Solaris) libstlstk.so.a (AIX) libstlstk.sl (HPUX) libstlstk.so.1 (SGI) libstlstk.so.1 (DYNIX/ptx) libstlstk.so (DECAXP) libstlstk.dll (NT i386)

DESCRIPTION NOTE: in this document, the term "ACSLS server" will be used to indicate the name of the system that is running any one of StorageTeks library manager programs: ACSLS on a Solaris or AIX host, Library Station on an MVS host, or Horizon Library Manager on a system running Windows NT or Windows 2000.

(UNIX only)

The ssi command is used indirectly by nsrjb to communicate with an ACSLS server. nsrjb loads libstlstk, which handles the TCP calls to and from ssi. ssi then handles all of communication to and from the ACSLS server. Starting with ACSLS version 5.3, it is possible to run NetWorker (either a server or a storage node) on the same host that ACSLS is running on.

ssi and mini_el must be running on the system on which jbcong was run to create the jukebox resource. ssi and mini_el are almost always run as background processes, and are usually started automatically by the system.

In addition to ssi and mini_el, a shared library le (usually called libstlstk.xxx where xxx is an operating system-dependent extension) is also required. An appropriate ver- sion of this library is installed as part of NetWorker.

New in version 2.00 of ssi:

ssi now supports communication with the ACSLS server on a specied port number, using the a command line option. This is part of the STK rewall enhancement. The ACSLS server must be running version 7.1 to use this functionality.

While you can still start ssi the same way as before - using the environment variable CSI_HOSTNAME to select the ACSLS server to connect to - you can also specify the ACSLS server hostname on the command line using the -A option. By using the a option, you may specify the port number that the ssi process will use when connect- ing to the ACSLS server. The ACSLS server must be congured to listen on this port. Using the S option, the ssi process can be congured to listen for response messages on a specic port. You may also specify the port number used for communication between NetWorker and that particular instance of ssi using the -P option. The allowed values for this port number are 50004 (for the rst instance), 50011 to 50019, and 50021 to 50099. Note that if you specify a port number that is already being used by an instance of ssi, the specied port cannot be used, and the next available port in the allowed range will be selected. If the port number is not specied, each succes- sive instance of ssi will take the next available port starting from 50004 and going upwards. If there are no available ports in the range, ssi will fail to load and should

NetWorker 19.1.1 111

Maintenance Commands libstlstk ( 1m )

display an error message. Note that specifying the port number is not necessary for normal operation. You do not need to insure that a given ACSLS server is always accessed over a given port. NetWorker and ssi use the name of the ACSLS server to establish a connection on the y.

If the A option is not used to specify a hostname on the ssi command line, the environment variable CSI_HOSTNAME must be set to the name of the library server, before the ssi process is started. If this variable is not found, ssi will exit with an error message.

mini_el is an event logger used by ssi to maintain a log of certain events. It should be started before ssi. Multiple instances of ssi will share a single instance of mini_el. A header consisting of the ACSLS server name and the local TCP port that ssi will be listening on is included at the start of any message placed into the log by any instance of ssi

(NT only)

On NT, the software equivalent to ssi and mini_el must be obtained from StorageTek as their product "Library Attach for NT". This package must be installed prior to conguring a Silo in NetWorker.

NOTE: Library Attach version 1.1 includes a portmapper function that will only install properly if the NetWorker services are not running. You should use Control Panel to stop the "NetWorker Backup and Recover Server" and the "NetWorker Remote Exec Service" before installing Library Attach. After Library Attach is installed, you should use Control Panel to start "NetWorker Remote Exec Service" and "NetWorker Backup and Recover Server".

NOTE: Since EMC does not supply "Library Attach for NT", we are unable to add the multiple ACSLS host functionality to our NT version of NetWorker.

NOTE: The rewall enhancements added to the ssi and mini_el processes are not available on systems running Windows.

(All platforms)

libstlstk.xxx is a shared library that handles the communication between nsrjb and ssi or Library Attach. ssi or Library Attach then handles the communication over the network to the library server (either ACSLS, Library Station or Horizon Library Manager). There are no options, parameters or environment variables that affect the operation of libstlstk. The correct path to this le should be entered when an STK silo is congured using jbcong. The default values specied by jbcong match the default locations chosen for the installation program, and in most cases can be accepted.

OPTIONS mini_el:

l logle Species the lename of the logle to be created by mini_el. The default value is /nsr/logs/ssi_event.log. If present, logle must be the complete path to the logle. If the le does not exist, it will be created. If the le does exist, it will be appended to. If there is not a l parameter, the default logle /nsr/logs/ssi_event.log will be used.

d Sets the debug ag. mini_el will output debug information.

h Displays usage information for mini_el.

NetWorker 19.1.1 112

Maintenance Commands libstlstk ( 1m )

ssi:

A ACSLS server is required if the CSI_HOSTNAME environment variable has not been set to the name of the system running ACSLS, LibraryStation or Horizon.

a ACSLS port number is only required if you need to specify the port number used for communication between the ssi process and the ACSLS server. If the ACSLS server is congured to listen on a specic port, this value should be set to that port number.

S SSI port number will force the ssi process to listen on the specied port number. This port is used in communications with the ACSLS server.

P port number is only required if you need to specify the port to be used for commun- ication between NetWorker and the ssi process. The allowed values for this port number are 50004 (for the rst instance), 50011 to 50019, and 50021 to 50099. Note that if you specify a port number that is already being used by an instance of ssi, the specied port cannot be used, and the next available port in the allowed range will be selected.

r retry count is only required if you need to increase the retry count for communica- tion between ssi and the ACSLS server due to network problems.

These parameters are not position sensitive. The command line option will be parsed accordingly in the ssi process.

ENVIRONMENT VARIABLES

ssi:

CSI_HOSTNAME (text, up to 256 chars, there is no default) If an ACSLS server name is not found on the command line, ssi will use the hostname specied by this variable. It is limited to 256 characters, and should simply be the hostname running the library server program that you are trying to connect to. If neither the command line hostname nor this environment variable specify a hostname for ssi to use, ssi will exit with an error message.

SSI_HOSTNAME (text, up to 256 chars, there is no default) This variable is intended for use on multi-homed systems. Normally, ssi uses the gethostbyname system function to determine the name to use for this side of the connection to the ACSLS server. On a system with several network interfaces, the name supplied by that function may not result in the use of the network interface needed to communicate with the ACSLS server. On these systems, you can explicitly specify the exact name of the network interface that ssi will use to connect to the ACSLS server. This variable needs to be set before ssi is started, and may be different for various instances of ssi In all cases, a message will be logged in the event log stating if this environment variable was found, and if not, that ssi will be using the hostname returned by gethostbyname. This is not an error message.

SSI_BASE_SOCKET (numeric, 0 < x < 64k, no default) If you need to restrict the socket values that ssi communicates on, this variable species the starting number for ssi to use when it needs to open a socket to talk to the ACSLS server. It appears that ssi will only open two sockets if this variable is set. The rst, at SSI_BASE_SOCKET, will be used to connect to any host. The second, at SSI_BASE_SOCKET + 1, will be used for direct com- munication to the ACSLS server. Note that there will still be the default sock- ets at 50001 and 50004 used to communicate between mini_el and ssi, but any communication between this host and the ACSLS server should occur using the two sockets starting at SSI_BASE_SOCKET.

NetWorker 19.1.1 113

Maintenance Commands libstlstk ( 1m )

NOTE: This environment variable will be ignored if the a option is used with a valid port number.

TIME_FORMAT (time format string, default = "%m-%d-%y %H:%M:%S") If you wish to see time values printed in a format other than the default of Month-Day-Year Hour:Minute:Seconds, use this variable.

%m is replaced by the current month %d is replaced by todays date %y is replaced by the current year %H is replaced by the current hour %M is replaced by the current minute %S is replaced by the current second

CSI_CONNECT_AGETIME (seconds, 0 < x < 31536000, default = 600) This will set the number of seconds for network connect aging purposes.

CSI_RETRY_TIMEOUT (seconds, 0 < x < 4,294,967,295, default = 4) This will set how long ssi will wait before retrying a network request.

CSI_RETRY_TRIES (numeric, 0 < x < 100, default = 5) This will set the number of times ssi will retry sending a network message before reporting an error.

CSI_TCP_RPCSERVICE (boolean, default is TRUE) This sets whether ssi will use TCP sockets to connect with the library server.

CSI_UDP_RPCSERVICE (boolean, default is FALSE) This sets whether ssi will use UDP sockets to connect with the library server. Setting CSI_UDP_RPCSERVICE to TRUE will allow ssi to communicate with a csi that is running on the same system.

EXAMPLES Normal STK silo setup: mini_el & ssi acsls1 &

or mini_el & setenv CSI_HOSTNAME acsls1 ssi &

Connect to 3 different ACSLS servers: mini_el & ssi -A acsls1 & ssi -A acsls2 & ssi -A acsls3 &

or mini_el & setenv CSI_HOSTNAME acsls1 ssi & setenv CSI_HOSTNAME acsls2 ssi & setenv CSI_HOSTNAME acsls3 ssi &

Connect to 3 different ACSLS servers over 3 different network interfaces:

mini_el & setenv SSI_HOSTNAME myhost_on_net1

NetWorker 19.1.1 114

Maintenance Commands libstlstk ( 1m )

ssi -A acsls1 & setenv SSI_HOSTNAME myhost_on_net2 ssi -A acsls2 & setenv SSI_HOSTNAME myhost_on_net3 ssi -A acsls3 &

Connect to ACSLS server congured to accept connections on port 30031 mini_el & ssi -A acsls1 -a 30031 &

or setenv CSI_HOSTNAME acsls1 mini_el & ssi -a 30031 &

To have mini_el use /nsr/logs/ssi.log.today as its log le

mini_el -l /nsr/logs/ssi.log.today & ssi -A acsls1 &

FILES /nsr/logs/ssi_event.log default logle created/appended to by mini_el

SEE ALSO nsrjb(1m), jbcong(1m), dasadmin(1m), libstlemass(1m), libstlibm(1m)

DIAGNOSTICS Several startup and shutdown messages along with any errors in communication between the NetWorker server and the ACSLS server will be logged in the logle /nsr/logs/ssi_event.log (or other logle as specied on the mini_el command line). The messages from any one ssi instance will be preceded by the name of the ACSLS server that that instance will be communicating with plus the local TCP port number that will be used between NetWorker and ssi.

For example: 10-12-00 12:31:44 SSI[0]: [devlab-acsls/50004] ONC RPC: csi_init(): Initiation Started source csi_init.c; line 165

10-12-00 12:33:20 SSI[0]: [acsls2/50011] ONC RPC: csi_init(): Initiation Completed ONC RPC: csi_init(): ACSLS server acsls2 accessed through port 50011

NetWorker 19.1.1 115

Maintenance Commands lrescan ( 1m )

NAME lrescan rescan for devices

SYNOPSIS lrescan

DESCRIPTION The lrescan program tells the underlying SCSI library to discard any cached informa- tion and scan again for new devices (see libscsi(1m)).

SEE ALSO libscsi(1m)

NetWorker 19.1.1 116

Maintenance Commands lreset ( 1m )

NAME lreset reset SCSI bus

SYNOPSIS lreset busnumber

DESCRIPTION The lreset program tells the underlying SCSI library (see libscsi(1m)) to reset the named logical scsi bus. You must have system privileges to execute this command.

WARNINGS This command can cause the destruction of vital data since it will cause a SCSI bus reset. This may also crash your system. You should only use it as an extreme last resort to abort a hung command.

SEE ALSO libscsi(1m)

NetWorker 19.1.1 117

Maintenance Commands lusbinfo ( 1m )

NAME lusbinfo print SCSI information

SYNOPSIS lusbinfo [ -v ]

DESCRIPTION The lusbinfo program prints a limited amount of information about the SCSI busses attached to the computer.

If you use the optional -v argument, additional information about the devices in the attached SCSI busses will also print.

NetWorker 19.1.1 118

Maintenance Commands lusdebug ( 1m )

NAME lusdebug set library debugging level

SYNOPSIS lusdebug debug-level

DESCRIPTION The lusdebug command sets a debugging level for the underlying NetWorker SCSI device drivers.

Debugging level 0 (zero) turns off debugging. Larger numbers enable greater levels of debugging.

The lusdebug level can now be specied as a bitmask; bit X set will show messages that are set to show at debug level X+1. For example, bit 0 set will cause messages at debug level 1 to be displayed. The exact level for any given message is listed at the end of the message in parentheses, such as (1m) for a message displayed for debug level 8.

Using the bitmask allows you to display any or all levels of debugging information. The old method only allowed you to set the highest level you wished to see; all levels lower that the selected level were always displayed, whether you wanted to see them or not.

You may still specify debugging levels the old way using by using the values old1 through old9. The results will be displayed using the new bitmask format.

Values can be entered in decimal (0 to 65535), hex (0x0 - 0xffff), or binary (0b0 - 0b1111111111111111). Zeros after the 0x or 0b prexes are not required for binary or hex values.

Values that correspond to previous debug levels are: new new new

old decimal hex binary 1 1 0x0001 0x0000000000000001 2 3 0x0003 0x0000000000000011 3 7 0x0007 0x0000000000000111 4 15 0x000f 0x0000000000001111 5 31 0x001f 0x0000000000011111 6 63 0x003f 0x0000000000111111 7 127 0x007f 0x0000000001111111 8 255 0x00ff 0x0000000011111111 9 511 0x01ff 0x0000000111111111 10 1023 0x03ff 0x0000001111111111 11 2047 0x07ff 0x0000011111111111 12 4095 0x0fff 0x0000111111111111 13 8191 0x1fff 0x0001111111111111 14 16383 0x3fff 0x0011111111111111 15 32767 0x7fff 0x0111111111111111 16 65535 0xffff 0x1111111111111111

Values corresponding to individual debug level are: new new new

old decimal hex binary 1 1 0x0001 0x0000000000000001 2 2 0x0002 0x0000000000000010 3 4 0x0004 0x0000000000000100

NetWorker 19.1.1 119

Maintenance Commands lusdebug ( 1m )

4 8 0x0008 0x0000000000001000 5 16 0x0010 0x0000000000010000 6 32 0x0020 0x0000000000100000 7 64 0x0040 0x0000000001000000 8 128 0x0080 0x0000000010000000 9 256 0x0100 0x0000000100000000 10 512 0x0200 0x0000001000000000 11 1024 0x0400 0x0000010000000000 12 2048 0x0800 0x0000100000000000 13 4096 0x1000 0x0001000000000000 14 8192 0x2000 0x0010000000000000 15 16384 0x4000 0x0100000000000000 16 32768 0x8000 0x1000000000000000

LIMITATIONS Invalid debug levels are treated the same as debug level zero.

Debug level values greater than 65535 (0xffff, binary 0x1111111111111111) will be treated as 65535 (0ffff, binary, and so forth).

NetWorker 19.1.1 120

Maintenance Commands mini_el ( 1m )

NAME ssi StorageTek silo interface module (UNIX only) mini_el event logger for use with ssi (UNIX only) libstlstk shared library for communication to ssi

SYNOPSIS ssi [ A ACSLS server ] [ a ACSLS port number ] [ S SSI port number ] [ P port number ] [ r retry count ] &

mini_el [ l logle ] [ d ] [ h ] &

libstlstk.so (Solaris) libstlstk.so.a (AIX) libstlstk.sl (HPUX) libstlstk.so.1 (SGI) libstlstk.so.1 (DYNIX/ptx) libstlstk.so (DECAXP) libstlstk.dll (NT i386)

DESCRIPTION NOTE: in this document, the term "ACSLS server" will be used to indicate the name of the system that is running any one of StorageTeks library manager programs: ACSLS on a Solaris or AIX host, Library Station on an MVS host, or Horizon Library Manager on a system running Windows NT or Windows 2000.

(UNIX only)

The ssi command is used indirectly by nsrjb to communicate with an ACSLS server. nsrjb loads libstlstk, which handles the TCP calls to and from ssi. ssi then handles all of communication to and from the ACSLS server. Starting with ACSLS version 5.3, it is possible to run NetWorker (either a server or a storage node) on the same host that ACSLS is running on.

ssi and mini_el must be running on the system on which jbcong was run to create the jukebox resource. ssi and mini_el are almost always run as background processes, and are usually started automatically by the system.

In addition to ssi and mini_el, a shared library le (usually called libstlstk.xxx where xxx is an operating system-dependent extension) is also required. An appropriate ver- sion of this library is installed as part of NetWorker.

New in version 2.00 of ssi:

ssi now supports communication with the ACSLS server on a specied port number, using the a command line option. This is part of the STK rewall enhancement. The ACSLS server must be running version 7.1 to use this functionality.

While you can still start ssi the same way as before - using the environment variable CSI_HOSTNAME to select the ACSLS server to connect to - you can also specify the ACSLS server hostname on the command line using the -A option. By using the a option, you may specify the port number that the ssi process will use when connect- ing to the ACSLS server. The ACSLS server must be congured to listen on this port. Using the S option, the ssi process can be congured to listen for response messages on a specic port. You may also specify the port number used for communication between NetWorker and that particular instance of ssi using the -P option. The allowed values for this port number are 50004 (for the rst instance), 50011 to 50019, and 50021 to 50099. Note that if you specify a port number that is already being used by an instance of ssi, the specied port cannot be used, and the next available port in the allowed range will be selected. If the port number is not specied, each succes- sive instance of ssi will take the next available port starting from 50004 and going upwards. If there are no available ports in the range, ssi will fail to load and should

NetWorker 19.1.1 121

Maintenance Commands mini_el ( 1m )

display an error message. Note that specifying the port number is not necessary for normal operation. You do not need to insure that a given ACSLS server is always accessed over a given port. NetWorker and ssi use the name of the ACSLS server to establish a connection on the y.

If the A option is not used to specify a hostname on the ssi command line, the environment variable CSI_HOSTNAME must be set to the name of the library server, before the ssi process is started. If this variable is not found, ssi will exit with an error message.

mini_el is an event logger used by ssi to maintain a log of certain events. It should be started before ssi. Multiple instances of ssi will share a single instance of mini_el. A header consisting of the ACSLS server name and the local TCP port that ssi will be listening on is included at the start of any message placed into the log by any instance of ssi

(NT only)

On NT, the software equivalent to ssi and mini_el must be obtained from StorageTek as their product "Library Attach for NT". This package must be installed prior to conguring a Silo in NetWorker.

NOTE: Library Attach version 1.1 includes a portmapper function that will only install properly if the NetWorker services are not running. You should use Control Panel to stop the "NetWorker Backup and Recover Server" and the "NetWorker Remote Exec Service" before installing Library Attach. After Library Attach is installed, you should use Control Panel to start "NetWorker Remote Exec Service" and "NetWorker Backup and Recover Server".

NOTE: Since EMC does not supply "Library Attach for NT", we are unable to add the multiple ACSLS host functionality to our NT version of NetWorker.

NOTE: The rewall enhancements added to the ssi and mini_el processes are not available on systems running Windows.

(All platforms)

libstlstk.xxx is a shared library that handles the communication between nsrjb and ssi or Library Attach. ssi or Library Attach then handles the communication over the network to the library server (either ACSLS, Library Station or Horizon Library Manager). There are no options, parameters or environment variables that affect the operation of libstlstk. The correct path to this le should be entered when an STK silo is congured using jbcong. The default values specied by jbcong match the default locations chosen for the installation program, and in most cases can be accepted.

OPTIONS mini_el:

l logle Species the lename of the logle to be created by mini_el. The default value is /nsr/logs/ssi_event.log. If present, logle must be the complete path to the logle. If the le does not exist, it will be created. If the le does exist, it will be appended to. If there is not a lparameter, the default logle /nsr/logs/ssi_event.log will be used.

d Sets the debug ag . mini_el will output debug information.

h Displays usage information for mini_el.

NetWorker 19.1.1 122

Maintenance Commands mini_el ( 1m )

ssi:

A ACSLS server is required if the CSI_HOSTNAME environment variable has not been set to the name of the system running ACSLS, LibraryStation or Horizon.

a ACSLS port number is only required if you need to specify the port number used for communication between the ssi process and the ACSLS server. If the ACSLS server is congured to listen on a specic port, this value should be set to that port number.

S SSI port number will force the ssi process to listen on the specied port number. This port is used in communications with the ACSLS server.

P port number is only required if you need to specify the port to be used for commun- ication between NetWorker and the ssi process. The allowed values for this port number are 50004 (for the rst instance), 50011 to 50019, and 50021 to 50099. Note that if you specify a port number that is already being used by an instance of ssi, the specied port cannot be used, and the next available port in the allowed range will be selected.

r retry count is only required if you need to increase the retry count for communica- tion between ssi and the ACSLS server due to network problems.

These parameters are not position sensitive. The command line option will be parsed accordingly in the ssi process.

ENVIRONMENT VARIABLES

ssi:

CSI_HOSTNAME (text, up to 256 chars, there is no default) If an ACSLS server name is not found on the command line, ssi will use the hostname specied by this variable. It is limited to 256 characters, and should simply be the hostname running the library server program that you are trying to connect to. If neither the command line hostname nor this environment variable specify a hostname for ssi to use, ssi will exit with an error message.

SSI_HOSTNAME (text, up to 256 chars, there is no default) This variable is intended for use on multi-homed systems. Normally, ssi uses the gethostbyname system function to determine the name to use for this side of the connection to the ACSLS server. On a system with several network interfaces, the name supplied by that function may not result in the use of the network interface needed to communicate with the ACSLS server. On these systems, you can explicitly specify the exact name of the network interface that ssi will use to connect to the ACSLS server. This variable needs to be set before ssi is started, and may be different for various instances of ssi In all cases, a message will be logged in the event log stating if this environment variable was found, and if not, that ssi will be using the hostname returned by gethostbyname. This is not an error message.

SSI_BASE_SOCKET (numeric, 0 < x < 64k, no default) If you need to restrict the socket values that ssi communicates on, this variable species the starting number for ssi to use when it needs to open a socket to talk to the ACSLS server. It appears that ssi will only open two sockets if this variable is set. The rst, at SSI_BASE_SOCKET, will be used to connect to any host. The second, at SSI_BASE_SOCKET + 1, will be used for direct com- munication to the ACSLS server. Note that there will still be the default sock- ets at 50001 and 50004 used to communicate between mini_el and ssi, but any communication between this host and the ACSLS server should occur using the two sockets starting at SSI_BASE_SOCKET.

NetWorker 19.1.1 123

Maintenance Commands mini_el ( 1m )

NOTE: This environment variable will be ignored if the a option is used with a valid port number.

TIME_FORMAT (time format string, default = "%m-%d-%y %H:%M:%S") If you wish to see time values printed in a format other than the default of Month-Day-Year Hour:Minute:Seconds, use this variable.

%m is replaced by the current month %d is replaced by todays date %y is replaced by the current year %H is replaced by the current hour %M is replaced by the current minute %S is replaced by the current second

CSI_CONNECT_AGETIME (seconds, 0 < x < 31536000, default = 600) This will set the number of seconds for network connect aging purposes.

CSI_RETRY_TIMEOUT (seconds, 0 < x < 4,294,967,295, default = 4) This will set how long ssi will wait before retrying a network request.

CSI_RETRY_TRIES (numeric, 0 < x < 100, default = 5) This will set the number of times ssi will retry sending a network message before reporting an error.

CSI_TCP_RPCSERVICE (boolean, default is TRUE) This sets whether ssi will use TCP sockets to connect with the library server.

CSI_UDP_RPCSERVICE (boolean, default is FALSE) This sets whether ssi will use UDP sockets to connect with the library server. Setting CSI_UDP_RPCSERVICE to TRUE will allow ssi to communicate with a csi that is running on the same system.

EXAMPLES Normal STK silo setup: mini_el & ssi acsls1 &

or mini_el & setenv CSI_HOSTNAME acsls1 ssi &

Connect to 3 different ACSLS servers: mini_el & ssi -A acsls1 & ssi -A acsls2 & ssi -A acsls3 &

or mini_el & setenv CSI_HOSTNAME acsls1 ssi & setenv CSI_HOSTNAME acsls2 ssi & setenv CSI_HOSTNAME acsls3 ssi &

Connect to 3 different ACSLS servers over 3 different network interfaces:

mini_el & setenv SSI_HOSTNAME myhost_on_net1

NetWorker 19.1.1 124

Maintenance Commands mini_el ( 1m )

ssi -A acsls1 & setenv SSI_HOSTNAME myhost_on_net2 ssi -A acsls2 & setenv SSI_HOSTNAME myhost_on_net3 ssi -A acsls3 &

Connect to ACSLS server congured to accept connections on port 30031 mini_el & ssi -A acsls1 -a 30031 &

or setenv CSI_HOSTNAME acsls1 mini_el & ssi -a 30031 &

To have mini_el use /nsr/logs/ssi.log.today as its log le

mini_el -l /nsr/logs/ssi.log.today & ssi -A acsls1 &

FILES /nsr/logs/ssi_event.log default logle created/appended to by mini_el

SEE ALSO nsrjb(1m), jbcong(1m), dasadmin(1m), libstlemass(1m), libstlibm(1m)

DIAGNOSTICS Several startup and shutdown messages along with any errors in communication between the NetWorker server and the ACSLS server will be logged in the logle /nsr/logs/ssi_event.log (or other logle as specied on the mini_el command line). The messages from any one ssi instance will be preceded by the name of the ACSLS server that that instance will be communicating with plus the local TCP port number that will be used between NetWorker and ssi.

For example: 10-12-00 12:31:44 SSI[0]: [devlab-acsls/50004] ONC RPC: csi_init(): Initiation Started source csi_init.c; line 165

10-12-00 12:33:20 SSI[0]: [acsls2/50011] ONC RPC: csi_init(): Initiation Completed ONC RPC: csi_init(): ACSLS server acsls2 accessed through port 50011

NetWorker 19.1.1 125

Maintenance Commands mminfo ( 1m )

NAME mminfo NetWorker media database reporting command

SYNOPSIS mminfo [ aIkvV ] [ o order ] [ s server ] [ x exportspec ] [ report ] [ query ] [ lter ] [ volname... ]

< report >: [ m p k B S X r reportspec ] < query >: [ c client ] [ l ] [ N name ] [ t time ] [ q queryspec ] < lter >: [ A attributes ]

DESCRIPTION The mminfo command reports information about NetWorker media and save sets. The mminfo command can produce several different reports depending on the ags specied. Several built-in reports can be specied using shorthand ags. Custom reports can also be specied. The default report, along with the built-in reports printed by the use of the v, V, m, p, S, B, and X ags, are described rst below. The custom query and report generators, using the q queryspec and r reportspec options, are described in the CUSTOM QUERIES AND REPORTS section. Other options are described in the OPTIONS section.

Without any options, mminfo displays information about the save sets that completed properly since the previous days midnight, and are still contained in an online le index (browsable save sets). The following information is printed for each save set: the containing volume name, the clients name, the creation date, the size saved on that volume, the save set level, and the save set name. The size eld is displayed in bytes (B), kilobytes (KB), megabytes (MB), gigabytes (GB), terabytes (TB), petabytes (PB), or exabytes (EB). The save set level will display full, incr, migration or 1 through 9, for full, incremental, migration save sets, level 1 through 9, respectively. The level is only kept for scheduled saves and le migration; save sets generated by explicitly run- ning the save(1m) command (called ad hoc saves) do not have an associated level.

Specifying the v ag prints aborted, purged, incomplete and recoverable save sets in addition to the complete, browsable save sets printed by default. The v ag also causes three additional elds to be displayed: the creation time, the internal save set identier (ssid), and two ags. One character is used per ag.

The rst ag indicates which part of the save set is on the volume. When the save is completely contained on the volume, a c is displayed. An h is displayed when the save set spans volumes and the head is contained on this volume. The remaining sec- tions will be on other volumes. An m is displayed when the save set spans volumes and a middle section is contained on this volume. The head and tail sections will be on different volumes. There may be more than one middle section. A t is displayed when the tail section of a spanning save set is contained on this volume. Again, the other sections will be on other volumes.

The second ag indicates the status of the save set. A b indicates that the save set is in the online index and is browsable via the recover(1m) command. An r indicates that the save set is not in the online index and is recoverable via the scanner(1m) com- mand. An E indicates that the save set has been marked eligible for recycling and may be over-written at any time. An a indicates that the save was aborted before comple- tion. Aborted save sets are removed from the online le index by nsrck(1m). An i indicates that the save is still in progress.

An optional third ag indicates the type of save set. An N indicates an NDMP save set. An R indicates a raw partition backup, eg., Networker Modules like Oracle, Sybase, and others that Networker supports, but it does not denote that the save set contains les utilizing the rawasm directive. A P indicates a snapshot save set. A k indicates a checkpoint enabled save set. A combination of ak denotes rst and all inter- mediate partial save sets. A combination of bk denotes a complete or nal partial save

NetWorker 19.1.1 126

Maintenance Commands mminfo ( 1m )

set.

An optional fourth ag s indicates whether an NDMP save set was backed up, via nsrdsa_save, to a NetWorker storage node.

The V ag displays even more detail than the v ag. This format also displays information such as, media le number and record number that can be used to speed the operation of the scanner(1m) command. The v ag displays one line per save set per volume. The V ag displays three lines for each section of a save set occurring within a le on a volume. A single save set will have multiple index entries if it starts in one le on a volume and ends in another. This report contains all of the informa- tion reported via the v ag, but, because of the additional detail, some of this infor- mation is reordered. The rst line will contain the volume name, the clients name, the size saved in that section, the save set level, and the save set name. The size eld lists the number of bytes that are contained in the section, rather than the total amount of the save set on this volume. The second line contains the following elds: the internal save set identier (ssid), the save time in seconds since 00:00:00 GMT, Jan 1, 1970, the creation data and time of day, the internal save set identier (ssid), the save set browse time, and the clone instance retention time. The third line contains: the offset of the rst and last bytes of the save set contained within section, the media le number, the rst record within the media le containing data for this save set, the internal volume identier (volid), the total size of the save set, and the ags, described in the v para- graph above, indicating which part of the save set is contained in this media le (c, h, m, or t) and the save sets status (b, r, a, or i).

The p ag causes mminfo to display a report on the browse and retention times for save sets. Each line of the report displays the save set creation date, and the stored browse and retention dates (undef is displayed when connecting to a downrev server), the save set identier, the clients name, and the save sets name. The v and V options have no effect on the columns included in this report.

The m ag causes mminfo to display the name of each volume in the media data- base, the number of bytes written to it, the percent of space used (or the word full indicating that the volume is lled to capacity), the retention (expiration) time, the number of bytes read, the number of times the read-label operation has been per- formed on the volume (not the count of explicit mounts), and the volumes capacity. Volumes that are recyclable (see nsrim(1m)) are agged by an E in the rst column (meaning Eligible for recycling). If a volume has been marked as manually-recyclable, an M is displayed instead of the E. If a volume is both manually-recyclable and eligi- ble for recycling, an X will be displayed. Archive and migration volumes are agged by an A, also in the rst column. If the volume is not an archive or migration volume, and is not recyclable, no ag appears.

Specifying the v ag with the m ag causes three additional elds to be displayed: the internal volume identier (volid), the number of the next le to be written, and the type of media.

Using a V ag with the m adds a column of ags to the output. There are currently two possible ags. The d ag is set if the volume is currently being written (dirty). The r ag is set if the volume is marked as read-only. If neither condition is present, the ags column will be empty.

The S ag displays a long, multiline save set report, which is used for debugging. The number of lines varies per save set. Due to the length, there are no column headers. Instead, each attribute of the save set is displayed in a name=value manner, except the client and save set name, which are displayed as client:name, and the extended attributes, described below. The rst line of each multiline group starts on the left margin and includes the save set identier (ssid), save time as both a date/time string and seconds since 00:00:00 GMT, Jan 1, 1970, and the client and save set names.

NetWorker 19.1.1 127

Maintenance Commands mminfo ( 1m )

Subsequent lines for this save set are indented. If the save set is part of a save set series (a continued save set) and is not the rst in the series, the save set identier of the previous save set in the series in shown on the second line by itself. The next line displays the level, the save set ags (in ssags format, as described in the table in the CUSTOM QUERIES AND REPORTS section), the save set size in bytes, the number of les in the save set, and the save set insertion date. The next line displays the save sets create, completion, browse and retention (expiration) dates. The string undef for any of the values on these two lines generally means an older server that does not store these values is being queried. If the client identier is set, it is printed on the next line. If the save set has extended attributes (such as the group to which the save set was a part or the archive annotation), they are printed next, at most one attribute per line. The format of each extended attribute is "name: values;". The clones or instances of the save set are shown last (every save set has at least once instance). The rst line of each clone shows the clone identier, the date and time the instance was created, the clone retention date, and the per-clone ags (in clags format from the CUSTOM QUERIES AND REPORTS table). For each instance, each section of that instance is shown as a fragment line. The fragment line shows the offset of that frag- ment from the beginning of the save set, the volume identier (volid) containing the fragment, the media le and record numbers of start of the fragment, an absolute posi- tioning identier (unused by existing servers), and the date of last access of the frag- ment. The v and V options have no effect on this report. The o sort order options o and m are ignored when -S is specied.

The X ag prepares a save set summary report instead of one or more lines per save set. Note that the entire media database must be examined to resolve this query, mak- ing it very slow and expensive. If used in conjunction with the a option, the query of all volumes is done to check for save sets. If used without the a option, only save set information in the last 24 hours is considered. The summary lists the total number of save sets and breaks the total down into several overlapping categories summarizing the save set types. The recent save set usage, if appropriate to the query, is also printed. The categories are: the number of fulls, the number of incrementals, the number of other non-full, non-incremental saves, the number of ad hoc, archive, migra- tion, empty and purged save sets, the number of index save sets, and, the number of incomplete save sets. For recent usage, the number of save sets per day is shown, up to a week ago, along with a summary of the weeks save sets and, if applicable, a sum- mary of the months save sets. For each line, the number of les (saved in the time interval specied), number of save sets, total size, average size per save set, and aver- age size per le are listed. The percentage of the amount saved for incrementals versus the amount saved for fulls and the percentage of browsable les are also printed, when appropriate. The v and V options have no effect on the summary report.

The B ag performs a canned query to output, in a convenient format, the list of bootstraps generated in the previous ve weeks. In this format, there is one line of output for each matched save set. Each line contains the save date and time, the save set identier (ssid), the starting le number, the starting record number, the volume name, the volume barcode, the volume location, the device last used to save or clone a bootstrap on the volume, and the access information (path) for the device. The equivalent query is described below in the EXAMPLES section. The v and V options have no effect on the bootstrap display. Note that when B is used, some columns may not be shown if they are empty or contain only redundant information.

OPTIONS a Causes queries to apply to all complete, browsable save sets, not just those in the last 24 hours. This option is implied by the c, N, q, m, and o options, described below. When combined with a media-only report ( m or a

NetWorker 19.1.1 128

Maintenance Commands mminfo ( 1m )

custom report showing only media information), a applies to all volumes, not just those with complete and browsable save sets.

c client Restricts the reported information to the media and/or save sets pertaining to the specied client. This is similar to specifying a client name using the querys- pec (see -q option) name. In both cases the names are matched using a case insensitive string comparison. If the reportspec (see -r option) includes volume, the reported information will include those pertaining to the aliases of the client. Use the -l option in conjunction with -c client (when reportspec includes volume) if information relating to the aliases of the client is not required in the output.

I Use ISO 8601 format time stamps instead of localized time and date formats. The elds must be at least 20 characters wide to accomodate the format.

l This option when used with -c client along with reportspec (see -r option) con- taining volume, the output will not include all the information pertaining to the aliases of the specic client.

k Displays backup details of virtual machines protected using VMware Backup Appliance(VBA). "vm_name" eld displays name of the virtual machine. "size" provides the size of the backup in the NetWorker device. "backup_size" provides the size of the backup in VBA internal storage or NetWorker device. "backup_size" and "size" will differ when backup is done to VBA internal storage. In this case "backup_size" shows the size of the backup in VBA and "size" shows the NetWorker metadata size.

m Displays a media report instead of the default save set report (in other words, a report about the media containing save sets, not the save sets themselves).

N name Restricts the reported information to the media and/or save sets pertaining to the specied save set name .

o order Sorts the output in the specied order. Before displaying the save sets, they are sorted by various elds. Numeric elds are sorted least to greatest, other elds are sorted alphabetically. order may be any combination of the letters celmnotR, representing client, expiration date, length, media name, name of save set, offset on media (le and record number), time, and Reverse, respec- tively. The default sorting order for save set reports is mocntl. The offset elds (le and record) are only considered when the V option has been selected and for custom reports that show save set section (fragment) informa- tion. When applied to m media-only reports, the length is the amount used on the volume, the time is the last time the media was accessed, and the other order ags are ignored.

p Displays a report on the browse and retention times for save sets, which are described above.

q queryspec Adds the given query constraint to the list of constraints on the current query. Multiple q options may be given. See the CUSTOM QUERIES AND REPORTS section below for the syntax of the queryspec.

r reportspec Appends the given report specication to the list of attributes to be displayed for the current query. Multiple r options may be given. See the CUSTOM QUERIES AND REPORTS section below for the syntax of the reportspec.

NetWorker 19.1.1 129

Maintenance Commands mminfo ( 1m )

s server Displays volume and save set information from the NetWorker system on server . See nsr(1m) for a description of server selection. The default is the current system.

t time Restricts the reported information to the media and/or save sets pertaining to the save sets created on or after time . See nsr_getdate(3) for a description of the recognized time formats. The default is yesterday, except when using the following switches: -a, -B, -c, -N, -m, -o and -q. When using those switches, there is no default value for time. If you wish to see only the backups since yesterday, you will have to specify -t yesterday explicitly.

v Turns on the verbose display reports, described above.

x exportspec As an alternative to the default human-readable output format, exportspec pro- vides for two styles of program-readable output formats. The exportspec m displays XML output, while exportspec c displays values separated by any single character or string. For example, mminfo xc, will produce comma-separated values.

A Save sets can be ltered based on extended attributes using a syntax similar to the q option for string comparisons, e.g. name=value. Equality and pres- ence are supported, and may be negated using ! or "not". Specifying an attri- bute name without a value requires only that the attribute be present in the save set. Specifying the same attribute multiple times with different values will match any save set with that attribute containing either value. Specifying multiple attributes requires that each save set match all of the specied attri- bute criteria.

B Runs the canned query to report bootstraps which have been generated in the past ve weeks, as described above. This option is used by savegrp(1m) when saving the servers index and bootstrap.

S Displays a long, multiline save set report, as described above.

V Displays additional verbose report output, as described above.

X Prepares a summary report, as described above.

CUSTOM QUERIES AND REPORTS

The custom query and report options of mminfo allow one to generate media and save set reports matching complex constraints without resorting to pipelines and scripts. This section describes the syntax of custom query and report specications, and gives some simple examples. Further examples are shown in the EXAMPLES section, below.

The custom query option, q queryspec , is an extension to the shorthand query options, such as c client , which allow you to make queries based on almost any media or save set attribute in the database, and allow various comparisons in addition to the simple equality comparison provided by the shorthand options. The format of a queryspec is

[!] name [ comp value ] [ , ... ]

where name is the name of a database attribute, listed in the table below, comp is a valid comparator for the attribute, from the set >, >=, =, <=, <, and value is the value being compared. Leading and trailing spaces can be used to separate the indivi- dual components of the specication. The comparator and value must be specied for all but ag attributes. Generally numeric attributes allow all ve comparators, and character string attributes generally only allow equality. When comparing ags whose values are normally true and false, one may alternatively use the [ ! ] name syntax. The !name form is equivalent to name=false, and name by itself is equivalent to name=true. The comparisons in the specication are separated by commas. If a time or a string contains commas, you must quote the value with single or double quotes.

NetWorker 19.1.1 130

Maintenance Commands mminfo ( 1m )

Quotes are escaped within a string by repeating them. The following is a valid string comparison:

name="Joes daily, ""hot"" Save Set"

Note that command line shells also interpret quotes, so you will need to enclose the entire query within quotes, and quote the single value inside the query, possibly with a different kind of quote, depending on the shell. Except for multiple character-string values, explained below, all of the specied constraints must match a given save set and/or media volume before a line will be printed in the report. Multiple q options may be specied, and may be combined with the shorthand query constraints c, N and t. The order of the above query constraints is unimportant. Matching for policy, workow, group, action and client elds is performed using case insensitive string comparison.

Numeric constraints, except for identiers (volume, save set and clone identiers), allow ranges to be specied, and all character string constraints allow multiple possible values to be specied. Note that times and levels are considered to be numeric values, not character strings. The upper and lower bounds of a numeric range are specied as two separate constraints. For example,

%used>20,%used<80

matches volumes that are between 20% and 80% used. All strings are also lists except attributes and volume attributes. Each possible value of a given character-string attri- bute is specied as a separate equality constraint. For example,

client=pegasus,client=avalon

matches save sets from the client pegasus or the client avalon.

Example, if group string attribute is used multiple times, the mminfo query would be

mminfo -av -q group=Default, group=Test

This would report save sets for both Default and Test groups.

The custom report option, r reportspec , allows one to specify exactly which media and save set attributes should be shown in the report, the order of the columns, the column widths, and where line breaks should be placed. The format of a reportspec is

name [ (width) ] [ , name [ (width) ] ... ]

where name is the name of a database attribute, listed below, and the optional width , enclosed in parentheses, species how wide the column should be. Leading and trail- ing spaces are ignored. The default column width depends on the attribute; default widths are also shown in the table below.

Some of the column headings have a short and a long (or more descriptive) version of the text. When the column width is wide enough, the long column heading is displayed; otherwise, the short heading is displayed. The column heading may not align properly with the data if the default column width is too wide or too narrow for the heading in non-US locales. To align the column heading and data, specify a width along with the attribute name.

For example, for certain locales, the column heading and data may not be aligned properly with "mminfo -p -q group=default" command. To adjust the alignment, exe- cute the command using a column width along with the attribute name. Depending on the size of the specied column width, this may cause the long heading to be displayed. For example:

mminfo -avot -q group=Default -r"savetime(17), ssbrowse(17), ssretent(17), ssid, client, name"

NetWorker 19.1.1 131

Maintenance Commands mminfo ( 1m )

Multiple r options may be specied. The order of the columns in the report will be left to right, and correspond to the order of the attribute names specied. Each line of output will contain all of the data requested (you can cause line breaks within a logical line by using the newline attribute name). If a value does not t in the requested column width, subsequent values in the line will be shifted to the right (values are truncated at 256 characters).

The table below lists all of the recognized attribute names, their valid range of query values (or NA for attributes that are only valid for report specications), their default column width in characters (or NA for ag attributes that are only valid for query specications), and a short description.

Numeric attributes (shown as number in the valid range column of the table) can be specied using any of the comparators listed above, and can be used in range com- parisons.

The =id attributes are used for various identiers (volume identier, save set identier, and so on) and only allow equality comparisons. In most cases, if the column is nar- row (less that 50 characters), only the short ID is shown, which corresponds to the ID used by downrev servers. If the column is wide enough, the full ID is shown. Client identiers always display as full IDs, and clone identiers always display as short IDs.

Flag attributes have the values true or false, only apply as query constraints, and have corresponding ag summary strings for report specications.

Time attributes are specied in nsr_getdate(3) format and are otherwise treated as numeric attributes (note that you will need to quote times that contain commas). The special time forever, when used as an expiration date, means a save set or volume will never expire. The special time undef is displayed when the time is undened. When output, times are displayed according to local settings, usually as MM/DD/YY HH:MM:SS for numeric month, day year (last two digits), hours, minutes, and seconds, respectively for English (United States) locale. If the column is very narrow (less that 17 characters), only the date is shown. Columns 22 characters wide will generally print the full date. This is dependent on the format reported by the operating system. If the returned date and time will not t in the specied columns, only the date is shown.

For non-US locales, time attributes are displayed in the locales date/time format, which usually requires a larger column width specication. If the column width is not big enough to display the entire locale date/time value for an attribute, (24-hour time) format will be attempted. If the column width is still not big enough, the date/time column will only display .

For example, for certain locales, to display the locale date/time for savetime attribute, specify an appropriate width, such as:

mminfo -avot -r"volume, client, savetime(40), sumsize, level, ssid, name, sumags"

Size and kbsize attributes may have a scale factor appended to them: KB for kilobytes, MB for megabytes, GB for gigabytes, TB for terabytes, PB for petabytes, or EB for exabytes. The default scale (when no scale is explicitly specied) on query con- straints for attributes is bytes; the default for kbsize attributes is kilobytes. The scale varies in reports, depending on the actual value.

String attributes may be any arbitrary character string, enclosed in quotes if necessary, as described above in the query syntax paragraph.

attribute value name range

width description

space NA 1 White space before the next column.

NetWorker 19.1.1 132

Maintenance Commands mminfo ( 1m )

newline NA 1 Line break(s) within a logical line. Width is actually the number of newlines desired.

volume string 15 The volume name. volid =id 11 The unique volume identier. barcode string 15 The volume barcode, when set. family string 4 The media family (for example, tape, disk). type string 7 The media type (for example, 8mm, optical). volags NA 5 Volume summary ags, d and r,

for dirty (in use), scan and read-only. state NA 7 Volume state summary, E, M, X and A,

meaning eligible for recycling, manually-recyclable, both, and archive or migration volumes, respectively.

full ag NA Matches full volumes. inuse ag NA Matches in-use (dirty) volumes. volrecycle ag NA Matches recyclable volumes. readonly ag NA Matches read-only volumes. manual ag NA Matches manually-recyclable volumes. scan ag NA Matches volumes that need to be scanned in. pool string 15 The pool containing the volume. location string 15 The volumes location. capacity size 8 The volumes estimated capacity. written kbsize 7 Kbytes written to volume. %used number 5 Estimated percentage used, or full

or full for volumes marked as full. read kbsize 8 Kbytes read (recovered) from the volume. next number 5 Next media le for writing. nrec number 5 Next media record for writing. volaccess time 9 Last time volume was accessed,

for read or write, for save or recover type of operation. A mount operation will not necessarily cause the access time to be updated. Old servers do not provide this value reliably.

volretent time 9 The date the last save set on this volume will expire.

olabel time 9 The rst time the volume was labeled. labeled time 9 The most recent time the media

volume was (re)labeled. mounts number 6 Number of times the read-label operation

is performed on the volume (not the count of explicit mounts).

recycled number 4 Number of times the volume was relabeled.

avail NA 3 Summary of volume availability, current valid values, n meaning nearline (that is, in a jukebox), and ov meaning the volume is being managed by SmartMedia.

near ag NA Matches nearline volumes. smartmedia ag NA Matches volumes managed by SmartMedia. metric number 6 Volume speed and desirability metric

(unused by existing servers). savesets NA 6 Number of save sets on a volume.

NetWorker 19.1.1 133

Maintenance Commands mminfo ( 1m )

volattrs NA 31 The extended volume attributes. ddrltype string 15 The Data Domain retention lock mode.

name string 31 The save set name. vmname string 31 The name of the virtual machine to which

this save set belongs. savetime time 9 The save time (on the client). nsavetime NA 11 The save time, printed as seconds

since 00:00:00 GMT, Jan 1, 1970. sscreate time 9 The creation time (on the server).

If the client and server clocks are out of sync, this time may be different from the save time.

ssid =id 10 The short format of ssid is the default. It can be ambiguous.

ssid =id 53 The long ssid format is guaranteed to be unique for a particular save set.

snap ag NA Display snapshot backups only. cover ag NA Display cover save sets and ssags will have K. level 0..9, 5 The backup level. Manual backups

full, incr, are printed as manual migration values in reports. or manual

client string 11 The client resource name associated with the host that was backed up in this save set.

attrs NA 31 The extended save set attributes. ssattr string NA Display save set with an extended attribute. pssid =id 11 When part of a save set series, the

previous save set identier in the series, zero for the rst or only save set in a series.

ssags NA 7 The save set ags summary, one or more characters in the set CvrENiRPKIFk, for continued, valid, purged (recoverable), eligible for recycling, NDMP generated, incomplete, raw (not for save sets backed up using rawasm), snapshot, cover, in-progress and nished (ended), checkpoint restart enabled, respectively.

continued ag NA Matches continued save sets. recoverable ag NA Matches recoverable (purged) save sets. ssrecycle ag NA Matches recyclable save sets. incomplete ag NA Matches incomplete save sets. rolledin ag NA Matches rolled-in save sets. ndmp ag NA Matches NDMP save sets. checkpoint-restart ag NA Match checkpoint restart enabled

save sets. dsa ag NA Display NDMP save sets that are backed up

NetWorker 19.1.1 134

Maintenance Commands mminfo ( 1m )

to NetWorker storage node via nsrdsa_save and ssags will have N and s.

raw ag NA Matches raw save sets, containing partitions saved by NetWorker modules.

valid ag NA Matches valid save sets. All save sets are marked valid by current servers.

sumags NA 3 Per-volume save set summary ags, as described for the v report.

fragags NA 3 Per-section save set summary ags, as described for the V report.

totalsize number 11 The total save set size. backup_size number 11 The size of the backup in VMWare backup

appliance(VBA) internal storage or NetWorker device. nles number 5 The number of the clients les

in the save set. ssbrowse time 9 The save sets browse time. This is

the time limit that the save set will remain browsable. undef is displayed when connected to a downrev server.

ssretent time 9 The save sets retention time (expiration time). This is the time limit that the save set will remain recoverable in the media database. ssretent is the max clretent of all copies of a saveset.

ddrltime time 9 The save sets retention lock time on Data Domain. This is the time limit that the save set will remain on Data Domain and cannot be deleted. The value undef is displayed when Data Domain retention lock time is not set for the save set.

ssinsert time 9 The save sets insertion time. This is the time when the save set was most recently introduced into the database (for example, by a backup or by running scanner(1m)).

sscomp time 9 The save sets completion time. This is the time when the save set backup was completed.

ssprotect time 9 The Policy Protection Period. This is the time limit that at least one copy of the save set will remain recoverable in the media database if policy protection period is enabled.

clientid =id 9 The globally unique client identier for the host that was backed up in this save set.

copies number 6 The number of copies (instances or clones) of the save set, all with the same save time and save set identier.

validcopies number 11 The number of successful copies (instances or clones) of the save set, all with the same save time and save set identier.

cloneid =id 11 The clone identier of one copy. clonetime time 9 The time when a copy was made. clretent time 9 The clone retention time is the time

limit that the clone instance will remain recoverable in the media database.

clags NA 5 The clone ags summary, one or more characters from the set aisET for aborted, incomplete, suspect (read error), eligible for recycling, marked for movement (in-transit) to the cloud, respectively. The summary reects the status of a save set instance.

NetWorker 19.1.1 135

Maintenance Commands mminfo ( 1m )

suspect ag NA Matches the suspect save set copies, which are copies that had errors during le recovery.

transit ag NA Matches in-transit save set copies, such as copies that are marked for movement to the cloud from a DD Cloud Tier device.

annotation string 31 The (archive) save sets annotation. In a queryspec, the string is a regular expression in the form used by grep(1).

policy string 12 The policy of this save set. This is the protection policy that created this save set.

workow string 12 The workow of this save set. This is the protection policy workow that created this save set.

group string 12 The NSR Protection Group containing the client of this save set.

action string 12 The action of this save set. This is the workow action that created this save set.

ssbundle string 15 The save set bundle of this save set. This is used to stage several save sets together.

rst number 11 The offset of the rst byte of the save set contained within the section.

last NA 11 The calculated offset of the last byte of the save set contained within the current section.

fragsize NA 7 The calculated size of the current section of the save set.

sumsize NA 7 The calculated total size of all of the sections of the save set on this volume.

mediale number 5 The media le number containing the current section of the save set.

mediarec number 5 The media record number where the rst bytes of the save set are found within the current media le.

mediamark number 5 The absolute positioning data for the current section (not used by existing servers).

ssaccess time 9 The last time this section of the save set was accessed (for backup or recovery).

checkpoint_id string 10 Checkpoint ID of the save set. checkpoint_seq string 10 Checkpoint sequence number of the save set. rehydrated ag NA Match save sets that are rehydrated from

Avamar deduplicated save sets. syntheticfull ag NA Match save sets that are at level full and

have "Synthetic full" attribute. deviceless ag NA Match deviceless backup save sets.

EXAMPLES In the following examples, the equivalent shorthand and custom versions of the report are shown, when a shorthand option exists for a given report or query.

Display the information about save sets on a volume, with save set ID in long ssid for- mat (53 characters).

mminfo av r volume, name, savetime, ssags, clags, ssid(53)

Display all bootstraps generated in the previous ve weeks, as reported by savegrp(1m):

mminfo B

NetWorker 19.1.1 136

Maintenance Commands mminfo ( 1m )

mminfo N bootstrap t 5 weeks ago avot -r savetime(24),space(2),ssid -r mediale(6),mediarec(6),space(2),volume -r barcode,location,device,access_info

Display information about all of the volumes: mminfo m mminfo a r state,volume,written,%used,volretent,read,space

-r mounts(5),space(2),capacity

Display media information from volumes mars.001 and mars.002: mminfo m mars.001 mars.002 mminfo m -q volume=mars.001,volume=mars.002

Display all browsable save sets named /usr: mminfo N /usr mminfo q name=/usr

Display browsable save sets named /usr, generated by client venus, in the past week: mminfo N /usr c venus mminfo q name=/usr,client=venus

Display browsable save sets named /usr, generated by client venus, on volume mars.001:

mminfo N /usr c venus mars.001 mminfo q name=/usr,client=venus,volume=mars.001

Display a media report of all volumes written on in the past week: mminfo m -t last week mminfo m -q savetime>=last week

Display a media report of all non-full volumes, showing the percent-used, pool and location of each volume:

mminfo a r volume,%used,pool,location -q !full

Display a media report similar to the m report but showing the barcode instead of the volume label:

mminfo a r state,barcode,written,%used,read,space -r mounts(5),space(2),capacity

Display a verbose list of the instances of all save sets with more than one copy, sorted by save time and client name:

mminfo otc v q copies>1

Query that should be used to check whether all completed save sets on a volume (for example,nmsun118.001) have at least one successful clone on other volumes:

mminfo -q volume=nmsun118.001,validcopies>1

Display all archive save sets with an annotation of "project data" for the past four months.

mminfo qannotation=project data -r"volume,client,savetime,sumsize,ssid,name,annotation" -tfour months ago

Display all snapshot save sets for the client cyborg. mminfo qclient=cyborg, snap

-r"volume,client,savetime,sumsize,ssid,name,annotation" -tfour months ago

Display all snapshot save sets with their snapshot handle, for the client cyborg. The snapshot handle is stored in the attribute snapid.

mminfo a S qclient=cyborg, snap -tfour months ago

NetWorker 19.1.1 137

Maintenance Commands mminfo ( 1m )

Display all checkpoint enabled save sets for the client cyborg. mminfo qclient=cyborg, checkpoint-restart

-r"checkpoint_id,checkpoint_seq,volume,client,ssid,name"

Display the third partial save set from the checkpoint restart sequence 1265299738. mminfo qcheckpoint_id=1265299738,checkpoint_seq=3

-r"checkpoint_id,checkpoint_seq,volume,client,ssid,name"

Display all rehydrated save sets for the client cyborg. mminfo qclient=cyborg, rehydrated

-r"volume,client,ssid,name"

Display all synthetic full save sets for the client cyborg. mminfo qclient=cyborg, syntheticfull

-r"volume,client,ssid,name"

Display all deviceless save sets for the client cyborg. mminfo qclient=cyborg, deviceless

-r"client,ssid,name"

Displays all the save sets that are marked for movement (in-transit) to the cloud from a DD Cloud Tier device.

mminfo q transit -r"volume,clags,ssid,cloneid,name"

Displays all the Block-based Backup enabled save sets. mminfo q "ssattr=BlockBasedBackup"

-r "client,ssid,name"

Displays all the Block-based Backup enabled save sets for client cyborg. mminfo q "client=cyborg, ssattr=BlockBasedBackup"

-r "ssid,name"

Displays savesets created by policy p1 and workow w1 . mminfo q "policy=p1, workow=w1"

-r "ssid,name,action"

Displays savesets created by workow action backup . mminfo q "action=backup"

-r "ssid,name,policy,workow"

PRIVILEGE REQUIREMENTS

A User with "Recover Local Data" privilege is allowed to query the media database for save set information only for the client where mminfo command is invoked.

A User with "Remote Access" privilege is allowed to query the media database for save set information for any client.

A User with "Operate Devices and Jukeboxes" privilege is allowed to query the media database for detailed volume information. The user is still required to have either "Recover Local Data" or "Remote Access" privilege to be able to access save set infor- mation. The "Remote Access" privilege can be granted either through "the "Remote access all clients" privilege or through the "Remote access" attribute in client resource.

A user with "Monitor Networker" privilege can query the media database for volume and save set information for any client. This is equivalent to having both "Operate Devices and Jukeboxes" and "Remote Access" privileges.

FILES /nsr/mm/mmvolume6 Directory containing the media database in legacy format. This contains the active media database prior to migration or after an unsuccessful migration.

/nsr/mm/mmvolrel Directory containing the media database in relational format. This

NetWorker 19.1.1 138

Maintenance Commands mminfo ( 1m )

contains the active media database after migration or a new instal- lation.

SEE ALSO grep(1), nsr_getdate(3), nsr_layout(5), nsradmin(1m), nsrmmdbd(1m), recover(1m), savegrp(1m), nsrworkow(1m), scanner(1m).

DIAGNOSTICS no matches found for the query No save sets or volumes were found in the database that matched all of the constraints of the query.

invalid volume name volname The volume name given is not in a valid format. Note that volume names may not begin with a dash. Queries that match no volumes will return the error no matches found for the query.

only one of m, B, S, X or r may be specied Only one report can be generated at a time. Use separate runs of mminfo to obtain multiple reports.

invalid sorting order specier, choose from celmnotR Only letters from celm n ot R may be used with the o option.

only one o allowed Only one sorting order may be specied.

only one s allowed Only one server can be queried at one time. Use multiple runs of mminfo to obtain reports from multiple servers.

Out of Memory The query exhausted available memory. Try issuing it again, using the sorting order om, or make the query more restrictive (for example, list specic volumes, clients, and/or save set names).

invalid value specied for attribute The value specied is either out of range (for example, a negative number for a value that can only take positive numbers), the wrong type (an alphabetic string value specied for a numeric attribute), or just poorly formatted (for example, non-blank characters between a close quote and the next comma or a missing close quote).

value of attribute is too long The value specied for attribute is longer than the maximum accepted value. Query attributes must have values less than 65 characters long.

non-overlapping range specied for attribute The range specied for attribute is a non-overlapping numeric range, and can- not possibly match any save set or volume in the database.

unknown query constraint: attribute The given query attribute is not valid. See the CUSTOM QUERIES AND REPORTS table for a list of all valid attribute names.

need a value for query constraint attribute The attribute is not a ag, and must be specied in the name comparator value format.

constraint attribute is only valid for reports The attribute specied for a query may only by used in report ( r) specications. Calculated values, ag summaries, save set extended attributes, and formatting tools (space and newline) may not be used in queries.

invalid comparator for query constraint attribute

NetWorker 19.1.1 139

Maintenance Commands mminfo ( 1m )

The comparator used is not valid for the given attribute. See the CUSTOM QUERIES AND REPORTS section for a list of the valid comparators for attri- bute .

query constraint attribute specied more than once The given attribute was specied more than once with the same comparator, and is not a string attribute (string attributes can match one of several specic values).

unknown report constraint: attribute The given report attribute is not valid; see the CUSTOM QUERIES AND REPORTS table for a list of all valid attribute names.

constraint attribute is only valid for queries The attribute specied for a report is a ag matching attribute and may only be used in query ( q) specications. See the CUSTOM QUERIES AND REPORTS table for the appropriate ag summary attribute that one may use in reports of a given ag.

column width of attribute is invalid The width specied for attribute is out of range. Column widths must be posi- tive numbers less than 256.

missing close parenthesis after report constraint attribute The width of attribute is missing a close parenthesis.

missing comma after report constraint attribute There are non-blank characters after the width specication for attribute without any comma preceding them.

No data requested, no report generated The given report specication contains only formatting, no data attribute names.

LIMITATIONS You cannot specify save set extended attributes as query constraints. However, the A option may be used to apply extended attribute lters to the results of any query.

You cannot list several possible equality matches for numbers, only for strings.

Some queries, namely those that are not highly selective (few query constraints) and use a sorting order where the volume name is not the primary sort key, still require mminfo to retrieve the entire database before printing any of it. Such queries use large amounts of memory in mminfo, but not, as was the case with older versions, in nsrmmdbd.

You cannot make a report that shows save set or media instances and a summary without running mminfo at least twice.

You cannot specify query constraints that compare database attributes with each other.

You cannot make a report that uses -B ag with -c ag.

The mminfo va ot q savetime today 90days command is used to query the save set that are older than 90 days. Note that the mminfo va ot q savetime today 90 days command is not the same as previous command. The white space character in today 90 days changes the meaning of the query. Ensure that you preview and validate the mminfo output before piping it to command such as nsrmm d that delete the client le index and media database entries from the NetWorker database.

NetWorker 19.1.1 140

Maintenance Commands mmlocate ( 1m )

NAME mmlocate NetWorker media location reporting command

SYNOPSIS mmlocate [ s server ] [ l { n volname i volid location }] [ L ] [ d location ]

[ c { n volname i volid }] [ u { n volname i volid location }]

DESCRIPTION The mmlocate command is used to access and manage the volume location informa- tion contained in the media database. The information contained in a volumes loca- tion eld is meant to give the user an idea of where the volume can physically be found. Other NetWorker commands will display the location along with the volume name (see the versions sub-command of recover(1m)). Any user can use this command with the -l (default) or -L options. The -c, -d and -u options are limited to NetWorker administrators (see nsr(1m)). -l is assumed by mmlocate if a -L, -c, -d or -u option is not specied.

Running mmlocate without any arguments lists all volumes and their locations for the specied server (if you do not specify a server, the current host is used).

Note that each time nsrjb(1m) moves a piece of media inside a jukebox, the location of a volume is set to the name of the jukebox. When using storage nodes, the name of the jukebox is used to indicate on which node the volume can be mounted. Hence, the rst portion of this eld containing the jukebox name should not be changed. When using volumes on a storage node that are not contained within a jukebox, this eld can be used to indicate on which node a volume should be mounted, by giving it a value of any remote device on that node. See nsr_storage_node(5) for additional details on storage nodes.

OPTIONS c Clears the location eld for the specied volume.

d location Deletes all volumes associated with the specied location. A conrmation prompt appears prior to the deletion of each volume.

i volid Restricts the mmlocate operation to the specied volume ID (volid).

l Lists entries. Performs a database query using the supplied volume name, volume ID or location.

If a volume name or volume id is given, then only the volumes location infor- mation is displayed. If a location is provided, then only volumes in that loca- tion are displayed. When the -l option is used without specifying any other options (volume name, volume id, or location), volumes without a set location are displayed.

L Lists all locations found in the database.

n volname Restricts the operation to the volume name (volname) listed.

s server Accesses the servers media database.

u Updates the location for a volume. Locations are limited to a maximum length of 64 characters. The -n volname or -i volid and location options must be used in conjunction with the -u option.

EXAMPLES Update the media database to show that volume Offsite.011 is now at location Media Vault

mmlocate u n Offsite.011 Media Vault

NetWorker 19.1.1 141

Maintenance Commands mmlocate ( 1m )

Delete volumes at location Media Shelf 6 mmlocate d Media Shelf 6

Delete location information for volume NonFull.001 mmlocate c n NonFull.001

List the location of volume NonFull.001 mmlocate n NonFull.001

List all volumes stored in the location Media Vault mmlocate Media Vault

FILES /nsr/mm/mmvolume The media database.

SEE ALSO nsrmm(1m), mminfo(1m), nsr(1m), nsrjb(1m), recover(1m) nsr_storage_node(5)

DIAGNOSTICS Server does not support remote update operations. If you are running mmlocate against an old server, you are not allowed to use the -u or -c options. You must login to that server and run the mmlocate pro- gram there.

NetWorker 19.1.1 142

Maintenance Commands mmpool ( 1m )

NAME mmpool NetWorker media pool reporting command

SYNOPSIS mmpool [ s server ] [ volume... ]

[ d pool ] [ l pool ] [ L ]

DESCRIPTION The mmpool command is used to access pool information stored in the NetWorker servers media database. This command can also be used to delete all the volumes in a particular pool. If you specify one or more volume names with the mmpool com- mand, the report shows the pool that each named volume belongs to. By default, all volumes and their pools are displayed.

You cannot change the pool to which a volume belongs without relabeling the volume, which destroys all data stored on the volume. Pools are congured through a Net- Worker administration tool, such as NetWorker Management Console or nsradmin(1m). These tools are used to create and modify unique pool (see nsr_pool(5)) resources.

OPTIONS d pool Deletes all volumes for the given pool. The user will be prompted for deletion of each volume.

l pool Lists all volumes and the pools to which they belong. If a pool is specied, mmpool only lists the volumes belonging to that pool.

L Lists the names of all pool resources congured on the server.

s server Species the NetWorker server to act upon. See nsr(1m) for a description of server selection.

FILES /nsr/mm/mmvolume (UNIX) The media database on the server.

SEE ALSO nsr(1m), nsr_device(5), nsr_pool(5), nsradmin(1m), nsrjb(1m), nsrmm(1m)

NetWorker 19.1.1 143

Standards, Environments, and Macros mm_data ( 5 )

NAME mm_data NetWorker media multiplexor data (tape and disk) format

DESCRIPTION This documents the data format that the NetWorker media multiplexor daemon, nsrmmd(8), writes to long term storage media such as tapes and optical disks. See nsr_device(5) and nsrmm(8) for a discussion of supported device families and types. The format described here applies to any xed record device, such as raw disks, or xed record tape devices with le marks. NetWorker uses the eXternal Data Representa- tion (XDR) standard to write media which can be interchanged among a wide variety of machines. Only the mechanism used to multiplex save set streams onto the storage media is described here; the formats of save set streams depend on the type of Net- Worker client, and are described in nsr_data(5).

A volume is one physical piece of media such as a tape reel or disk cartridge. A tape volume is made up of multiple media les, and each media le may contain several media records. These media les and records should not be confused with a clients (for example UNIX or DOS) user les or records; the two do not necessarily correspond. For example, a given media le or even a single media record may con- tain many small client user les. On the other hand, a single large client le may be split across several media les, and even across several volumes. Media les do not span volume boundaries. Save sets may span media les and even volumes.

On most tapes, media les can be skipped very quickly by the devices hardware or associated device driver software, and the hardware can detect when an end of a le has been reached. On some tapes, records can also be quickly skipped forward. Oth- erwise, access to the media is sequential.

Media records are described by the mrecord structure. Label records are xed in size, MINMRECSIZE bytes. Other records can potentially be a larger size that must be some constant for the rest of the volume. NetWorker always writes, reads and skips data in units of full-sized media records. Each mrecord contains zero or more mchunks These mrecords are used for storing one or more client save sessions or used by NetWorker for synchronization and labelling. The XDR format of a media les mrecords and mchunks are as follows:

const MINMRECSIZE = 32768; / minimum media record size / const MMAXCHK = 2048; / maximum number of chunks in record / const MHNDLEN = 120; / private area length for handlers /

enum mrec_version { / mrecord version / MREC_VER5 = 0, / older format mrecord / MREC_VER6 = 6 / current format mrecord /

};

/ For media record format version 5, the data types lgui_t, lg_off64_t, and lg_time64_t are dened as: /

typedef struct lgui_t unsigned long; typedef struct lg_off64_t unsigned long; typedef struct lg_time64_t unsigned long;

/ For media record format version 6, the data types lgui_t, lg_off64_t, and lg_time64_t are dened as: /

NetWorker 19.1.1 144

Standards, Environments, and Macros mm_data ( 5 )

typedef struct lgui_t { / XDR encoded Unique Id. / char _bytes[20];

} lgui_t; typedef struct lg_off64_t unsigned long long; typedef struct lg_time64_t unsigned long long;

typedef lgui_t ssid_t; / save set id / typedef lgui_t volid_t; / key for the volume database /

struct mchunk { ssid_t mc_ssid; / owning save set id / lg_off64_t mc_low; / 1st byte, relative to save stream / opaque mc_data ;/ chunks data /

};

struct mrecord { opaque mr_handler[MHNDLEN];/ private to media handler / mrec_version mr_version; / Media record version number / u_long mr_orec; / record size / volid_t mr_volid; / encompassing volumes id / u_long mr_fn; / encompassing le number / u_long mr_rn; / record number within the le / u_long mr_len; / record byte length / mchunk mr_chunk ;/ chunks of save streams /

};

The rst eld of an mrecord, mr_handler, is reserved for media-specic data (currently it is not used by any implementation). The mr_version eld is the version number of the media record format. The size of the rest of the elds in the media record depends on the version number. The mr_orec eld is the size of the current record. A media records header elds, mr_volid, mr_fn, and mr_rn, are used to check the tape position and the data read from the record. The le numbers and record numbers start at zero and increment sequentially. The record number is reset each time the le number is incremented. On disks, le numbers are always zero. The mr_len eld is the actual number of valid bytes in this record, as opposed to the size of the devices read or write request.

If le or record skipping is unreliable, NetWorker can still recover from isolated errors, at worst by rewinding and reading the tape from the start. If a volume can be physi- cally unmounted or mounted without notice to the media management daemon, then the volume identier in each record provides a quick way of verifying when this hap- pens, without the need for a full rewind and reading of the label in most cases.

The mchunks within an mrecord contain client data from one or more save sessions. The mc_ssid and mc_low values are used to reconstruct the save streams from the chunks within the records. The mc_data eld holds the actual data of each chunk. For a given save set, mc_low plus the length of mc_data should equal the following chunks value for mc_low. Save sets may by intermingled arbitrarily within media records.

The rst chunk of the rst record of the rst media le on the volume encapsulates the volume label information; for some media, the second chunk contains additional volume information, for example, the media pool the volume belongs to: Subsequent data in the rst le is reserved for future expansion. The label may be duplicated in a second le for redundancy, in case the rst copy of the label gets accidentally

NetWorker 19.1.1 145

Standards, Environments, and Macros mm_data ( 5 )

overwritten. The formats of the volume label and additional label information are described by the following XDR data structures:

const MVOLMAGIC = 0x070460; / volume magic number / const NSR_LENGTH = 64; / length of several strings / const RAP_MAXNAMELEN = 64; / maximum length of attribute name /

struct mvollabel { u_long mvl_magic; / medium volume verication number / lg_time64_t mvl_createtime; / time at which volume labeled / lg_time64_t mvl_expiretime; / time for volume to expire / u_long mvl_recsize; / expected size of mrecords / volid_t mvl_volid; / medium volume id / string mvl_volname ;/ medium volume name /

};

struct vallist { vallist next; string value<>; / attribute value /

};

struct attrlist { attrlist next; string name ;/ attribute name / vallist values; / attribute values /

};

/ Additional information may includes the following attributes (listed by the name they are stored with): "volume pool" : the media pool /

struct mvolinfo { struct attrlist mvi_attributes; / any other information /

};

The mvl_magic eld must be equal to MVOLMAGIC in order for the chunk to represent a valid volume label. If the volume label changes in the future, the new for- mat will have another magic number, but the format described here must still be allowed. The mvl_volid is an internal identier assigned and managed by the media manager. The mvl_volname is the volume name that is assigned when the media is rst labeled. The time elds are in UST format the number of seconds elapsed since 00:00 GMT, January 1, 1970. The mvl_recsize is the size of all subsequent media records found on the tape.

The mvp_pool is the pool name that is assigned when the media is rst labeled. Dif- ferent media pools allow administrators to segregate their data onto sets of volumes. Media cannot be reassigned from one media pool to another. Pool names are a max- imum of NSR_LENGTH characters long.

Synchronization marks, called schunks, are also written periodically to the media for each save set. Synchronization chunks are used by scanner(8) when verifying or extracting directly from a volume. They are also used by nsrmmd when trying to recover from media errors during le recovery. The following XDR data structure describes a synchronization chunk:

NetWorker 19.1.1 146

Standards, Environments, and Macros mm_data ( 5 )

typedef lgui_t clientid_t;

struct ssclone_t { lg_time64_t ssc_cloneid; / unique UST stamp wrt ss_ssid / u_long ssc_ag; / lots of status buried here/ u_long ssc_frag; / not used, always 0 /

};

/ Synchronization chunk of the newer MREC_VER6 media format. /

struct schunk { u_long ssi_gen; / Not used. / ssid_t ssi_ssid; / save set identier / ssid_t ssi_prev; / non-zero iff continuation / u_long ssi_level; / backup level/ lg_time64_t ssi_time; / save time on client / lg_time64_t ssi_create; / creation time on server / lg_time64_t ssi_insert; / insertion time on server / lg_time64_t ssi_complete; / completion time on server / clientid_t ssi_clientid; / client name identier / u_long ssi_ags; / more details about this ss / string ssi_host<>; / client name - save set owner / string ssi_name<>; / symbolic name, for example "/usr" / uint64_t ssi_size; / actual number of bytes saved / uint64_t ssi_nles; / number of client les saved / u_long ssi_browse; / browse time offset / u_long ssi_recycle; / recycle time offset / struct attrlist ssi_al; / generic RAP attribute list / ssclone_t ssi_clones<>; / information about this clone /

};

/ Synchronization chunk of the older MREC_VER5 media format. /

struct old_schunk { opaque ssi_host[NSR_LENGTH]; / save set host / opaque ssi_name[NSR_LENGTH]; / symbolic name / u_long ssi_time; / save time / u_long ssi_expiry; / expiration date / u_long ssi_size; / actual size saved / u_long ssi_nles; / number of les / ssid_t ssi_ssid; / ssid for this save set / u_long ssi_ag; / various ags, see below / u_long ssi_info; / volid or ssid, see below /

};

#dene SSI_START 1 / start of a save set / #dene SSI_SYNC 2 / synchronization point / #dene SSI_CONT 3 / continued from another volume / #dene SSI_END 4 / end of this save set / #dene SSI_SSMASK 0x0000000f / save set sync chunk type / #dene SSI_LBIAS 0x10000000 / the level is included in the ags /

NetWorker 19.1.1 147

Standards, Environments, and Macros mm_data ( 5 )

#dene SSI_LMASK 0xff000000 / mask to cover bits for level / #dene SSI_LSHIFT 24 / shift amount for the level / #dene SSI_INCOMPLETE 0x00010000 / not nished (aborted) / #dene SSI_CONTINUED 0x00800000 / continued save set series /

The ssi_ssid is the save set identier of this save set. The ssi_time eld contains the create time of the save set in UST based on the clients clock. The ssi_create eld con- tains the create time of the save set in UST based on the servers clock. The ssi_insert eld contains the time the save set was inserted into the media database in UST based on the servers clock. The ssi_complete eld contains the completion time of the save set in UST based on the servers clock. The ssi_clientid and ssi_host are the client identier and name of the index which contains this save set. Traditionally this is the client identier and name of the client where the save set originated. The ssi_name is the save set name to be presented to the user. These are both null-terminated strings, even though the elds are xed length in the older version media records. The ssi_size and ssi_nles are the number of bytes and number of les saved so far for this save set. The ssi_browse is the time offset in seconds from the save set insertion time to the time this save set is no longer browsable. The ssi_recycle is the time offset in seconds from the save set insertion time to the time this save set becomes recyclable. The ssi_al is the generic save set attribute.

The ssi_ag indicates the type of this synchronization chunk and other information about the save set. In the older version synchronization chunk, this eld also contains the level of this save set. There are four basic types of synchronization marks that can be found from examining ssi_ag & SSI_SSMASK. SSI_START is used to mark the beginning of a save set. SSI_SYNC marks a periodic synchronization point and is only written at an exact le boundary in the save set. SSI_CONT indicates that this is the continuation of a save set that started on a different volume. When ssi_ag & SSI_SSMASK is SSI_CONT, ssi_prev or ssi_info contains the volume identier for the save sets preceding volume. These synchronization chunks are used when a save set spans a volume boundary. SSI_END marks the end of a save set.

On the new version of synchronization chunk, the ssi_level eld contains the save set backup level. On the older version of synchronization chunk. Should the SSI_LBIAS bit be set then ssi_ag & SSI_LMASK shifted to the right by the value of SSI_LSHIFT species the level of the save set. The SSI_INCOMPLETE bit indicates that this save set did not nish properly. This could be caused by a user interrupting an in progress save.

The SSI_CONTINUED bit indicates that this save set is logically continued to or from another save set. These continued save sets are used to handle very large save sets. If the SSI_CONTINUED bit is set and ssi_ag & SSI_SSMASK is SSI_START, then ssi_prev or ssi_info gives the previous save set id that this save set was continued from. If the SSI_CONTINUED bit is set and ssi_ag & SSI_SSMASK is SSI_END, then ssi_prev or ssi_info gives the next save set id that this save set is continued to.

The ssi_expiry eld is the expiration date, in UST, for this save set. This eld is zero if an explicit save set expiration time was not specied when the save set was created. This eld no longer exists in the new synchronization chunk.

SEE ALSO nsr_device(5), nsr_data(5), nsrmm(8), nsrmmd(8), nsrmmdbd(8), nsr(8), scanner(8)

RFC 1014 XDR: External Data Representation Specication

NetWorker 19.1.1 148

Maintenance Commands msense ( 1m )

NAME msense get mode sense data

SYNOPSIS msense -a b.t.l [ -p pagecode ]

DESCRIPTION The msense program will send a MODE SENSE command to the named device.

OPTIONS The required -a argument must be used to select a specic ordinal SCSI address (see libscsi(1m)).

The optional -p pagecode argument may be used to select a specic mode page, other- wise, all pages are fetched (code 0x3f). This argument must be specied in hexadecimal notation.

BUGS The output is not readable. It is intended as input to pmode(1m).

SEE ALSO libscsi(1m), pmode(1m)

NetWorker 19.1.1 149

Maintenance Commands networker.cluster ( 1m )

NAME networker.cluster congure NetWorker software as highly-available

SYNOPSIS networker.cluster [ r nsr_bin ]

DESCRIPTION The networker.cluster is an interactive script for conguring the NetWorker Client or NetWorker Server to be a highly available application in a cluster. It should be run after a proper installation of NetWorker on all the nodes of the cluster to activate the failover and cluster-aware capabilities of NetWorker.

The conguration separates the local NetWorker database area, used by the cluster- aware NetWorker Client, from the global NetWorker database area, used by the Highly Available NetWorker Server. This is done via a set of symbolic links which are created to enable easy switching between the global and local NetWorker databases. The global NetWorker database is on a shared storage media and follows the Highly Available (virtual) NetWorker Server on a failover.

The NetWorker.clustersvr le is created in the NetWorker binaries directory to specify that NetWorker has been installed as a highly available service.

The script then creates the appropriate lcmap(1m) script for the cluster platform.

When a NetWorker Server is congured, the user is asked for cluster platform specic information to prepare for registration of the NetWorker Server with the cluster software. However, the setup is nished manually. On the node, only the NetWorker Client is started node by the networker.cluster script. Refer to the NetWorker Installa- tion Guide appropriate for your cluster platform for specic instructions.

If a mistake is made during the conguration, run networker.cluster with the r option to undo the changes.

OPTIONS r nsr-bin Used to remove the cluster conguration of NetWorker software. The optional nsr-bin parameter is used to specify the location of NetWorker binaries when NetWorker software is installed in non-default location.

SEE ALSO nsrd(1m), pathownerignore(5), lcmap(1m) The EMC NetWorker Installation Guide

NetWorker 19.1.1 150

Maintenance Commands nsr ( 1m )

NAME nsr introduction and overview of NetWorker

DESCRIPTION NetWorker facilitates the backup and recovery of les on a network of computer sys- tems. Files and lesystems may be backed up on a scheduled basis. Recovery of entire lesystems and single les is simplied by use of an on-line index of saved les.

NetWorker uses a client-server model to provide the le backup and recover service. At least one machine on the network is designated as the NetWorker server , and the machines with disks to be backed up are NetWorker clients . Six daemons provide the NetWorker service, control access to the system, and provide index and media sup- port. On the clients, there are special programs to access the le systems and com- municate with the NetWorker server.

The NetWorker system has several parts. Commands and les are only briey men- tioned here; see the appropriate reference manual page for more detailed information. Each command has a manual page entry in section 8. The les and their formats are explained in section 5 manual pages.

The NetWorker Administrators Guide provides information on conguring and adminis- tering a NetWorker system. It includes many examples and rationales for setting up and running a successful backup operation.

INSTALLATION How NetWorker is installed depends on the architecture of the machine upon which you are installing. For detailed installation instructions, see the NetWorker Installation Guide for your specic platform.

nsr_layout(5) Describes where NetWorker programs, les, and manual pages are installed.

SERVER DAEMONS NetWorker uses a client-server model to provide a backup and recover service. The following daemons encompass the server side of NetWorker.

nsrd(1m) The main NetWorker daemon. nsrd handles initial communication with clients, and starts and stops the other NetWorker server daemons.

ansrd(1m) The agent nsrd process, spawned by nsrd in response to a recovery, clone, or other session. The ansrd daemon is invoked on an as-needed basis and is only present when there are sessions active to the Net- Worker server. Modern versions of save(1m) do not require use of an ansrd daemon.

nsrindexd(1m) This server daemon provides access to the NetWorker on-line index. The index holds records of saved les. The index allows clients to selec- tively browse and choose les to recover without having to access the backup media.

nsrmmdbd(1m) The media management database daemon provides an index of save sets and media. The nsrmmdbd daemon provides a much coarser view of the saved les than does nsrindexd, and therefore the resultant index is usually much smaller.

nsrjobd(1m) The jobs daemon provides for the centralized monitoring and control of remote execution "jobs", typically save and directed recover. It manages the parallelism when spawning remote jobs and monitors the status for reporting and storing execution information. All scheduled backups are initiated from nsrjobd.

NetWorker 19.1.1 151

Maintenance Commands nsr ( 1m )

nsrmmd(1m) The media multiplexor daemon provides device support for NetWorker. When more than one client is saving les, the data from each client is multiplexed. During recovery operations, the data is demultiplexed and sent back to the requesting clients. When the multiple devices are enabled, several of these daemons may be active simultaneously.

ADMINISTRATION NetWorker is administered via resources and attributes. Every resource has one or more attributes associated with it. For example, a device is a NetWorker resource type; an attribute of devices is the device type , for example, 4mm or 8mm. The Net- Worker resource format is documented in nsr_resource(5). There is also a manual page for each NetWorker resource in section 5 of the manual.

Resource les are not normally edited by hand. Rather, a NetWorker tool (usually NetWorker Management Console or nsradmin(1m)) is used to modify resource les dynamically so that values can be checked and changes can be propagated automati- cally to the interested programs. The following are tools that are used to administer various aspects of NetWorker.

NetWorker Management Console Monitors the activity of and administers NetWorker servers. NetWorker Management Console is a Java based application and is most users pri- mary interface to NetWorker.

nsradmin(1m) A curses(3) based tool for the administration of NetWorker servers.

nsrwatch(1m) A curses(3) based tool to monitor the activity of NetWorker servers.

nsrmm(1m) Media manager command. The nsrmm command is used to label, mount, unmount, delete and purge volumes. Mount requests are gen- erated by nsrmmd, and displayed by NetWorker Management Console or nsrwatch. The size of the on-line user le indexes may be controlled by deleting and purging volumes.

nsrjb(1m) The NetWorker jukebox-controlling command. When dealing with a jukebox, nsrjb, rather than nsrmm, should be used to label, load, and unload the volumes contained within a jukebox.

nsrim(1m) Automatically manages the on-line index. It is usually run periodically by the "Server Protection" policy, "Server Backup" workow, "Expiration" action.

mminfo(1m) Provides information about volumes and save sets.

nsrck(1m) Checks and repairs the NetWorker on-line index. It is run automatically when nsrd starts up if the databases were not closed cleanly due to a sys- tem crash.

nsr_render_log(1m) Creates a human readable version of the NetWorker logs.

nsr_shutdown(1m) A shell script used to safely shut down the local NetWorker server. The nsr_shutdown script can only be run by the super user.

SAVING FILES NetWorker supports both scheduled and manual saving of les and lesystems. Each client may be scheduled to save all or part of its lesystems. Different clients may be scheduled to begin saving at different times.

save(1m) A command-line-based tool used to back up a specied le or group of

NetWorker 19.1.1 152

Maintenance Commands nsr ( 1m )

les. The save command may be run manually by users and administra- tors, or automatically by the server according to schedule.

savegrp(1m) Backup action binary used to initiate the backup of a group of client machines. Usually started automatically by the NetWorker server. The savegrp command also backs up the clients on-line le indexes, which are stored on the server. Starting with NetWorker version 9.0, executed automatically by nsrworkow. When backing up the server itself, a bootstrap save set is also created.

nsrexec(1m) The legacy remote execution agent command monitors the progress of NetWorker commands.

nsrclone(1m) The NetWorker save set/volume cloning command. Using nsrclone, clones , or exact replicas, of save sets or entire volumes can be made. Clone data is indistinguishable from the original data, except for the Net- Worker media volumes upon which the data reside.

nsrexecd(1m) NetWorker-specic remote execution service which runs on NetWorker clients. Used by nsrjobd to start save and savefs on client machines.

savefs(1m) Used by savegrp to determine characteristics of a client, and to map the save set All to the current list of all save sets on a client. The savegrp is spawned by nsrworkow.

RECOVERING FILES NetWorker maintains an on-line index of user les that have been saved. Users may browse the index and select les for recovery. This information is used to build a representation of the le heirarchy as of any time in the past. NetWorker then locates the correct volume and recovers the requested les.

recover(1m) Browses the on-line user le index and selects les and lesystems to recover.

nsrdr(1m) Used only for disaster recovery. Recovers the special bootstrap index and the servers on-line le index. The recover command is used to recover other on-line le indexes.

scanner(1m) Veries correctness and integrity of NetWorker volumes. Can also recover complete save sets and rebuild the on-line le and media indexes.

nsr_crash(1m) A man page describing crash recovery techniques.

nsrinfo(1m) Used to generate reports about the contents of a clients le index.

APPLICATION SPECIFIC

MODULES

In order to process user les in an optimal manner, NetWorker provides the ASM

mechanism. Pattern matching is used to select les for processing by the different ASMs. The patterns and associated ASMs are described in nsr(5). The save command keeps track of which ASMs were used to process a le so that recover may use the same ASMs to recover the le.

uasm(1m) UNIX lesystem specic save/recover module. The uasm man page documents the general rules for all ASMs. The uasm command and its man page actually comprise several additional ASMs, including compressasm, mailasm, and xlateasm, to name a few.

nsrindexasm(1m) Processes the on-line user le indexes.

nsrmmdbasm(1m) Processes the on on-line media database.

NetWorker 19.1.1 153

Maintenance Commands nsr ( 1m )

SERVER LOCATION On large networks there may be several NetWorker servers installed. Each NetWorker client command must select a server to use.

For server selection, the client commands are classied into two groups: administration and operation. The administration commands include NetWorker Management Con- sole, nsrwatch, and mminfo. The operation commands include save, savefs, and recover. Both groups of commands accept a s server option to explicitly specify a NetWorker server.

When a server is not explicitly specied, the operation commands use the following steps to locate one. The rst server found is used.

1) The local machine is examined to see if it is a NetWorker server. If it is, then it is used.

2) The machine where the current directory is actually located is examined to see if it is a NetWorker server. If it is, then it is used.

3) The machine specied with the c option is examined to see if it is a NetWorker server. If it is, then it is used.

4) The list of trusted NetWorker servers is obtained from the local machines nsrexecd(1m). Each machine on the list is examined to see if it is a NetWorker server. The rst machine determined to be a NetWorker server is used.

5) A broadcast request is issued. The rst NetWorker server to respond to the request is used.

6) If a NetWorker server still has not been found, then the local machine is used.

The administrative commands only use step 1.

SECURITY Before a save is allowed, there must be an NSR client resource created for the given client. Before a recovery is allowed, the server validates client access by checking the remote access attribute in the NSR client resource (see nsr_client(5)).

The savegrp(1m) command initiates the save(1m) command on each client machine in an NSR group by using the nsrexecd(1m) remote save execution service. See the nsrexecd(1m) man page for details. For backward compatibility with older versions of NetWorker, savegrp(1m) will fall back on using the rsh(1) protocol for remote execu- tion if nsrexecd is not running on a particular client.

Access to the NSR resources through the nsradmin(1m) command or NetWorker Management Console is controlled by the administrator attribute on the NSR server resource (see nsr_service(5)). This attribute has a list of names of the users who have permission to administer that resources. Names that begin with an ampersand (&) denote netgroups (see netgroup(5)). Also names can be of the form user@host or u ser =user,h ost =host to authorize a specic user on a specic host.

ROOT PRIVILEGES The system administrator can grant root privileges to specic groups of users by changing the mode of a NetWorker program to setuid-root and setgid-group. (See chgrp(1) and chmod(1) for more details.)

When a user invokes a program that is both setuid-root and setgid-group, he may retain root privileges if one of the following is true:

1. The users name and the programs group name are identical.

2. One of the processs supplementary group id names is identical to the programs group name. (See getgroups(2) for more details.)

3. The users name is an element of the netgroup whose name is identical to the programs group name. (See getgrnam(3) for more details.)

NetWorker 19.1.1 154

Maintenance Commands nsr ( 1m )

For example, the mode and group owner of the recover command can be changed such that the ls output looks like:

-rws--s--x 1 root staff 548808 Apr 18 16:04 recover A user invoking this command will retain root privileges if (1) his name is staff, or (2) he is a member of the group staff, or (3) his name appears as an element of the netgroup staff.

Granting root privileges may be applied to the following NetWorker programs: nsrexec(1m), nsrports(1m), recover(1m), nsrclone(1m), nsrconsolidate(1m), nsrmm(1m), mmpool(1m), mmlocate(1m), nsrjb(1m), nsrinfo(1m), nsrstage(1m), nsrcap(1m), save(1m), nsrpmig(1m), nsrck(1m), nsrim(1m), jbcong(1m), nsrcnct(1m), and scanner(1m).

NAMING AND AUTHENTICATION

As described above, the NSR server only accepts connections initiated from the machines listed as clients or listed in the remote access list (for recovering). Since machines may be connected to more than one physical network and since each physi- cal network connection may have numerous aliases, the policies below are used as a compromise between security and ease of use.

A client determines its own name as follows. First the clients UNIX system name is acquired via the gethostname(3) system call. The UNIX system name is used as a parameter to the getaddrinfo(3) library routine. The client declares its name to be the ofcial (or primary) name returned by getaddrinfo. This name is passed to the Net- Worker server during connection establishment.

A server authenticates a client connection by reconciling the connections remote address with the clients stated name. The address is mapped to its canonical name via the getnameinfo(3) library function. Next, the clients stated name is used as a parameter to getaddrinfo to acquire its canonical name. The client is successfully authenticated only if the names returned by the two library functions match.

The NetWorker server maps a clients name to an on-line index database name by resolving the clients name to the ofcial name returned by getaddrinfo. This map- ping takes place both at client creation time and at connection establishment time.

To ensure safe and effective naming, the following rules should be employed:

1) The NetWorker clients and servers should access consistent host name databases. The Network Information Service (NIS) and the Domain Name System (DNS) are naming subsystems that aid in host name consistency.

2) All hosts entries for a single machine should have at least one common alias among them.

3) When creating a new client, use a name or alias that will map back to the same ofcial name that the client machine produces by backward mapping its UNIX system name.

SEE ALSO rsh(1), gethostname(3), getaddrinfo(3), getnameinfo(3), netgroup(5), nsr(5), nsr_layout(5), nsr_resource(5), yples(5), ypmake(5), mminfo(1m), nsr_crash(1m), nsr_service(5), nsr_render_log(1m), nsr_shutdown(1m), nsradmin(1m), nsrck(1m), nsrclone(1m), nsrd(1m), nsrdr(1m), nsrexecd(1m), nsrim(1m), nsrindexasm(1m), nsrindexd(1m), nsrinfo(1m), nsrjb(1m), nsrls(1m), nsrmm(1m), nsrmmd(1m), nsrmmdbasm(1m), nsrmmdbd(1m), nsrwatch(1m), recover(1m), save(1m), savefs(1m), savegrp(1m), nsrworkow(1m), scanner(1m), uasm(1m),and the NetWorker Administration Guide

NetWorker 19.1.1 155

Standards, Environments, and Macros nsr ( 5 )

NAME nsr NetWorker directive le format

DESCRIPTION This man page describes the format of .nsr directive les. These les are interpreted by save(8) and Application Specic Module (ASM) programs, during NetWorker backup processes. This format is also used in the directive attribute of the nsr_directive(5) resource.

Directives control how particular les are to be backed-up, how descendent directories are searched, and how subsequent directives are processed. For each le backed-up, any ASM information required to recover that le is also backed-up. This enables recover(8), or any ASM directly invoked, to recover a le correctly, even if the current directives have changed since the le was backed-up. See uasm(8) for a general description of the various ASMs.

The .nsr directive le in each directory is parsed before anything in that directory is backed up, unless NetWorker is being run in ignore mode. Each line of a .nsr directive le, and each line of the directive attribute, contains one directive. Any text after a "#" character until the end of the line is treated as a comment and discarded. Directives appear in one of three distinct forms:

[+ ] ASM [args ...] : pattern ... save environment << dir >>

The three forms are referred to as ASM specications, save environment directives, and << dir >> directives, respectively.

Use ASM specications (name and any arguments) to specify how les or directories with a matching pattern are backed-up. When a pattern matches a directory, the specied ASM is responsible for handling the directory and its contents. Any pattern or ASM arguments requiring special control or white space characters should be quoted using double quotes (").

A colon (:) is used as the separator between the ASM specication (and any arguments) and the pattern specication list. The pattern list for each ASM specication consists of simple le names or patterns. The pattern cannot be ".." and must not contain any "/" characters (all names must be within the current directory). The string "." can be used to match the current directory. Standard sh(1) le pattern matching (, [...], [!...], [x-y], ?) can be used to match le names. If a "+" precedes the ASM name, then the directive is propagated to subdirectories. When a directory is rst visited, it is searched for a .nsr le. If one is found, it is then read. Each .nsr le is only read once. When start- ing a save at a directory below /, any .nsr les on the normalized path of the current working directory are read before any les are saved to catalog any propagated direc- tives.

The following algorithm is used to match les to the appropriate ASM specication. First the .nsr le in the current directory (if any) is scanned from top to bottom for an ASM specication without a leading "+" whose pattern matches the le name. If no match is found, then the .nsr in the current directory is re-scanned for an ASM

specication with a leading "+" whose pattern matches the le name (for clarity, we recommend placing all propagating ("+") directives after all the non-propagating direc- tives in a .nsr le). If no match is found, then the .nsr le found in the ".." directory (if any) is scanned from top to bottom looking for a match with an ASM specication that has a leading +. This process continues until the .nsr le in the "/" directory (if any) is scanned. If no match is found (or a match is found with an ASM specication whose name is the same as the currently running ASM), then the currently running ASM will handle the save of the le.

NetWorker 19.1.1 156

Standards, Environments, and Macros nsr ( 5 )

Use save environment directives to change how ASM specications and future .nsr les are used. The save environment directives do not take any le patterns. They affect the currently running ASM and subsequent ASMs invoked below this directory. There are three different possible save environment directives that can be used:

forget Forget all inherited directives (those starting with a "+" in parent directories). Note that saveset "All" will not work with "forget" directive. That is, the "forget" directive works only at a saveset level and the directory needs to be explicitly noted as an indivi- dual saveset in the Client resource, for the directive to take effect and forget the inher- ited asms.

ignore Ignore subsequent .nsr les found in descendent directories.

allow Allow .nsr le interpretation in descendent directories.

The << dir >> directive can be used to specify a directory where subsequent ASM specications from the current .nsr le should be applied. This directive is intended to be used to consolidate the contents of several .nsr les to a single location or directory. The dir portion of this directive must resolve to a valid directory at or below the direc- tory containing this directive or subsequent ASM specications will be ignored. Rela- tive path names should be used for le names to ensure the interpretation of subse- quent ASM directives is consistent, even if a directory is mounted in a different abso- lute part of the lesystem.

There must be a << d ir >> a s t h e r st d ir ect ive in a d ir ect ive le u sed in con j u n ct ion wit h t h e f op t ion t o save(8), savefs(8) or with an ASM program. Also, when << dir >> directives are used in this manner, whether rst or later in the le, absolute path names should be used to ensure appropriate interpretation. Absolute path names should also be used for each directory specied within the directive attribute of the NSR directive resource (see nsr_directive(5)).

When a << dir >> directive is used, subsequent directives are parsed and logged for later use. When a directory specied by dir is opened, any save environment directives specied for that directory (for example, allow, ignore, and forget) are processed rst. If the ASM

is not currently ignoring .nsr les and a local .nsr le exists, the le is read and pro- cessed. Finally, any of the non save environment directives specied for that directory are handled as if they where appended to the end of a .nsr le in that directory. If multiple << dir >> specications resolve to the same directory, then the corresponding save directives are handled logically in "last seen rst" order.

EXAMPLES Having a /usr/src/.nsr le containing: +skip: errs .o +compressasm: .

will cause all les (or directories) located in the /usr/src directory named errs or .o (and anything contained within them) to be skipped. In addition, all other les con- tained in the /usr/src directory will be compressed during save and will be set up for automatic decompression on recover.

Having a /var/.nsr le containing: compressasm: adm .nsr null: .?

causes all les (or directories) and their contents located within the /var directory and anything contained within them (except for those les located in the /var/adm directory and the .nsr le itself) to be skipped, although all the names in the directory would be backed-up. In addition, since compressasm is a searching directive (see uasm(8)), the les contained within the /var/adm directory will be compressed during backup and

NetWorker 19.1.1 157

Standards, Environments, and Macros nsr ( 5 )

will be set up for automatic decompression on recover.

The following is an example of using the /.nsr le as a master save directive le for the entire lesystem by using << dir >> directives to consolidate the various ASM save direc- tives to a single location:

# Master NetWorker directive le for this machine << ./ >> # /mnt and /a are used for temporary fs mounting # and need not be saved

skip: mnt a +skip: core errs dead.letter %

# Dont bother saving anything within /tmp << ./tmp >>

skip: .? << ./export/swap >>

swapasm: # Translate all mailboxes. Also, use mailasm to save each # mail le to maintain mail le locking conventions and # to preserve the last le access time. << ./usr/spool/mail >>

xlateasm: . mailasm:

# Allow .nsr les to be interpreted in /nsr, even if we # are currently ignoring .nsr les. NetWorker # applications (such as nsrindexd) set up their own private # .nsr les which save index les more intelligently. << ./nsr >>

allow # We can rebuild any .o les in /usr/src # from sources except those in /usr/src/sys. # Ensure that /usr/src/sys is explicitly noted as a saveset # in the Client resource for "forget" to work.

<< ./usr/src >> +skip: .o

<< ./usr/src/sys >> forget

FILES .nsr save directive le in each directory

SEE ALSO sh(1), nsr_directive(5), nsrindexasm(8), nsrmmdbasm(8), recover(8), save(8), savefs(8), uasm(8)

NetWorker 19.1.1 158

Maintenance Commands nsraddadmin ( 1m )

NAME nsraddadmin add an entry to the administrator attribute or to the external roles attribute

SYNOPSIS nsraddadmin [ s server ] u user_entry nsraddadmin [ s server ] e external_role_entry nsraddadmin [ s server ] H authentication_server [ P authentication_port ]

DESCRIPTION The nsraddadmin program is used to add a user entry to a NetWorker servers administrator attribute or an external role entry to the Application Administrators and Security Administrators user groups. The program updates the server on the same host where the command runs. The addition of a user entry gives that user full administrator privileges on the NetWorker server. Similarly, the addition of an exter- nal roles entry gives all the users in that role full administrator privileges on the Net- Worker server. Please see nsr_service(5) for additional information about this attribute and for valid formats of the user entries.

OPTIONS s server Opens a connection to the named NetWorker server instead of the local one.

u user_entry Causes nsraddadmin to add a user entry to NetWorkers administrator attri- bute. Only one user entry at a time can be added with this command.

e external_roles_entry Causes nsraddadmin to add an external roles entry to NetWorkers Applica- tion Administrators and Security Administrators user groups. Only one external role entry at a time can be added with this command.

H authentication_server Causes nsraddadmin to fetch the distinguished name of the default Adminis- trators group on the specied authentication server and add it to the external roles attribute of NetWorkers Application Administrators and Security Administrators user groups. This option should only be used if the default Administrators group has not been renamed or deleted on the authentication server.

P authentication_port Uses the specied port when connecting to the authentication server. This option is only applicable when using the H switch.

SEE ALSO nsr_service(5), nsrd(1m)

DIAGNOSTICS get resdb handle failed, err: error info An error occurred while connecting to the NetWorker server. Check to ensure the server is running, and retry the command.

query resdb failed, err: error info An error occurred while querying the NetWorker server. Check to ensure the server is running, and retry the command.

RAP error: Permission denied, user user on hostname does not have Change security settings privilege

The user running this program is not listed in the administrators list for the server. You need to be a valid administrator to run nsraddadmin.

user user-entry is already on the administrator list The user entry that was given on the command is already contained on the servers administrator list.

NetWorker 19.1.1 159

Maintenance Commands nsraddadmin ( 1m )

added user user-entry to the administrator list The user entry has been added to the servers administrator list.

NetWorker 19.1.1 160

Maintenance Commands nsradmin ( 1m )

NAME nsradmin NetWorker administrative program

SYNOPSIS nsradmin [ c ] [ i le ] [ s server ] [ p {prognum progname} ] [ v version ] [ query ]

nsradmin [ c ] [ i le ] [ d resdir . . . ] [ t typele ] [ query ]

nsradmin [ c ] [ i le ] [ f resle . . . ] [ t typele ] [ query ]

nsradmin [ c ] [ i le ] [ S SQLite db le ] [ query ]

nsradmin C [ y ] [ s server ] [ p {prognum progname} ] query

DESCRIPTION The nsradmin command is a command-line based administrative program for the Net- Worker system. Normally nsradmin monitors and modies NetWorker resources over the network. Commands are entered on standard input, and output is produced on standard output.

If nsradmin is started without a query argument, it uses a default query. By default, if the daemon being administered is nsrd, then all resources will be selected, but for all other daemons, no resources will be selected.

OPTIONS C Perform miscellaneous validation checks on NetWorker resources. When using this option the query argument is mandatory.

c Uses the UNIX curses(3) library or Windows Console API to implement a full- screen display mode, just like the visual command described below.

d resdir Uses the NetWorker resource database resdir instead of opening a network connection. The database resdir must be in directory format. This should be used sparingly, and only when the NetWorker server is not running. Multiple d and resdir arguments can be used to start nsradmin with access to more than one database at a time.

f resle Similar to the d resdir option except that it opens an existing resource le, rather than a resource directory. Some conguration databases are stored in le format, while others are in directory format.

i le Takes input commands from le instead of from standard input. In this mode, the interactive prompt will not be printed.

s server Opens a connection to the named NetWorker server instead of allowing administration of all servers. Useful to limit the number of resources if there are many servers, or to administer when the RAP location service is not work- ing.

p {prognum progname} Use the given RPC program number or name instead of the default program number of 390103 - which refers to nsrd. Other suitable program arguments include, but are not limited to:

NetWorker Remote Execution Daemon:

NetWorker 19.1.1 161

Maintenance Commands nsradmin ( 1m )

390113 or nsrexecd

S SQLite db le Similar to the d resdir option except that it opens a nsrjobd SQLite database le, rather than a resource directory. SQLite database is used by nsrjobd in versions higher than the 7.6.x line. Note: SQLite database is opened in read- only mode by nsradmin.

t typele Uses the alternate le typele to dene RAP types.

y Autocorrect RAP resource errors found during validation checking using the C option.

v version Binds to the NetWorker RAP service with the given version number. The default is 2. This option is generally used only for debugging.

query If a query is specied (in the form of an attribute list), the edit operation is performed on the results of the query. See COMMANDS for more information on how the edit command works.

RESOURCES Each NetWorker resource is made up of a list of named attributes. Each attribute can have zero or more values. The attribute names and values are all represented by print- able strings. Upper and lower case is not distinguished on comparisons, and spaces are ignored except inside the names and values.

The format for specifying attributes and attribute lists is:

a ttr ibute ::= na m e [ : v a lue [ , v a lue ] ] An attribute is a name optionally followed by a colon, followed by zero or more values, where values are separated by commas. A comma at the end of a line continues the line.

a ttr ibute list ::= a ttr ibute [ ; a ttr ibute ] An attribute list is one or more attributes separated by semicolons. A semi- colon at the end of a line continues the line. The list is ended by a newline that is not preceded by a comma or semi-colon.

Here is an example of an attribute list:

name: mars; type: NSR client; remote access: mars, venus, jupiter;

For more information on attributes, attribute lists and the NetWorker resource types, see the resource(5), and nsr_resource(5), manual pages.

COMMANDS At each input prompt, nsradmin expects a command name and some optional argu- ments. Command names can be shortened to the smallest unique string (for example, p for print). Command arguments are always specied in the form of an attribute list. Most commands operate on a set of resources returned by a query . The query is specied as an attribute list which is used to match resources with the following rules:

1) The resource must match all the given attributes.

2) If more than one value is specied the resource can match any one of the values.

3) If an attribute is specied with no value the resource must contain an attri- bute of that name.

NetWorker 19.1.1 162

Maintenance Commands nsradmin ( 1m )

Thus, a query: type:NSR device; name:mars, venus; test

will match all resources that have a type attribute with the value NSR device, a name attribute with a value of either mars or venus, and an attribute test with any value.

If the query has only one name and no values (for example, if there is no semi-colon or colon in it), then the program tries to guess a more reasonable query. If the name is a host name, then the query will select all the resources on the given host. Otherwise, the name will be interpreted as a type name, and all resources of that given type will be selected.

bind [quer y] Bind to the service that owns the resource described by query . If no query is specied, queries are sent to the RAP Resource Directory, and update, create, and delete commands to the service that owns the resource being changed. On failure, the previous service will continue to be used.

create a ttr ibute list Create a resource with the given attributes. One of the attributes must be type to specify a NetWorker type that can be created. The types command can be used to nd out which NetWorker types a server supports. Note that the RAP types are case sensitive and must be used exactly as shown by the types com- mand. For example: NSR group is a valid type, but nsr group is not.

delete [quer y] Delete the resources that match the current query. If a query is specied, it becomes the current query.

edit [quer y] Edit the resources that match the current query. If a query is specied, it becomes the current query. If the environment variable EDITOR is set, then that editor will be invoked, otherwise vi(1) will be started. When the editor exits, nsradmin applies update, delete and create operations based on the changes to the resources. Be careful to not edit the resource identier attribute, and to write the le out before exiting the editor. (UNIX Only)

help [com m a nd] Print a message describing a command. If no command name is given a synopsis of all of the commands is printed.

option [list] This command enables some options to change the display of resources. With no arguments it displays the current options; with a list of options it turns the specied ones on. The options are: Dynamic, which displays all dynamic attributes, even the normally hidden ones. Hidden, which displays all attri- butes, even the normally hidden ones. Raw I18N, which suppresses rendering of I18N text to the current locale, and displays the I18N data as raw structured text. Resource ID, which displays the resource identier on each resource, a number that is used internally to provide sequencing and uniqueness. Regexp, when enabled, supports regular expression search for the resources.

print [quer y] Print the resources that match the current query. If a query is specied, it becomes the current query. If a name has been specied for the the current show list, only the attributes for the specied name in the show list will be displayed.

quit

NetWorker 19.1.1 163

Maintenance Commands nsradmin ( 1m )

Exits nsradmin.

server [ser v er na m e] Bind to the given NetWorker server name. If no server is specied, the RAP location service will be used. On failure, the previous server will continue to be used.

show [na m e; ...] If a name list (really an attribute list with no values) is specied, add those names to the show list. Only these attributes will be displayed in subsequent print commands. If no name list is given the show list is cleared, resulting in all attributes being shown.

types Print a list of all known types.

unset [list] This command turns off the specied option.

update a ttr ibutes Update the resources given by the current query to match attributes.

visual [quer y] Enter a full-screen mode using the UNIX curses(3) library or Windows Con- sole API to step through commands in a perhaps more user-friendly manner than the command line interface. You can get this mode directly using the c command line argument.

. [quer y] If a query is specied, this command will set the current query without printing the results of the query. Otherwise, it will display the current query, show list, server binding, and options.

? [com m a nd] Same as the help command above.

EXAMPLES print type:NSR device Print all resources of type NSR device and make this the current query.

show type; name Set the show list to display only the attributes type and name.

delete Delete all resources that match the current query.

delete type:NSR device; hostname: mars Delete the resource with attributes: type: NSR device and hostname: mars.

edit type:NSR notication Edit all resources of type NSR notication.

To create a NSR protection policy action with the default attributes:

1. Create resource of type NSR Protection policy: create type: NSR Protection policy; name: Policy1

2. Create pseudo resource of type NSR Protection policy workow: create type: NSR Protection policy workow; policy name: Policy1; name:Policy1- Workow1

3. Create pseudo resource of type NSR Protection policy action: create type: NSR Protection policy action; policy name:Policy1; workow name:Policy1-Workow1; name:backup; action type:backup; backup subtype:traditional

4. Create pseudo resource of type NSR Protection policy action and associate it with NSR Schedule resource:

create type: NSR Protection policy action; policy name:Policy1; workow

NetWorker 19.1.1 164

Maintenance Commands nsradmin ( 1m )

name:Policy1-Workow1; name:backup; action type:backup; backup subtype:traditional; period:reference; actions:Schedule1

Note: "Schedule1" is a valid NSR Schedule resource.

To print policy, workow, and action, use the following commands:

print type: NSR Protection policy Print all resources of type NSR Protection policy and make this the current query.

print type: NSR Protection policy workow; policy name:Policy1; name:Policy1-Workow1 Print pseudo resource of type NSR Protection policy workow where policy name is Policy1 and name of the workow is Policy1-Workow1 and make this the current query.

name:backup print type: NSR Protection policy action; policy name:Policy1; workow name:Policy1-

Workow1; Print pseudo resource of type NSR Protection policy action where policy name is Policy1 , workow name is Policy1-Workow1 and name of the action is backup and make this the current query.

To delete policy, workow, and action, use the following commands:

delete type: NSR Protection policy; name:Policy1 Delete resource of type NSR Protection policy where name of policy is Policy1 .

delete type: NSR Protection policy workow; policy name:Policy1 Delete all pseudo resource of type NSR Protection policy workow from NSR Protection policy where policy name is Policy1 .

name:backup delete type: NSR Protection policy action; policy name:Policy1; workow name:Policy1-

Workow1; Delete pseudo resource of type NSR Protection policy action from NSR Pro- tection policy and NSR Protection policy workow where policy name is Pol- icy1 , workow name is Policy1-Workow1 and name of the action is backup .

SEE ALSO ed(1), vi(1), curses(3), nsr_resource(5), termcap(5), nsr(1m)

NOTES If the backslash ("\") character is contained in a value that is entered for an attribute value when you create or update a RAP resource, it is treated as a marker that indi- cates that it may be combined with the following character to produce a special charac- ter. (This is similar behavior to that seen in various UNIX shells.)

If you wish your attribute value to contain an actual backslash character, then you should enter two backslashes in succession - e.g. C:\\dir_one\\dir_two

Special character # can be escaped with \ if it has to be used as an input for an attri- bute. - e.g. comment: Test\#1

Create, retrieve, update, and delete operations are supported for NSR Protection pol- icy, NSR Protection policy workow, and NSR Protection policy action resources. The NetWorker Administration Guide provides more information.

NSR Protection Policy Workow and NSR Protection Policy Action are pseudo RAP resources and encapsulated under NSR Protection Policy RAP resource. Querying these pseudo RAP resources in nsradmin requires resource type.

All other RAP resources including NSR Protection Policy resource can be queried without specifying RAP resource Types.

NetWorker 19.1.1 165

Maintenance Commands nsradmin ( 1m )

Supported action type are backup, clone, probe, check connectivity, generate index, expire, discover and server backup.

Supported backup subtype are traditional, snapshot and vmware.

When you delete a policy, all dependent workows and actions in the policy are deleted. When you delete a workow, all dependent actions in the workow are deleted.

You can associate NSR Schedule resource with NSR Protection Policy Action resource.

DIAGNOSTICS The following exit status values are meaningful:

0 Interactive mode exited normally.

1 There was a usage or other non-query related error.

2 When reading input from a le ( i le), one or more RAP operations failed. This status is never returned interactively.

NetWorker 19.1.1 166

Maintenance Commands nsralist ( 1m )

NAME nsralist NetWorker archive request executor

SYNOPSIS nsralist R archive request name

DESCRIPTION The nsralist command is used to execute an archive request (see nsr_archive_request(5)). The nsralist command is run automatically by nsrd(1m), as specied by each archive request resource.

The nsralist command will set up an RPC connection to nsrexecd(1m) to run nsrarchive(1m) on the specied client. If nsrexecd is unavailable, nsralist will fall back on using the rcmd(3) protocol and the client-side rshd(1m).

The nsralist monitors the execution of the archive command and stores any output in the log of the archive request. The nsrarchive command running on the client updates the server with its progress, including whether or not optional verication and cloning operations have completed successfully. See nsrclone(1m) for more information on cloning.

OPTIONS R archive request name This option species which archive request is supposed to be run.

FILES /nsr/tmp/al.request_name A lock le to keep multiple runs of the same archive list from running simul- taneously.

SEE ALSO nsrarchive(1m), nsrclone(1m), nsrexecd(1m), nsr_archive_request(5).

NetWorker 19.1.1 167

Maintenance Commands nsrarchive ( 1m )

NAME nsrarchive archive les to long term storage with NetWorker

SYNOPSIS nsrarchive [ BiInpqvxVy ] [ b pool ] [ f directive lename ] [ G remove ] [ I input_le ] [ N name ] [ R name ] [ s server ] [ T annotation ] [ o save_operations ] [ W width ] [ path . . . ]

DESCRIPTION nsrarchive can archive les, directories, or entire lesystems to the NetWorker server (see nsr(1m)). The progress of an archive can be monitored using the Java based Net- Worker Management Console or the curses(3X) based nsrwatch(1m) program, depending on the terminal type. Use of nsrarchive is restricted to users in NetWorker administrator list or members of the archive users list or to those who possess the Archive Data privilege.

If no path arguments are specied, the current directory is archived. nsrarchive archives a directory by archiving all the les and subdirectories it contains, but it does not cross mount points or follow symbolic links.

The directive les (see nsr(5)) encountered in each directory are read by default. These les contain special instructions directing how particular les are to be archived (that is, compressed, skipped, etc.). These les are named .nsr for UNIX platforms and nsr.dir for Windows platforms.

Each le in the subdirectory structures specied by the path arguments is encapsulated in a NetWorker archive stream. This stream of data is sent to a receiving process (see nsrd(1m)) on the NetWorker server. Entries are then added to the media database for the archive save set. The data will eventually reside on a long term storage medium (see nsrmmd(1m)).

Details about handling media are discussed in nsrmm(1m) and nsr_device(5).

If the grooming option ( G remove) is requested, you can selectively remove les and directories that have been archived. If verication is requested, the les will not be removed if the verication fails. The user is prompted for conrmation before the les and directories are removed, unless the y option is supplied.

If the user does not supply a T option on the command line, they will be prompted to enter an annotation for the archive.

OPTIONS b pool Specify a destination pool for the archive save set. If this option is not used, the Indexed Archive pool is used.

B Force archive of all connecting directory information from root (/) down to the point of invocation. The connecting directory information is always archived, even without this option, if a client le index is generated.

C clone pool Generate a clone of this archive save set to the specied clone pool . This option is no longer supported. Use nsrclone to clone save sets.

E Estimate the amount of data which will be generated by the archive, and then perform the actual archive. The estimate is generated from the inode informa- tion, and thus, the data is only read once.

f lename The le from which to read default directives (see nsr(5)). A lename of - causes the default directives to be read from standard input.

i Ignore directive les as they are encountered in the subdirectory structures being archived.

I input_le In addition to taking the paths for nsrarchive from the command line, a list of

NetWorker 19.1.1 168

Maintenance Commands nsrarchive ( 1m )

paths in the named input_le will be archived. The paths must be listed one per line. If no paths are specied on the command line, then only those paths specied in the input_le will be archived.

G remove Groom the les after they have been archived. If verication is requested, no grooming is performed until the verication has completed successfully.

Be aware that the groom option must be entered as G remove. Entering G alone will not invoke the groom option.

The user is prompted for removal of les and directories unless the y option is supplied as one of the nsrarchive options. The valid remove responses and their meanings are:

n Keep the current le or directory.

y Remove the current le or directory.

N Keep all remaining les and directories.

Y Remove all remaining les and directories.

The default response, "n", is displayed within square brackets and can be selected by pressing [R et u r n]. When either Y or N is specied, there will be no further prompting and each subsequent removal decision is made as if the corresponding lower case letter has been selected.

nsrarchive creates a temporary le which contains a list of all les and directories to be removed. The temporary le is placed in /tmp unless the environment variable TMPDIR is set.

n No archive. Estimate the amount of data which will be generated by the archive, but do not perform the actual archive.

N name The symbolic name of this archive save set. By default, the rst path argument is used as the name.

v Verbose. Cause the nsrarchive program to tell you, in great detail, what it is doing as it proceeds.

p Exit with status 0. Used by the server to determine if the client is installed properly.

q Quiet. Display only summary information or error messages.

R name This option should only be used by the nsralist program, which han- dles executing archive requests. Updates to the named archive request resource occur when this option is specied.

s server Specify which machine to use as the NetWorker server.

T annotation Archive save sets can be annotated with arbitrary text. This option species an annotation for the archive save set being generated.

V Verify the archive save set after it completes.

o save_operations Save Operations of the form KEYWORD:TOKEN=STATE. It is used to congure VSS saves on the Windows OS. Examples:

"vss:=off" Turn off VSS.

NetWorker 19.1.1 169

Maintenance Commands nsrarchive ( 1m )

"vss:Microsoft Exchange Writer=off" Disable a writer.

"vss:C:=off" Disable VSS for a drive.

Please see the Admin Guide for more details.

W width The width used when formatting summary information output.

x Cross mount points.

y Answer yes to any questions.

SEE ALSO curses(3X), nsr_getdate(3), nsr(5), nsr(1m), nsr_service(5), nsr_device(5), nsrmm(1m), nsrmmd(1m), nsrd(1m), nsrwatch(1m), nsrretrieve(1m)

DIAGNOSTICS Exit Codes: 0 Normal exit.

Non-zero Abnormal exit.

NetWorker 19.1.1 170

Maintenance Commands nsrauthtrust ( 1m )

NAME nsrauthtrust congure trust relationship with an authentication service

SYNOPSIS nsrauthtrust [ r ] [ l ] [ f certicate_le ] [ H host ] [ P port ]

DESCRIPTION The nsrauthtrust utility is used to establish trust between NetWorker server and an authentication service, i.e. congure NetWorker server to honour authentication asser- tions issued, signed and encrypted by a particular authentication service.

The trust between NetWorker server and an authentiction service on the same machine is established automatically, however, when there is a need to e.g. exchange tokens among multiple servers in a complex environment, it may be necessary to run this util- ity manually. This is also necessary in environments where a single NetWorker Management Console server is used to administer multiple NetWorker servers. All NetWorker servers in such a setup need to be congured to trust the authentication service used by the console.

The primary function of the utility is to import the authentication services certicate. The certicate can be obtained automatically by contacting the service on the provided host and port. Alternatively, it can be provided as a PEM formatted le, in which case the service will not be contacted.

The utility normally requires NetWorker to be up and running, however it can also be run in "local mode" by providing l ag, in which case required data is written to the lesystem and the trust will be established at the next startup of the NetWorker server.

The trust can only be congured by users in the Security Administrators user group in normal mode, or a local root user when running in "local mode".

nsrauthtrust is also used to revoke previously established trust with a service on pro- vided host and port, by providing r ag.

OPTIONS f certicate_le certicate_le is a locally accessible le containing a PEM formatted certicate of the authentication service. If this option is provided, the authentication service on provided host and port is not contacted.

H host host is the name of the host on which the authentication service is running.

l local mode. NetWorker server is not contacted for data validation and addi- tional conguration beyond importing the certicate.

P port port on which the authentication service is running.

r revoke trust with authentication service on specied host and port.

EXAMPLES Congure trust with the authentication service running on host mars and port 18080. nsrauthtrust -H mars -P 18080

Congure trust with the authentication service running on host mars and port 18080. The certicate has been copied via sFTP to a le /space/mars.pem because the service is temporarily not available due to rewall problem.

nsrauthtrust -H mars -P 18080 -f /space/mars.pem

Congure trust with the authentication service running on host mars and port 18080 in local mode during disaster recovery scenario. The certicate has been copied via sFTP to a le /space/mars.pem

nsrauthtrust -l -H mars -P 18080 -f /space/mars.pem

NetWorker 19.1.1 171

Maintenance Commands nsrauthtrust ( 1m )

Revoke trust with the authentication service running on host mars and port 18080. nsrauthtrust -r -H mars -P 18080

DIAGNOSTICS You must provide certicate to add. This will occur if neither f has not been specied and either H and P options have not been specied, or the authentication service at that location could not be contacted.

BAD_DATA. This will occur if provided certicate is not valid.

You are not authorized to run this command. This will occur if the command is executed by a user without Change Security Settings privilege or by a non-root user in local mode.

Exit Codes:

0 Normal exit.

1 Abnormal exit. User asked for something that is incorrect.

NetWorker 19.1.1 172

Maintenance Commands nsrcap ( 1m )

NAME nsrcap update the capabilities of a NetWorker installation

SYNOPSIS nsrcap [ vn ] { c d u } enabler-code [ a authorization-code ]

DESCRIPTION The nsrcap program is primarily used to enable new features on NetWorker. You can also use nsrcap to upgrade or downgrade NetWorker software features that are currently being used. (Upgrades and downgrades should be performed carefully. Read the options descriptions below). Enablers are separate from the NetWorker software, and are specied by an 18-digit enabler-code, usually displayed as 3 groups of 6 digits each. The authorization code is an 8 digit hexadecimal number. To enable a new feature, the nsrd(1m) program must be running on the system where the Net- Worker server software is installed. To enable a new feature you must be logged in to the NetWorker server as administrator or root. The nsrcap program is run once for each feature you want to enable by specifying the 18-digit enabler-code. You may authorize a new enabler as you enable the feature or authorize an already existing ena- bler. If no errors occur, the following message gets displayed on the screen: "License enabler loaded. Please register all enablers immediately." You can inspect the enablers currently loaded by viewing the NSR license resources using nsradmin(1m).

OPTIONS c Causes nsrcap to enable a feature that is not currently installed, using the specied enabler code. Enabler codes are listed on enabler certicates provided when you purchase NetWorker. An authorization code is required to make each license permanent. To obtain authorization codes for your NetWorker product via the World Wide Web, simply point your web browser to URL: http://customernet.emc.com. You will need to enter the enabler code for each authorization code that you request. For more details on NetWorker licensing, including other methods to obtain authorization codes, refer to the NetWorker Installation and Administration Guide and the latest NetWorker Release Sup- plement. You can only load a feature once; an error is returned if you attempt to load the enabler more than once. You can only specify one of the c, d, or u options.

d Causes nsrcap to downgrade an existing Base or Jukebox enabler. After you downgrade the enabler, you cannot return to the previous level enabled on the system. Do not use the -u option unless instructed to do so by EMC Technical Support. You must specify one of the c, d, or u options.

u Causes nsrcap to enter an enabler that upgrades an existing Base or Jukebox enabler. After you upgrade the enabler, you cannot return to the previous level enabled on the system. If you use the Base enabler, it will put the new license in the grace mode. The nsrcap program utilizes the grace mode to ensure that the new enabler will not immediately time out. Do not use the -u option unless instructed to do so by EMC Technical Support.

v Causes nsrcap to display more verbose information, describing the enabler being loaded. You must specify one of the c, d, or u options.

n No load. Causes nsrcap to inspect the enabler code for validity. When you specify the -n option, the enabler code you enter on the command line is inspected and veried, but is not entered into the NetWorker servers nsr_license resource. You must specify one of the c, d, or u options.

a Authorizes a license with the specied authorization code, making the license permanent. Specify the license to be authorized by using the c option fol- lowed by the enabler-code and the a option followed by the authorization- code. To obtain authorization codes for this product via the World Wide Web,

NetWorker 19.1.1 173

Maintenance Commands nsrcap ( 1m )

simply point your web browser to customernet.emc.com to enter the enabler code for each authorization code that you request. For more details on pro- duct licensing, including other methods to obtain authorization codes, refer to the product Installation and Administration Guide and the latest Release Sup- plement.

SEE ALSO jbcong(1m), nsradmin(1m), nsrd(1m), lgtolic(1m).

DIAGNOSTICS enabler-code is too long Enabler codes must be 18 digits in length. The code entered is longer than 18 digits and is invalid. Note that 24-digit enabler codes are intended for the Net- Worker License Manager.

authorization-code is too long Authorization codes must be 8 digits in length. The code entered is longer than 8 digits and is invalid.

authorization-code is too short Authorization codes must be 8 digits in length. The code entered is shorter than 8 digits and is invalid.

invalid enabler code: xxxxxx-xxxxxx-xxxxxx The 18-digit enabler code entered on the command line is invalid. Re-check the enabler-code on your enabler sheet.

License authorization fails Either the 8-digit authorization code entered on the command line is invalid or this license has already been authorized and hence cannot overwrite existing authorization code. Re-check the enabler-code and the corresponding authorization-code.

cannot nd a jukebox resource to enable The code word entered is a jukebox license enabler, but there are no jukebox resources to enable. You need to run jbcong(1m) to complete the jukebox installation before running nsrcap.

found a jukebox, but it had more than N slots. Jukebox enablers can only enable jukeboxes with at most N physical slots, where N is the type of jukebox enabler. Either the jukebox was installed incorrectly, or you need to obtain a larger jukebox enabler.

this enabler-code is already assigned The enabler-code entered is already loaded onto the system and cannot be used again for an upgrade.

no appropriate jukeboxes to upgrade An upgrade was attempted, but no jukebox resources were found. Only use the u option for jukeboxes when upgrading from one jukebox level to another, not on the initial installation. You also need to run jbcong(1m) before running nsrcap.

this enabler-code previously loaded The enabler-code entered has been loaded onto the system previously and can- not be used again. You need to purchase a new enabler-code for the upgrade.

dont know how to upgrade this enabler dont know how to downgrade this enabler

The enabler-code entered is not for a base or jukebox enabler. These are the only types of enablers that you can currently upgrade or downgrade.

base enabler must be loaded before upgrading base enabler must be loaded before downgrading

NetWorker 19.1.1 174

Maintenance Commands nsrcap ( 1m )

You cannot perform an upgrade or downgrade until a base product has been installed. Install a base enabler, and then perform the upgrade or downgrade.

cannot nd the enabler to upgrade A jukebox upgrade was attempted, but the license enabler for the jukebox is not currently loaded. You must use the c option for the initial installation of a jukebox enabler, not the u option.

RPC error: Program not registered The nsrcap program requires that the NetWorker daemons be running. Start your NetWorker daemons (cd /; nsrd) and re-run the nsrcap program. If nsrd is already running, you have probably reached a resource limit on the server (for example, not enough memory, or no more processes).

RAP error: user login name needs to be of the type: NSR administrator list. Your login name is not listed in the administrators list for the server. You need to be a valid administrator to run nsrcap.

RAP error: ... Various other errors can be returned from nsrd if the enabler is invalid. For example, if you try to load a base enabler onto a system that already has a base enabler loaded, or if you attempt to load a jukebox enabler before the jukebox has been completely installed. The specic problem will follow the RAP error prex.

NetWorker 19.1.1 175

Maintenance Commands nsrcapinfo ( 1m )

NAME nsrcapinfo Estimate the total amount of data protected by NetWorker.

SYNOPSIS nsrcapinfo [ i lein ] [ o leout ] [ r report_type ] [ s server ] [ d days ]

DESCRIPTION The nsrcapinfo program reads saveset information from either an input .XML le gen- erated by mminfo , or directly from nsrmmdbd . It nds the maximum full saveset size for each client from the last 60 days and denes this as the clients capacity. The sum of all client capacities provides an estimate of the total capacity. Savesets are categorized by le system types and backup applications. The algorithm does not compute the total amount of data ingested by NetWorker over the period, nor does it try to estimate the impact of a le system that grows or shrinks in an incremental fashion. The heuristic is intentionally simple, and represents the lower bound of data protected by NetWorker.

OPTIONS If nsrcapinfo is run with no options it will by default communicate with the local nsrmmdbd and generate a summary XML report to stdout. When nsrcapinfo is launched by NetWorker nsrd will send the XML report to the congured ESRS server. For report validation several options are supplied.

i lein Allows the user to specify the input XML le. This option is useful for com- paring results generated by nsrcapinfo with those generated by other tools. If omitted, nsrcapinfo will directly query the local nsrmmdbd.

o leout Allows the user to specify the output le. If omitted, nsrcapinfo will send its output to the terminal.

r report_type If r is omitted, nsrcapinfo will generate a default XML summary. Five addi- tional report types can be generated. Report summary provides the same summary as the default report only in CSV format. Report clients provides a breakdown by client showing the sum of maximum savesets per client. Report savesets provides a more detailed breakdown showing the maximum saveset size for each client and each saveset name. Report other_apps shows the list of savesets included in "Other_Applications". Report app_types provides a list of recognized application types and the save set prexes usually associated with those types. Report all generates all of the previous reports in a single output le as a sequence of tables. This is the same result that running each report type one after the other would produce.

s server Allows a remote server to be specied for nsrmmdbd queries.

d days Specify the number of days to use for the estimate. By default 60 days are used.

APPLICATION TYPES

NetWorker savesets identify their types through the use of prexes. The nsrcapinfo tool uses these prexes to categorize le system types. In many cases the prexes are self explanatory. A list of some of the common prexes follows:

MSEXCH: Microsoft Exchange.

index: NetWorker indices.

RMAN: Oracle backup data.

NetWorker 19.1.1 176

Maintenance Commands nsrcapinfo ( 1m )

SYBASE: Sybase backup data.

C: Windows lesystem backup data for drive C:.

/usr Unix le system data for the directory "/usr".

EXAMPLES Default Summary Capacity Estimate To generate the summary report in CSV format for a remote host:

# nsrcapinfo -r summary -s networker_server "Capacity_Estimate_Report", "" "Time_Stamp", "2017-04-13T16:45:22Z" "Clients", "234" "", "" "Exchange_NMM9.x", "28.8371" "Oracle", "3178.5320" "SQL_VDI", "23.9834" "Meditech", "775.3451" "", "" "Other_Applications", "0.8302" "", "" "Unix_Filesystems", "31045.2769" "VMware_Filesystems", "22.0023" "Windows_Filesystems", "5123.3050" "", "" "Total_Largest_Filesystem_Fulls", "36190.5842" "Peak_Daily_Applications", "4007.5296" "Capacity_Estimate", "36190.3073" "Unit_of_Measure_Bytes_per_GiB", "1073741824" "Days_Measured", "60"

List Save Set Names for Other_Applications Any save set type that doesnt t into one of the main categories is classied as "Other_Applications". To see the types that are included in this group use report type 4:

# nsrcapinfo -r other_apps "Unrecognized_Save_Set", "Max_GiB", "Count" "master", "0.0040", "1" "proc", "7.2756", "1" "DC=kaysap,DC=int", "0.0008", "1"

Generate Capacity Estimate via an mminfo XML File An XML report collected from mminfo needs to be generated with a certain set of elds in a particular order so it can be parsed by nsrcapinfo. Extra elds in the mminfo output will be ignored by nsrcapinfo . The following example demonstrates using the tools in combination with the minimum set of required mminfo elds.

# mminfo -avI -xm -t 01/28/2017 -r "client,name,sscreate(50),level,totalsize,vmname" > /tmp/ssinfo.xml

# nsrcapinfo -i /tmp/ssinfo.xml -o /tmp/nsrcapinfo_max_client_ss.csv -r clients

NOTES ON CAPACITY ESTIMATES

Denition of Constants All decimal values in the capacity report are in units of gigibytes (GiB). The value of 1 GiB is included in the report, it is slightly larger than the value of 1 GB, i.e. 1,000,000,000 bytes. Precision is limited in the output to .0001 GiB, although internally all sums are computed to the byte.

NetWorker 19.1.1 177

Maintenance Commands nsrcapinfo ( 1m )

Cumulative Values "Total_Largest_Filesystem_Fulls" is the sum of "Unix_File_Systems", "VMware_File_Systems" and "Windows_File_Systems". Application data is reported separately and not included as part of "Total_Largest_Filesystem_Fulls". "Peak_Daily_Applications" is the sum of all application capacity estimates including "Other_Applications". NetWorker metadata, including indices are not included in either the application or the lesystem capacity estimates. "Capacity_Estimate" is the sum of all reported elds, including both application data and le system data. Measurement of application capacity is open to interpretation, see the next section on Oracle and SAP.

Oracle and SAP Capacity Estimates NetWorker metadata for Oracle savesets always indicates that a saveset is a full whether it is or not. To estimate the capacity of an Oracle database nsrcapinfo takes the sum of all savesets marked with an "RMAN:" prex in a 24 hour period and denes this as a possible full, this is called the daily peak. The maximum daily peak for an Oracle database recorded over the measure- ment period is dened as the capacity of the Oracle client. If multiple Oracle backups are run per day, this value will be too high. If Oracle backups are split across several days this value will be too low. A similar algorithm is used for SAP capacity estimation.

NetWorker 19.1.1 178

Maintenance Commands nsrcat ( 1m )

NAME nsrcat NetWorker notication redirector for tty devices

SYNOPSIS nsrcat [-n]

DESCRIPTION The nsrcat command appends a carriage return to all newlines. This allows Net- Worker notication messages can be redirected to the /dev/console or /dev/tty directory on systems with tty drivers that do not append a carriage return to output lines. This command reads text messages from standard input, appends a carriage return to the newline character, and writes the message to standard out.

OPTIONS n Indicates that the codeset is to be converted from UTF-8 to the users native character encoding.

EXAMPLES type: NSR notication; name: Log default;

action: nsrcat > /dev/console;

SEE ALSO console(4), tty(4), nsr_notication(5), nsr(5)

NetWorker 19.1.1 179

Maintenance Commands nsrcheckconnectivity ( 1m )

NAME nsrcheckconnectivity utility to check status of Networker client services

SYNOPSIS nsrcheckconnectivity help

nsrcheckconnectivity [ policy_name policy_name p policy_name ] [ workow_name workow_name w workow_name ] [ group_name group_name g group_name ] [ client client_name c client_name ] [ parallelism parallelism_for_execution P parallelism_for_execution ] [ retry number_of_times_to_retry r number_of_times_to_retry ] [ retry_interval wait_time_before_retry i wait_time_before_retry ] [ success_criteria { All Any } u { All Any } ] [ server NetWorker_server s NetWorker_server ]

DESCRIPTION The nsrcheckconnectivity program is a utility to check if Networker client services are up and running. It is a standalone and action binary. This program will perform RPC ping to check if nsrexecd service is up and running.

OPTIONS nsrcheckconnectivity

help Display the usage information.

p policy_name Species the policy name.

w workow_name Species the workow name under the policy.

g group_name Species the name of a group with which the workow is associated.

c client Species the cilent name to be protected.

P parallelism_for_execution Species the parallelism used to execute the task. Default is 8.

r number_of_times_to_retry Species the number of times a task is retried before giving up.

i wait_time_before_retry Species the wait time after which the task is restarted.

u { All Any } Species if checking connectivity for all savesets or a set of savesets. All: If all the clients pass then result is a pass. Any: If any of the client fails then result is a fail.

s NetWorker_server Species the Networker server executing the workow.

EXAMPLES The nsrcheckconnectivity options can be displayed using nsrcheckconnectivity --help

To check the connectivity for a policy with a success criteria of All nsrcheckconnectivity --policy_name A --workow_name A_w --success_criteria All

NetWorker 19.1.1 180

Maintenance Commands nsrck ( 1m )

NAME nsrck NetWorker index consistency check, repair, and recovery program

SYNOPSIS nsrck [ qMv ] [ R [ Y ] ] [ L check-level [ t date ] X [ x percent ] C F

m n c ] [ T tempdir ] [ clientname . . . ]

DESCRIPTION nsrck is used to check the consistency of the NetWorker online index of clients save records. Normally, nsrck is started automatically and synchronously by the nsrindexd(1m) program when nsrindexd starts. You can modify the nsrck modes to allow normal users to run nsrck and retain root privileges (see nsr(1m) for more details).

When nsrindexd starts up, it determines whether any further checking of a clients index is necessary. This phase veries the internal state of the index database, and if that state is consistent, avoids further passes. This phase also reports any suspicious- looking index names (that is indexes whose names cannot be mapped into network addresses). These online le indexes are then checked more rigorously.

nsrck detects whether any client indexes need to be converted and does the proper conversion. Converting the indices takes free space on the volume that contains them; if there is not sufcient free space, you may use the T tempdir ag to specify a dif- ferent directory which the conversion will use as its work space. You may also manu- ally convert client indices by issuing the nsrck command manually.

There are seven different checking levels supported by nsrck. If client names are sup- plied, the check is performed on the given client names. If no names are given, the checks are performed for all client indexes. The check levels work as follows for each client checked:

Level 1 validates the online le index header, merging a journal of changes with the existing header. In addition, all save set record les and the corresponding key les are moved to the appropriate subdirectories under db6.

Level 2 does a level 1 check and checks the online le index for new and cancelled saves. New saves are added to the online le index, and cancelled saves are removed.

Level 3 does a level 2 check and reconciles the online le index with the online media index. Records that have no corresponding media save sets are discarded. Also all empty subdirectories under db6 directory are deleted.

Level 4 does a level 3 check and checks the validity of the online le indexs internal key les. If any of these key les are invalid, they are rebuilt.

Level 5 does a level 4 check and veries the digest of individual save times against their key les.

Level 6 does a level 5 check and extracts each record from each save time, verifying that each record can be extracted from the database. The digest of each save time is re-computed and compared against the stored digest, and the internal key les are rebuilt.

Level 7 does not do a level 6 check, but merges to the online le index (the index data recovered from backup media), rebuilds the internal key les, and rebuilds the index header. Note that it will not overwrite existing les in the client le index. So, if online client le index data already exists for a save set for a particular save time, it must be removed before Level 7 can be used to restore it from the backup media. The t date option may be used to recover the index as of a specic time. Note that recov- ering the index to a specic time adds the entire contents of the index as of that time to the current index contents. This option allows browsing of save sets that have passed their browse policy and are still recoverable. The save sets referred to by the recovered index will be marked as browsable. They will remain browsable for the

NetWorker 19.1.1 181

Maintenance Commands nsrck ( 1m )

length of time they were originally browsable.

For example, if a .rec le in the le index is corrupted, and a nsrck -L5 is not per- formed to purge the corrupted save set rst, before doing a nsrck -L7, then the recover will not overwrite the corrupted .rec le and the le index will remain corrupted.

Checks done at a higher level generally take longer than checks at a lower level. Checks at a higher level provide a more thorough checking of the online le index. Level 7 is used when the online le index on disk needs to add in le index data recovered from backup media. The nsrck program is restartable at any time during its execution. Therefore, it can survive system crashes or exhaustion of resources without losing data.

Each time the NetWorker server starts, it runs nsrck -L 1 to perform a fast and efcient check for each of the congured client le indexes. Only the consistency of the index header and journal les are checked. It is generally not necessary (and very time con- suming) to check every record and key le in the client le index at startup. The pro- gram nsrim will automatically invoke nsrck -L 3 after updating the save sets browse and retention times in the media database to remove client le indexes that have exceeded the retention policy. If a problem is detected, a more thorough check will be automatically performed on the client le index in question.

If you believe an index may be corrupt, you can manually run a higher level check on the index, for example:

nsrck -L 6

OPTIONS C This option validates the clients online le index header. It is identical to specifying the L 1 option.

c This option is the same as using L 2.

F This option is the same as using L 2.

t date Recover the index as of the specied date (in nsr_getdate(3) format). This option is only valid with the L 7 option.

T tempdir Species a different directory to use for conversion. This is useful if your client indexes are on le systems that are nearly full. It will enable the conver- sion to use the tempdir specied as a work space for converting indexes. It is not recommended to use /tmp, since its contents are lost if your machine is rebooted.

L level Species the level of checking to use. The valid levels are 1-7.

M Master mode (not advised for manual operation). This advises nsrck that it is being run by nsrd(1m) or another NetWorker daemon and should log mes- sages with timestamps, and perform any other behavior expected by nsrd.

m Invokes consistency checks to detect and remove inconsistent records from the media database. If inconsistent records are detected, the occurences will be recorded in the daemon log. If inconsistent save set records are detected and removed, then nsrck -X should be run to remove the associated index records from the clients online le index.

This option must only be run when the NetWorker server is idle, as the media database will be unresponsive while performing the consistency checks. This option performs the same operations that are invoked at startup after an improper media database shutdown is detected, namely:

NetWorker 19.1.1 182

Maintenance Commands nsrck ( 1m )

1) A checksum verication is performed on every record in the media database to verify record corruption has not occurred.

2) All records from previous media database versions will be upgraded to the current media database record format.

3) The client id map records are checked for unique identiers and names.

4) Each client resource is then checked to verify a client id map record exists in the media database for the client resource.

5) Each save set record is checked for a valid client entry.

6) The save set records are then checked for valid and unique record identier elds.

7) The volume records are then checked for unique record identier and name elds.

8) Save set records are checked to ensure each (continuation) save set reference exists in the media database.

9) Save set records are checked to ensure that each volume reference exists in the media database.

10) The volume records are then checked to ensure all the save set references exist in the media database.

n This option should only be used with the -m option. It is used to only report consistency errors in the media database, without repairing or removing the inconsistent entries.

q Quiet mode. All advisory messages are suppressed.

v Verbose mode. Advisory messages are emitted.

R Removes the index for the client. This is valid only when the Y option is also specied. If the nsrck command is not in master mode, the user will be prompted with a warning indicating which online le indexes will be com- pletely removed and given an opportunity to kill the command if this was not what the user intended.

X This is the same as using L 3

x percent This is the same as using L 1. The "percent" value is ignored, but permitted. This allows customer scripts using this option to continue working.

Y Used in conjunction with R to remove online le indexes. Using this ag means that you really do wish to remove the online le index(es). If you fail to use this ag with the R option, you will be warned that you need to add the Y ag to the nsrck command.

FILES /nsr/index/ clientname /db6/nsrck.lck nsrck locks this le, thereby insuring that only one copy of nsrck is checking a clients index.

/nsr/index/clientname

NetWorker 19.1.1 183

Maintenance Commands nsrck ( 1m )

/nsr/index/clientname /db6

SEE ALSO nsr_layout(5), nsr_policy(5), nsr_render_log(1m), hosts(5), nsr(1m), nsrd(1m), nsrindexd(1m), nsrmmdbd(1m), nsrim(1m), savegrp(1m), nsrworkow(1m)

DIAGNOSTICS checking index for clien t n am e Informative message that the les associated with the named client are being inspected.

WARNING no valid savetimes - cross-check not performed for clien t n am e During a cross-check, no save sets were found for this client. Since this situa- tion can occur during disaster recovery, nsrck avoids deleting the entire con- tents client index.

cross-checking index for clientname Displayed when the L 3 option is in effect.

completed checking count clients Displayed as the program nishes, provided some form of checking was accomplished.

NetWorker 19.1.1 184

Maintenance Commands nsrclientx ( 1m )

NAME nsrclientx correct client ID issues in the media and resource databases.

SYNOPSIS nsrclientx a le [ p ]

nsrclientx u le

DESCRIPTION The nsrclientx command is used to detect client ID corruption as well as client IDs eligible for purging in the media database. It can also merge clients together in both the resource database and the media database.

By default, NetWorker congures a NSR task resource to schedule nsrclientx to run every Monday at 7:00 AM. The resource name for this task is DefaultNsrclientxTask. The tasks scheduling can be adjusted by using nsradmin(1m) to modify the start time and interval attributes of the DefaultNsrclientxTask NSR task resource. Completion status of each task run is reported in the /nsr/logs/daemon.raw log le.

Output of the nsrclientx task is written to a le under /nsr/logs/client_x. When errors are detected, this le can be used to correct the errors by manually running nsrclientx with the u option.

OPTIONS a le Analyze the media database. The results are printed on screen and to the le specied by le . If is used instead of a le name then the results will only be displayed on screen.

p When running the analysis also look for clients that should be purged. Purg- ing is not recommended unless there are clients what will never need to be recovered again as the client ID will be permanently lost by this action.

u le Update the resource and media databases with the information obtained from the le le . If is specied for le then input is read from standard in.

FILE STRUCTURE The le read in and output are of the same format. The le consists of a comma separated list of clients separated by newlines. The number of clients on the line deter- mines the actions taken.

One client When there is only one client on the line it means it is marked to be purged. This will not show up during the analysis step unless the p ag is used. Clients are usually reported for purging (when requested) when an old client exists with no resource or media database entries. This is caused by either expired decommissioned clients or from merging one client into another.

More than one client More than one client means that the clients listed are to be merged together. The rst name in the list is the primary name whose name and client ID will be preserved (if it already exists). The following names (secondary names) will all be merged into the primary name. Any client resources of the secondary names will be renamed to the primary name and the alias lists of all clients will be combined. The media database entires will also have their client IDs and names merged into the primary name. At this point the index of the pri- mary name is unlikely to be accurate. The two approaches to take are to either leave it and just have the next backup potentially back up more data one time or to try to use scanner(1m) to scan in the index.

EXIT STATUS 0 Normal exit.

1 Abnormal exit.

NetWorker 19.1.1 185

Maintenance Commands nsrclientx ( 1m )

EXAMPLES nsrclientx -a - If the output of the above command is "venus.emc.com, saturn", the daemon.raw would contain a line similar to "Detected error with client id(s): %s 1 48 24 venus.emc.com, saturn"

FILES /nsr/logs/client_x DefaultNsrclientxTask task output is written to les under this directory. These les have the following format: DefaultNsrclientx_YYYYDDMMHHMMSS

BUGS This command does not support the renaming of a storage node or server. Old clients can be merged into the storage node and server, but the canonical name should not be changed with this feature. It is also recommended that a backup of the media data- base is done beforehand, only one client is dealt with at a time and the results are hand checked before moving to the next client. This can be accomplished by taking the analysis output le, running it through the system one line at a time and then checking the results with mminfo(1m).

SEE ALSO nsr_client(5), nsr_client_x(5), mminfo(1m), scanner(1m) nsrtask(1m)

NetWorker 19.1.1 186

Maintenance Commands nsrclone ( 1m )

NAME nsrclone NetWorker save set cloning command

SYNOPSIS nsrclone [ v ] [ n ] [ F ] [ s server ] [ J recover storage node ] [ d save storage node ] [ b pool ] [ y retention ] [ w browse ] [ R ] [ m ] [ o ] {[ I ] f le volname... }

nsrclone [ v ] [ n ] [ F ] [ s server ] [ J recover storage node ] [ d save storage node ] [ b pool ] [ C less than copies in pool ] [ y retention ] [ w browse ] [ R ] [ m ] [ o ] S {[ I ] f le ssid... }

nsrclone [ v ] [ n ] [ F ] [ s server ] [ J recover storage node ] [ d save storage node ] [ b pool ] [ C less than copies in pool ] [ y retention ] [ w browse ] [ m ] S t start time [ e end time ] [ B pool name ]... [ N saveset name ]... [ l level or range ]... [ c client name ]... [ g group_name ]... [ q lter_name=value ]...

nsrclone [ v ] [ n ] [ F ] [ s server ] [ J recover storage node ] [ d save storage node ] [ b pool ] [ C less than copies in pool ] [ y retention ] [ w browse ] [ m ] S e end time [ t start time ] [ B pool name ]... [ N saveset name ]... [ l level or range ]... [ c client name ]... [ g group_name ]... [ q lter_name=value ]... [ h volume_name ]...

nsrclone [ v ] [ n ] [ F ] [ s server ] [ J recover storage node ] [ d save storage node ] [ b pool ] [ y retention ] [ w browse ] [ R ] [ m ] [ o ] V {[ I ] f le

volid... } nsrclone [ v ] [ s server ] [ J storage-node ] [ y retention ] P W volname

DESCRIPTION The nsrclone program makes new copies of existing save sets. These copies are indis- tinguishable from the original, except for the volume(s) storing the copies. The copies are placed on different media volumes, allowing for higher reliability than a single copy provides. The copies may be made onto any kind of media (for example, save sets on an 8mm tape may be copied to a set of optical disks). However, all media used as the destination of an nsrclone operation must be in a clone pool . See nsr_pool(1m) for a description of the various pool types.

Although the command line parameters allow you to specify volume names or volume identiers, nsrclone always copies complete save sets. Save sets that begin on a specied volume will be completely copied, so volumes may be requested during the cloning operation in addition to those specied on the command line. Conversely, save sets residing on the specied volumes that begin elsewhere are not cloned.

Note that nsrclone does not perform simple volume duplication , but rather, copies full save sets to a set of destination volumes in a given pool. If the rst destination volume chosen cannot hold all of the save sets to be copied, another volume will be chosen. This allows you to use different kinds of media for each copy, allowing for variable sized volumes, such as tapes.

The nsrclone program, in conjunction with nsrmmd(1m), guarantees that each save set will have at most one clone on a given volume. When you specify a volume name or identier, the copy of the save sets on that volume are used as the source. When save sets are specied explicitly, those with existing multiple copies are automatically chosen (copies of save sets that exist on volumes in a jukebox are chosen over those that require operator intervention). You can also specify which copy (clone) of a save set to use as the source, (see the S option,in the options section).

Cloning occurs between a source storage node reading from a volume and a target storage node writing to a volume. The source storage node is determined by rst using the value associated with the J option passed to nsrclone. If this option is not

NetWorker 19.1.1 187

Maintenance Commands nsrclone ( 1m )

passed to nsrclone, then the "recover storage nodes" attribute of the host of the device where the volume is mounted containing the needed savesets is consulted. If this attri- bute is empty, "nsrserverhost" is used as the source storage node. The target storage node of a clone is determined by rst using the value associated with d option passed to nsrclone. If this option is not passed to nsrclone, the target storage node of a clone is determined by the "clone storage nodes" attribute of the source storage node. If the "clone storage nodes" attribute is not specied, then the "storage nodes" attribute of the source storage nodes client resource is used. If the "storage nodes" attribute is not specied in the source storage nodes client resource, then a device in the correct pool on the server is used. Please note that nsrclone never looks at the clone storage node afnity of the clients whose savesets are being cloned. See nsr_storage_node(5) and nsr_client(5) for additional detail on how these attributes are used and on other storage node information.

The -c, -N, -l, -g and -q criteria options select candidate savesets for cloning and are intended to behave like the equivalent mechanisms in mminfo(1m).

The nsrclone program can also be used to clone NDMP (Network Data Management Protocol) save sets. If the save set to be cloned was backed up by nsrndmp_save via nsrdsa_save (Data Server Agent program where the save sets ags have N and s), then the save set can be cloned to any NetWorker storage device other than an NDMP tape device. See mminfo(1m) for more details on the N and s save set ags. Refer to nsrndmp_save(1m) for more information regarding NDMP backup. Non-DSA NDMP save sets can only be cloned to NDMP tape devices. Cloning from a non- NDMP tape device to an NDMP tape device, and vice-versa, is not supported.

When -m option is specied, nsrclone program is used to migrate (or stage) existing save sets on a manual basis. Migration is the process of moving one or more save sets between storage volumes. The process begins by making a clone of the specic save sets to the new volume specied, and then deleting the cloned save set entries from the media database (see the -S description). Finally, the save sets will be removed from the original source volumes. The second and the third operations are triggered by the successful completion of the previous operation. The data is moved to new media volumes, making room for new data on the original volumes.

Migration can be onto any media type (for example: save sets on a Data Domain, adv_le or le volume can be migrated to a tape or disk volume). The nsrclone pro- gram supports save set and volume migration from Data Domain, adv_le and le type volumes.

For migration operation, if the nsrclone program encounters an error after successfully cloning some of the specied save sets, then it will delete only those successful save sets from the source volume before it is aborted. Concurrent migration operation from RW and RO volumes of Data Domain and adv_le is not supported.

Note the following:

- nsrclone can be executed only from the server. - nsrrecopy and ansrd daemons are spawned by nsrclone. - nsrclone is supported on Cloud Boost and DD Cloud Tier devices.

OPTIONS b pool Species the media pool to which the destination clones should be sent. The pool may be any pool currently registered with nsrd(1m) that has its status set to clone . The possible values can be viewed in NetWorker Management Con- sole by clicking Media from the Administrator window, then selecting Media Pools from the left pane. If you omit this option, the cloned save sets are automatically sent to the Default Clone pool.

B pool name

NetWorker 19.1.1 188

Maintenance Commands nsrclone ( 1m )

If a pool name is specied, only the save sets belonging to that pool will be selected. More than one pool name can be specied by using multiple -B options. This option can only be used with the -t or -e options.

C less than copies in pool Species the upper non-inclusive integer bound such that only savsets with a lesser number of clone copies in the target clone pool will be considered for cloning. Note that since the target is a clone pool, each savesets original copy is never considered when tallying the savesets number of copies.

This option can be used with the t or e option. It can also be used with S option when ssid(s) or f lename is specied to clone only those ssid(s) meet- ing the condition; that is, ssids with fewer clone copies in the target clone pool than the number specied on less than copies in pool will be cloned.

For example, if ssidA has one clone copy and ssidB has two clone copies in Default Clone pool, then the following command will clone ssidA but not ssidB. Note b Default Clone is optional.

n sr clon e C 2 [ b "Def au lt C lon e"] S ssidA ssidB

This option is useful when some of the ssids in the input list may have already been cloned to a target clone pool. Specifying C less than copies in pool enables nsrclone to select only those ssids meeting the condition which may help to avoid "Waiting for writable volume(s)..." state by ltering out ssids exceeded the specied number of clone copies. However, in the above example, if both ssidA and ssidB have one clone copy but in different volumes of Default Clone pool, where the pool only has these two volumes, then nsrclone will still result in "Waiting" state since both volumes of the target pool will not be available. To workaround this "waiting" state, specify ssidA on one nsrclone command and ssidB on another.

f le Instructs nsrclone to read the volume names, volume identiers or save set identiers from the le specied, instead of listing them on the command line. The values must be listed one per line in the input le. This option cannot be specied with -t and -e options. The le may be "-", in which case the values are read from standard input. The cloning operation begins only when all the entries in the le are correctly specied; even if one of the entries is invalid, the operation will not continue and the corresponding error is reported.

h volume_name Filters savesets based on the volume on which they are located.

I Used with the f option to cause savesets identied by the saveset identiers, volume identiers, or volume names read from the input le to be cloned immediately as opposed to waiting until all of the contents of the input le are read before beginning any clone. This option is most useful when the input le is stdin.

o Causes the id (ssid/cloneid) of each saveset clone produced to be output to stdout on a single line. This option can be used to cascade clone operations.

R Removes the input le that species the volume names, save set or volume identiers to be cloned/staged. This option can only be specied with a -f option.

F If specied will force nsrclone to skip all invalid savesets/volumes and con- tinue cloning.

NetWorker 19.1.1 189

Maintenance Commands nsrclone ( 1m )

s server Species a NetWorker server to migrate save sets from. See nsr(1m) for a description of server selection. The default is the current system.

J recover storage node Species which host to use as the storage node for the recovery part of the cloning process (see nsr_storage_node(5)). This option acts as an override of the normal process used to select the recover storage node. If the specied storage node does not exist or isnt congured as a valid storage node, the clone operation will fail. If this storage node does exist but is unavailable or it cannot access the needed volume, the clone operation will wait until one of the following events occurs: the storage node is made available, the needed volume is made accessible, or the user cancels the clone operation, causing the clone operation fail.

d save storage node Species which host to use as the storage node for the save part of the cloning process (see nsr_storage_node(5)).

v Enable verbose operation. In this mode, additional messages are displayed about the operation of nsrclone, such as save sets that cross volumes, names of cloned volumes, or save set series expansions. If concurrent nsrclone opera- tions are performed on the same save sets, it is possible for the volume names to be inaccurate. In that case nsrclone will issue a warning. Please see DIAG- NOSTICS for the exact warning message.

y retention Sets the date (in nsr_getdate(3) format) when the cloned data will become recyclable. The special value forever is used to indicate that a volume that never expires (i.e. an archive volume) must be used. By default, the server determines this date for the save set based on the retention policies in effect. This option allows overriding the existing policies. See also nsrmm(1m) and its -S & -e options. Note: If nsrclone is run without specifying a retention time and if the clone pool does not have a retention policy congured in the RAP resource, the newly created saveset clone instance in the associated clone volume will have its clone retention set to the saveset retention (maximum value of clone retention among the savesets existing clones).

w browse Sets the date (in nsr_getdate(3) format) when the cloned saveset will become non-browsable. However, a savesets existing browse policy is left unchanged if it is later than the intended time or if it has already passed, i.e. the saveset has become non-browsable and is in the purged-from-index state. This option requires the -y retention option and must not be greater than the retention time. See also nsrmm(1m) and its -S & -w options.

S Causes nsrclone to treat subsequent command line parameters as save set identiers, not volume names. Save set identiers are unsigned numbers. You can nd out the save set identier of a save set using the mminfo -v command (see mminfo(1m)). The S option is useful when you want to copy individual save sets from a volume or all save sets matching an mminfo query (see the examples below). The save set identiers may also specify exactly which copy of a save set with multiple copies to use as the source. To specify exact copies, use the ssid/cloneid format for each save set identier. In this case, the ssid and the cloneid are unsigned numbers, separated by a single slash (/). You can nd out the cloneid for a particular copy by using the mminfo -S report, or a

NetWorker 19.1.1 190

Maintenance Commands nsrclone ( 1m )

custom report.

V Causes nsrclone to treat subsequent command line parameters as volume identiers (volid), not volume names. Volume identiers can be found using the mminfo -mv report, for example. This option can not be used in conjunc- tion with the S option.

Only one -V needs to be specied with multiple volids. Multiple -Vs may cause this command to fail, see the CAVEATS section.

n Do not execute. This option causes nsrclone to generate and print out the list of savesets to be cloned but not actually perform the operation. The list is new- line terminated and the ids are of the form: ssid/cloneid.

N saveset name Species the saveset name for savesets that will be considered for cloning.

l level or range Species the level or n1-n2 integer range from 0 to 9 for savesets that will be considered for cloning. Use "manual" for ad-hoc (client-initiated) savesets, "full" for level full savesets, "incr" for level incremental savesets, integers 0 through 9 (where 0 also means full), etc. More than one level can be specied by using multiple -l options and/or the -l n1-n2 range format. This option can only be used with the -t or -e option.

e end time Specify the end time (in nsr_getdate(3) format) for selecting save set IDs for cloning. This option can only be used with the -S option. If not specied, end time is set as current time. Please note that, -e 0 is same as -e today.

t start time Specify the start time (in nsr_getdate(3) format) for selecting save set IDs for cloning. This option can only be used with the -S option. If not specied, start time is set as end time - 24 hours. Please note that, -t 0 is same as -t today. When specifying a time range, at least -t or -e option must be specied.

c client name If client name is specied, only the save sets belonging to that client will be selected. More than one client name can be specied by using multiple -c options. This option can only be used with the -t or -e option.

g group_name When group_name is specied, only the save sets belonging to that group will be selected. More than one group name can be specied by using multiple g options. It can be used with the c option. This option can only be used with both the S option and the t or e options.

q query_spec=value When query specication is provided, only the save sets matching that query will be selected. Matching is performed using case insensitive string com- parison. Supported query specications include policy=policy_name, workow=workow_name, action=action_name and group=group_name. More than one lter can be specied by using multiple q options or by separating lters with a comma. Multiple values for the same lter are joined using a logical OR (any value satises a match) and different lters are joined using a logical AND (all lters must match). This option can be used with the c option. This option can only be used with both the S option and the t or e options. nsrclone attempts to detect invalid lter values by using a quick regex-based check for the value appearing in the saveset attributes of some savesets in the media database. If this search fails, appropriate feedback is

NetWorker 19.1.1 191

Maintenance Commands nsrclone ( 1m )

provided to the operator. Since this is only a quick check, sometimes it is not possible to detect invalid value due to partial match occuring for some entries. Final evaluation is always performed on full strings and is always accurate.

m Performs the actual migration (or stage) operation. For Block based backup save sets, this option does not migrate save sets to the new media volumes. For volumes that have a combination of Block based backup save sets and reg- ular NetWorker save sets, nsrclone -m will skip over the Block based backup save sets with an error.

P Instructs nsrclone to perform cleaning operation for one volume. Scans a volume for save sets with no entries in the media data base and recovers their space. Space for recyclable and aborted save sets are also recovered from the volume with the save set entries removed from the media data base. You can perform this operation on Data Domain, adv_le and le type volumes. This option must be specied with a -W option.

W volname Species the name of the volume to be cleaned. This option cannot be used with S or m options.

CAVEATS On Linux, this command will fail when volids are specied with multiple -Vs. This behavior can be changed by setting POSIXLY_CORRECT environment variable.

EXAMPLES Copy all save sets that begin on the volume mars.001 to a volume in the Offsite Clone pool:

nsrclone b Offsite Clone mars.001

Copy all complete save sets created during the weekend. If no time of day is specied with the date, nsr_getdate (3) uses midnight as the start time for copying all the com- plete save sets. Only complete save sets can be copied by nsrclone(1m):

nsrclone -S mminfo r ssid \ -q !incomplete,savetime>last saturday,savetime<last monday

Copy a specic clone of a specic save set: nsrclone -S 1538800517/770700786

Copy all save sets created between time 01/21/05 14:50:03 and 01/24/05 14:50:03 for the group Default

nsrclone -S -t 01/21/05 14:50:03 -e 01/24/05 14:50:03 -g Default

Copy all save sets created between time 01/21/05 14:50:03 and 01/24/05 14:50:03 for the policy P1 or policy P2

nsrclone -S -t 01/21/05 14:50:03 -e 01/24/05 14:50:03 -q policy=P1,policy=P2

Copy all save sets created between time 01/21/05 14:50:03 and 01/24/05 14:50:03 for the workow W1 of policy P1

nsrclone -S -t 01/21/05 14:50:03 -e 01/24/05 14:50:03 -q policy=P1,workow=W1

Copy all save sets created in the last 24 hours for clients "rose" and "seam": nsrclone -S -e now -c rose -c seam

Copy all save sets created in the last 24 hours for clients "rose" and "seam" with saveset names "/data1" and "/data2" for backup level "full" only:

nsrclone -S -e now -c rose -c seam -N /data1 -N /data2 -l full

Copy all save sets that were not copied to the default clone pool in a prior partially aborted nsrclone session, assuming no copies existed prior to that aborted session:

nsrclone -S -e now -C 1

NetWorker 19.1.1 192

Maintenance Commands nsrclone ( 1m )

As in the preceding but with extended retention and browse periods: nsrclone -S -e now -C 1 -y 12/12/2010 -w 12/12/2010

Migrate all save sets from the volume mars.101 and jupiter.101 to a volume in the Offsite Clone pool:

nsrclone -m b Offsite Clone mars.101 jupiter.101

Migrate save sets 1234 and 4568 to a volume in the Offsite Clone pool: nsrclone b Offsite Clone -m -S 1234 4567

Migrate clone instance 12345678 of save set 1234 to a volume in the Default Clone pool: nsrclone m S 1234/12345678

Migrate all save sets created since last Saturday to a volume in the Default Clone pool: nsrclone m S mminfo r ssid \

-q savetime>last saturday

Recover space from volume jupiter.013: nsrclone P W jupiter.013

Only complete save sets can be migrated by nsrclone(1m).

SEE ALSO nsr_getdate(3), nsr_client(5), nsr_device(5), nsr_pool(5), nsr_stage(5), nsr_storage_node(5), mminfo(1m), nsr(1m), nsrd(1m), nsrmmd(1m), nsrndmp_save(1m)

DIAGNOSTICS The exit status is zero if all of the requested save sets were cloned or migrated success- fully, non-zero otherwise.

Several messages are printed signaling that nsrd(1m) is unavailable for cloning data; these are self-explanatory. You may also see a message from the following list.

adding save set series which includes parent ssid If running in verbose mode, this message is printed when nsrclone notices that a requested save set is continued, requiring the entire series to be cloned (even if only part of the series was specied in the command line parameters).

adding save set series which includes descendent ssid If running in verbose mode, this message is printed when nsrclone notices that a requested save set is a continuation, requiring the entire series to be cloned.

Cannot contact media database The media database (and most likely other NetWorker services as well) on the named server is not answering queries. The server may need to be started, or if it was just started, it needs to nish its startup checks before answering queries.

cannot clone save set number, series is corrupt The given save set is part of a save set series (used for saving very large les or lesystems), but not all of the save sets in the series were found in the media database. This can happen if, for example, you relabel a tape that con- tains part of a save set series.

cannot clone backup and archive data together Archive and backup data is fundamentally different and cannot be cloned to the same pool. You need to run nsrclone twice, once to clone the backup save sets and once more for the archive save sets.

cannot open nsrclone session with server This message is printed when the server does not accept clone sessions.

cloning not supported; upgrade required Another enabler is required to use this feature.

NetWorker 19.1.1 193

Maintenance Commands nsrclone ( 1m )

cloning requires at least 2 devices Cloning requires at least one read/write device and one read-only or read/write device, since data is copied from one volume directly to another.

server does not support cloning The named server is not capable of cloning.

each clone host needs at least two enabled devices When cloning between two storage nodes that share the same physical drive, each node must have at least two enabled devices.

error, no valid clones of ssid number The listed save set exists, but cannot be cloned because there are no complete copies of the save set. The save set was either aborted or is in progress. Only complete save sets can be copied.

error, user username needs to be on administrator list Only NetWorker administrators are allowed to make clones of backup save sets. NetWorker administrators are listed in the NSR server resource, see nsr_service(5) for more information. For servers with archive capability, users listed in the NSR archive clients user list are allowed to clone archive save sets, as long as they have the "Monitor NetWorker" privilege; users listed in the NetWorker administrator list will also be able to clone archive save sets.

no complete save sets to clone Only complete save sets can be copied, and no complete save sets were found matching the requested command line parameters.

number is not a valid save set The given save set identier is not valid. Two forms are understood: simple save set identiers and those with a cloneid specied. Simple save sets are unsigned numbers. The save set with the cloneid form is specied as two unsigned numbers separated by a single slash (/).

pool is not a cloning pool The pool specied with the b pool option is not a clone pool. You must always use a pool with a type of "Backup Clone" or "Archive Clone" for the b option.

save set number does not exist The given save set (from a S save set list) does not exist. Verify your save set identiers using mminfo(1m).

save set number crosses volumes; requesting additional volumes This message is printed in verbose mode when volume names or IDs were specied, but the given save set is only partially resident on the listed volumes. Since only complete save sets can be cloned, nsrclone automatically requests additional volumes.

save set clone number/cloneid does not exist A specic clone of a save set was specied, but that save set has no clones with that clone identier. Verify your save set identiers using mminfo(1m).

volume name-or-number does not exist The given volume (either a volume name or a volume id specied in the V option) does not exist in the media database.

Cannot nd volume name in media data base The volume name specied in the W option does not exist in the media data- base.

waiting 30 seconds then retrying

NetWorker 19.1.1 194

Maintenance Commands nsrclone ( 1m )

A temporary error occurred and nsrclone will automatically retry the request until the condition is cleared. For example, an error will occur if all devices are busy saving or recovering and nsrclone must wait for these devices become available.

WARNING: Multiple concurrent cloning operations on the same savesets have been detected. The list of volumes reported below may not be accurate. nsrclone prints this message when it detects more clone instances than it expected. This happens when more than one nsrclone commands are run on same save set concurrently. Verify the clone volumes using mminfo(1m). Please note that the result of the clone operation is not affected by this warn- ing.

Space can only be recovered from Data Domain, adv_le and le type devices. The given volume (if you specied the W option) is not a Data Domain, le or adv_le type volume. This message is also printed after a successful migra- tion of data from volumes of type other than Data Domain, le and adv_le.

NetWorker 19.1.1 195

Maintenance Commands nsrconsolidate ( 1m )

NAME nsrconsolidate NetWorker program for synthetic full and rehydrated tape out

SYNOPSIS nsrconsolidate [ v ] [ n ] [ q ] [ V ] c client N save set [ J source storage node ] [ d destination storage node ] [ b pool ] [ g group ] [ m backup mode ] [ w browse time ] [ y retention time ] [ t start time ] [ e end time ] [ i on off ] [ f dirle ]

nsrconsolidate [ v ] [ n ] [ q ] [ V ] [ J source storage node ] [ d destination storage node ] [ b pool ] [ g group ] [ w browse time ] [ y retention time ] [ t start time ] [ e end time ] [ i on off ] [ f dirle ] { C -I input_le client:save set }

nsrconsolidate [ v ] [ n ] [ q ] [ V ] [ J source storage node ] [ d destination storage node ] [ b pool ] [ g group ] [ w browse time ] [ y retention time ] [ t start time ] [ e end time ] [ i on off ] [ f dirle ] [ R ] { S -I input_le ssid[/cloneid] ... }

DESCRIPTION The nsrconsolidate program creates a synthetic full backup from a previously created full backup and subsequent incremental backups. This new backup is equivalent to a full backup taken at the time of the latest incremental backup that was used in con- structing the synthetic full save set. Since it is built from existing backups, a synthetic full backup does not burden the original client with the overhead of another tradi- tional full backup.

Normally, nsrconsolidate is invoked within savegrp(1m) as part of a incr_synth_full level backup. See savegrp(1m) for more information. nsrconsolidate can be invoked manually to run a synthetic full backup when required, or to rehydrate individual Avamar deduplication save sets.

For consistency, nsrconsolidate checks the source save set instances to ensure that the specied client:save set-name can be used to create a synthetic full. The following requirements apply to each non-full save set to be used for the synthetic full save set:

1) The save set must be browsable and complete. Any checkpoint-restarted save sets must contain all parts to form a completed save.

2) The save set must contain the save set extended attribute anchor save set time. Note that this attribute only appears in the save set record for NetWorker 8.0 and later clients. Full save sets are not anchored to another save set, so a pre-8.0 full save set might be usable with 8.0 or later non-full save sets for nsrconsolidate.

3) The save set must have the client attribute Backup renamed directory enabled.

4) The save sets must form a complete chain of save sets that are linked through their anchor save set time attribute to a full backup.

When these criteria are met, a restore list (rlist) is built from the index entries for each client:save set-name. The NetWorker server is contacted to obtain information such as which storage node shall write the synthetic full save set. The nsrrecopy(1m) backend program is then spawned using the NetWorker jobs monitoring APIs (nsrjobd(1m)) for each client:save set-name on the target storage node. The XDR encoded rlist is sent to the backend to perform the synthetic full or rehydration operation using the recover piped to save model. Status updates from the backend are returned via nsrjobd.

NetWorker 19.1.1 196

Maintenance Commands nsrconsolidate ( 1m )

nsrconsolidate requires the source save sets to be specied using one of the following options:

-c and -N -C -S

To identify a synthetic full save set, two additional extended save set attributes are created in the save set record:

source save set times Synthetic full

For any Avamar deduplication save sets that are participating in a synthetic full opera- tion, the data will be rehydrated automatically during the recover part of the synthetic full operation for saving to the target volume.

Individual Avamar deduplication save sets can be rehydrated with option -R -S . The new rehydrated save set will retain the same backup level, and anchor save set time and backup start time extended attributes as the original deduplication save set. To identify a rehydrated save set, two additional extended attributes are created in the save set record:

Rehydrated source save set times.

All of the deduplication save sets that are participating in a synthetic full operation must be backed up to the same Avamar deduplication node. In order to create a synthetic full from save sets that were backed up to more than one Avamar deduplication node, the save sets from the second and third (etc) Avamar node must be rehydrated by using the -R -S options rst, then followed by a synthetic full operation (with the -c & -N, or -C, or -S option).

In NetWorker 8.1 or later, when a scheduled backup is started at incr_synth_full level with Perform virtual synthetic full attribute enabled in the NSR group resource, Data Domain virtual synthetic full backup mode will be performed if all of the following requirements have been met. If any of the requirements are not met, a non-virtual synthetic full backup will be performed. See savegrp(1m), nsr_schedule(5), nsr_group(5) for more information on scheduled backup, level, and group resource.

1) Source save sets participating in a synthetic full level have been backed up to Data Domain devices.

2) Storage nodes for source save sets and the target of a synthetic full level backup are at NetWorker 8.1 or later releases.

3) Source save sets and the target of a synthetic full level backup must be on the same Data Domain host.

4) There are no Avamar deduplication save sets participating in the synthetic full level backup.

5) There are no directives specied for the synthetic full level backup.

Similarly, when nsrconsolidate is invoked manually in NetWorker 8.1 or later releases, virtual synthetic full backup will be the default mode if all of the above requirements have been met.

Virtual synthetic full backups are supported on Data Domain systems with the DD Boost option "virtual-synthetics" enabled (refer to "ddboost option" command on Data Domain host for more information). Otherwise, the synthetic full operation will fail.

OPTIONS b pool name Species the destination media pool to store the new synthetic full or rehy- drated save set. For more information, see nsr_pool(5).

NetWorker 19.1.1 197

Maintenance Commands nsrconsolidate ( 1m )

c client Species the name of the client whose save set is to be included for the syn- thetic full operation. This option must be specied with -N. Only one client can be specied.

C client:save set-name Species a list of clients and save sets (in format) for the synthetic full operation. The list can be supplied on the command line or through the -I input_le.

d destination storage node Species the destination storage node where the backend program, nsrrecopy(1m) is intended to run. By default, the NetWorker server deter- mines the destination storage node based on the storage node afnity list of the client. See nsr_storage_node(5) and nsr_client(5) for more information.

e end time Species the end time (in nsr_getdate(3) format) to select save sets for the syn- thetic full operation. This option can only be used with the -S, -c & -N, and -C options. If not specied, end time is set as the current time. Note that -e 0 is same as -e today.

f dirle Instructs nsrconsolidate to read the directives (see nsr_directive(5)) from "dirle" and apply them to the les in the synthetic full save sets or les rehy- drated from the Avamar deduplication save sets. For synthetic full operation, may contain both UNIX and Windows save set paths, which will be used as a global directive during one invocation of nsrconsolidate. Directives are applied to the recovered stream during the save operation of recover piped to save.

The only supported directives are aes (for encryption) and compressasm. See uasm(1m) for more information.

When rehydrating, directives should only be used when writing to a non-Data Domain device or volume. This can be accomplished by specifying the -b option with a pool containing non-Data Domain volumes. See nsr_pool(5) for more information.

To apply the aes directive to the root path, follow this example of a directive le:

<</>> +aes:

To apply directives to specic subtrees, follow this example of a directive le:

<<"H :\T ech Docs\im p or t a n t">> +compressasm: <</en gin eer in g/d ocs>> +aes:

g group name This option is used by savegrp to specify the group name of the synthetic full. This is similar to the save command, and is used by the NetWorker server to select the specic media pool.

i on off

NetWorker 19.1.1 198

Maintenance Commands nsrconsolidate ( 1m )

This option species whether on-line le index entries will be generated for the new synthetic full or Avamar rehydrated save set. Specify "on" to generate on-line le index, "off" to suppress index generation. There is a corresponding option "store index entries" in the NSR pool resource, see nsr_pool(5) for more information.

If the -i option is not specied when rehydrating Avamar save sets with the -R and -S options, the default is to suppress index generation. When performing a synthetic full operation (that is, without the -R option), the default is to gen- erate index entries when the -i option is omitted.

recover -S or scanner can be used to recover from any save set without indexes. See recover(1m) and scanner(1m) for more details.

I input_le Species the input lename that is used by nsrconsolidate program to read the "client:save set-name" pairs or save set identiers (ssid) for the synthetic full or rehydration operation. Each entry must be separated by a newline. This option is supported with -C or -S, but cannot be specied with -c & -N.

J source storage node Species which host to use as the storage node for the recovery part of the synthetic full operation (see nsr_storage_node(5)). The host specied must be included in "recover storage nodes" or "storage nodes" attribute of servers client resource. See nsr_client(5) for more information. By default, the Net- Worker server determines the recover storage node.

m backup mode Species the backup mode, say le system or block based backup. If the save set was backed using block based then specify this option as bbb. By default the backup mode is le system.

n Do not execute. This option causes nsrconsolidate to verify that the save set criteria are met, send a request to the server, and build the rlist without spawning the backend program which would perform the actual synthetic full or rehydration operation.

N save set-name Species the name of the save set that is used for the synthetic full operation. This option must be specied with the -c option. Only one client and save set-name can be specied. Use the -C option to specify multiple clients and/or save sets.

q Runs quietly.

R Rehydrates one or more Avamar deduplication save sets. This option requires the -S option to specify the save set ssids to be rehydrated.

See the -i option for the default behavior of index generation.

S ssid Species a list of full and incremental save sets for synthetic full in ssid[/cloneid] format. The list can be supplied on the command line or by the -I input_le option. When specied with the -R option, the Avamar deduplica- tion save sets will be rehydrated. Any Avamar deduplication save set can be rehydrated individually, regardless of its backup level.

You can nd the ssid of a save set by using the mminfo -v command (see mminfo(1m)). If there are multiple copies (clones) of a save set, you can choose which specic copy to read by using the ssid/cloneid format. In this

NetWorker 19.1.1 199

Maintenance Commands nsrconsolidate ( 1m )

case, the ssid and cloneid are separated by a single slash (/). You can nd the cloneid for a particular copy by using the mminfo -S report, or a custom report.

t start time Specify the start time (in nsr_getdate(3) format) to exclude save sets that are older than this date from the synthetic full operation. This option can only be used with the -S, -c & -N, or -C options. If not specied, start time is set as end time - 24 hours. Note that -t 0 is same as -t today. When specifying a time range, at least -t or -e option must be specied.

v Enable verbose operation. In this mode, additional messages are displayed about the operation. This option will be passed to the backend program to enable its verbosity.

w browse time Sets the date (in nsr_getdate(3) format) after which the new synthetic full 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. This option allows overriding the existing policies.

y retention time Sets the date (in nsr_getdate(3) format) when the new synthetic full save set will become recyclable. The special value forever is used to indicate that a volume that never expires (i.e. an archive volume) must be used. By default, the server determines this date for the save set based on the retention policies in effect. This option allows overriding the existing policies. See also nsrmm(1m) and its -S & -e options.

V Causes nsrconsolidate to verify the save set after a successful synthetic full operation. This option is ignored when rehydrating Avamar save set with the -R and -S options.

EXAMPLES To create a synthetic full for save set /dev/daily on client mars: nsrconsolidate c mars N /dev/daily

To create synthetic full for save set E:\ enabled for block based backup on client jupiter:

nsrconsolidate -m bbb c jupiter N E:\

To create synthetic fulls for save set /jupiter_les on client jupiter, and save set /saturn_les on client saturn:

nsrconsolidate C jupiter:/jupiter_les saturn:/saturn_les

To rehydrate all Avamar deduplication save sets for client mars and create the new save sets in pool rehydrate_pool:

nsrconsolidate b rehydrate_pool R S mminfo c mars q dedupe r ssid

SEE ALSO nsr_getdate(3), nsr_client(5), nsr_device(5), nsr_protection_group(5), nsr_pool(5), nsr_directive(5), nsr_storage_node(5), mminfo(1m), nsr(1m), nsrd(1m), nsrmmd(1m), nsrjobd(1m), nsrrecopy(1m), recover(1m), savegrp(1m), nsrworkow(1m), scanner(1m)

DIAGNOSTICS The exit status is zero if a synthetic full operation is successful for all of the requested save sets, non-zero otherwise.

NetWorker 19.1.1 200

Maintenance Commands nsrconsolidate ( 1m )

Several messages are printed which signal that nsrd(1m) is unavailable for a synthetic full operation. The following messages might also display:

Cannot contact media database The media database and other NetWorker services on the named server are not answering queries. The server might need to be started, or if it was just started, it might need to nish its startup checks before answering queries.

cannot open nsrconsolidate session with server This message is printed when the server does not accept synthetic full sessions.

You are not authorized to run this command Only users with superuser priviledges (e.g., user root on Unix systems) are allowed to run the nsrconsolidate command.

ssid[/cloneid] number is not valid The given save set identier is not valid. Two forms are understood: simple save set identiers and those with a cloneid specied. Simple save sets are unsigned numbers. The save set with the cloneid form is specied as two unsigned numbers separated by a single slash (/).

waiting 30 seconds then retrying A temporary error occurred and nsrconsolidate will automatically retry the request until the condition is cleared. For example, an error will occur if all devices are busy saving or recovering and nsrconsolidate must wait for these devices to become available.

Save set <ssid> (<client>:<save set>) invalid for this operation The listed save set does not meet the criteria for nsrconsolidate. Information describing the specic criteria failure will be appended to the message.

NetWorker 19.1.1 201

Maintenance Commands nsrcpd ( 1m )

NAME nsrcpd daemon providing remote client software installation services

SYNOPSIS nsrcpd [ D debug-level ]

DESCRIPTION The nsrcpd daemon provides an RPC-based remote client software installation service. This service allows users to distribute and upgrade client software from a centralized software repository across a network. In addition, users can manage the centralized software repository and inventory existing NetWorker clients for currently installed software. The RPC program number provided by nsrcpd is 390437.

Normally, nsrcpd is invoked by nsrd upon receiving a request to start up the remote client software installation service and does not need to be started directly by a user.

The main thread for nsrcpd handles all RPC messages for the service. Each time a remote client installation operation begins, nsrcpd creates a new session and spawns a new thread to process that operation. The operation thread receives all data for the session from the main RPC thread and handles any user dialogs and processing for the operation. The operation thread automatically exits when a session completes. Nsrcpd automatically terminates after it has been idle for a pre-determined period.

Nsrcpd maintains a set of resources reecting the current set of software products located in the centralized software repository, as well as the current set of products and packages installed on NetWorker clients in the datazone where it is running. These resources are managed during repository, inventory, and upgrade operations.

When nsrcpd is started with the D <debug level> option, it runs with the requested debug level.

OPTIONS D debug-level Instructs nsrcpd to start up in debug mode with the requested debug level.

FILES /nsr/logs/nsrcpd.raw The le to which nsrcpd sends information about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

/nsr/res/cpdb Information describing the remote client installation service and its resources.

SEE ALSO nsr(1m), nsrpush(1m), nsr_render_log(1m)

NetWorker 19.1.1 202

Maintenance Commands nsrd ( 1m )

NAME nsrd daemon providing the NetWorker service

SYNOPSIS nsrd

ansrd [ commentary ]

DESCRIPTION The nsrd daemon provides an RPC-based save and recover service. This service allows users to save, query for, and recover their les across a network. The RPC program number provided by nsrd is 390103.

Normally nsrd is invoked from a startup shell script (for example rc.local , rc.boot) at boot-time, and should never need to be started directly by a user. After it is started, nsrd starts up the other daemons it needs to provide the NetWorker service. Starting with NetWorker version 9.0, nsrctld starts NetWorker services and nsrd is spawned by nsrctld.

The nsrd command must be run on a machine with appropriate resources. Required resources include both devices, such as tape drives, and sufcient disk space for the index daemons, (see nsrindexd(1m) and nsrmmdbd(1m)). The devices are controlled by multiplexor software (see nsrmmd(1m)), and the disk space is used to maintain the index of saved user les and volumes with corresponding les.

Each time a backup, recover, or another session begins, nsrd starts the program, ansrd, to process the requested session. The ansrd program is called an agent . The agent is in charge of monitoring that backup, recover, or another session, and automatically exits when a session completes. Using ps(1) or another process monitoring tool, you can inspect the subsequent parameters of ansrd to see what kind of session it is moni- toring. If necessary, agents can be forcibly terminated to abort a backup or recover session. Agents cannot be run directly; they can only be started by nsrd.

FILES /nsr/logs/daemon.raw The le to which nsrd and other NetWorker daemons send information about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

/nsr/res/nsrdb Information describing the NetWorker service and its resources (See nsr_service(5)).

SEE ALSO nsr(1m), nsr_service(5), nsr_render_log(1m), nsrmmd(1m), nsrmmdbd(1m), nsrindexd(1m), ps(1), rc(1m)

NetWorker 19.1.1 203

Misc. Reference Manual Pages nsrdbsave8 ( Jul 20, 19 )

NAME nsrdbsave action binary to perform client le index backup and NetWorker server databases backup

SYNOPSIS nsrdbsave [ l backup_level ]

DESCRIPTION The nsrdbsave is an action binary to perform client le index backup and NetWorker server databases backup. This binary gets executed when server backup type action gets run. nsrdbsave command does the following:

o Perform client le index backup of NetWorker clients. List of Networker clients are assigned through the Protection group.

o Perform backup of Networker server databases RAP DB, Media DB and Authentica- tion DB. These backups are required for disaster recovery of Networker.

OPTIONS l backup_level It indicates the backup level for client le index backup. Networker server database backup will always be taken at level full.

SEE ALSO nsrdr(1m), nsrworkow(1m)

NetWorker 19.1.1 204

Maintenance Commands nsrdiscover ( 1m )

NAME nsrdiscover discover and provide the most recent validated checkpoint path for the specied VBA nodes

SYNOPSIS nsrdiscover -p policyname [ -a actionname ] [ -s networker_server_name ] [ -j parent_jobid ] [ -D debug_level ]

DESCRIPTION nsrdiscover starts the discover operation on each VMware backup appliance (VBA) associated with a data protection policy and constructs the most recent validated checkpoint path upon completion.

nsrdiscover places most of its output on standard error. When a discover operation is completed the most recent validated VBA checkpoint path is written to standard out. vba_hostname:vba_size:cp_tag:backup_paths are written to standard out for each of the VBAs associated with the data protection policy.

OPTIONS -p policyname The name of the data protection policy resource containing the list of VBAs that will be used to perform the backups.

-a actionname The name of an action resource.

-s networker_server_name The name of the networker server used to assist in discovering the VBA check- points. If this option is omitted the default networker server is discovered and used.

-j jobid nsrdiscover operates within the Networker job hierarchy managed with nsrjobd. This ag species the id of nsrdiscovers parent job.

-D debug_level A number from 0 to 9 species the amount of debug tracing information to display to standard error. A higher value displays more information.

FILES /nsr/logs/policy/POLICYNAME The directory where logs for the VBA checkpoint discover operation will be placed.

/nsr/res/nsrdb The resource database that contains the NetWorker service and its resources (See nsr_service(5)).

SEE ALSO nsrpolicy(1m), nsrvba_cpsave(1m)

NetWorker 19.1.1 205

Maintenance Commands nsrdr ( 1m )

NAME nsrdr NetWorker server disaster recovery tool

SYNOPSIS nsrdr [ q v ] [ a ] [ K ] [ A ] [ B bootstrap_id ] [ d device_name ] [ t date ] [ N n ] [ c ] [ I { client_name ... f client_list_input_le } ]

DESCRIPTION nsrdr is a command line interface (CLI)-based tool that automates most of the manual steps in a traditional NetWorker server disaster recovery process. Users can use nsrdr in both interactive and non-interactive mode.

Use the nsrdr command to recover from the loss of the critical les on a NetWorker server. The NetWorker server requires these les to perform any operation. Typical events that cause the loss of the critical les on a NetWorker server include the accidental removal of these les by a user or a disk crash on the NetWorker server. The SolVe Desktop, found on the EMC Online Support web site, provides you with procedures that describe how to perform a disaster recovery of a NetWorker client, storage node, and server.

When you recover from a NetWorker bootstrap backup, you can recover the client le indexes (CFIs) separately from the media database, the server resource les, and the NetWorker Authentication Service database. By default, nsrdr recovers all of the CFIs. To recover only certain CFIs, you can use the I command line option to specify a list of clients or use the f option to specify an input le. The nsrdr tool can run multiple nsrck operations, which enable parallel CFI recovery operations.

When you recover a NetWorker media database, the nsrdr tool will set the scan needed ag on volumes on le type and advanced le type devices that exist in the recovered media database.

Note: This command overwrites the existing metadata on the NetWorker server.

IMPORTANT! Before you use this command, ensure that you fully install and correctly congure the NetWorker software on the host. If the host is missing any NetWorker binaries, re-install the NetWorker software from the distribution les before you run nsrdr. Ensure that you use the same release of the NetWorker software, and install NetWorker in the original location.

When you start nsrdr in interactive mode, nsrdr may ask for the following informa- tion:

1. The tool will prompt you for the name of the device that contains the bootstrap save set.

2. The tool will prompt you for the bootstrap save set identier (ssid). You can nd this number in the fourth column (labeled ssid ) of the bootstrap information that the mminfo B command displays.

3. The tool will prompt you to provide the starting le and record locations of the bootstrap save set, which applies when you use a tape type device to recover the bootstrap. You can nd the starting le and record locations in the fth and sixth columns of mminfo B output. When you do not know the starting le and record number, use the default value 0.

Note: specifying the correct le and record numbers will allow NetWorker to more quickly locate the bootstrap save set on the tape.

The following is an example of the output of the mminfo B command:

Jun 17 22:21 2012 marss NetWorker bootstrap information Page 1

date time level ssid le record volume 6/14/12 23:46:13 full 17826163 48 0 mars.1

NetWorker 19.1.1 206

Maintenance Commands nsrdr ( 1m )

6/15/12 22:45:15 9 17836325 87 0 mars.2 6/16/12 22:50:34 9 17846505 134 0 mars.2 mars.3 6/17/12 22:20:25 9 17851237 52 0 mars.3

In this example, the ssid of the most recent bootstrap save set is 17851237.

- The values for the starting le number is 52 and the starting record location is 0.

- The volume that contains the bootstrap save set is mars.3.

The tool will prompt you to mount the volume that contains the selected bootstrap ssid into the specied device.

Note: If the bootstrap save set spans more than one volume, the mminfo B output displays multiple volume names for the save set. The order that the output displays is the order required by nsrdr. In the example above, the third save set produced on 6/16/12 begins on volume mars.2 and spans to volume mars.3.

4. If a bootstrap save set spans volumes, nsrdr will prompt you for the name of the device that contains the next volume when the recovery operation reaches the end of the current volume.

5. The recovery process will prompt you to keep the original resource les in the /nsr/res folder or replace the resource les with the recovered resource les. If the resource conguration les were lost, select yes. nsrdr will automatically restore the les to the original location on the NetWorker server.

6. nsrdr prompts you to recover the CFIs after the recovery operation restarts the Net- Worker services. To recover the CFIs, select yes.

Note: To perform a CFI recovery for selected clients, use the nsrdr command with the I option and then provide a space-separated list of client hostnames. To use an input le, use nsrdr with the f option.

When nsrdr completes the CFI recovery operation, a message similar to the following appears:

"completed recovery of index for client client_name"

After nsrdr recovers the index for a NetWorker client, you can use the recover com- mand to recover les for the client.

Note: You can restore the indexes in any order; you do not have to recover the index for the NetWorker server before you recover the index for a NetWorker client.

After nsrdr restores the bootstrap save set, the recovery operation replaces all of the data in the media database. If any backup or clone processes wrote data to any of the volumes after the creation time of the bootstrap save set, the recovered media database will not contain information about the save sets. For tape volumes, the NetWorker server will have incorrect tape position information. NetWorker will use the incorrect tape position to write new data to the volume, and will overwrite existing data. For a le type or an advanced le type device, the recover space operation, which the Net- Worker server runs automatically, will delete all of the save sets on the device that were created after the creation time of the recovered bootstrap save set.

Consider the following situation: you need to perform a disaster recovery of the Net- Worker metadata today and the latest available bootstrap save set is one day old. After nsrdr uses the bootstrap save set to recover the metadata, the media database will contain volumes and save set records as of yesterday. Any save sets that a backup or clone operation creates after the creation time of the bootstrap save set do not exist in the media database, but they do exist on the physical medium. NetWorker will use the old media position information from the volume records in the media

NetWorker 19.1.1 207

Maintenance Commands nsrdr ( 1m )

database, and a backup or clone operation will overwrite the data on the volume for save set records that are missing from the media database.

nsrdr will automatically mark all non-read only volumes on le type and advanced le type devices with the scan needed ag. This volume ag instructs nsrmmd to nd the real end of the volume and will prevent data loss. To recover data from save sets that were created after the bootstrap creation time, the NetWorker administrator must scan the volume information into the media database. For le type or advanced le type devices, the NetWorker server suspends the recover space operation until you scan the device, then remove the scan needed ag.

If you recovered the NetWorker server bootstrap to a different host, for example, after a major hardware failure, the NetWorker Licensing software detects the move and you must contact Licensing within 15 days of the move to perform a host transfer afdavit. You will then receive new authorization codes for each NetWorker license, based on the hostid of the new machine. If you do not add the new codes to the NetWorker server within 15 days of the server move, the NetWorker server becomes disabled and you can only perform recoveries. You cannot perform new backups until you re- register the server with the new authorization codes. The NetWorker server will gen- erate notications, which warn you that you need to re-register the product. The SolVe Desktop application provides detailed information about performing a disaster recovery to a different host.

OPTIONS A Use this option to instruct the recovery process to keep the original NetWorker Authentication Service database le and do not replace it with the recovered le. When you specify this option, the recovery process does not prompt you to keep or replace the existing NetWorker Authentication Service database le.

a Use this option to run nsrdr in non-interactive mode. This options requires the B and d options.

B bootstrap_id Use this option to specify the bootstrap SSID that nsrdr will use to perform the disaster recovery. When you specify this option, the recovery process does not prompt you to specify the bootstrap ssid.

c Use this option to instruct the recovery process to only perform index recoveries.

d device_name Use this option to specify the name of the device that contains the volume with the bootstrap backup you want to recover. When you specify this option, the recovery process does not prompt you to specify the device that contains the bootstrap backup.

F Use this option to set the scan needed ag on volumes on le and advanced le type devices only. When specied, the scan needed ag will not be set on volumes that are on tape media. (This is the default behavior; this option is for backward compatibility with previous Networker versions.)

I client_name ... Use this option to perform a CFI recovery for the specied clients, after a bootstrap recovery. Specify a list of client host names, separated by a space after the I option. To specify a list of clients in an input le instead of a space-separated list after the I option, use the I option with the f option. You can only specify a space-separated client list after I.

I f client_list_input_le

NetWorker 19.1.1 208

Maintenance Commands nsrdr ( 1m )

Use these options to specify the name of the le that contains a list of clients for which to recover indexes. Ensure that you specify each client name in the le on a separate line.

K Use this option to instruct the recovery process to keep the original /nsr/res folder and to not replace the resource les with the recovered les. When you specify this option, the recovery process does not prompt you to keep or replace the existing resource les.

N Use this option to set the scan needed ag on all of the volumes, including those on tape media. By default, after nsrdr recovers the media database, the tool will mark all volumes on le type and advanced le type devices in the media database read-only and scan needed to indicate that you must scan the save set information back into the media database before you can use the volume. The N option adds the scan needed ag on volumes on tape dev- ices as well.

n Use this option to prevent the default scan needed ag from being set on volumes on le type and advanced le type devices. (WARNING: use this option with caution).

q Quiet mode. Use this option to displays only error messages during the recovery process.

t date Use this option to recover the index backup from the specied date.

v Verbose mode. Use this option to generate debugging information.

FILES /nsr If this was a symbolic link when the bootstrap save set was created, you must recreate the symbolic link before you run the nsrdr command.

/nsr/res The directory and its contents are saved as part of the bootstrap. When the recovery process recovers this directory and the contents, it temporarily renames the original directory to /nsr/res.timestamp.

/nsr/mm/mmvolume6 Directory containing the media database in legacy format. This contains the active media database prior to migration or after an unsuccessful migration.

/nsr/mm/mmvolrel Directory containing the media database in relational format. This contains the active media database after migration or a new installation.

/nsr/debug/nsrdr.conf An optional conguration le for the nsrdr tool. You can specify parameters in this le to control the nsrdr conguration settings.

SUPPORTED PATAMETERS

NSRDR_NUM_THREADS=number_of_threads This parameter denes the number of threads that the recovery process can start to perform parallel CFI recoveries.

NSRDR_SERVICES_PATH=service_path For the UNIX platforms, nsrdr uses the default service start path when the recovery process performs an internal service restart. If the service path is not the default path, use this parameter to specify the service path.

/nsr/logs/nsrdr.log The log le that nsrdr uses to send detailed information about the internal operations that nsrdr performs during the recovery process. The recovery pro- cess overwrites this le each time you run the nsrdr tool.

NetWorker 19.1.1 209

Maintenance Commands nsrdr ( 1m )

DIAGNOSTICS Failed to set scan ag for the volume volume_name This error message indicates that the scan needed ag was not set for the specied volume. A more detailed error message that states the cause of the failure follows this message.

SEE ALSO mminfo(1m), nsr_crash(1m), nsr(1m), nsrck(1m), nsrd(1m), nsr_client(5), nsr_schedule(5), nsr_shutdown(1m), recover(1m), save(1m), savefs(1m), scanner(1m), nsrindexasm(1m), nsrmm(1m), nsrmmdbdasm(1m), nsrwatch(1m), nsr_getdate(3)

NetWorker 19.1.1 210

Maintenance Commands nsrexec ( 1m )

NAME nsrexec remotely execute NetWorker commands on NetWorker clients

SYNOPSIS nsrexec

DESCRIPTION The nsrexec command is run only by other NetWorker commands. It is used to remotely execute commands on NetWorker clients running nsrexecd, and also to moni- tor the progress of those commands.

SEE ALSO nsr(5), nsr(1m), nsrexecd(1m), savegrp(1m), nsrworkow(1m)

NetWorker 19.1.1 211

Maintenance Commands nsrexecd ( 1m )

NAME nsrexecd NetWorker client execution service

SYNOPSIS nsrexecd [ s server [ s server ... ]] [ f serverle ] [ p savepath ] [ i ] [ r ]

DESCRIPTION nsrexecd is used by NetWorker servers to perform automatic operations on NetWorker clients. It is currently used by savegrp(1m) to start saves and storage node functions on NetWorker client machines. The savegrp is spawned by nsrworkow. When storage node functions are in use, nsrexecd starts nsrmmd(1m) daemons and nsrjb(1m) commands on the host, and responds to polling requests from the server. See nsr_storage_node(5) for additional detail on storage nodes. The nsrexecd service is normally started at boot time on each NetWorker client machine. Since NetWorker servers are usually expected to be clients of themselves, nsrexecd runs on all Net- Worker servers as well.

The nsrexecd service exports an RPC-based service to remotely execute NetWorker operations. All requests must be authenticated, and can optionally be restricted to specic NetWorker servers. Only save requests (for example, save(1m) or savefs(1m)) and storage node requests are allowed.

When command execution is requested, nsrexecd rst veries that the request is authenticated, and that it comes from a valid NetWorker server; the NetWorker server running on the localhost is always considered valid, independent from the options supplied to nsrexecd. Next, nsrexecd veries that the command is a save command (for example, save(1m) ). It then executes the specied command from the NetWorker binary directory. This directory is normally determined by the location of the nsrex- ecd executable, but can be specied on the command line.

OPTIONS i As part of the NetWorker server authentication, the servers network address is mapped to a name. The name is then reverse-mapped to a network address. The server is authenticated if and only if the original network address matches the reverse-mapped address. The i ag skips the address comparison thereby allowing workarounds to miscongured or misfeatured naming systems. This option should be used with care since it may allow the NetWorker client to send its data to an unauthorized machine.

f serverle Species a le containing a list of NetWorker servers which can initiate saves. This le should list one server name per line. If no f or s options are specied, nsrexecd looks for a default le in this same format. The location of this default le is listed in the FILES section of this man page.

p savepath Tells nsrexecd to look for save commands in the savepath directory, rather than the default (the directory in which nsrexecd exists).

s server Allows save requests to be initiated only by the given NetWorker server. Mul- tiple s options may be given to allow access by several NetWorker servers. If a NetWorker server has multiple network interfaces, it is often best to list the hostname corresponding to each network interface, to avoid failed saves.

r This option should be used with EMC Snapshot Management only. This option starts another instance of nsrexecd for Snapshot Management administration purposes.

NetWorker 19.1.1 212

Maintenance Commands nsrexecd ( 1m )

FILES /nsr/res/nsrladb The resource directory with attributes describing the NetWorker nsrexecd service and its resources (see nsrla(5)).

/nsr/res/servers The le containing the default list of servers that can back up the NetWorker client.

SEE ALSO nsrla(5), nsr_storage_node(5), nsrports(1m), save(1m), savefs(1m), savegrp(1m), nsrworkow(1m)

NetWorker 19.1.1 213

Maintenance Commands nsrim ( 1m )

NAME nsrim NetWorker index management program

SYNOPSIS nsrim [ c client ] [ N saveset ] [ V volume ] [ lnqvKMXC ]

nsrim S X h avamar_node_name [ t time ] [ f ]

DESCRIPTION The nsrim program is used to manage the NetWorker online le and media indexes. It can also be used to manage the save set lists and policy denitions stored on an Avamar node when the S ag is supplied.

Normally, nsrim is run by "Server Protection"/"Server Backup" workow ("Expiration" action). The expiration action expires save sets in the media database based on reten- tion time of the save set. When the retention time of the save set has been reached, NetWorker uses the nsrim process to expire the save set. When a save set expires, the nsrim process performs the following actions:

1) Removes information about the save set from the client le index.

2) If the save set data resides on an AFTD/DD, removes the save set information from the media database and removes the save set data from the AFTD/DD.

3) If the save set data resides on a tape device, the nsrim process marks the save set as recyclable in the media database. When all save sets on a tape volume have expired, the volume is eligible for reuse.

An expiration action is created automatically in the Server maintenance workow of the "Server Protection" policy. An expiration action only supports Execute and Skip schedule activities.

Entries that have been in an online le index longer than the period specied by the respective clients browse policy are removed. Save sets that have existed longer than the period specied by a clients retention policy are marked as recyclable in the media index. When all of the save sets on a volume have been marked recyclable, then the volume is considered recyclable. Recyclable volumes may be selected by NetWorker (and automatically relabeled by a jukebox) when a writable volume is needed to hold new backups. When a recyclable volume is reused, the old data is erased and is no longer recoverable. Space for recyclable and aborted save sets of a disk family volume (see nsr_device(5)) is removed from the volume (on disk), and the save set entries are deleted from the media index. The data in these save sets will no longer be recover- able.

Unless the q option is used, nsrim prints header and trailer information for each group of save sets. The header lists the save set type, the client name, the save set name, and the applicable browse and retention policies that apply to the save set. (See the example in this man page). There are four types of save sets:

Normal All save sets backed up automatically, that are associated with a schedule, retention policy or protection group.

Ad hocs User-initiated save sets are designated by appending ad hocs to the header line.

Archives Save sets that never expire automatically are designated by appending archives to the save set line.

Migrations Save sets that never expire automatically, and were created by a le migration application, are designated by appending migrations to the save set line.

NetWorker 19.1.1 214

Maintenance Commands nsrim ( 1m )

The trailer lists four utilization statistics of the save set after nsrim has applied the pol- icies to it. The four statistics are the total number of browsable les remaining in the online index, the total of les currently associated with the save set, and the amount of recoverable data out of the total of data associated with the save set. For example, nsrim may print the following output for one save set name:

mars:/usr, retention policy: Year, browse policy: Month, ad hocs 8481 browsable les of 16481 total, 89 MB recoverable of 179 MB total

mars:/usr, retention policy: Year, browse policy: Month, ad hocs 0 browsable les of 13896 total, 163 MB recoverable of 163 MB total

mars:/usr, retention policy: Year, browse policy: Month 43835 browsable les of 427566 total, 6946 MB recoverable of 7114 MB total

When the v option is used, the following information is also printed for each save set: the save set id, creation date, level, le count, size, and status. A save sets status is one of the fol- lowing:

browse The le entries for the save set are browsable (the save set les still exist in the online index). These les are easily restored using the NetWorker recover mechanisms.

recover The age of the save set does not exceed the retention policy for the save set, but its entries have been purged from the NetWorker online index. This means that save set can be recovered from the backup media by using recover. (See r ecover(1m).) scanner(1m) may also be used to recover the save set, but users should try recover rst.

recycle The save set is older than its associated retention policy and may be overwrit- ten (deleted) once its backup media is recycled. Until the media is recycled, the save set is also recoverable from the backup media. Recyclable save sets of disk family (see n sr_d evice(5)) volumes will be removed from the volumes and the media database, the data in these save sets will no longer be recoverable.

delete The save set will be deleted from the media database. nsrim deletes only recyclable save sets that have zero les.

The save set status may be followed by any of the following modiers:

(archive) The save set never expires, and is exempt from any status change.

(migration) The save set was created by a le migration application and never expires, and is exempt from any status change.

(scanned in) The save set was restored using the scanner command, and is exempt from any status change.

(aborted) A save set of questionable size, consuming backup media space.

If nsrim changes the status of a save set, then it prints the transition symbol > fol- lowed by the new status. For example:

17221062 3/05/92 f 23115 les 158 MB recycle 17212499 3/19/92 f 625 les 26 MB recover(aborted)->recycle 17224025 5/23/92 i 0 les 0 KB recover->recycle->delete

NetWorker 19.1.1 215

Maintenance Commands nsrim ( 1m )

17226063 6/05/92 f 3115 les 58 MB recover 17226963 6/09/92 f 3197 les 114 MB browse->recover 17227141 6/10/92 f 3197 les 115 MB browse

Once nsrim has processed all of the save sets, it ags the le index for cross-checking in nsrindexd(1m). If the l ag is specied, the cross-check is attempted synchro- nously, otherwise, it is simply scheduled and nsrindexd performs the cross-check when the index is idle. At the same time, nsrim processes the status of any affected NetWorker volumes. With the absence of the q ag, a line is printed for each volume. The line includes the volume name, the amount of space used, the total number of save sets, and the status. The status will be one of the following:

appendable More save sets may be appended to the volume. The status may also be modied with (currently mounted) which signies that the volume could transi- tion to the recyclable state if it was not mounted for writing.

read-only , full No more save sets can be appended to the volume, nor can the volume be reused since it contains some valuable save sets.

recyclable No more save sets can be appended to the volume, and all save sets on the volume have expired.

In addition, the following modier applies to all three of these states:

(manual-recyclable) The volume will not be automatically eligible for recycling when all of its save sets have expired. Instead, the volume may only be recycled by a manual rela- bel operation. Note that a read-only volume can still be recycled unless the manual-recyclable ag is also set. The manual-recyclable ag can be set using NetWorker Management Console or the nsrmm(1m) and nsrjb(1m) commands when volumes are labeled, or at any time thereafter. This ag is never set automatically.

If the volume status changes, then nsrim appends >recyclable to the status. If the volume contains some browsable save sets, then this is noted; recoverable save sets are also noted. The odd case where an appendable volume has only recyclable save sets is also noted. For example:

jupiter.20: 3474 MB used, 398 save sets, full->recyclable jupiter.21: 4680 MB used, 440 save sets, full, 249 recoverable jupiter.22: 4689 MB used, 351 save sets, full, 351 browsable jupiter.24: 1488 MB used, 141 save sets, appendable, 141 browsable

RETENTION AND BROWSE POLICIES

Under normal circumstances, the association between browse or retention policies and client save sets is obvious. However, since a save set may be listed by more than one client resource with the same name, and each client resource may specify different browse and retention policies, determining the policies applicable to a save set is not always straight forward. nsrim(1m), uses the following steps to select an instance of a client resource with the clients name. Once the client resource is selected, its browse or retention policy is used for managing information about the save set.

1) Locate all the client resources which belong to the same group that the save set belongs to. If no client resource belongs to the save sets group, or if the group no longer exists, or if the saveset is from a backup earlier than version 5 (when

NetWorker 19.1.1 216

Maintenance Commands nsrim ( 1m )

group information was not recorded in the save set), apply the following rules to all the client resources to get the best match.

2) Locate a client resource explicitly listing the save set. If more than one client resource lists the save set, choose the client resource with the longest policy.

3) Search for a client resource listing the save set "All". If more than one client resource lists the save set "All", choose the client resource with the longest policy.

4) Find the client resource listing a save set with the most common prex (longest) of the target save set. If more than one client resource lists the save set with the most common prex, choose the client resource with the longest policy.

5) Among all of the client resources, choose the client resource with the longest pol- icy.

Note that if two or more client resources with the same name exist, it is possible that the browse policy from one instance of the client resource and the retention policy of another instance may be used for managing save set information.

Save sets that have no corresponding NetWorker client resource use the NetWorker client resources of the server to determine the browse or retention policies.

A save set cannot be purged from the index or marked for recycling until all of its dependent save sets are also eligible for purging or recycling. See the NetWorker Administrators Guide for an explanation of dependent save sets.

The last (and only) Full save set will not be purged from the online index until it is also marked for recycling. In this case, the header line of the save set omits the browse policy and prints a message stating that only one browsable cycle exists.

With the exception of the l option, manual ad hoc save sets are treated as full save sets that have no dependents. However, unlike true Full save sets, the last manual save set is not given any special consideration with regard to index purging.

The retention time applied to save sets is rounded up to midnight when the elapsed time implied by the policies is greater than or equal to a day. Therefore, nsrim should produce the same results whether it is run at 8 a.m. or 5 p.m. on the same day.

OPERATION WITH AN AVAMAR

NODE

If nsrim is invoked with the S option it will manage savesets and policy denitions on the Avamar node specied with the h ag. There are 2 types of Avamar nodes, one is known as a VMware Backup Appliance (VBA), and the other is an Avamar server. The node type is determined from its name with RAP lookups. For VBA type nodes, the policy denitions stored on the VBA are kept synchronized with the VMware Protection Policy denitions stored in RAP. For both types of Avamar nodes, the save set lists on the Avamar node and on the NetWorker server are kept in sync. The timeframe of the synchronization is specied with the t ag and the f ags explained in the OPTIONS section.

nsrim is invoked with the S ag by nsrvmwsd when a rollback operation is requested on the VBA, but it can be invoked manually.

OPTIONS c client Only process the online le index for the specied client. Normally, all client indexes are processed. This option may be repeated to process multiple clients.

C Force the compression of media database at the end of the nsrim run. Nor- mally nsrim initiates database compression operation, but nsrmmdbd performs the operation based on the standard compression policy. By specifying this option, nsrmmdbd will ignore the standard policy and perform the compres- sion immediately.

NetWorker 19.1.1 217

Maintenance Commands nsrim ( 1m )

K Mark any cover sets without child save sets as recyclable.

l Removes the oldest full save, and all save sets dependant on it, from the online index. Browse and retention policies are ignored. The save set header infor- mation will print the number of browsable full cycles currently in the online index. Archive and migration save sets are ignored. With this option, manual save sets are treated as normal incremental save sets. This option also sets the utilization threshold to 30 percent.

M Master mode (not advised for manual operation). Advises nsrim that it is being run by nsrd(1m) or another NetWorker daemon, that it should log mes- sages with timestamps, and that it should perform any other behavior expected by nsrd.

N save set Process only save sets named; all others are skipped. This option can be repeated to process multiple save sets.

n Do nothing. Instead, emulate the actions of this command without the index cross-check. Note that trailer statistics reect current (and not emulated) results.

q Run quietly. This option will not generate header, trailer, or save set mes- sages.

V volume Species the name of the volume to be processed. This option can be repeated to process multiple volumes. The c, N and l options are ignored when this option is specied.

v Produce a more detailed report. This may produce a large amount of output. When both v and q are issued, they cancel each other.

X Check the consistency of the data structures of the save set with the data struc- tures of the volume. This is only required after a NetWorker crash.

S If the type of the Avamar node specied with the h ag is VBA then syn- chronize policy denitions on the VBA with the denitions stored in RAP on a NetWorker server. No matter what type the Avamar node is the save set lists on the Avamar node and in NetWorker are synchronized.

h avamar_node_name Supplies the name of the Avamar node nsrim is to operate on.

f When the force ag is specied, savesets that only exist on the Avamar node will be deleted during synchronization. Normally these savesets are not deleted. This ag also forces the entire database to be synchronized if the t option is not supplied.

t time Savesets created on or after this time are to be considered when synchronizing the save set lists of the Avamar node and NetWorker. The time must be in a format nsr_getdate(3) can understand. The time specied is normally a VBA checkpoint time. If the t ag is omitted then the presence or absense of the f ag governs what time to use for the synchronization operation. If f is omitted, then the time of the latest valid VBA checkpoint is used. If f is sup- plied, then a time of zero is used. This causes all savesets related to the VBA to be considered during the synchronization operation.

NOTES The standard policy for media database compression is to perform the compression every 22.5 days. By compressing the media database, the possibility of performance degradation due to fragmentation in the database can be reduced, but nsrmmdbd will

NetWorker 19.1.1 218

Maintenance Commands nsrim ( 1m )

not be available for service for the duration of the database compression. As a result, the -C option should not be used as a default option. The -C option will not used when nsrim is started by nsrworkow.

If customer suspects performance degradation due to fragmentation of media database, nsrim can be run with -C option to reduce the fragmentation. Please select a time at which the Networker server is not busy to perform the database compression.

FILES /nsr/tmp/.nsrim nsrim locks this le to prevent more than one copy of itself from thrashing the media database.

DIAGNOSTICS You are not authorized to run this command Only root may run nsrim to modify the online indexes. However, any user may invoke the command with the n option.

nsrim has nished checking volume <name> This notication message appears in the NetWorker messages window when nsrim completes and the command was invoked with the V option.

nsrim has nished (cross) checking the media db This notication message appears in the NetWorker messages window when nsrim completes and the command was invoked without the V option.

SEE ALSO nsr_getdate(3), nsr_client(5), nsr_layout(5), nsr_policy(5), nsr(1m), nsrd(1m), nsrindexd(1m), nsrmm(1m), recover(1m), nsrworkow(1m), scanner(1m)

NetWorker 19.1.1 219

Maintenance Commands nsrimport ( 1m )

NAME nsrimport Import DDBDA and DDBMA backups to the NetWorker server.

SYNOPSIS nsrimport [ cdhnpr ] [ f script_le ] [ t history_time ]

DESCRIPTION The nsrimport command imports DDBDA and DDBMA backups to the NetWorker server. The DDBDA and DDBMA backups are cloned from their device paths on the Data Domain target to a NetWorker device. After the import completes, the imported backups are indistinguishable from backups that were created by the NetWorker modules for databases and applications. The imported backups can be restored, cloned, staged, and so on. The import operation does not alter or remove the original DDBDA and DDBMA backups on the Data Domain target.

To perform an import operation run the nsrimport command with the f script_le option where, the script_le is the pathname of a script le that contains the nsrimport commands. Records of the import operation are stored in a SQLite database located at nsr/res/importdb/import.db. The records can be printed by using the nsrimport his- tory options c , h , and t.

Some DDBDA and DDBMA backups cannot be imported due to save time collisions. A save time collision occurs when a operation, if it were allowed to complete, would attempt to create multiple backups for the NetWorker client with identical save times. A NetWorker client cannot have more than one backup with a specic save time. The nsrimport command detects potential save time collisions before an import operation is performed. The command requires the user to resolve the collisions before the import. There are two types of save time collisions, external and internal.

An external collision occurs when the client already has a backup with the same save time as a backup being imported. When an external collision occurs, the backup can- not be imported unless the administrator removes the colliding backups from the server. If some of the backups conict but others do not, nsrimport prompts whether to proceed with the import. If the user answers y then all the backups that create a collision will not be imported. All backups that do not create a collision will be imported.

Internal collisions occur when a DDBDA or DDBMA client has two with the same save time. This type of collision can when DDBDA or DDBMA used multiple device paths to backup the same client. Only of the internally colliding backups can be imported. The nsrimport command prompts the user with a list of the colliding backups and asks the user to select the backup to be imported.

OPTIONS c Prints the collision history.

d Renames the SQLite database to import.db.<current>time and creates a new empty import.db database, which is used for subsequent operations.

f script_le The pathname of the nsrimport script le that contains the import commands.

h Prints the import history.

n Performs the import operation without scanning the Data Domain target for DDBDA and DDBMA backups. The operation will only import backups located by previous scans.

p Turns off all prompting. Any backups that cause internal or external collisions will not be imported. If cannot determine the username and password of the Data Domain target it will not prompt the user to enter them. Instead it will

NetWorker 19.1.1 220

Maintenance Commands nsrimport ( 1m )

exit with an error.

r Instructs nsrimport to remove all data from the the SQLite database except for the history entries. This option can be used to reduce the size of the SQLite database if it has grown too large.

t history_time Species how far back in time the import history option h or the collision his- tory option c, will print records. When the t option is specied, only records that were created after the specied time will be printed.

COMMANDS The nsrimport command operations are determined by the commands in the script specied by the f option.

The following example script has the most basic form of an import script:

set nsrdevice jupiter.lss.emc.com_dev1 connect target jupiter.lss.emc.com path /su1/device_path set retention Month add client mars import

set nsrdevice This command species the name of the NetWorker device the backups will be imported to. In the example script above they will be imported to a device called jupiter.lss.emc.com.

connect This command species the Data Domain target and device path that contains the DDBDA and DDBMA backups to be imported. In the example script above they will be imported from the target jupiter.lss.emc.com and device path /su1/device_path.

set retention This command species the NetWorker retention time the backups will be assigned. If the DDBDA and DDBMA backups already have retention times assigned these policies will be maintained. However, the set retention com- mand still must be specied every time an import operation is run.

add client This command species which client on jupiter.lss.emc.com under /su1/device_path will be imported. In the example script above the backups from the client mars will be imported.

import This command starts the import process.

Instead of the import command, the user can specify the check command:

set nsrdevice jupiter.lss.emc.com_dev1 connect target jupiter.lss.emc.com path /su1/device_path set retention Month add client mars check

The check command performs the same steps as the import command except it does not place the backups onto the NetWorker server. The check command allows the users to perform a dry-run of the import and determine if there will be any problems such as save time collisions. If the user performs the import immediately after the check completes they can shorten the time the import will take by using the n option.

NetWorker 19.1.1 221

Maintenance Commands nsrimport ( 1m )

The n option instructs the nsrimport command not to rescan the Data Domain target for backups. The scan operation was already done by the check command.

Multiple clients can be included in an import script:

set nsrdevice jupiter.lss.emc.com_dev1 connect target jupiter.lss.emc.com path /su1/device_path set retention Month add client mars add client venus import

This script imports the backups from the clients mars and venus.

Multiple Data Domain targets and device paths can be included in a single script. The following script imports backups from two different Data Domain targets and three different device paths:

set nsrdevice jupiter.lss.emc.com_dev1 connect target jupiter.lss.emc.com path /su1/device_path1 set retention Month add client mars set nsrdevice jupiter.lss.emc.com_dev1 connect target jupiter.lss.emc.com path /su1/device_path2 set retention Month add client venus set nsrdevice saturn.lss.emc.com_dev1 connect target saturn.lss.emc.com path /su1/device_path3 set retention Month add client mercury import

Note: The order of the commands is important. Each set nsrdevice must be followed by the corresponding connect which must be followed by the corresponding set reten- tion , and add client commands.

The alias command species to use a NetWorker client name for the import that differs from the name used during DDBDA and DDBMA backups. The following script imports DDBDA and DDBMA backups made under the client name mars to the NetWorker client venus:

set nsrdevice jupiter.lss.emc.com_dev1 connect target jupiter.lss.emc.com path /su1/device_path set retention Month alias client mars nsrclient venus add client mars import

The print command displays the clients and backup types on the specied Data Domain targets and device paths. The possible backup types are DB2, mssql, saphana and saporacle. The following script prints the DDBDA and DDBMA clients and backup types for the Data Domain target jupiter.lss.emc.com with the device path /su1/device_path1 and the Data Domain target saturn.lss.emc.com with the device path /su1/device_path3:

set nsrdevice jupiter.lss.emc.com_dev1

NetWorker 19.1.1 222

Maintenance Commands nsrimport ( 1m )

connect target jupiter.lss.emc.com path /su1/device_path1 set nsrdevice saturn.lss.emc.com_dev1 connect target saturn.lss.emc.com path /su1/device_path3 print

NetWorker 19.1.1 223

Maintenance Commands nsrindexasm ( 1m )

NAME nsrindexasm NetWorker module for recovering indexes

SYNOPSIS nsrindexasm [sta nda r d-a sm -a r gum ents]

DESCRIPTION The nsrindexasm is a standard, external ASM (Application Specic Module). It assists in the recovery of NetWorker on-line save record index les that were saved with Net- Worker versions earlier than version 6.

See uasm(1m) for a general description of ASM and the [sta nda r d-a sm -a r gum ents]. It is intended that nsrindexasm be invoked by uasm during nsrck(1m) index recovery opera- tions.

FILES /nsr/index/clientname /db6 This is directory whose data is recovered by this ASM.

SEE ALSO nsr_layout(5), nsrck(1m), nsrdr(1m), nsrindexd(1m), uasm(1m)

NetWorker 19.1.1 224

Maintenance Commands nsrindexd ( 1m )

NAME nsrindexd NetWorker le index daemon

SYNOPSIS nsrindexd

DESCRIPTION The nsrindexd daemon is started by the server nsrd(1m) daemon. It should not be started manually. The daemon provides an RPC-based service to the server nsrd(1m) daemon; direct network access to this service is not allowed. The RPC program and version numbers provided by nsrindexd are 390105 and 4, respectively.

The service provided to the NetWorker system is designed for high performance inser- tion and deletion of save records into indexes. This performance is obtained by keep- ing information cached in the nsrindexd process address space. When the NetWorker system wishes to commit a save sessions records, it noties the nsrindexd daemon (via a remote procedure call) to ush its volatile state to its le(s).

Since the daemon (or the server) may crash at any time, the index les may be left in an inconsistent state. Therefore, the maintenance program, nsrck(1m) is run automati- cally by the nsrd daemon before the NetWorker service is started.

When the NetWorker service is started, it starts the process nsrindexd which will invoke nsrck -L 1 to perform a fast and efcient check for each of the congured client le indexes. Only the consistency of the index header and journal les are checked. It is generally not necessary (and very time consuming) to check every record and key le in the client le index at startup. If a problem is detected, a more thorough check will be automatically performed on client le index in question.

If you believe an index may be corrupt, you can manually run a higher level check on the index, for example:

nsrck -L 6

Running nsrck -L 7 will not overwrite existing les in the client le index. So, if online client le index data already exists for a saveset for a particular save time, it must be removed before nsrck -L 7 can be used to restore it from the backup media.

Since nsrindexd and nsrck are run at the same time, both programs use an advisory le-locking mechanism on the le v6ck.lck to synchronize their access to an index.

FILES /nsr/index/clientname /db6 This directory is where the clients index header le and jour- nal les are stored. The index record les (.rec) and the corresponding key les (.k0 and .k1) are stored in different subdirectories under db6 directory.

/nsr/index/clientname /db6/v6hdr This is the name of the index header.

/nsr/index/clientname /db6/v6journal This is the name of the journal le.

/nsr/index/clientname /db6/v6hdr.lck This is the name of the lock le used for synchronizing access to the index header le and journal le.

nsr_layout(5), nsr(1m), nsrck(1m), nsrd(1m), nsrim(1m), nsrindexasm(1m), nsrls(1m), nsrmm(1m)

DIAGNOSTICS Continuing without index header for client clien t n am e This is an informative message to indicate that another program is accessing the same le that is required by this daemon. The daemon determined that it can continue its operation safely without the index header.

NetWorker 19.1.1 225

Maintenance Commands nsrinfo ( 1m )

NAME nsrinfo NetWorker le index reporting command

SYNOPSIS nsrinfo [ vV ] [ s server L ] [ n namespace ] [ N lename ] [ t time ] [ T ] [ X application ] [ x exportspec ] client

DESCRIPTION The nsrinfo command generates reports about the contents of a client le index. Given a required NetWorker client name and no options, nsrinfo will produce a report of all les and objects, one per line, in the backup name space for that client. It can also generate reports for: a specic le index name space, all name spaces at once, or even a particular XBSA application. Reports can also be restricted to a single time (the time at which the entry was entered into the le index, called the savetime).

For example, to generate a report of all les backed up in the most recent backup of the /usr le system for the client mars , use the following sequence of commands (assuming the % character is the shell prompt):

% mminfo r nsavetime v N /usr c mars ot tail 1 809753754 % nsrinfo t 809753754 mars

Note: The time used in the query is obtained by running the mminfo(1m) command with a custom report to print the save time for the most recent save set for /usr. The time printed is passed to nsrinfo along with the name of the client (mars).

OPTIONS v Verbose mode. In addition to the lename, it prints the type of the le, the internal le index identier (if any), the size (if a UNIX le), and the savetime. This option may be combined with the V option.

V Alternate verbose mode. In addition to the lename, it prints the offset within the save set containing the le, the size within the save set, the application name space (see the n option for a list of values), the save time, and if avail- able, the le times (mtime, atime, ctime) and the UNIX clients le access per- missions and ownership. This option may be combined with the v option.

s server Indicates the name of the NetWorker system to be queried. By default, the server on the local system is queried.

L Opens a le index directly without using the server. This option is used for debugging, or to query the le index while NetWorker is not running.

n namespace Indicates the le index name space to query. By default the backup name space is used. The other recognized values are: migrated , archive , nsr (for internal use), bbb (for Block based backup data), db2 (for DB/2 data), informix (for INFORMIX data), iq (for SAP IQ data), msexch (for Exchange data), mssql (for SQL Server data), mysql (for MySQL data), notes (for Lotus Notes data), oracle (for Oracle data), saphana (for SAP HANA data), sybase (for Sybase data), and all . The name space eld is case sensitive.

N lename Indicates an exact lename to look for in the le index. Only index entries matching this name exactly print. Note that for some clients, such as NetWare, the name stored in the le index is often not made up of printable ASCII char- acters, giving this option limited use.

t time Restricts the query to a single, exact save time. The time can be in any of the NetWorker nsr_getdate(3) formats. Every save set created by NetWorker has a unique save time; these times can be determined by using the mminfo(1m) command.

NetWorker 19.1.1 226

Maintenance Commands nsrinfo ( 1m )

T Indicates the actual lenames backed up but excluds the continuation direc- tories.

X application Restricts the query to list information for only a specic X/Open Backup Ser- vices (XBSA) application. Valid application types are All, Informix, and None. The application type is not case sensitive. See the APPLICATION TYPES sec- tion of this man page for more information.

x exportspec As an alternative to the default human-readable output format, exportspec pro- vides for two styles of program-readable output formats. The exportspec m displays XML output, while exportspec c displays values separated by any single character or string. For example, nsrinfo xc, will produce comma-separated values.

FILE TYPES The le index can store entries for all types of clients. Each index entry includes an index entry type. In general, only the client that created the index entry can decode the entry.

This section lists index entry types recognized by nsrinfo. However, even though these types are recognized, nsrinfo can only completely decode one entry type: the UNIX version decodes UNIX entry types, and the NT version decodes NT entry types. For other recognized types, some information may be incomplete.

old UNIX Clients running versions earlier than 3.0 of NetWorker for UNIX.

UNIX Clients running versions earlier than 4.0 of NetWorker for UNIX.

UNIX ASDF Index entries including extended ASM Structured Data Format (ASDF) information for clients running versions 4.1 and later of Net- Worker for UNIX.

UNIX ASDF v2 Index entries from agentless saves for clients running versions 4.2 and later of NetWorker for UNIX.

UNIX ASDF v3 Index entries for large les (les > 2 gigabytes) for clients running versions 5.1 for UNIX and later NetWorker for UNIX.

old DOS DOS clients running versions 2.0 and earlier of NetWorker for DOS.

DOS DOS, Windows, or OS/2 clients running version 2.0 of NetWorker for DOS, Windows, or OS/2.

DOS old ASDF DOS, Windows, or OS/2 clients running version 2.0 of NetWorker for DOS, Windows, or OS/2.

WIN ASDF Windows or NT clients running NetWorker for Windows NT 4.2 and above.

WIN ASDF v2 Windows or NT clients running NetWorker for Windows NT 4.2 and above, created by using agentless saves.

old NetWare NetWare clients running version 3.0 and earlier of NetWorker for NetWare.

NetWare NetWare clients running version 3.0 and later of NetWorker for NetWare 3.0.

OSF 64bit A client running OSF/1 with 64bit le sizes and offsets.

continuation A special internal index entry, that is generated when a le crosses save set boundaries in a save set series.

NetWorker 19.1.1 227

Maintenance Commands nsrinfo ( 1m )

APPLICATION TYPES

All This application type prints out all of the X/Open Backup Services API (XBSA) information available for each object; only XBSA objects are printed. The -v and -V ags have the same effect here as they do on les.

Informix This application type prints out only those objects recognized as Informix Database objects (XBSA ObjectOwner.bsaObjectOwner is INFORMIX). The -v ag behaves as it does with les, while the -V ag prints out all the XBSA information about the object (see All, above), including the normal -V information.

None This application type prints out objects that are not XBSA objects, but match the given criteria. For example, this option can be used to print a list of les backed up from a client.

PRIVILEGE REQUIREMENTS

A user is required to have "Operate Networker" privilege in order to invoke this com- mand. If the -L option is used, the user must also be an administrator on the system where this command is invoked (that is, root on a UNIX system).

FILES /nsr/index/client /db6

SEE ALSO nsr_getdate(3), mminfo(1m), nsrck(1m), nsrindexd(1m)

DIAGNOSTICS bad time value time The time value specied in the t option is not in a valid nsr_getdate(3) for- mat.

cannot open index for client client: reason The le could not be opened using the L option. The specic reason is printed, although there may be several. The most likely reasons are permission denied if the user is not the superuser, and service busy, try again if the le index is already locked (for example, by nsrindexd(1m)).

cannot create db scan on client An internal error occurred while attempting to query the le index. Contact EMC Technical Support.

number bad records for client client This diagnostic prints at the end of a report if any bad index records were detected. This is a sign that the index is damaged, and may need to be recovered.

cannot connect to server server The index server is not available for one of many reasons. For example, the NetWorker server may be down, or nsrinfo may not be able to connect to a running server due to either a resource shortage or a network problem.

cannot start session with server server The index server is running, but refused the connection. The exact reason is printed on the subsequent line of output. The most likely reasons are permis- sion denied if the user is not a NetWorker administrator, and service busy, try again if the le index is locked (for example, by nsrck(1m)).

lookup failed to server server The index server is running, but was unable to process the query. The exact reason is printed on the subsequent line of output.

LIMITATIONS The command line options should be made as powerful as those of mminfo(1m).

NetWorker 19.1.1 228

Maintenance Commands nsrinfo ( 1m )

The v and V reports are not formatted into columns.

A query for a specic time can take a very long time due to the schema of the le index.

The queries are limited due to the lack of a cross-platform browser.

NetWorker 19.1.1 229

Maintenance Commands nsrjb ( 1m )

NAME nsrjb NetWorker jukebox control command

SYNOPSIS nsrjb [ C ] [ j name ] [ s server ] [ v ] [ f device ] [ S slots T Tags volume names ]

nsrjb L [ j name ] [ s server ] [ gimnqvG ] [ Y N ] [ B ] [ b pool ] [ f device

J hostname ] [ e forever ] [ c capacity ] [ o mode ] [ [ S slots T Tags ] [ volume names ] ]

nsrjb L [ j name ] [ s server ] [ gimnqvG ] [ Y N ] R [ b pool ] [ f device J hostname ] [ e forever ] [ c capacity ] [ o mode ] [ S slots T Tags volume names ]

nsrjb l [ j name ] [ s server ] [ nvqrG ] [ R [ b pool ] ] [ f device J hostname ] [ S slot T tags volume names ]

nsrjb u [ j name ] [ s server ] [ qv ] [ f device ] [ S slot T tags volume names ]

nsrjb I [ j name ] [ s server ] [ Evpq ] [ I f device ] [ S slots T tags volume_names ]

nsrjb p [ j name ] [ s server ] [ vq ] [ f device ] [ S slot T tag volume name ]

nsrjb o mode [ j name ] [ s server ] [ Y ] [ S slots T tags volume names ]

nsrjb H [ j name ] [ s server ] [ EHvp ]

nsrjb h [ j name ] [ s server ] [ v ]

nsrjb U uses [ j name ] [ s server ] [ S slots T tags ]

nsrjb V [ j name ] [ s server ]

nsrjb d [ j name ] [ s server ] [ v ] [ N ] [ Y ] [ P ports ] [ S slots ] [ T tags ] [ volume names ]

nsrjb w [ j name ] [ s server ] [ v ] [ N ] [ Y ] [ P ports ] [ S slots T tags volume names ]

nsrjb a [ j name ] [ s server ] [ vd ] [ T tags [ T tags ] volume names ]

nsrjb x [ j name ] [ s server ] [ vwX ] [ T tags S slots ]

nsrjb F [ j name ] [ s server ] [ v ] f device

NetWorker 19.1.1 230

Maintenance Commands nsrjb ( 1m )

DESCRIPTION The nsrjb program manages resources in two broad classes of jukeboxes: remotely managed jukeboxes and locally managed jukeboxes. Remotely managed jukeboxes are controlled through an external agent. nsrjb communicates with this agent to gain access to jukebox resources. The agent allows multiple applications, including multiple NetWorker servers, to share resources in the jukebox. An example of an agent is StorageTeks ACSLS . nsrjb communicates directly with a locally managed jukebox, there is no intervening agent. Resources in a locally managed jukebox can be used by only one NetWorker server.

For a locally managed jukebox, the jukebox resource is used to track the state of the entire jukebox. The resource records the number of drives and slots in the jukebox. It is also used to track whether devices are loaded, whether there is media residing in the slots, the name of any volume on the media, and other information as well. See nsr_jukebox(5) for more information on jukeboxes.

The jukebox resource for a remotely managed jukebox does not reect the current state of the entire jukebox, only NetWorkers view of it. Media in remotely managed jukeboxes must be allocated before NetWorker may access it. For more details, see the description of the a option. The number of slots in a remote jukebox resource increases as media is allocated for NetWorkers use and decreases as media is deallo- cated after NetWorker has no further use for the media. The order in which media is listed in the jukebox resource does not necessarily reect physical location within the jukebox. The number of drives in a remote jukebox is the upper bound on the number of volumes in the jukebox that NetWorker may access simultaneously.

The nsrjb command is used to manage all jukeboxes for a NetWorker server. Use this command, rather than nsrmm(1m), to label, load, and unload the volumes contained within a jukebox. Multiple nsrjb commands may access a jukebox at any given time.

A nsrjb command which requires use of jukebox resources does not directly perform the requested operation. Instead the command makes a request of the NetWorker server process, nsrd, which forwards the request to nsrmmgd for processing.

Since nsrjb does not perform the operation directly, killing nsrjb will not cause the operation to be aborted. Provisions for operation cancellation are built into nsrjb via an interrupt handler that is tied to SIGINT. This means that if you have a nsrjb command running, and you want the operation to be cancelled, then you may do it either by means of Control-C against the nsrjb process, or using the UNIX kill command to send a SIGINT signal.

A single Control-C or SIGINT will cause the operation to be cancelled and nsrjb will still monitor the status of the appropriate NSR jukebox operation status resource until it is clear that the operation has, in fact, terminated. A second Control-C or SIGINT will tell nsrjb to exit without waiting for conrmation of the operations termination.

A NSR jukebox operation status resource will be automatically generated and managed by nsrd for each jukebox operation that is created, regardless of whether it was ini- tiated automatically by nsrd or it was created explicitly by invoking nsrjb

This NSR jukebox operation status resource tracks the current state of the operation, holds all messages (error, informational, or verbose) related to the operation, and gen- erally acts as a communication path between both the nsrjb process that invoked the operation, and the various Networker programs that carry the operation out. See the nsr_op man page for more details on this resource.

NetWorker 19.1.1 231

Maintenance Commands nsrjb ( 1m )

A volume resides on a side of a physical piece of media. Examples of a piece of media are: tape cartridges or optical disks. Tape cartridges have one side and therefore have one volume residing on each cartridge. Optical media may have two sides with a volume residing on each side of the media. Each volume within a jukebox, and each jukebox itself, has a name recognized by NetWorker. A volume name is specied when the volume is rst labeled by NetWorker. You can change the volume name when a volume is relabeled. NetWorker refers to volumes by their volume names. For exam- ple, when requesting the mount of a volume, NetWorker asks for it by volume name.

Before using nsrjb, the jukebox and its device resources must be added to the Net- Worker server. Use jbcong to add the jukebox resource and its device resources to the NetWorker server. The jukebox resource is described in nsr_jukebox(5).

When a NetWorker server requires a volume for backup or recovery, and an appropri- ate volume is not already mounted, the server checks the media database to verify whether a jukebox contains a volume that satises the media request. If so, nsrd sends a request to nsrmmgd to load the media into an idle device. The Available Slots attri- bute species the slots containing volumes available to automatically satisfy Net- Worker requests for writable volumes. When automatically selecting a writable volume for backup, NetWorker only considers volumes from the list of available slots. It is important to note that the Available Slots attribute does not limit what slots the user running nsrjb can operate on.

nsrjb attempts to determine which jukebox to use based on the options j , f , or a volume name . If one or more of these options do not uniquely identify a jukebox, and one must be selected, the nsrjb program prompts you to select a jukebox. You can set the NSR_JUKEBOX environment variable to the name of the jukebox you want the nsrjb program to use by default.

NOTE: In a clustered conguration, either the f device or the J hostname option must be provided.

OPTIONS Options are separated into two groups. The rst are the options which specify the operation to be performed, e.g. label or load media. The second group list the addi- tional options which provide arguments for the operation, e.g. specifying the media to be labeled or loaded. Note that option arguments that have spaces, for example, pool name, must be enclosed in double quotes.

OPERATION OPTIONS

a This option is used in conjunction with the T tags option, to allocate volumes in a remotely managed jukebox. A volume must be allocated before it can be labeled and used by a NetWorker server.

For STL silos, a d option can be added for silos that support depositing (also known as importing or entering) tapes from their I/O ports. The d must appear after the a on the command line. This function is usually handled by the silo management software, but is added here for ease of use. This option may not be supported on all silos supported by NetWorker.

Use a in conjunction with T tags option to allocate volumes for NetWorkers use. Both scratch and in-use volumes can be allocated this way. By specifying the barcode or physical cartridge label with this option, volumes from specic media cartridges may be allocated. In-use volumes will be discovered by the jukebox inventory operation.

See x for a description of how volumes are removed from a remote jukeboxs list of volumes available for use by a NetWorker server.

NetWorker 19.1.1 232

Maintenance Commands nsrjb ( 1m )

C Displays both the current volumes in the jukebox, and the devices associated with the jukebox. This is the default command option, used if no other com- mand options are specied. It displays a list of slot numbers, volume names, media pools, optional bar code information, volume ids, and volume modes. If the jukebox attribute Bar Code Reader is enabled, and there are bar code labels on the media volumes, then the bar code label is included in the list. If Bar Code Reader is set and the volume does not have a bar code label, a dash prints, indicating that there is no bar code label on the media. By default, the short volume id of a volume is displayed. Using the verbose option (-v) displays the long volume id along with other information described below. The -C option does not perform an actual jukebox inventory; nsrjb only reports on the volumes currently contained within the jukebox resource. Volumes may be succeeded by one of the following ags: an (R), to indicate the volume is read- only; or an (A), to indicate the volume is either an archive or a migration volume. When combined with the v option, the capacity of the volumes that have been lled is also displayed. Volumes that are not contained in the Net- Worker media database are marked with an asterisk, "".

The Mode column contains additional information about the mode of the volume. The Mode eld can have one of three values: manually recyclable , to indicate that the volume will not be automatically recycled or relabeled; recycl- able , to indicate that the volume is eligible for automatic recycling; or it may be left blank, to indicate that neither of the other two values apply.

After the slot map prints, a line about each device is displayed. For each enabled device, the following information is provided: drive number, device pathname, slot number and name of the currently loaded volume, and an indi- cation of whether NetWorker has the volume mounted. If the device is dis- abled, only the drive number and pathname are displayed, along with the mes- sage disabled . When several device resources share a physical drive in the jukebox, via the same hardware id attribute value, the drive number is only displayed on the rst device pathname sharing the drive.

d Deposits (loads into the jukebox) one or more cartridges from the cartridge access ports (also called import/export elements, mail slots, or I/E ports).

The number of cartridges to deposit is determined by the number of specied slots or tags. If no slots or tags are specied, all empty slots in the jukebox are deposited. Multiple destination slot ranges may be specied, but full slots are skipped. If all available import ports are empty, and there are cartridges to deposit, the operator will be prompted to ll the import ports. When the N option is used in conjunction with the jukebox polling feature, the jukebox will poll for cartridges in the import ports until all of the cartridges are deposited, or an error occurs. Exceeding the polling timeout while waiting for additional cartridges is considered an error.

Specifying volume names on the command line is not recommended. The inventory command should be run to accurately determine the volume names.

If d is used with a T tags option, then the command is assumed to be run- ning on a silo, and is treated internally as if it had been run with the a and d options. Specied volume tags (barcodes) will be deposited into the silo and then NetWorker will attempt to allocate them for its use. Depending on the exact type of silo used, this allocation step may or may not succeed. You

NetWorker 19.1.1 233

Maintenance Commands nsrjb ( 1m )

should verify the success of the allocation, and retry the command with just the a option for all of the tag values specied. If the tags have already been allocated, you will see a message indicating this. This is not an error, and only means that the volumes had already been successfully allocated for use by Net- Worker.

F Releases a shared device contained within an STL silo. This option is only available for tape libraries with device sharing. See nsr_jukebox(5).

h Displays the actions and results of the past 120 jukebox commands issued. These include commands issued on the command line by the user, or requests that were started automatically by NetWorker. If you wish to change the number of command lines saved in the history, you may set the environment variable NSRJB_HISTORY_COUNT to a value between 20 and 2000. Values smaller than 20 will result in 20 being used, and values larger than 2000 will result in 2000 being used.

H Resets the jukebox hardware (and the NetWorker database representing the jukebox) to a consistent state. The jukebox clears the transport and then unmounts and unloads volumes from the drives to slots. An actual inventory is not performed; (see the I option). If the jukebox senses that the inventory is out-of-date, it prints an appropriate message.

For silos, only devices which NetWorker thinks are loaded are unloaded. You can use the silo controller to empty other drives.

If the -p option is also specied, a check operation will be performed on the loaded volumes.

I Performs an inventory on the jukeboxs contents. Use this option to ensure that the mapping between slot number and volume name is correct. If necessary, the volumes in the specied slots may be loaded into a device, so their labels may be read. This option can take a long time to complete depending on the type of jukebox.

If a jukebox has a bar code label reader, the jukebox resource attribute Bar Code Reader is set, and Match Bar Code is set, then the volume name associated with a slot is derived from the media bar code label.

Tapes are always loaded into drive for labels to be read in the following condi- tions: 1) jukebox does not have a barcode reader 2) jukebox has a barcode enabled but the tapes barcode is not in the media database 3) jukebox has a barcode and Match Bar Code is set; the tapes barcode is in the media database but the location is empty

If a bar code label on the media has changed, then the NetWorker media data- base is updated with the new bar code label. Proper use of a jukeboxs bar code reader can minimize the time it takes to perform an inventory.

The -II option can be used to perform a fast inventory which operates only on slots with volumes that can be veried without reading their labels. Since fast inventory does not involve reading the tapes, this option may not be combined with a device specication ( f).

The -Ip option forces tapes to be loaded into the drive for their label to be read

NetWorker 19.1.1 234

Maintenance Commands nsrjb ( 1m )

even if the volumes label can be veried.

For jukeboxes that have element status capability, you can use the E option in conjunction with the I option to reinitialize the jukeboxs inventory state. The -E option increases the amount of time it takes to inventory a jukebox because the hardware must check every component, including all slots and drives, for the presence of media. You should only use this option if you are manually swapping media in or out of a jukebox.

If the p option is also specied, nsrjb requests the volumes be loaded so that labels on each volume may be veried.

To allocate slots in a jukebox for cleaning cartridges, set the jukebox resource attribute Auto Clean to Yes and the Cleaning Slots attribute to a non-empty range of slots. For further information see nsr_jukebox(1m). Volumes from slots that are reserved for cleaning cartridges are not loaded during the inven- tory of a jukebox. For jukeboxes that do not support element status, or have a bar code reader, the U uses option must be used to enter a cleaning cartridge into the jukeboxs inventory. For jukeboxes that support element status, or have a bar code reader, cleaning cartridge slots that were previously empty, but now contain a cartridge, have the number of uses for the cleaning cartridge is listed in the jukebox attribute Default Cleanings.

l Loads and mounts specied volumes. Volumes are specied by name, by the slot in which the volume resides, or for remote jukeboxes by the tag associated with the volume. The operation fails if the number of volumes specied is greater than the number of available drives.

The J option can be used to specify a different storage node.

The f option can be used to specify which media devices you want the volumes to be loaded into.

If loading a device located in a remote jukebox, an NDMP device for instance, the "-f" option with the "rd=" syntax in the device name must be specied.

L Labels the volumes in the specied slots, or for remotely managed jukeboxes, by specied tags. Names for the volumes labeled are derived from media bar code labels, volume names specied on the command line, or generated by referencing the label template resource for the given pool. If you do not specify any slots, the range of slots is as described in the NSR_jukebox resource for the jukebox. Labeling a complete jukebox may take a long time.

If the jukebox has a bar code label reader, and the NSR_jukebox resource attributes Bar Code Reader and Match Bar Code Labels are set, then the volume label is derived from the bar code label on the media. If the jukebox resource attribute Match Bar Code Labels is not set, or the jukebox does not have a bar code reader, then the volume label is derived from volume names specied on the command line. If more volumes are being labeled then volume names specied on the command line, then the volume label is derived from the label template. No matter how the volume label is derived, if the media labeled has a media bar code label, the bar code is stored in the NetWorker media data- base so that it can be used during inventory operations.

Volumes names cannot be used without S or R options for regular jukeboxes.

NetWorker 19.1.1 235

Maintenance Commands nsrjb ( 1m )

The reason for this is that the volume names do not exist in the media database for new or imported tapes.

Volumes located in slots set aside for cleaning cartridges cannot be labeled. See I for a discussion of how the slots of a jukebox are set aside for cleaning cartridges.

If an empty slot is encountered, an informational message is displayed and the operation continues.

See the m option if you want the volume to be automatically mounted after being labeled.

o mode Sets the mode of a volume or range of slots. The following mode values are available: [not]recyclable, [not]readonly, [not]full, or [not]manual. If the Y option is not used, you are prompted to conrm the operation for each volume. See nsrim(1m) for a discussion of the per-volume ags.

p Veries and prints a volume label. A slot or, for remotely managed jukeboxes, a tag may be specied. The device used to read the volume may also may be specied. See nsrmm(1m).

u Unloads a volume from a device. To unload a volume from a device, specify the name of the volume, the device in which the volume is loaded, or the slot from which the volume was loaded. If no volume, device or slot is specied, media is unloaded from all loaded devices.

U uses Sets the number of times a cleaning cartridge can be used. Slots can also be specied. Any slot specied must be in the range of slots set aside for cleaning cartridges in the jukebox. If a range of slots is not specied, all slots set aside for cleaning cartridges are updated. For slots that are currently empty in the jukeboxs inventory, this option updates the inventory to indicate that the slot is occupied by a cleaning cartridge. For a discussion of how slots of a jukebox are set aside for cleaning cartridges, see I.

Uses must be either a positive integer, or the reserved words remove or default. The reserved word remove can be used (for example, -U remove) to delete the cleaning cartridge(s) from the NetWorker inventory. Specifying default sets the number of times a cleaning cartridge may be used to the value of the default cleanings attribute for the jukebox. See nsr_jukebox(5).

You can use the T option in conjunction with the U option to add cleaning cartridges to a Silo Tape Library (STL). This option sets aside a cleaning slot in the STL each time a cleaning cartridge is added. For a description of how to remove cleaning cartridges from an STL, see x. See I for a discussion of how slots in a non-STL jukebox are set aside for cleaning cartridges.

V Display the current jukebox conguration.

w Withdraws (ejects media from the jukebox) one or more cartridges to the car- tridge access ports.

Cartridges must be specied by slot, volume name or tag. Multiple slot ranges and volume names may be specied, empty and duplicate slots are ignored. If the available export ports are full, and there are cartridges to withdraw, the operator will be prompted to empty the export ports. When the N option is

NetWorker 19.1.1 236

Maintenance Commands nsrjb ( 1m )

used in conjunction with the jukebox polling feature, the jukebox will poll for empty export ports until all cartridges are withdrawn or an error occurs. Exceeding the polling timeout while waiting for empty ports is considered an error.

If w is used with a T tags option, then the command is assumed to be run- ning on a silo, and is treated internally the same as if it had been run with the x and w options. Specied volume tags (barcodes) are withdrawn from the silo. Then NetWorker deallocates them from its list of volumes for that silo. In general, you can only withdraw at most about 40 volumes from a silo at one time, although this limit differs on different silo models. If a given command does not cause any tapes to be withdrawn from the silo, try again using fewer tag values on the command line.

x This option, when used in conjunction with the T tags or S slots option, is used to remove volumes from a remote jukebox. The specied volumes are removed from the remote jukeboxs list of volumes available for use by a Net- Worker server.

For STL silos, a w option can be added to withdraw or eject tapes from the silo or to physically remove the tapes from the silo. The w must appear after the x on the command line. This function is normally handled by the silo management software, but is added here for ease of use. This option may not be supported on all silos supported by NetWorker.

See a for a description of how volumes are allocated for use by a NetWorker server.

ADDITIONAL OPTIONS

b pool Species the media pool to which the volume should belong. The pool may be any pool currently registered with the NetWorker server. The pool names can be viewed by selecting Media Pools from the left pane of NetWorker Manage- ment Consoles Media display. The pool name is referenced by the Net- Worker server when determining what save sets can reside on the volume. If you omit this option the volume is automatically assigned to the Default pool. If you specify a pool name without a volume name, nsrjb will use the next volume name associated with the specied pools label template resource. See nsr_label(5).

c capacity Overrides the volumes default capacity. See nsrmm(1m).

B Veries that the volume currently being labeled does not have a readable Net- Worker label. Before labeling a volume, NetWorker attempts to read any exist- ing labels written on the volume. If you specify this option and the volume has a NetWorker label that is readable by the device currently being used, the label operation is canceled and an error message is displayed. If the volume does not have a label, or has a label that is not readable by the current device, then the volume can be labeled. This option is used by nsrd(1m) to label volumes automatically when nsrmmd(1m) makes a request for a volume while saving data.

e forever Species the volume to be an Archive volume. (see nsrmm(1m)).

E Initializes element status for jukeboxes that support this feature. You can use this option in conjunction with the I or H options. Some jukeboxes have the

NetWorker 19.1.1 237

Maintenance Commands nsrjb ( 1m )

ability to keep track of whether or not there is media in a component in the jukebox. This feature is known as an "element status" capability. The V option may be used to determine whether a jukebox has this capability. When swapping media into the jukebox where media was not previously loaded, it may be necessary to reinventory ( I ) the jukebox with the E option so the jukebox reinitializes its element status.

f media device Species a media device to be used for an operation. Use the pathname of the media device as it is congured in the jukebox resource. When more than a single media device has been congured for a jukebox, nsrjb selects available devices with the lowest value for the device resource attribute accesses. See nsr_device(5). When loading or verifying volumes, the number of devices available must at least be greater than or equal to the number of volumes specied for the operation. For other operations, the value of the jukebox attri- bute max parallelism is an upper bound on the number of devices that may be used by any nsrjb command. You can override the device selection by using the f option. You can use this option multiple times, to specify more than one media device.

g This option is kept for historical reasons only. It has no affect.

G This option is used only by the server. The -G option is used to tell the auto- loader to mount or label a volume in a Network Data Management Protocol (NDMP) device.

i This option is kept for historical reasons only. It has no affect.

j name Species a particular jukebox to use. The given name is the one assigned by the user when the jukebox resource is created. This option overrides the NSR_JUKEBOX environmental variable.

J hostname Species a particular hostname to use. Drive selection by nsrjb will be res- tricted to a drive on the given hostname. This option can be used with the l (load) or L (label) options, but cannot be used with the f option.

If the jukebox that you manage is connected to a NDMP server (e.g., a NAS ler), you need to use this option to specify the NDMP server. See Examples.

m Mount a volume after it has been labeled. There must be enough available drives to mount all volumes to be labeled.

n Loads, but does not mount, the volume when specied with the l option.

N Tells nsrjb to skip the conrmation prompt when used in conjunction with one or more of the LRdw options. When NetWorker recycles volumes, Net- Worker prompts you to conrm that it is okay to overwrite any volumes con- sidered to be nonrecyclable. See nsrim(1m) for a discussion of the per-volume ags.

P ports Species a cartridge access port or range of ports to deposit or withdraw volumes.

Ranges are specied as low to high. Both low and high must be integers; low must be less than or equal to high . Both numbers are checked for validity against the resource describing the jukebox. You can specify only one port range for a command.

NetWorker 19.1.1 238

Maintenance Commands nsrjb ( 1m )

q Runs the nsrjb program in quiet mode. Turns off all of the messages normally produced when: verifying, labeling, loading or unloading volumes, or invento- rying a jukebox. You can use this option only with the p, L, l, u, or I options.

r Loads the volume as read-only. You can use this option only with the l option. See nsrmm(1m).

R Recycles the volume. If the conditions as described for the -L option are met for using bar codes as labels, then the volume label is derived from the bar code label on the media (without exception). If the volume is recycled to a new pool, the label is generated by referencing the label template resource for the given pool. Otherwise the volume is relabeled using its current name.

Normally NetWorker recycles volumes automatically as needed. Since you are opting to force a recycle operation, you are not prompted for conrmation as to whether or not this volume may be overwritten regardless of the recyclable state of the volume.

See nsrmm(1m) for a discussion of the per-volume ags.

s server Species the controlling server when nsrjb is used on a storage node. To use nsrjb on a storage node, the command must be run on the storage node. See nsr_storage_node(5) for additional information on storage nodes.

S slots Species a slot, or range of slots, on which to operate. Specify the slot range from low to high integer order. Both low and high must be integers; low must be less than or equal to high . Both numbers are checked for validity against the resource describing the jukebox. You can specify multiple slot ranges for a command.

T tags Species tags, or barcodes, of volumes in a remote jukebox. You can specify this option more than once for a command.

tags can specify a single volume tag or a volume tag template (similar to a label template). See nsr_label(5). The volume tag Template is a list of template elds separated by slashes "/". A template eld is a constant alphanumeric string or an alphabetic or numeric range represented by the low and high value separated by a "-".

This template differs from the templates used in the NetWorker GUI. Each portion of the template is entered into a separate line in the GUIs dialog box instead of using a "/" as a separator.

The tag is used to identify the media when a request is made of the agent managing the remote jukebox. This identier is determined by the remote agent. A tag is often a bar code label. When making a request to load media into a device, NetWorker sends the tag with the request to the agent to identify the media to be loaded. Volumes in a jukebox resource are listed in alpha- numeric order of their tags. Therefore, the order in the jukebox resource may change as media is allocated and deallocated, and has no relation to the slot in which the media may reside in a physical library.

v Set the verbosity level by the number of times this ag is specied on the com- mand line. The maximum verbosity level supported is 5. See other arguments

NetWorker 19.1.1 239

Maintenance Commands nsrjb ( 1m )

for specic details on the verbose output.

X You can use this option in conjunction with x to purge a volume from NetWorkers media database when the volume is being deallocated. Unless Y is also specied, a prompt is displayed to conrm that the volume is to be purged from the media database.

Y Disables conrmation prompting. Rather than prompting for conrmation, a yes answer is assumed. Prompts are normally generated when a volume is being relabeled before its expiration date, or when a volume is still registered in the NetWorker media database. If the operation is to label ( L ) a volume or to load ( l ) a volume, with the R option also specied, and the volume is recyclable, there is no prompt to conrm whether the volume may be overwritten.

volume name Species the name to be used when labeling a volume. After a volume has been labeled, the volume name is used to select media for an operation. Multi- ple volumes names may be specied for a single command, but they must come at the end of the command line.

EXAMPLES Labeling volumes : To label all of the volumes in a jukebox, use the L option:

nsrjb L

To specify a particular pool, use the b option: nsrjb L bOffsite

Labeling the volumes in slots 5 through 19 : To label the volumes in slots 5 through 19, use the S option:

nsrjb L S 5 19

Labeling a volume with a non-standard name : To label the volume in slot 20 with a name that does not match the label tem- plate associated with a pool, specify the name along with the L option:

nsrjb L S 20 mars.special

When more than one volume is to be labeled, the name must match the label template associated with the pool. This ensures that nsrjb generates the subse- quent names.

Mounting a volume after it has been labeled : To mount a volume after it has been labeled use the m option:

nsrjb L S 20 m To mount an NDMP volume after it has been labeled, use either of the following commands with the -m option:

nsrjb J L S 20 m or

nsrjb L S 20 m f

The command fails if there are not be enough drives to mount all volumes to be labeled.

Labeling volumes with a standard name : To label the volumes in slots 21 through 28, starting with a name different than that referenced by the label template associated with the pool resource, specify the rst name along with the L option. In order for nsrjb to generate the additional names, the specied name must match the layout of the label tem- plate.

nsrjb L bOffsite S 21 28 Offsite.501

After labeling the volume in slot 21 with Offsite.501 nsrjb uses the label

NetWorker 19.1.1 240

Maintenance Commands nsrjb ( 1m )

template to generate names for the volumes in slots 22 (Offsite.502) through 28 (Offsite.508). If the next volume name in the sequence for a label template is already in use, the name is skipped.

Loading a volume : To load volumes, use the l option.

nsrjb l

nsrjb will select volumes to load into selected devices. It will continue loading volumes until all of the devices are loaded.

Loading specic volumes : To load a volume named mars.001 , specify the volume name along with the l option:

nsrjb l mars.001

To load the volume in slot 5, use the S option: nsrjb l S 5

To load the selected volume into device /dev/nrst1, include the f option. nsrjb l f /dev/nrst1 mars.005

Loading volumes in a jukebox connected to an NDMP server : To load the volume in slot 1 of jukebox mylibrary (connected to NDMP server 10.31.32.220), use the -J and -j options.

nsrjb J 10.31.32.220 j mylibrary l S 1

To load the volume in slot 1 of jukebox mylibrary (connected to NDMP server 10.31.32.220) to a specic device nrst0l,

nsrjb l f "rd=10.31.32.220:nrst0l (NDMP)" j mylibrary S 1

Unloading a volume You can unload a particular volume, slot, or device. To unload volume mars.0028 , use the -u option:

nsrjb u mars.0028

To unload the volume in slot 28 , use the S option: nsrjb u S 28

To unload the volume in device /dev/nrst3 , use the f option. nsrjb u f /dev/nrst3

Displaying the jukeboxs current volumes To display a list of slots and volumes, and which volumes are loaded in to a jukeboxs devices, use the -C option:

nsrjb C

The C option is the default and is used when no other options are selected. A range of slots may also be specied. For example, to display the volumes in slots 10 through 23, use the -S option:

nsrjb S 10 23

Setting the number of uses for a cleaning cartridge : To set the number of times all cleaning cartridges in a jukebox may be used to 12, use the -U option:

nsrjb U 12

To set the number of times the cleaning cartridge in slot 10 may be used, use the -S option:

nsrjb U 25 S 10

Slot 10 must be a slot set aside for cleaning cartridges in the jukebox.

Inventorying the volumes :

NetWorker 19.1.1 241

Maintenance Commands nsrjb ( 1m )

To reconcile the actual volumes and the list of volumes produced by nsrjb, use the I option. Each volume may be loaded into a device and examined for a NetWorker label (depending on bar code settings and other factors). The inter- nal list is then updated with the new information. After all volumes have been examined, the new list is compared to the NetWorker media database, and a message listing any volumes located in the jukebox but not in the database is produced. To inventory the volumes in slots 17 through 43, use the -S option:

nsrjb I S 17 43

Like labeling, volume inventory may take considerable time.

Using the NetWorker notication system : When NetWorker needs a volume, a "media event" is generated. To have nsrjb automatically respond to these events, the NetWorker notication system is used. This notication resource is automatically generated.

Using the cartridge access port : To withdraw cartridges from jukebox slot 7 through 11 to the cartridge access port 5 through 10, use the -w option along with the -S and -P options:

nsrjb w S 7 11 P 5 10

To deposit cartridges into jukebox slot 8 through 10 from the cartridge access port 3 through 5, use the -d option along with the -S and -P options:

nsrjb d S 8 10 P 3 5

Using barcode templates on tape libraries : To add volumes with barcodes D001A, D002A, ..., D100A to the volumes avail- able for NetWorker in the tape library, use the -a and -T options:

nsrjb a T D/001 100/A

To deposit tapes labeled with barcodes D001A, D002A, ..., D012A into the silo and also to make the volumes available for NetWorker in the tape library, use the -a and -T options along with the -d option:

nsrjb a T D/001 012/A d

To remove volume with barcode D055A from the volumes available for Net- Worker in the tape library, use the -x and -T options:

nsrjb x T D055A

To remove volume with barcode D055A from the volumes available for Net- Worker in the tape library, and to withdraw it from the tape library physically (for example, for off-site storage), use the -x and -T options, along with the -w option:

nsrjb x T D055A w

To label volumes with barcodes D010A, D011A, ... , D020A, use the -L and -T options:

nsrjb L T D0/10 20/A

To add cleaning cartridge with barcodes C010A, that can be used the default number of time for this jukebox, use the -U and -T options:

nsrjb U default T C010A

Forcing an unload of all drives on a tape library : nsrjb HH

ENVIRONMENT VARIABLES

NSR_JBOX_POLL_JUKEBOX_OP_STATUS When nsrjb is run to initiate a jukebox operation, a request is submitted to nsrmmgd for execution. Status of the operation is reported by nsrmmgd using a NSR JUKEBOX_OPERATION_STATUS resource. This resource is stored in the RAP database maintained by nsrd. Periodically, nsrjb polls nsrd to deter- mine the status of the request. The default is to poll every 10 seconds. Set this

NetWorker 19.1.1 242

Maintenance Commands nsrjb ( 1m )

environment variable to modify the polling interval. The minimum polling interval is every 5 seconds and the maximum polling interval is every 30 seconds.

FILES /nsr/mm/mmvolume The NetWorker media database.

/nsr/res/nsrdb The conguration database containing resource descriptors.

SEE ALSO jbcong(1m), jbexercise(1m), mminfo(1m), mmlocate(1m), nsr(1m), nsrd(1m), nsrmmgd(1m), nsr_layout(5), nsr_device(5), nsr_jukebox(5), nsr_op(5), nsr_notication(5), nsr_storage_node(5), nsradmin(1m), nsrim(1m), nsrmm(1m), nsrmmd(1m), nsrwatch(1m)

DIAGNOSTICS The exit code returned by the nsrjb command has one of four possible values:

0 (success) A zero exit code indicates successful execution of the command.

1 (not executed) Indicates that the command caused an error that prevented it from being sub- mitted for execution. For example, an invalid command-line argument.

2 (non-retryable) The command was submitted to nsrmmgd for execution, but a "non-retryable" error occurred. For instance, the named volume does not exist.

3 (retryable) The command was submitted to nsrmmgd for execution, but a "retryable" error occurred. For instance, a required drive is busy.

In general, a "retryable" error indicates that if you simply retry the same nsrjb com- mand again, there is a possibility that it would succeed this time. Conversely, a "non- retryable" error indicates that some user intervention is required in order to resolve the issue before the nsrjb command should be retried.

NetWorker 19.1.1 243

Maintenance Commands nsrjobd ( 1m )

NAME nsrjobd NetWorker jobs monitoring daemon

SYNOPSIS nsrjobd

DESCRIPTION The nsrjobd daemon is one of the NetWorker server daemons. It is responsible for spawning and monitoring of jobs of NetWorker client binaries. All executions of save(1m), savefs(1m) and savegrp(1m) are considered jobs. The savegrp is spawned by nsrworkow. Every execution of the binary is considered a separate job. nsrjobd allows for monitoring and long term recording of NetWorker activities. Ultimately, all functionality requiring monitoring or remote execution will be considered a job and handled with help of nsrjobd.

nsrjobd extends the capabilities previously offered by nsrexec. An example of where nsrjobds capabilities are taken advantage of is when savegrp(1m) requires execution of save(1m) and savefs(1m). In addition to the remote spawning, nsrjobd collects run-time information to be used by the NetWorker GUI to report and monitor on both actively running as well as com- pleted jobs.

For storing job related information, nsrjobd maintains its own database in /nsr/res/jobsdb. To prevent this database from constantly growing, there is a reten- tion period placed on the data in the database. Data pertaining to completed jobs will be migrated to an SQL database maintained by the NetWorker GUI, then deemed eligi- ble for purging from the nsrjobds database. The value for the retention period for completed job records is stored in the NSR Resource in nsrds RAP database. It is congurable by the NetWorker server administrator. In contrast to NetWorkers RAP database, nsrjobds database is considered an opaque data store for nsrjobds private use, and thus no tools are provided for manipulating its contents. To query contents of the database while nsrjobd is running, use jobquery(1m) utility. Off-line read only access is possible via nsradmin(1m) with -S option, or -d for versions prior to 8.0.

nsrjobd is started and stopped automatically when nsrd(1m) is started and shut down respectively. It is not meant to be started manually.

nsrjobd uses the client side nsrexecd(1m) for remote execution, so the NetWorker server requesting command execution must be in the clients servers le.

FILES /nsr/res/jobsdb Directory holding nsrjobds database.

SEE ALSO nsrd(1m), nsrexecd(1m) nsradmin(1m) jobquery(1m) nsrgrpcomp(1m)

NetWorker 19.1.1 244

Maintenance Commands nsrlcpd ( 1m )

NAME nsrlcpd NetWorker library control program daemon

SYNOPSIS nsrlcpd s server N mmgd_daemon_num n lcpd_daemon_num

DESCRIPTION The nsrlcpd daemon provides a uniform library interface to the NetWorker media management daemon, nsrmmgd. The nsrlcpd implements class specic protocols to communicate to the NetWorker supported library classes which include:

o SCSI medium changers connected through SCSI cables, bre-channel SANs or NDMP Services.

o Microsoft Removable Storage Subsystems.

o Standard Tape Libraries (STL), sometimes refered to as "SILO" Subsystems.

The nsrlcpd manages the library subsystem media, slot, drive and port resources pro- viding control to move and access the resources within the library subsystems.

The NetWorker media management service starts one nsrlcpd daemon for each virtual jukebox instance dened in the NetWorker servers conguration resource database. Each nsrlcpd daemon will be started on the NetWorker Storage Node which has access to the library subsystem interface. Once the nsrlcpd daemon is started, it provides the ability to:

o Accept conguration information to access and control the library.

o Report library components and characteristics as controllable resources.

o Report accessible media within the library.

o Allocate and deallocate media for use by the NetWorker application.

o Load and unload media into read and writable devices.

o Deposit and withdraw media into the library systems.

The nsrlcpd daemon provides an RPC-based library control program service across network boundaries. The RPC program number for nsrlcpd is 390429. To support mul- tiple instances, the RPC version number used by the nsrlcpd during the RPC service registration is calculated by multiplying 100 by the nsrlcpd daemon number and adding 1, which is the base version. For example, a nsrlcpd process started with the command, "nsrlcpd -s NetWorkerServer -N 1 -n 2" would register with the program number 390429 and the version number 201.

OPTIONS s server Specify the controlling NetWorker server.

N mmgd daemon num Specify the nsrmmgd daemon number.

n lcpd daemon num Specify the nsrlcpd daemon number.

FILES /nsr/logs/daemon.raw The le to which nsrlcpd and other NetWorker daemons send information about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

SEE ALSO nsr(1m), nsr_service(5), nsr_render_log(1m), nsrmmgd(1m)

NetWorker 19.1.1 245

Maintenance Commands nsrlic ( 1m )

NAME nsrlic NetWorker license reporting command

SYNOPSIS nsrlic [ vip ] [ s server ]

nsrlic C L license-le P licspec-le

DESCRIPTION The nsrlic command generates reports about all license information currently active on a NetWorker server. This command queries the NetWorker resource database, and formats and displays the results to standard output.

The nsrlic program reports the following information:

The number of standard client licenses

The number of standard client licenses used

The number of standard client licenses borrowed by virtual client physical nodes

The number of remaining standard client licenses

The list of standard clients connected to the named NetWorker server

The list of standard clients dened in the specied NetWorker server

The number of clients, listed by platform

The attributes of resource type "NSR License"

The nsrlic program reports the following information for virtual client physical hosts and for NDMP clients:

The number of licenses

The number of licenses used

The number of remaining licenses

The list of clients connected to the specied NetWorker server

When applications exist which require licensing, nsrlic also reports them in the same manner. In this case, however, the output will not contain any references unless there are either licenses available, or a connected client is utilizing a license count for such applications.

nsrlic also checks the validity of the license le installed in /nsr/lic.

OPTIONS i Selects interactive mode. In this mode, you can request different reports, refresh the information, or switch to a different server. The information is requested once, and then cached until another connect command is issued.

p Selects single line print mode. In this mode, licensing information is printed in a single line per record with little formatting. Details of all the attributes of resource type "NSR License" are printed, in addition to client licenses.

s server Selects which NetWorker server to query. By default, the server on the local system is queried.

v Selects verbose mode. In addition to the number of licenses (or clients), a list of connected and dened clients is gathered and displayed.

C Checks /nsr/lic/licspec.properties and the license le specied within it. The default is /nsr/lic/dpa.lic. This tests that the license le exists, that its SERVER line species a host and port, that the specied CLP server can be accessed, and what entitlements are provided by that CLP server. Diagnostic messages are printed if any problems are found. The s server option cannot be used with C.

L license-le

NetWorker 19.1.1 246

Maintenance Commands nsrlic ( 1m )

Does the C checks on the given license le. The s server option cannot be used with L.

P licspec-le Does the C checks on the license le specied by the given licspec.properties le. The s server option cannot be used with P.

USAGE The following commands are supported in the interactive mode:

connect [ server ] Connects to the named server. By default, this is the server on the local system.

detail Produces a detailed report. Displays a list of connected clients (clients that have saved to NetWorker) and a list of dened clients (clients that are dened in the NetWorker server, abut not yet saved).

help Displays a list of available commands.

summary Displays a summary report.

? Is the same as online help.

quit Performs an immediate exit from nsrlic.

DIAGNOSTICS nsrlic displays a "usage" message describing the available options when characters are used that are not valid for this command.

command not found Indicates that the attempted command is not supported.

RPC error: Remote system error RPC error: Program not registered Indicates that some problems were encountered while connecting to the Net- Worker server on the specied system. The nsrlic command requires that the NetWorker daemons be running. Start your NetWorker daemons (nsrd) and rerun nsrlic. If nsrd is already running, you have probably reached a resource limit on the server (for example, not enough memory or no more processes).

SEE ALSO nsrd(1m), nsradmin(1m)

NetWorker 19.1.1 247

Maintenance Commands nsrlogd ( 1m )

NAME nsrlogd daemon that provides the NetWorker Security Audit Log service

SYNOPSIS nsrlogd

DESCRIPTION The nsrlogd daemon records messages describing security related events to the Secu- rity Audit Log le. The service records conguration changes of sensitive elds in both the NetWorker client and server, including user passwords and privileges, modication of remote binary executables, changes to authorization methods, as well as log in attempts and failures.

The logging service is congured by the NSR auditlog RAP resource. The NSR audit- log resource is created by default and cannot be deleted. Only users with the Security Administrator role can change the resource on the server. The client maintains a read-only copy of the resource.

The resource can be used to dene which client acts as the host for the nsrlogd dae- mon, the level of detail that the log records at, the size of the log, and how the logs are rendered.

Only one logging service can run in each NetWorker datazone. A single client that belongs to multiple datazones can provide the security audit logging service for each congured client in all of the datazones.

SEE ALSO nsr_auditlog(5), nsr_render_log(1m)

NetWorker 19.1.1 248

Maintenance Commands nsrlogin ( 1m )

NAME nsrlogin NetWorker CLI login utility

SYNOPSIS nsrlogin { s NetWorker_server H authentication_host ] [ P port } [ t tenant ] [ d domain ] [ p password ] [ f ] u user

DESCRIPTION Use the nsrlogin utility to log in to the NetWorker system and perform command line NetWorker operations as an authenticated user. When the NetWorker Authentication Service successfully authenticates the user credentials, the NetWorker Authentication Service generates a token with the appropriate authentication assertions. The authenti- cation assertions are valid for a period of time dened by the NetWorker Authentica- tion Service. After this time elapses, the token expires. The NetWorker server will prevent further operations performed by that user due to authentication failure, until the user is re-authenticated by running the nsrlogin command again.

By default, the nsrlogin command will contact the NetWorker server on localhost to obtain the port number to use to contact local NetWorker Authentication Service. If the s argument is specied, then nsrlogin contacts the identied NetWorker server for connection information. Use H to specify the host name of the NetWorker Authentication Service host. Use P to specify the port number on which to contact the NetWorker Authentication Service. When you do not specify the -H and -P options and nsrlogin cannot contact the NetWorker Authentication Service on localhost, nsrlogin will use standard NetWorker CLI command heuristics to determine which server to use to obtain connection information for the NetWorker Authentica- tion Service. By default, the nsrlogin command is supported only for non-root users. Running as a root user can cause impediments with daemon processes. Use f argue- ment to allow access for a root user.

The NetWorker Authentication Service maintains a local user directory. You can also congure the NetWorker Authentication Service to interact with multiple LDAP or Active Directory identity providers. If you specify an LDAP or AD user name with the nsrlogin command, you must also provide information about the identity provider conguration in the NetWorker Authentication Service database. Use the d argument to specify the domain name and optionally, use the t argument to specify the tenant name. The Security Conguration Guide provides more information about how to congure the NetWorker Authentication Service.

Note: If you specify the tenant name, then you must also specify the domain name. You can specify the domain name without the tenant name, in which case NetWorker Authentication Service uses the default tenant hierarchy to search for the domain. When you do not specify the domain and tenant names, the NetWorker Authentication Service uses the local user directory to verify the user credentials.

OPTIONS d domain Species the name of the domain for the identity provider conguration in NetWorker Authentication Service. When you omit this option, NetWorker Authentication Service uses the local user directory to verify the user creden- tials.

H authentication_host Species the name of the host that runs the NetWorker Authentication Service. Use this option when you do not want to use the Authentication Service on the NetWorker server, or in complex deployments where there are trusts esta- blished between multiple NetWorker servers and NetWorker Authentication Services.

P port Species the port number on which the NetWorker Authentication Service is

NetWorker 19.1.1 249

Maintenance Commands nsrlogin ( 1m )

available.

p password Species the password to send to the identity provider to verify the user. If this argument is not provided nsrlogin will prompt the user to specify the password.

s NetWorker_server Instructs nsrlogin to use the NetWorker Authentication Service local to the NetWorker server to validate user credentials.

t tenant Species the tenant name for the identity provider conguration in the Net- Worker Authentication Service database. Use this argument in multi-tenant congurations to identify the tenant hierarchy from which NetWorker Authen- tication Service should select the specied domain to verify the user creden- tials. When you omit the tenant name, NetWorker Authentication Service uses the default tenant hierarchy.

f Allows nsrlogin to be run as a root user.

u user Required. Species the user string that identies the user, in a format appropriate for the identity provider. The user string may be a username, email address, or another string, depending on conguration of the Identity Provider.

EXAMPLES Log in to the NetWorker server as a user name foo, which is dened in the local user directory with the password bar.

nsrlogin u foo p bar

Log in to the NetWorker server named mars as a user named john, which is dened in the domain HR within the default tenant, with password secret1.

nsrlogin s mars d HR u john p secret1

Log in to the NetWorker server running on host mars as a user named john, which is dened in the domain ENG within the tenant ACME, with password secret1.

nsrlogin s mars t ACME d ENG -u john -p secret1

Exit Codes:

0 Normal exit.

>1 Abnormal exit. User asked for something that is incorrect or the provided credentials were not valid in the specied identity provider.

NetWorker 19.1.1 250

Maintenance Commands nsrlogout ( 1m )

NAME nsrlogout NetWorker CLI logout utility

SYNOPSIS nsrlogout [ f ]

DESCRIPTION Use the nsrlogout utility to revert the effect of executing nsrlogin command for the current user, resulting in the NetWorker command line utilities to operate as an OS authenticated user. Use nsrlogin to return to operate as a user authenticated by the NetWorker Authentication Service.

OPTIONS f Species the force mode. If this option is specied, nsrlogout will perform as much cleanup as possible, disregarding errors encountered in the process.

Exit Codes:

0 Normal exit.

>1 Abnormal exit.

NetWorker 19.1.1 251

Maintenance Commands nsrls ( 1m )

NAME nsrls list statistics of NetWorker index les

SYNOPSIS nsrls [ clientname . . . ]

DESCRIPTION When nsrls is used without any specied options, the number of records in an online index and the usage of the online index with respect to the number of kilobytes allo- cated to its les is printed. Administrators can use this command to establish how many les have been saved by a client.

An empty argument list prints the statistics for all known clients.

EXAMPLE % nsrls jupiter

/space2/nsr/index/jupiter: 292170 records requiring 50 MB /space2/nsr/index/jupiter is currently 100% utilized

SEE ALSO nsr_layout(5), nsrindexd(1m)

DIAGNOSTICS ... is not a registered client The client named is not a valid NetWorker client.

NetWorker 19.1.1 252

Maintenance Commands nsrmm ( 1m )

NAME nsrmm NetWorker media management command

SYNOPSIS nsrmm [ C ][ v q ][ s server ][ f device ]

nsrmm m [ v q ][ s server ][ f device ][ r ][ volume ]

nsrmm l [ v q ][ s server ][ f device ][ myB ][ e forever ][ c capacity ][ o mode ][ b pool ][ R volume ]

nsrmm H f device [ v q ][ s server ][ y ]

nsrmm { u j }[ v q ][ s server ][ y ][ f device volume.. ]

nsrmm p [ v q ][ s server ][ f device ]

nsrmm E [ v q ][ s server ][ f device ][ y ]

nsrmm { d o mode }[ v q ][ s server ][ Py ][ S ssid[/cloneid] V volid volume ... ]

nsrmm S ssid[/cloneid] [ e retention-time ][ y ]

DESCRIPTION nsrmm is a command line interface used by NetWorker servers and storage nodes to manage the media and devices (tapes, disks, and les).

A volume is a physical piece of media, for example, a tape or disk cartridge. When dealing with le type devices, volume refers to a directory on a le system. NetWorker must have exclusive use of this directory, as les will be both created and removed. The NetWorker system keeps track of which user les have been saved on which volumes, so that they can be recovered more easily. Every volume managed by Net- Worker has a volume name (also known as a volume label) which is selected by an operator when the volume is rst introduced into the system. This name can only be changed by relabeling the volume. The volume should have an external label display- ing its volume name for future reference. When using these media devices to perform jobs, NetWorker will refer to them by their volume names (or labels).

The NetWorker system automatically manages an index that maps saved user les to volumes. NetWorker also records other attributes associated with a volume, including the expected capacity of the volume.

The NetWorker server can request the mounting of a specic volume (by name) for a recovery, or any writable volume(s) for a save. These requests are submitted through the nsr_notication(5) mechanism. NetWorker Management Consoles Administra- tion window or the nsrwatch(1m) command can be used to monitor pending mount requests. Typically, the requests will also be either written to the system console or logged in a le. The same requests can be used as input for software that controls a jukebox (a device that automatically loads and unloads volumes).

Before the nsrmm command can be used (that is, before any data can be saved or recovered), at least one device must be congured for the NetWorker server. The Net- Worker conguration may be modied with NetWorker Management Consoles Administration window or the nsradmin(1m) command after NetWorker has been installed.

OPTIONS B Veries that the volume you want to label does not have a readable Net- Worker label. Before labeling the volume, an attempt is made to read any existing label that the volume may already possess. If you specify this option, and the volume has a valid, readable NetWorker label, then the label operation is canceled and an error message will be displayed. The volume may only be labeled if it does not already possess a readable label. This option is used by nsrd(1m) when automatically labeling volumes on behalf of nsrmmd(1m) requests.

NetWorker 19.1.1 253

Maintenance Commands nsrmm ( 1m )

b pool Species the pool to which the volume belongs. b pool can name any pool currently registered with nsrd. The possible values can be viewed by selecting Media Pools from the left pane of NetWorker Management Consoles Media display or by using the nsradmin(1m) command. The pool name is referenced by nsrd when determining which save sets can reside on the volume. If you omit this option, the volume is automatically assigned to the Default pool. If you specify a pool name without specifying a volume name, the next volume name associated with the pools label template resource is used.

C Displays a list of NetWorker congured devices and the volumes currently mounted in them. This list displays only the devices and volumes assigned to the server, not necessarily all the actual devices and volumes that are attached. The p option veries the volume label. C is the default option.

c capacity Overrides the default capacity of a volume. NetWorker normally uses built-in default capacities based on the device type. This option overrides these defaults. The format of the specication is number multiplier . Multiplier can be one of K (1024 bytes), M (1000 KB), or G (1000 MB). Lower case letters are also accepted, as are extra characters like spaces, or an extra B after K, M, or G. Number may be any value, including an integer or real number, with up to three decimal places.

d Deletes the client le indexes and media database entries from the NetWorker databases. It can be used in conjunction with S ssid/cloneid to delete a specic saveset. Note that the ssid used can be the long format, to avoid ambiguity. The long format of ssid can be obtained by running the mminfo with r "ssid(53)". The mminfo manpage has details of this usage. The action does not destroy the volume, but instead removes all references used by NetWorker to the volume and the user les contained on it. This option can be used to con- trol the size of the NetWorker databases.

E Erases the media in a device, including the label and all NetWorker directory structures. This feature is implemented for Data Domain and adv_le devices.

e time When used in conjunction with the S option, it sets the clone retention time of the specied save set or save set clone instance. The retention time should be specied in the format that is acceptable to the function nsr_getdate(1m). If a clone identier is not specied, all clone instances will be updated with specied clone retention time. The save set retention time will reect the long- est recoverable clone instance retention time. However, the save set retention time may not be set such that the save set would become recyclable while it is still browsable. When used in conjunction with volumes, the volume labeled will be an Archive volume if the value of time is forever (Archive volumes mean that the volume label never expires). Any other values of time are not applicable to a volume.

f device Species a device explicitly. When more than one device has been congured, nsrmm will select the rst device by default. This option overrides the selec- tion made by nsrmm.

H Performs a software reset on the given device. Ongoing operations on the given device will be interrupted, which can sometimes result in data loss. This option resets the internal Networker device state, not the physical device.

j Ejects a volume from the device. This option is similar to performing an unmount operation, except that the volume is also physically ejected from the device, if possible. This feature is not supported by some device types, disk

NetWorker 19.1.1 254

Maintenance Commands nsrmm ( 1m )

devices, and tapes. CAUTION: the j option should be used only on devices that are in idle mode -- using the j option on an active device may cause a core dump.

l Labels (initializes) a volume for NetWorker to use and recognize. Labeling must be performed after the desired volume is physically loaded into the dev- ice, either by an operator or a jukebox. When more than one enabled device exists, specify [ f device ] to indicate which device to use for the label opera- tion.

m Mounts a volume into a device. Mounting is performed after a volume is placed into a device and labeled. You can mount only labeled volumes. When more than one enabled device exists, specify [ f device ] to indicate which dev- ice to use for the mount operation. The labeling and mounting operations can be combined into a single command line. See the EXAMPLES section.

o mode Sets the mode of a volume, save set, or save set clone instance. The mode can be one of the following: [not]recyclable, [not]readonly, [not]scan, [not]full, [not]offsite, [not]manual or [not]suspect. The [not]recyclable mode applies only to volumes, save sets and save set clone instances. Setting a volume to recyclable will also set the volume to full. A volume becomes recyclable when all the save sets on that volume become recyclable. A save set is recyclable when all the save set clone instances become recyclable. Therefore, setting the last not recyclable save set clone instance to recyclable can cause the save set and volume to also become recyclable. Setting a recyclable save set clone instance to not recyclable will also force the associated save set and volume to become not recyclable. If a save set is not recyclable, at least one save set clone instance must be not recyclable. So, if all clone instances of a saveset have expired, and a particular clone instance needs to be recovered, that particular saveset clone instance needs to have its clone retention time reset to the future, by using the -e option along with -S ssid/cloneid , before the saveset can be made notrecyclable. Setting a save set to not recyclable is not recommended, since once a save set becomes recyclable it is possible that all of the volumes for an associated save set have been overwritten. Once a save set becomes recyclable, all associated save sets are not guaranteed to be available for recovery. For example, if an incremental save set depends on a full save set. The full save set will not be marked recyclable until all dependent save sets have also past their retention times. However, once the all the associated save sets have passed their retention times, all the save sets becomes recyclable. Any one of the save sets can be overwritten. Setting all the remaining save set not recyclable does not guarantee a complete recovering of the original data. Set- ting a save set not recyclable will only set the clone instances that have not past their retention time back to recyclable. The [not]readonly, [not]scan, [not]offsite, [not]full and [not]manual modes apply only to volumes. The [not]manual mode is the only valid mode when used with the l option. The [not]suspect mode applies only to save set clone instances, meaning it must be specied along with S ssid/cloneid , not just S ssid by itself. (Remember that every instance of a save set has a clone identier, even the original.) See nsrim(1m) for a discussion of the per-volume ags. The suspect ag is set automatically when a recover(1m) encounters a media error recovering data from a particular save set clone.

P When used in conjunction with the d option the corresponding le index entries are purged, without deleting the entries in the media database. The scanner(1m) command can then be used to recover the le index entries.

NetWorker 19.1.1 255

Maintenance Commands nsrmm ( 1m )

p Veries and prints a volumes label. To conrm that the external volume label matches the internal label, load a volume into a drive and use this option to display the volume name in the label. Verifying a label unmounts mounted volumes.

q Quiet mode. This option tells nsrmm to print out as little information as pos- sible while performing the requested operation. Generally, only error mes- sages are printed.

R Relabels a volume. This option rewrites the volume label and purges the Net- Worker indexes of all user les previously saved on the volume. Some of the volume usage information is maintained.

r Mounts a volume as read-only. To prevent NetWorker from writing to a volume, specify the read-only ag when mounting the volume. Volumes marked as full and those in the read-only mode ( o readonly) are automatically mounted read-only.

s server Species the NetWorker server to perform the nsrmm operation on. See nsr(1m) for a description of server selection.

S ssid Changes (specied with o) or removes (specied with d) a save set from the NetWorker databases, or used in changing the retention time (specied with e) of the specied save set record. Note that using the long format of the ssid can avoid amibiguity. The long format of ssid can be obtained by running the mminfo with r "ssid(53)". Check mminfo manpage for details on how to query and report a saveset record in long format. The save set is identied by a save set identier, ssid . A save set instance, or clone, can be specied using the format ssid/cloneid. The mminfo(1m) program may be used to determine save set and clone identiers.

u Unmounts a volume. A volume should always be unmounted before you unload it from a device.

V volid Removes a volume from the NetWorker databases when used in conjunction with the d option. The volume is identied by a volume identier, or volid . The mminfo(1m) command can be used to determine volume identiers.

v Verbose mode. This option polls the NetWorker server to print out more information as the operation proceeds.

y Do not conrm (potentially destructive) operations before performing them. This option must be used with extreme care.

EXAMPLES Labeling new tapes : To introduce a new tape, named mars.001, to the NetWorker system, load the tape in an empty drive, then use the command:

nsrmm l mars.001

The tape is labeled with mars.001 and an entry is made in the appropriate Net- Worker indexes. The mminfo(1m) command may be used to inspect the volume database and display information about the volumes:

mminfo m

Mounting a tape : To mount a NetWorker volume, use the m option. Note that the volume must have been labeled previously and loaded in the drive:

nsrmm m

NetWorker 19.1.1 256

Maintenance Commands nsrmm ( 1m )

When mounting, a volume name can also be specied: nsrmm m mars.001

The mount will fail unless the given volume name matches the one read from the media.

By mounting a volume, you make the volume available to NetWorker. When nsrmmd(1m) needs the volume, the label will be read again and conrmed, preventing accidental data loss. Volumes are also veried and mounted automatically if the server recovers after a crash.

Labeling and mounting a tape : A volume may be labeled and mounted with a single nsrmm command by combining the m and l options. The following example labels a volume as mars.003 and mounts it on device /dev/nrst0:

nsrmm m l f /dev/nrst0 mars.003

Unmounting or ejecting a volume : When a volume needs to be unmounted, use either the u or j option, depending on whether or not the device can physically eject a volume.

nsrmm u

When more than one volume is mounted, you can specify either the volume name or device to select the desired volume. The following example ejects the volume named mars.003.

nsrmm j mars.003

Displaying the current volumes : The C option displays the congured devices and the mounted volumes. This is the default option.

nsrmm C

Deleting a volume : To remove references to a volume and the user les saved on it from the Net- Worker indexes, use the d option. This option does not modify the physical volume, and should only be used when the physical volume is destroyed. By deleting a volume, you free up space in the NetWorker le index and the Net- Worker media index, but not much more than if you had purged it. The amount of space released depends on the number of user les saved on the volume. The following example deletes the volume mars.003:

nsrmm d mars.003

The scanner(1m) command can be used to rebuild the database entries.

Purging le index entries : The le index contains information about each le saved by NetWorker. Due to size constraints, it may be necessary to purge information from the le index. When a volume or save set is deleted, the corresponding le index entries are also removed. It is also possible to preserve the media database entries of a volume while purging the le index by specifying the P option when deleting.

The following example purges all of the le index entries for volume mars.001: nsrmm d P mars.001

The scanner(1m) command can be used to recover the le index.

SEE ALSO nsr(1m), nsr_getdate(3), nsr_layout(5), nsr_device(5), nsr_notication(5), mminfo(1m), mmlocate(1m), nsrmmd(1m), nsradmin(1m), nsrim(1m), recover(1m), scanner(1m)

NetWorker 19.1.1 257

Maintenance Commands nsrmm ( 1m )

DIAGNOSTICS type family volume mounted on device , write enabled Message indicating that the m (mount) option was successfully performed on a device with the given media type and media family , for example, 8mm tape.

saveset is not a valid save set id The given save set identier is not in the valid format. The format is either a single number (for the save set without reference to its instances), or two numbers separated by a slash (/) (representing a save set and clone (instance) identier pair).

duplicate name; pick new name or delete old one It is illegal to label two tapes with the same name. If you wish to reuse a name, remove that volume from the index using the d option.

Are you sure you want to over-write volume with a new label? An attempt is being made to relabel a volume. A positive conrmation will overwrite the existing data on that tape.

Purge le index entries for type family volume? ... After conrmation, the le index entries are removed.

volume not in media index The media index has no entry associated with volume, so the m command cannot be used. This problem may be caused by mistyping the volume name when the tape was originally labeled, or deleting it.

No valid family label The tape or disk in the named device does not have a valid NetWorker label.

NetWorker 19.1.1 258

Maintenance Commands nsrmmd ( 1m )

NAME nsrmmd NetWorker media multiplexor daemon

SYNOPSIS nsrmmd n number b lowest nsrmmd number N nsrsnmd daemon number [ D debug level ][ s server ] [ t storage node ] [ r NDMP server ] [ v ]

DESCRIPTION The nsrmmd daemon is the storage node daemon and is responsible for network save and recover media multiplexing operations.

The nsrmmd daemon does the following:

o Receives backup information from the NetWorker client.

o Writes data to the devices (volumes).

o Sends tracking information to the NetWorker server to track the data written to the devices (volumes).

o Reads the data from the devices (volumes) at the request of the client during a recovery.

The nsrmmd RPC program ID is 390104 and the daemon version number is 5. To sup- port multiple instances of nsrmmd (if the Concurrent Device Support feature is enabled), the daemon numbers are incremented by 100. The rst daemon registered is 105, then 205, and so on.

One nsrmmd per enabled device is started automatically by nsrd. Additional nsrmmd daemons can be started when a mount request is pending. To change the number of daemons, alter the number of enabled devices.

OPTIONS n number Specify the daemon number.

b lowest nsrmmd number The lowest nsrmmd daemon number allowed on this storage node.

N nsrsnmd daemon number The daemon number for the managing nsrsnmd process.

D debug level Sets the debug level.

s server Specify the controlling server. This option is used on a storage node (see nsr_storage_node(5)).

t storage node Specify the name of the storage node this nsrmmd process is associated with. One nsrmmd cannot be associated with more than one storage node.

r NDMP server Some nsrmmd programs run on the server but are controlling a device attached to a Network Data Management Protocol (NDMP) system. Such instances of nsrmmd have an optional r argument specifying the system that is being controlled.

v Verbose: Print out messages about what the daemon is doing.

SEE ALSO nsr(1m), nsr_layout(5), nsr_service(5), nsr_storage_node(5), nsrd(1m), nsrmm(1m), mm_data(5)

NetWorker 19.1.1 259

Maintenance Commands nsrmmdbasm ( 1m )

NAME nsrmmdbasm NetWorker module for saving and recovering media databases

SYNOPSIS nsrmmdbasm [ sta nda r d-a sm -a r gum ents ]

DESCRIPTION The nsrmmdbasm is a standard, external ASM (Application Specic Module) that assists in the saving and recovering of the NetWorker media multiplexors database les.

See uasm(1m) for a general description of ASMs and the [sta nda r d-a sm -a r gum ents]. It is intended that nsrmmdbasm only be invoked by nsrmmdbd(1m) or nsrdr(1m) opera- tions.

Features of nsrmmdbasm performance specic to the NetWorker application during a save are:

Architecture independence: The high speed access methods and data structures implemented by the data- base code are machine-dependent. This ASM saves only the records (and not access indexes) in an architecture-independent manner. Therefore, NetWorker media databases may be saved from one machine architecture and recovered to another.

Conservation: Since only changed records are saved, and not internal indexes, considerable network bandwidth and tape space are conserved.

The recover operation of this ASM is the inverse of the save operation.

FILES /nsr/mm/.nsr This directive le causes most les in the directory to be skipped during normal save operations. nsrmmdbasm ignores this direc- tive.

/nsr/mm/mmvolrel The directory containing the media database which is saved and recovered by this ASM.

/nsr/mm/mmvolrel.r A temporary le that stores the contents of a recovered media database until nsrmmdbd(1m) has completed building a new media database.

/nsr/mm/mmvol<n> A temporary le that this ASM reads when backing up data. The unique le name is generated by appending , a six digit hex number, to the le name.

/nsr/mm/mmvolrel.<t> A temporary copy of the /nsr/mm/mmvolrel directory used as a snapshot during nsrmmdbasm save operations. A unique directory name is generated by appending a timestamp , to the directory name. The directory is deleted once the media database save completes.

/nsr/mm/volume.tmp A temporary le created when converting an older media data- base schema to the present schema during recovery.

SEE ALSO nsr(5), nsr_layout(5), nsrdr(1m), nsrmmd(1m), nsrmmdbd(1m), nsrindexasm(1m), recover(1m), savegrp(1m), nsrworkow(1m), uasm(1m)

NetWorker 19.1.1 260

Maintenance Commands nsrmmdbd ( 1m )

NAME nsrmmdbd NetWorker media management database daemon

SYNOPSIS nsrmmdbd

DESCRIPTION The nsrmmdbd daemon provides an RPC-based database service to the nsrd(1m) and nsrmmd(1m) daemons, and query-only access to the NetWorker clients. The RPC pro- gram number provided by nsrmmdbd is 390107. The RPC version numbers provided by nsrmmdbd are 3, 4, and 5. Nsrmmdbd is normally started by nsrd(1m).

The daemon manages a volume, save set and client id database located in the direc- tory /nsr/mm/mmvolrel. The primary purpose of the database is to remember which save sets reside on which backup volumes. The database also provides the client name mapping to the internally used client identier. Numerous access methods are pro- vided to save set, volume and client id map records within the database.

FILES /nsr/mm/mmvolrel Directory containing the media database in relational format. This con- tains the active media database after migration or a new installation.

/nsr/mm/mmvolume6 Directory containing the media database in legacy format. This contains the active media database prior to migration or after an unsuccessful migration.

/nsr/mm/cmprssd For performance and space reasons, the database is periodically rebuilt (or compressed). This le is created each time the database is compressed; its associated ctime is used to determine the next time that the database will be compressed. The database compression can be invoked by removing this le and running nsrim. This is not recom- mended while the NetWorker server is actively saving or recovering data.

/nsr/mm/mmvol<n> This temporary le is created to hold the media database information that will be saved to a volume by nsrmmdbasm(1m). A unique le name is generated by utilizing , a 6 digit hex number appended as part of the le name.

/nsr/mm/mmvolrel.r The le (created by nsrmmdbasm) that is read when the media database information is being recovered.

/nsr/mm/volume.tmp A temporary directory created when recovering or compressing the media database.

/nsr/mm/nsrim.prv An empty le is used to track the last time that the program nsrim was started to perform maintenance on the NetWorker databases.

/nsr/logs/daemon.raw The le to which Networker daemons writes the log messages.

SEE ALSO nsrdr(1m), nsr(1m), nsrd(1m), nsrim(1m), nsrmmd(1m), nsrmmdbasm(1m), nsrmm(1m), nsr_render_log(1m), mminfo(1m)

NetWorker 19.1.1 261

Maintenance Commands nsrmmdbd ( 1m )

DIAGNOSTICS The nsrmmdbd diagnostic messages will normally be logged to the /nsr/logs/daemon.raw le.

Besides the messages listed below, nsrmmdbd may generate other diagnostics. Many are only informational in nature. If a diagnostic indicates a serious problem with the media database, it may be necessary to recover the media database using the nsrdr(1m) command.

Media database will be migrated from legacy to relational storage. A media database created prior to the NetWorker 8.5 release will be migrated (once) to the new database format.

Media database successfully migrated clients clients, volumes volumes, and savesets save sets. Printed when the conversion is completed successfully, indicating the quantity of each object type that was migrated.

Original media database has been renamed to name. At the end of migration, the original media database directory is preserved with a different name. This directory may be removed at the administrators discretion.

Migration unsuccessful Printed when the migration or rename does not complete successfully. A more detailed reason may be appended to the message. NetWorker will attempt to continue operation using the original database. Migration will be re-attempted the next time NetWorker is started.

The media database is saving its data; this may take a while. Printed when the daemon is exporting its records to a temporary le for backup. When using the new relational database format, the service remains available for other operations.

The media database is recovering; this may take a while. Printed when the daemon is reloading its database. The service is unavailable while the data is being reloaded.

media db is checking and rebuilding btrees Printed each time the daemon is restarted when using a database in legacy for- mat. Upon start-up, the daemon performs sanity checks on the database search indexes.

media db is consistency checking the database Printed each time the daemon is restarted. Upon start-up, after the database search indexes are checked, the database is checked for incomplete records.

media db is open for business Printed after consistency checking or recovery to indicate that the service is once again available.

media db is closed Printed after the media database is successfully shutdown.

A copy of this process is already running! Another copy of nsrmmdbd(1m) is currently running and has exclusive access to the media database. Only one nsrmmdbd process should be running on a given machine at a time. This can happen if the previous nsrmmdbd was not properly killed off. Use nsr_shutdown(1m) or ps(1) and kill(1) to identify and kill off all the NetWorker daemons before restarting nsrd(1m) again.

Cannot open lock le An internal error, check the permissions on the /nsr/tmp and /nsr/mm direc- tories.

NetWorker 19.1.1 262

Maintenance Commands nsrmmgd ( 1m )

NAME nsrmmgd NetWorker daemon that manages jukebox operations

SYNOPSIS nsrmmgd

DESCRIPTION The nsrmmgd daemon provides an RPC-based service that manages all jukebox opera- tions on behalf of the nsrd NetWorker server.

The nsrd server maintains all of the RAP resources that describe the state of any jukeboxes and their associated devices, pools, and operations. The nsrmmgd daemon is the process that is responsible for ensuring that the necessary jukebox operations actually get performed when needed by nsrd.

nsrmmgd runs on the same host as the nsrd server, and there will be at most one such daemon running. Multiple nsrlcpd daemons (one per enabled jukebox) may be started and controlled by nsrmmgd to handle the lower-level control of, and interface to, the various jukeboxes. The nsrlcpd processes that nsrmmgd manages may be distributed across multiple hosts, since nsrlcpd runs on the host that the jukebox is on.

The nsrmmgd daemon is invoked automatically by nsrd when needed, and never needs to be started directly by a user. If nsrd detects that there are any jukeboxes congured and enabled, then it will start nsrmmgd as part of the nsrd startup process. If no jukeboxes are enabled when nsrd starts up, then nsrmmgd will not be started until such time as a jukebox resource gets added, or an existing disabled jukebox resource is enabled.

The RPC program number for nsrmmgd is 390430.

FILES /nsr/logs/daemon.raw The le to which nsrmmgd and other NetWorker daemons send informa- tion about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

SEE ALSO nsr(1m), nsr_service(5), nsr_render_log(1m), nsr_op(5), nsrd(1m), nsrlcpd(1m)

NetWorker 19.1.1 263

Maintenance Commands nsrmon ( 1m )

NAME nsrmon command to remotely control NetWorker commands and daemons

SYNOPSIS nsrmon

DESCRIPTION The nsrmon command is run only by NetWorker daemons. nsrd(1m) starts the com- mand to remotely control other commands and daemons on NetWorker storage nodes running nsrexecd(1m). Commands and daemons started remotely include nsrjb(1m) and nsrmmd(1m). See nsr_storage_node(5) for additional detail on storage nodes.

SEE ALSO nsr(1m), nsr_storage_node(5), nsrd(1m), nsrexecd(1m), nsrjb(1m) nsrmmd(1m)

NetWorker 19.1.1 264

Maintenance Commands NSRNASSNAP ( 1m )

NAME nsrnassnap NetWorker client side module to perform NAS device snapshot manage- ment

SYNOPSIS nsrnassnap [ vx ] [ s server ] [ c client ] < g group > [ f dirle ] [ x save-options ] [ path . . . ]

DESCRIPTION nsrnassnap command is a NetWorker client side command used by savegrp to per- form NAS device snapshot management related commands for le system and applica- tion backups. The savegrp is spawned by nsrworkow. NOTE: running nsrnassnap directly is not recommended; use nsrworkow(1m) instead.

savegrp(invoked by nsrworkow) invokes nsrnassnap on the NetWorker Client instead save for Networker groups which are congured to use snapshots. nsrnassnap per- forms four key functions namely retention, snapshot based backup, live-backup, and retry mechanism.

nsrnassnap queries media database for enforcing retention policy. It uses nsrnassnapck binary for performing snapshot deletion and snapset expiration.

If nsrnassnap is started with r option, nsrnassnap will perform a live-backup opera- tion after the snapshot based backup. nsrnassnap always uses nsrndmp_save to do a live-backup.

A snapshot based NetWorker group will start nsrnassnap to perform its retry logic. nsrnassnap will follow the same steps to create snapshot based backups and live- backup.

OPTIONS c client-name Species the NAS device name for starting the save session.

f dirle The le from which to read prototype default directives (see nsr(5)). A dirle of causes the default directives to be read from standard input.

g group This option is used by savegrp(1m) and savefs(1m) to denote the group of the save (see nsr_client(5) and nsrworkow(5)) and is used by the NetWorker server to select the specic media pool.

s server Species which machine to use as the NetWorker server.

v Causes the save program to provide additional detail about the save as it proceeds.

x save-options Savegrp can pass extra options to nsrnassnap_save or the application with this argument, and nsrnassnap will pass down the save-option to nsrnassnap_save or the application without parsing.

path Specify the NAS device path names to be backed up.

SEE ALSO nsr_client(5), nsrworkow(5), nsrd(1m), recover(1m), save(1m), savefs(1m), savegrp(1m), nsrworkow(1m), nsrnassnap_recover(1m), nsrnassnap_save(1m), nsrsnapadmin(1m)

DIAGNOSTICS Exit Codes 0 Normal exit. This means that a save set was correctly created on the server. <>0 Abnormal exit. A save set was not correctly created on the server.

NetWorker 19.1.1 265

Maintenance Commands NSRNASSNAPCK ( 1m )

NAME nsrnassnapck NetWorker NAS snapset validation and deletion utility.

SYNOPSIS nsrnassnapck [ s server ] [ vy ] [ c client-name ]

nsrnassnapck [ s server ] [ c client-name ] [ vy ] d S ssid [ S ssid ]...

DESCRIPTION nsrnassnapck is a NetWorker client utility to delete and validate NAS snapsets. If the d option is not specied, the binary nds all the snapsets corresponding to the NAS device (client-name) specied. It then validates the snapsets and if the snapsets are not valid, they are deleted.

OPTIONS c client-name client-name is the name of the NAS device.

d Delete the specied snapsets.

s server Selects which NetWorker server to use. The default value is the local machine.

S ssid Species which Snapset ID to operate on.

v Verbose. More information is printed if this option is specied.

y Dont prompt for user input for deletion. By default the user is prompted before deleting the snapset.

EXAMPLES To delete saveset IDs 2654636090 7637858874 for a client of the NetWorker server jupiter, the command will be:

nsrnassnapck -s jupiter -d -S 2654636090 -S 7637858874

NetWorker 19.1.1 266

Maintenance Commands NSRNASSNAP_DISCOVER ( 1m )

NAME nsrnassnap_discover NetWorker client command to perform NAS device snapshot discovery

SYNOPSIS nsrnassnap_discover [ v ] [ s server ] [ c client ] [ G debug-level ]

DESCRIPTION nsrnassnap_discover command is a NetWorker client command to perform NAS dev- ice snapshot discovery.

OPTIONS c client-name Species the NAS device name for starting the discovery operation.

s server Species which machine to use as the NetWorker server.

v Causes the save program to provide additional detail about the save as it proceeds.

DIAGNOSTICS Exit Codes 0 Normal exit. This means that the discovery completed successfully. <>0 Abnormal exit. Discovery did not complete successfully.

NetWorker 19.1.1 267

Maintenance Commands NSRNASSNAP_INDEX ( 1m )

NAME nsrnassnap_index NetWorker client command to perform NAS device snapshot con- tent indexing.

SYNOPSIS nsrnassnap_index [ v ] [ s server ] [ c client ] [ G debug-level ] S ssid

DESCRIPTION nsrnassnap_index command is a NetWorker client command to perform NAS device snapshot content indexing.

OPTIONS c client-name Species the NAS device name for starting the index operation.

s server Species which machine to use as the NetWorker server.

v Verbose. Causes the save program to provide great detail about the save as it proceeds.

SEE ALSO nsr_client(5), nsr_protection_group(5), nsrd(1m), nsrnassnap_recover(1m), nsrnassnap_save(1m), nsrsnapadmin(1m) recover(1m), save(1m), savefs(1m), savegrp(1m), nsrworkow(1m)

DIAGNOSTICS Exit Codes 0 Normal exit. This means that a save set was correctly indexed on the server. <>0 Abnormal exit. A save set was not correctly indexed on the server.

NetWorker 19.1.1 268

Maintenance Commands NSRNASSNAP_RECOVER ( 1m )

NAME nsrnassnap_recover recover NetWorker les created from NAS-based snapshot back- ups.

SYNOPSIS nsrnassnap_recover [ b basepath ] [ c client_name ] [ d destination ] [ f metadata_le ] [ n namespace ] [ s server ] [ R recovery host ] [ i {NYR} ] [ G debug_level ] [ I input_le ] [ M data_mover_host ] [ K metadata_key ] [ P ] [ S ssid t savetime ] path . . .

DESCRIPTION nsrnassnap_recover can be used to recover data from a NAS-based snapshot save set.

nsrnassnap_recover allows users to recover data from a point-in-time NAS-based snapshot. It is not mandatory to specify an attribute list to nsrnassnap_recover. NOTE: running nsrnassnap_recover directly is not recommended for snap set or save set recovery; use nsrsnapadmin(1m) instead.

The user needs to specify either the save set ID or the save set time.

The user has to specify the les to be recovered on the command line. However all the les have to belong to the same save set.

OPTIONS b basepath Species the base pathname to use for relative path names. Used with the I option.

c client_name Species the client name for starting the recover session.

d destination Species the destination directory to relocate recovered les.

f metadata_le Species the le name to which metadata information is recovered.

n namespace Species a namespace for recover.

s server Selects which NetWorker server to use.

t savetime Species a savetime of save set for the save set to be recovered.

R recovery host Species the client name that receives the recovered data.

i conicting le action Species the overwrite response to use when recovering existing les. Only one letter may be specied. The default behavior will be to overwrite the les, if this option is not provided. 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. Valid values are N, Y, and R.

G debug_level Species the debug level to use. debug_level is a number between 0-9.

I input_le Species an input le of les to recover. See also b.

In addition to taking the paths to recover from the command line, read paths to recover from the named le. The paths must be listed one per line. If no paths are specied on the command line, then only those paths specied in the le will be recovered.

NetWorker 19.1.1 269

Maintenance Commands NSRNASSNAP_RECOVER ( 1m )

nsrnassnap_recover allows the restore of more than one saveset per restore ses- sion. Use of the I command line option allows input le specication of saveset IDs and associated le paths to be recovered. If neither the S nor t option is specied on the command line with I, the contents of the specied input le will be expected to have a different format, and will be interpreted differently. In such cases, nsrnassnap_recover will expect each line of the input le to have the following format: ssid=

Each line of the le must identify a single le path to be restored, and the ID of the saveset that it will be restored from. For example: ssid=4145682356 /vol/hosts ssid=4145682356 /vol/vfstab ssid=4188238921 /vol/motd

White space will be the delimiter for the two values specied on each line. In cases where a le path contains white space, the path must be surrounded by double quotes. For example: ssid=4874309231 "/My File Directory/mytestdoc.doc"

Other than S and t, all options that are available on the nsrnassnap_recover command line will apply to all saveset restores for savesets listed in the input le. For example, if an alternate destination path is specied with d, all les from all the specied savesets will be restored to the same alternate destina- tion. Also, if the b option is specied, the value specied will be used as the base path for all les specied in the input le.

When using this feature, you must ensure that all the savesets specied in the input are of the same type, since what you specify on the command line will apply to all savesets that are listed in the le. The type of storage array must be the same for all savesets listed as well. Errors will likely occur if you do not follow this guideline.

M data_mover_host The name of the computer that would be used to mount/access the snapshots. If this option is not specied, the local computer is assumed to be the data mover host.

K metadata_key Species metadata key for recover metadata.

P Recovers parent directory permissions.

S ssid Species the save set ids for the save set to be recovered.

SEE ALSO nsr_client(5), nsr_protection_group(5), nsrd(1m), nsrnassnap(1m) nsrnassnap_save(1m), nsrsnapadmin(1m), recover(1m), save(1m), savefs(1m), savegrp(1m), nsrworkow(1m)

EXAMPLES nsrnassnap_recover s ledma243 c ledma011 S 4088878394 /FS1

DIAGNOSTICS Exit Codes 0 Normal exit. <>0 Abnormal exit. The command failed.

NetWorker 19.1.1 270

Maintenance Commands NSRNASSNAP_SAVE ( 1m )

NAME nsrnassnap_save create a snapshot based backup for a NAS device le system and backup snapshots to long-term storage.

SYNOPSIS nsrnassnap_save [ qSuv ] [ s server ] [ c client-name ] [ e expiration ] [ f dirle ] [ G debug-level ] [ I input_le ] [ g group ] [ l level ] [ w browse_time ] [ path . . . ]

DESCRIPTION nsrnassnap_save can be used to backup data on a NAS device le system to a save set.

OPTIONS c client-name Species the NAS device name for starting the save session.

e expiration Set the date (in nsr_getdate(3) format) when the saved data will expire.

f dirle The le from which to read prototype default directives (see nsr(5)). A dirle of causes the default directives to be read from standard input.

g group This option is used by savegrp(1m) and savefs(1m) to denote the group of the save (see nsr_client(5) and nsrworkow(1m)) and is used by the NetWorker server to select the specic media pool.

i nsrnassnap_save will ignore this option.

l level The level of the save. This option is used by savegrp(1m) and savefs(1m) to specify a particular level for a scheduled save.

q Quiet. Displays only summary information and error messages.

s server Species which machine to use as the NetWorker server.

u Stop the save if an error occurs. The save program normally treats errors as warnings and continues to save the rest of the les in the backup. When this option is set, errors will cause save to exit and abort the save. This option is not recommended for general use, although it can be useful when a group of les needs to be backed up as a set.

v Verbose. Causes the save program to provide great detail about the save as it proceeds.

w browse_time Sets 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. This option allows overriding the existing policies on a save by save basis.

I input_le In addition to taking the paths to save from the command line, read paths to save from the named le. The paths must be listed one per line. If no paths are specied on the command line, then only those paths specied in the le will be saved.

S Allows only save set recovery. This performs the save without creating any index entries. This means that the save set will not be browsable, although save set recovery may be used to recover the data.

path Specify the saveset names on the NAS device to be backed up.

NetWorker 19.1.1 271

Maintenance Commands NSRNASSNAP_SAVE ( 1m )

SEE ALSO nsr_client(5), nsrworkow(1m), nsrd(1m), nsrnassnap(1m) nsrnassnap_recover(1m), nsrsnapadmin(1m), recover(1m), save(1m), savefs(1m), savegrp(1m)

EXAMPLES nsrnassnap_save s ledma243 c ledma011 /fs1

DIAGNOSTICS Exit Codes 0 Normal exit. This means that a save set was correctly created on the server. <>0 Abnormal exit. A save set was not correctly created on the server.

NetWorker 19.1.1 272

Maintenance Commands nsrndmp_clone ( 1m )

NAME nsrndmp_clone use NetWorker and Network Data Management Protocol(NDMP) to perform save set cloning

SYNOPSIS nsrndmp_clone [ v ] [ p ] [ s server ] [ J recover-storage-node-name + ] [ b pool ] ] y retention ] { f le volname... }

nsrndmp_clone [ v ] [ p ] [ s server ] [ J recover-storage-node + ] [ b pool ] [ y retention ] S { f le ssid[/cloneid]... }

nsrndmp_clone [ v ] [ p ] [ s server ] [ J recover-storage-node + ] [ b pool ] [ y retention ] S t start time [ e end time ] [ c client name ] [ g group name ]

nsrndmp_clone [ v ] [ p ] [ s server ] [ J recover-storage-node + ] [ b pool ] [ y retention ] S e end time [ t start time ] [ c client name ] [ g group name ]

nsrndmp_clone [ v ] [ p ] [ s server ] [ J recover-storage-node + ] [ b pool ] [ y retention ] V { f le volid... }

The nsrndmp_clone program makes new copies of existing save sets. These copies are indistinguishable from the original, except for the volume(s) storing the copies. The copies are placed on different media volumes, allowing for higher reliability than a sin- gle copy provides. The copies may be made onto any kind of media (for example, save sets on an 8mm tape may be copied to an LGTO Ultrium 2 tape). However, all media used as the destination of an nsrndmp_clone operation must be in a clone pool . See nsr_pool(1m) for a description of the various pool types.

Although the command line parameters allow you to specify volume names or volume identiers, nsrndmp_clone always copies complete save sets. Save sets that begin on a specied volume will be completely copied, so volumes may be requested during the cloning operation in addition to those specied on the command line. Conversely, save sets residing on the specied volumes that begin elsewhere are not cloned.

Note that nsrndmp_clone does not perform simple volume duplication , but rather, copies full save sets to a set of destination volumes in a given pool. If the rst destina- tion volume chosen cannot hold all of the save sets to be copied, another volume will be chosen. This allows you to use different kinds of media for each copy, allowing for variable sized volumes, such as tapes.

The nsrndmp_clone program, in conjunction with nsrmmd(1m), guarantees that each save set will have at most one clone on a given volume. When you specify a volume name or identier, the copy of the save sets on that volume are used as the source. When save sets are specied explicitly, those with existing multiple copies are automatically chosen (copies of save sets that exist on volumes in a jukebox are chosen over those that require operator intervention). You can also specify which copy (clone) of a save set to use as the source (see the S option description, in the Options sec- tion).

The nsrndmp_clone program can also be used to clone regular NetWorker savesets over NDMP. This is accomplished via the use of the p option. The resulting clone savesets in this case are known as opaque savesets (their clone ag shows o in the mminfo report). NetWorker treats opaque save sets the same way as regular save sets when dealing with data recovery and scanning.

Cloning between storage nodes is accomplished by an NDMP Tape Server on the source node reading from a volume, and another NDMP Tape Server on the target node writing to a volume. The source node is determined by the location of a source volume; where the volume is currently mounted, or by its "location" eld if unmounted (see mmlocate(1m)). The target node of a clone is determined by the

NetWorker 19.1.1 273

Maintenance Commands nsrndmp_clone ( 1m )

"clone storage nodes" attribute of the client resource in descending priority. See nsr_storage_node(5) and nsr_client(5) for additional detail on how these attributes are used and for other storage node information.

If the save set to be cloned was backed up by nsrndmp_save via nsrdsa_save (i.e. the save sets ags have N and s), then use nsrclone to clone these save sets; they are cloned to any NetWorker storage device other than an NDMP tape device. Cloning from a non-NDMP tape device to an NDMP tape device, and vice-versa, is not sup- ported. See mminfo(1m) for more details on the N and s save set ags.

OPTIONS b pool Species the media pool to which the destination clones should be sent. The pool may be any pool currently registered with nsrd(1m) that has its status set to clone . The possible values can be viewed by selecting Media Pools from the left pane of NetWorker Management Consoles Media display. If you omit this option, the cloned save sets are automatically sent to the Default Clone pool.

f le Instructs nsrndmp_clone to read the volume names, volume identiers or save set identiers from the le specied, instead of listing them on the command line. The values must be listed one per line in the input le. The le may be "-", in which case the values are read from standard input.

s server Species a NetWorker server. See nsr(1m) for a description of server selection. The default is the current system.

J storage-node Species the NetWorker recover storage node. You must use this option to specify the source for the clone, for Path-To-Tape cloning.

v Enable verbose operation. In this mode, additional messages are displayed about the operation of nsrndmp_clone, such as save sets that cross volumes, or save set series expansions.

p Enable cloning of regular NetWorker savesets over NDMP.

y retention Sets the date (in nsr_getdate(3) format) when the cloned data will become recyclable. The special value forever is used to indicate that a volume that never expires (i.e. an archive volume) must be used. By default, the server determines this date for the save set based on the retention policies in effect. This option allows overriding the existing policies.

S Causes nsrndmp_clone to treat subsequent command line parameters as save set identiers, not volume names. Save set identiers are unsigned numbers. You can nd out the save set identier of a save set using the mminfo -v com- mand (see mminfo(1m)). The S option is useful when you want to copy indi- vidual save sets from a volume or all save sets matching an mminfo query (see the examples below). The save set identiers may also specify exactly which copy of a save set with multiple copies to use as the source. To specify exact copies, use the ssid/cloneid format for each save set identier. In this case, the ssid and the cloneid are unsigned numbers, separated by a single slash (/). You can nd out the cloneid for a particular copy by using the mminfo -S report, or a custom report.

V Causes nsrndmp_clone to treat subsequent command line parameters as volume identiers, not volume names. Volume identiers can be found using the mminfo -mv report, for example. This option can not be used in conjunc- tion with the S option.

e end time

NetWorker 19.1.1 274

Maintenance Commands nsrndmp_clone ( 1m )

Specify the end time (in nsr_getdate(3) format) for selecting save set IDs for cloning. This option can only be used with -S option. If not specied, end time is set as current time. Please note that, -e 0 is same as -e today.

t start time Specify the start time (in nsr_getdate(3) format) for selecting save set IDs for cloning. This option can only be used with -S option. If not specied, start time is set as end time - 24 hours. Please note that, -t 0 is same as -t today. When specifying a time range, at least -t or -e option must be specied.

c client name If client name is specied, only the save sets belonging to that client will be selected. More than one client name can be specied by using multiple -c options. This option can only be used with -t or -e option.

g group name If a group name is specied, only the save sets belonging to that group will be selected. Only one group name can be specied. It can be used with -c option. This option can only be used with -t or -e option.

EXAMPLES Copy all save sets that begin on the volume mars.001 to a volume in the Offsite Clone pool:

nsrndmp_clone b Offsite Clone mars.001

Copy all complete save sets created during the previous weekend (recall that nsr_getdate(3) dates without time-of-day match midnight at the beginning of that day). Only complete save sets can be copied by nsrndmp_clone(1m):

nsrndmp_clone -S mminfo r ssid \ -q !incomplete,savetime>last saturday,savetime<last monday

Copy a specic clone of a specic save set: nsrndmp_clone -S 1538800517/770700786

Copy all save sets created between time 01/21/05 14:50:03 and 01/24/05 14:50:03 for the group Default

nsrndmp_clone -S -t 01/21/05 14:50:03 -e 01/24/05 14:50:03 \ -g Default

Copy all save sets created in the last 24 hours for clients "rose" and "seam". nsrndmp_clone -S -e now -c rose -c seam

Clone a specic regular NetWorker save set 3517744106 over NDMP to a volume in the ndmpclone pool:

nsrndmp_clone -p -b ndmpclone -S 3517744106

SEE ALSO nsrclone(1m), nsrndmp_save(1m), nsrndmp_recover(1m), nsr_getdate(3), nsr_pool(5), nsr_storage_node(5), mminfo(1m), nsr(1m), nsrd(1m), nsrmmd(1m)

DIAGNOSTICS The exit status is zero if all of the requested save sets were cloned successfully, non- zero otherwise.

Several messages are printed signaling that nsrd(1m) is unavailable for cloning data; these are self-explanatory. You may also see a message from the following list.

adding save set series which includes parent ssid If running in verbose mode, this message is printed when nsrndmp_clone notices that a requested save set is continued, requiring the entire series to be cloned (even if only part of the series was specied in the command line parameters).

adding save set series which includes descendent ssid If running in verbose mode, this message is printed when nsrndmp_clone

NetWorker 19.1.1 275

Maintenance Commands nsrndmp_clone ( 1m )

notices that a requested save set is a continuation, requiring the entire series to be cloned.

Cannot contact media database The media database (and most likely other NetWorker services as well) on the named server is not answering queries. The server may need to be started, or if it was just started, it needs to nish its startup checks before answering queries.

cannot clone save set number , series is corrupt The given save set is part of a save set series (used for saving very large les or lesystems), but not all of the save sets in the series were found in the media database. This can happen if, for example, you relabel a tape that con- tains part of a save set series.

cannot open nsrndmp_clone session with server This message is printed when the server does not accept clone sessions.

cloning not supported; upgrade required Another enabler is required to use this feature.

cloning requires at least 2 devices Cloning requires at least one read/write device and one read-only or read/write device, since data is copied from one volume directly to another.

server does not support cloning The named server is not capable of cloning.

each clone host needs at least two enabled devices When cloning between two storage nodes that share the same physical drive, each node must have at least two enabled devices.

error, no valid clones of ssid number The listed save set exists, but cannot be cloned because there are no complete copies of the save set. The save set was either aborted or is in progress. Only complete save sets can be copied.

error, user username needs to be on administrator list error, user username needs to be on archive users list

Only NetWorker administrators are allowed to make clones of backup save sets. NetWorker administrators are listed in the NSR server resource, see nsr_service(5) for more information.

no complete save sets to clone Only complete save sets can be copied, and no complete save sets were found matching the requested command line parameters.

number is not a valid save set The given save set identier is not valid. Two forms are understood: simple save set identiers and those with a cloneid specied. Simple save sets are unsigned numbers. The save set with the cloneid form is specied as two unsigned numbers separated by a single slash (/).

pool is not a cloning pool The pool specied with the b pool option is not a clone pool. You must always use a pool with a type of "Backup Clone" for the b option.

Volume name has clone; requesting additional volumes This message is printed in verbose mode when a specied save set has already been cloned to the volume specied in the error message. Since a save set can have at most one clone per volume, nsrndmp_clone automatically requests additional volumes.

NetWorker 19.1.1 276

Maintenance Commands nsrndmp_clone ( 1m )

save set number does not exist The given save set (from a S save set list) does not exist. Verify your save set identiers using mminfo(1m).

save set number crosses volumes; requesting additional volumes This message is printed in verbose mode when volume names or IDs were specied, but the given save set is only partially resident on the listed volumes. Since only complete save sets can be cloned, nsrndmp_clone automatically requests additional volumes.

save set clone number/cloneid does not exist A specic clone of a save set was specied, but that save set has no clones with that clone identier. Verify your save set identiers using mminfo(1m).

volume name-or-number does not exist The given volume (either a volume name or a volume id specied in the V option) does not exist in the media database.

waiting 30 seconds then retrying A temporary error occurred and nsrndmp_clone will automatically retry the request until the condition is cleared. For example, an error will occur if all devices are busy saving or recovering and nsrndmp_clone must wait for these devices become available.

NetWorker 19.1.1 277

Maintenance Commands nsrndmp_recover ( 1m )

NAME nsrndmp_recover use NetWorker and Network Data Management Protocol (NDMP) to recover data

SYNOPSIS nsrndmp_recover [ c client ] [ s server ] [ J storage-node ] [ R recover-target ] [ O stderr-le ] [ f ] { -r raw device -S ssid[/cloneid] -m mount point [ -v { on off } ] [ paths [ paths... ] ] -F }

DESCRIPTION nsrndmp_recover is used to coordinate recover operations with NetWorker and a Net- work Data Management Protocol(NDMP) system. Only the super-user may run this com- mand. There are two ways to recover data: destructive recovers and le-level recovers. Destructive recovers occur when a raw partition is specied by the r option along with a save set ID ( S) option. Only a single save set can be specied at a time since the target raw device pathname must be specied. Users may opt to use the adminis- trative user interface, to perform the destructive recover operation through the save set recover window. Users can determine save set IDs using the user interfaces or the mminfo(1m) command. File level recovers are specied by the F option in conjunc- tion with the use of the recover(1m) command. Users should not specify this option.

The status of a recover can be monitored using the Java based NetWorker Manage- ment Console or the curses(3X) based nsrwatch(1m) program for other terminal types. Only volume information is available at this time. The amount of data that has been recovered is not provided.

nsrndmp_recover is not responsible for moving data on the NDMP system. All such activity is handled by the NDMP system. nsrndmp_recover receives messages from the NDMP system and processes them appropriately. Such messages could request a new tape be mounted or to post a log message. Refer to the NDMP specication and documentation available at www.ndmp.org for more details.

In order to recover data from another system, make sure the user performing the nsrndmp_recover operation is on the remote access attribute list of the client resource. See nsr_client(5).

Supports recovering data from a NetWorker storage device, if the save set was backed up by nsrndmp_save via nsrdsa_save. The Nsrndmp_recover program will spawn nsrdsa_recover locally if the save sets ags are identied to have N and s. See mminfo(1m) for more details on N and s save set ags. Notes: It should be noted that browsers such as recover and winworkr will spawn nsrndmp_recover locally. Therefore, for better performance, try to launch browsers based on a volume location that has save sets to be restored. For instance, if a backup was performed to a NetWorker storage node that is different from the NetWorker server, launch the browser on the NetWorker storage node for better performance. If the browser is launched on the NetWorker server, data will ow from the NetWorker storage node to the NetWorker server and from the NetWorker server to the NDMP system. All command line options mentioned below apply for recovering from Net- Worker storage node as well.

OPTIONS c client Client is the name of the machine that saved the les.

F Species that a le-level recovery is going to be performed. This option should only be specied by recover(1m).

m mount point Species the destination directory to relocate recovered les. If no mount point is specied, the data will be restored to its original location.

NetWorker 19.1.1 278

Maintenance Commands nsrndmp_recover ( 1m )

Notes: If the NDMP Server is SnapImage, the mount point of the raw device should be specied by the -r option. The lesystem will be unmounted for the recover operation and mounted after the operation is complete.

r raw device This option species the pathname of the raw device the data is to be recovered to. This option should only be used for destructive recovers with the SnapImage product.

R recover-target This option species the name of the destination host the data will be recovered to. If no recover-target is specied, the data will be restored to the source host.

s server This option selects which NetWorker server to use.

J storage-node This option selects which NetWorker storage node to use.

S ssid[/cloneid] This mandatory option is used to specify save set recover mode. This mode can be used to implement fast batch le recovery without requiring the Net- Worker le index entries. ssid species the save set ID for the save set to be recovered. When there are multiple clone instances for a save set, the cloneid can also be specied to select the particular clone instance to be recovered from. The cloneid of a particular saveset can be obtained from mminfo(1m) output.

When no path arguments are specied, the entire save set contents will be recovered. One or more path arguments can be specied to limit which direc- tories and les are actually recovered. If path arguments are supplied, the beginning of each path name, as it exists in the save set, must exactly match one of the path arguements before it will be recovered. Shell-like lename matching, using meta characters like , ?, and [...], is not supported.

v on off This option species the value of the verify ag. If the verify ag is turned on then, prior to sending to ndmp server for recovery, the existance of paths in the index database, for the given save set ID, will be veried. Only those entries that are found in the index database would be sent to the NDMP server for recovery. On other hand, if the verify ag is off, paths would be sent across to the NDMP server without verication. The default value of this ag is on.

O stderr-le This option causes nsrndmp_recover to reopen the stderr descriptor on the le supplied with this option. This option is useful on platforms that dont allow stderr to be redirected to a le.

f This option is used to force the use of IPv4 addresses for NDMP data connec- tion during recover operation.

EXAMPLES Sub-directory level restore to original location. nsrndmp_recover -s server -c client -S ssid[/cloneid]

/fs/dir1 /fs/dir2 /fs/dir3 /fs/dir4/le1 ... When indexes are not available for the specied paths nsrndmp_recover -s server -c client -S ssid[/cloneid]

-v off /fs/dir1 /fs/dir2 /fs/dir3 ...

NetWorker 19.1.1 279

Maintenance Commands nsrndmp_recover ( 1m )

Restore to the original location nsrndmp_recover -s server -c client -S ssid[/cloneid]

Relocate to a different location on the client nsrndmp_recover -s server -c client -S ssid[/cloneid]

-m /destdir where /destdir is the destination directory on the client

Relocate to a different location on the remote host nsrndmp_recover -s server -c client -S ssid[/cloneid]

-m /destdir -R desthost OR nsrndmp_recover -s server -c client -S ssid[/cloneid]

-m desthost::/destdir where desthost is another NDMP Client congured in the NW server

Destructive restore with SnapImage nsrndmp_recover -s server -c client -S ssid[/cloneid]

-m /mntpoint -r /dev/rdsk/c2t2d0s1

DIAGNOSTICS Skipping le due to incomplete save set: /core The user has marked a le that is associated with an incomplete save set. The user should run nsrim -X to resynchronize the le index and media database.

Entry /core not found in index, skipping The user specied a directory / le (/core), in the path arguments, which could not be found in the index database. The user should run nsrndmp_recover from the command line, with v off, if it is necessary to bypass this check. This can be useful if the indexes were lost but the data still exists in backup media.

SEE ALSO mminfo(1m), nsr_client(5), nsrndmp_save(1m), recover(1m),

NetWorker 19.1.1 280

Maintenance Commands nsrndmp_save ( 1m )

NAME nsrndmp_save use NetWorker and Network Data Management Protocol (NDMP) to save data

SYNOPSIS nsrndmp_save T backup-type c client-name [ LL ] [ M ] [ P Proxy-host ] [ I Index-host ] [ g group ] [ l level ] [ b pool ] [ m masquerade ] [ N name ] [ s server ] [ J storage-node ] [ t date ] [ e expiration ] [ w browse_time ] [ y retention_time ] [ W width ] [ k checkpointid ] [ O stderr-le ] [ f ] path

DESCRIPTION nsrndmp_save coordinates the backup process with NetWorker and a target Network Data Management Protocol(NDMP) system. Only the super-user may run this command. The user must specify backup type , client-name , server , and path.

The behavior of the backup depends on the NDMP system being protected. Certain environment variables may be needed depending upon the target system. Documenta- tion for such backups should be consulted for more details.

The status of a backup can be monitored using the Java based NetWorker Manage- ment Console or the curses(3X) based nsrwatch(1m) program, depending on your ter- minal type.

nsrndmp_save is not responsible for moving data on the NDMP system. All such activity is handled by the NDMP system. nsrndmp_save receives messages from the NDMP system and processes them appropriately. Such messages could request that a new tape be mounted or a new le index entry be created. Refer to the NDMP specication and documentation available at www.ndmp.org for more details.

Details about handling media are discussed in nsrmm(1m) and nsr_device(5).

In order to save data for another system, make sure the user performing the nsrndmp_save operation is on the remote access attribute list of the client resource. See nsr_client(5).

OPTIONS c client-name Species the client name for starting the save session. This is useful on clients with multiple network interfaces, and hence multiple host names. It can be used to create multiple index databases for the same physical client. Note that this does not specify the network interface to use. This is specied in the server network interface attribute of the client resource. See nsr_client(5).

M An NDMP client will be backed up to a NetWorker storage node by the nsrdsa_save program. This option provides most of the NetWorker storage node features, such as backup to disk, multiplexing, automedia verication, and staging. The nsrndmp_save program spawns nsrdsa_save locally. A Net- Worker storage node hostname should be listed in the "storage nodes" attri- bute of servers client-name resource. Notes: Save sets that are backed up by nsrndmp_save (via nsrdsa_save) will be treated as regular NetWorker save set and will have the save set ags Net- Worker storage node. See mminfo(1m) for more details.

P proxy-host nsrndmp_save spawns nsrdsa_save on Proxy-host. Proxy-host must be a valid NetWorker client and should be listed in the remote access list of the client- name resource. This host will act as a proxy to NDMP Data Server to receive the data and save it to NetWorker storage device. This option is valid only with -M.

I index-host Used by savegrp to spawn nsrndmp_save on Index-host. Index-host must be a

NetWorker 19.1.1 281

Maintenance Commands nsrndmp_save ( 1m )

valid NetWorker client and should be listed in the remote access list of client- name resource. This host is designated to perform NDMP backup initiation and index processing. This host must have Operate NetWorker privileges.

This parameter is accepted but must be ignored by nsrndmp_save. The reason for this is nsrndmp_saves command line is specied in the Networker client resource. savegrp accesses the client resource and examines nsrndmp_saves command line before starting nsrndmp_save. If the -I ag is present savegrp knows to start nsrndmp_save on the node named index-host. Once nsrndmp_save has been started there is no further need for the ag and its argument but, it is passed on to nsrndmp_save which needs to ignore it.

g group Is used by savegrp(1m) and savefs(1m) to denote the group of the save. See nsr_client(5) and nsrworkow(1m). It is also used by the NetWorker server to select the specic media pool.

l level Indicates the level of the save. This option is used by savegrp(1m) and savefs(1m) to specify a particular level for a scheduled save. Valid values are: full, incr, and 1 through 9 inclusive. The incr option is only supported when used with NDMP servers that support token based backups using the NDMP BASE_DATE/DUMP_DATE backup environment variables. Currently Net- work Appliance and EMC Celerra lerservers are recognized as supporting this. For other NDMP servers an incremental backup is forced to a full backup and a message noting this is included in nsrndmp_saves output. When the level value incr is specied the -t option must also be included and must specify the save time of a previously produced full or incremental backup. See the -t option for additional information. If the NDMP servers implementation is lower than version 4, incremental backups are forced to full backups.

When the level values 1-9 are specied nsrndmp_save will use the NDMP servers native dump levels 1-9 if there is no token based backup support. If the NDMP server does support token based backups, then the -t option species the savetime of a previously created saveset and the current backup will contain les created or modied since the previous backup. If token based backups are supported and -t is not specied the requested level backup will be forced to a full backup.

b pool Valid values are: full, incr, and 1 through 9 inclusive. The incr option is only supported when used with NDMP servers that support token based backups using the NDMP BASE_DATE/DUMP_DATE backup environment variables. Currently Network Appliance and EMC Celerra lerservers are recognized as supporting this. For other NDMP servers an incremental backup is forced to a full backup and a message noting this is included in nsrndmp_saves output. When the level value incr is specied the -t option must also be included and must specify the save time of a previously produced full or incremental backup. See the -t option for additional information. If the NDMP servers implementation is lower than version 4, incremental backups are forced to full backups.

When the level values 1-9 are specied nsrndmp_save will use the NDMP servers native dump levels 1-9 if there is no token based backup support. If the NDMP server does support token based backups, then the -t option species the savetime of a previously created saveset and the current backup will contain les created or modied since the previous backup. If token based backups are supported and -t is not specied the requested level backup

NetWorker 19.1.1 282

Maintenance Commands nsrndmp_save ( 1m )

will be forced to a full backup. Species a particular destination pool for the save.

L When two L options are specied, this option causes an extra line to be printed at the end of the form complete savetime=number, where number is the savetime of the save set created by this backup. Used by savegrp(1m).

m masquerade Species the tag to precede the summary line. This option is used by savegrp(1m) and savefs(1m) to aid in savegrp summary notications.

n Provide an estimate of the size of the backup. This option is not supported but is accepted to be compatible with savegrp(1m). If this option is specied no estimate is produced and no backup is performed.

N name Indicates the symbolic name of this save set. By default, the most common prex of the path arguments is used as the save set name. The indexes get stored against the actual path name.

q Indicates quiet. Not supported, but provided for compatibility.

s server Species which machine to use as the NetWorker server.

J storage-node Species which machine to use as the NetWorker storage node.

t date Indicates the date (in nsr_getdate(3) format) after which les must have been modied before they will be saved. This option is used by savegrp(1m) and savefs(1m) to perform scheduled saves by consulting with the media database to determine the appropriate time value based on the previous saves for the save set and the level of the scheduled save. nsrndmp_save lists a valid (but cryptic) date that may be used in future runs requesting an incremental backup. Look for an output line like: "nsrndmp_save: browsable save- time=1290539475". The large number is the save time and may be used with this option.

T backup-type The type of backup the NDMP server should perform, for example dump , tar, cpio , smtape , or celestra . The backup-type value supplied with this ag is dependent on the type of NDMP client being backed up. Check the NDMP clients vendor documentation to discover what values may be supplied with the NDMP backup environment variable TYPE. Valid values for the TYPE variable may be specied with -T.

e expiration Set the date (in nsr_getdate(3) format) when the saved data will expire. When a save set has an explicit expiration date, the save set remains both browsable and non-recyclable until it expires. After it expires and it has passed its browse time, its state will become non-browsable. If it has expired and it has passed its retention time, the save set will become recyclable. The special value forever is used to indicate that a volume which never expires (i.e. an archive or a migration volume) must be used. By default, no explicit expira- tion date is used.

w browse Sets the date (in nsr_getdate(3) format) after which the saved data will no longer be browsable. By default, the server determines the browse date for the save set based on the browse policies in effect. This option allows for the over- riding of the existing policies on a save-by-save basis.

NetWorker 19.1.1 283

Maintenance Commands nsrndmp_save ( 1m )

y retention Sets the date (in nsr_getdate(3) format) when the saved data will become recyclable. The special value forever is used to indicate that a volume which never expires (an archive or a migration volume) must be used. By default, the server determines this date for the save set based on the retention policies in effect. This option allows for the overriding of the existing policies on a save-by-save basis.

W width The width used when formatting summary information output.

k checkpointid Requests that a checkpointed backup be performed if the NDMP data server being backed up supports it. A checkpointed backup is paused periodically to remember the current state of the backup. If the backup is interrupted, it can be resumed from the point of the last checkpoint. The rst backup of a check- pointed backup is performed with a checkpoint id argument of zero. As part of the backup the checkpoint id for the backup will be printed out. If the backup is interrupted before completion it can be resumed by specifying the checkpoint id from the output of the previous interrupted backup. The check- point id remains the same until the backup completes either in failure or suc- cess.

O stderr-le This option causes nsrndmp_save to reopen the stderr descriptor on the le supplied with this option. This option is useful on platforms that dont allow stderr to be redirected to a le.

f This option forces the use of IPv4 addresses for data connection during a backup operation.

The savegrp is spawned by nsrworkow.

SEE ALSO curses(3X), mminfo(1m), nsr_getdate(3), nsr_client(5), nsr_device(5), nsrworkow(1m), nsr_service(5), nsrd(1m), nsrim(1m), nsrindexd(1m), nsrmm(1m), nsrmmd(1m), nsrndmp_recover(1m), nsrwatch(1m), recover(1m), savefs(1m), savegrp(1m)

NetWorker 19.1.1 284

Maintenance Commands nsrpolicy ( 1m )

NAME nsrpolicy NetWorker policy administration program

SYNOPSIS nsrpolicy policy create { policy_name policy_name p policy_name } [ com m en t user_comment c user_comment ] [ -ser v er NetWorker_server s NetWorker_server ] [ notication_action notication_command T notication_command ] [ notication_execute_on n ot i cat ion_ev en t x notication_event ] [ restricted_data_zone R est r ict ed_Dat a_Z on e Z Restricted_Data_Zone ]

nsrpolicy policy delete { policy_name policy_name p policy_name } [ ser v er N et W or k er_ser v er_n am e s NetWorker_server ]

nsrpolicy policy display { policy_name policy_name p policy_name } [ ser v er N et W or k er_ser v er_n am e s server ]

nsrpolicy policy update { policy_name policy_name p policy_name } [ com m en t user_comment c user_comment ] [ ser v er NetWorker_server_name s NetWorker_server ] [ notication_action notication_command T notication_command ] [ notication_execute_on n ot i cat ion_ev en t x notication_event ]

nsrpolicy policy list [ server server s server ]

nsrpolicy workow create { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } [ com m en t user_comment c user_comment ] [ st ar t start_time S start_time ] [ in t er v al interval i interval ] [ en d end_time e end_time ] [ au t o_st ar t Yes/No u Yes/No ] [ en ab le Yes/No E Yes/No ] [ { gr ou p_n am e group_name g group_name } ] [ r est ar t_w in d ow restart_window_time r restart_window_time ] [ ser v er NetWorker_server_name s NetWorker_server ] [ notication_action notication_command T notication_command ] [ notication_execute_on n ot i cat ion_ev en t x notication_event ]

nsrpolicy workow delete { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } [ ser v er NetWorker_server_name s NetWorker_server ]

nsrpolicy workow display { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } [ ser v er NetWorker_server_name s NetWorker_server ]

nsrpolicy workow update { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } [ w or k ow_n ew n am e new_workow_name W new_workow_name ] [ [ com m en t user_comment c user_comment ] [ st ar t start_time S start_time ] [ in t er v al interval i interval ] [ en d end_time e end_time ] [ au t o_st ar t Yes/No u Yes/No ] [ en ab le Yes/No E Yes/No ] [ gr ou p_n am e group_name g group_name ] [ r est ar t_w in d ow restart_window_time r restart_window_time ] [ ser v er NetWorker_server_name s NetWorker_server ] [ notication_action notication_command T notication_command ] [ notication_execute_on n ot i cat ion_ev en t x notication_event ]

NetWorker 19.1.1 285

Maintenance Commands nsrpolicy ( 1m )

nsrpolicy workow list { policy_name policy_name p policy_name } [ server server s server ]

ACTION_CREATE_COMMON { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } { act ion_n am e action_name A action_name } [ com m en t user_comment c user_comment ] [ en ab le Y es/N o e Yes/No ] [ concurrent Y es/N o C Yes/No ] [ d r iv en_b y_act ion action_name d action_name ] [ act ion_st ar t t im e action_start_time M action_start_time ] [ on_f ailu r e action_failure_impact F action_failure_impact ] [ in act iv it y action_inactivity_timeout I action_inactivity_timeout ] [ act ion_p ar allelism action_parallelism j action_parallelism ] [ retries act ion_r et r ies R action_retries ] [ retry_delay act ion_r et r y_d elay E action_retry_delay ] [ schedule_activity act ion_sch ed u le_act iv it y t action_schedule_activity ] [ schedule_override act ion_sch ed u le_ov er r id e O action_schedule_override ] [ schedule_period act ion_sch ed u le_p er iod P action_schedule_period ] [ sch ed u le_com m en t action_schedule_comment K action_schedule_comment ] [ h ar d_lim it Time_after_action_starts_to_begin_terminating_all_activities H Time_after_action_starts_to_begin_terminating_all_activities ] [ sof t_lim it Time_after_action_starts_to_stop_starting_new_activities S Time_after_action_starts_to_stop_starting_new_activities ] [ ser v er NetWorker_server_name s NetWorker_server ] [ notication_action notication_command T notication_command ] [ n ot i cat ion_ex ecu t e_on n ot i cat ion_ev en t x notication_event ]

nsrpolicy action create check-connectivity ACTION_CREATE_COMMON [ all_clients_must_succeed Yes/No m Yes/No ]

nsrpolicy action create probe ACTION_CREATE_COMMON [ probe_must_succeed Yes/No m Yes/No ]

BACKUP_ACTION_CREATE_COMMON [ storage_node st or age_n od e_n am e g storage_node_name ] [ retention_period b ack u p_r et en t ion_p er iod r backup_retention_period ] [ su ccess_t h r esh old Backup_action_child_success/failure_level u Backup_action_child_success/failure_level ] [ d est in at ion_p ool pool_name o pool_name ]

nsrpolicy action create backup traditional ACTION_CREATE_COMMON BACKUP_ACTION_CREATE_COMMON [ backup_estimate Yes/No k Yes/No ] [ v er if y_sy n t h et ic_f u ll Yes/No v Yes/No ] [ revert_to_full Y es/N o z Yes/No ]

nsrpolicy action create backup snapshot ACTION_CREATE_COMMON BACKUP_ACTION_CREATE_COMMON [ minimum_retention backup_minimum_retention_period m backup_minimum_retention_period ]

nsrpolicy action create backup vmware ACTION_CREATE_COMMON BACKUP_ACTION_CREATE_COMMON [ vba_name name_of_a_VBA v name_of_a_VBA ] [ u se_v b a_st or age Yes/No G Yes/No ] [ t y p e_of_v m w ar e_b ack u p VMDK/VirtualMachine V VMDK/VirtualMachine ]

nsrpolicy action create backup vmware vproxy

NetWorker 19.1.1 286

Maintenance Commands nsrpolicy ( 1m )

ACTION_CREATE_COMMON BACKUP_ACTION_CREATE_COMMON [ v p r ox y_n am e name_of_a_vProxy v name_of_a_vProxy ] [ quiesce_app a ] [ quiesce_script_path p at h q path ]

nsrpolicy action create clone ACTION_CREATE_COMMON [ destination_pool_name pool_name o pool_name ] [ retention r et en t ion_p er iod r retention_period ] [ d elet e_sou r ce Yes/No u Yes/No ] [ st or age_n od e storage_node_name n storage_node_name ] [ d est in at ion_st or age_n od d est in at ion_st or age_n od e_n am e i destination_storage_node_name ] [ lt er_ex clu d e Yes/No G Yes/No ] [ lt er_clien t client_name1, client_name2... Q client_name1, client_name2... ] [ lt er_lev el level B level ] [ lter_start_time >= st ar t_t im e X >= start_time ] [ lt er_en d_t im e <= end_time J <= end_time ] [ lt er_sav eset_t y p e sn ap sh ot /p r ot ect p oin t L snapshot/protectpoint ]

nsrpolicy action create discover-nas-snap ACTION_CREATE_COMMON

nsrpolicy action create index-nas-snap ACTION_CREATE_COMMON

nsrpolicy action create vba-checkpoint-discover ACTION_CREATE_COMMON

nsrpolicy action create vba-checkpoint-backup ACTION_CREATE_COMMON { destination_pool pool_name o pool_name } { driven_by_action act ion_n am e d action_name } [ retention_period r retention_period ]

nsrpolicy action delete { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } { act ion_n am e action_name A action_name } [ server N et W or k er_ser v er_n am e s NetWorker_server ]

nsrpolicy action display { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } { act ion_n am e action_name A action_name } [ server N et W or k er_ser v er_n am e s NetWorker_server ]

ACTION_UPDATE_COMMON { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } { act ion_n am e action_name A action_name } [ action_newname act ion_n ew n am e N action_newname ] [ com m en t user_comment c user_comment ] [ en ab le Yes/No e Yes/No ] [ con cu r r en t Yes/No C Yes/No ] [ d r iv en_b y_act ion action_name d action_name ] [ action_starttime act ion_st ar t_t im e M action_start_time ] [ on_f ailu r e action_failure_impact F action_failure_impact ] [ in act iv it y action_inactivity_timeout I action_inactivity_timeout ] [ act ion_p ar allelism action_parallelism j action_parallelism ] [ r et r ies action_retries R action_retries ] [ retry_delay act ion_r et r y_d elay E action_retry_delay ] [ schedule_activity act ion_sch ed u le_act iv it y t action_schedule_activity ] [ schedule_override act ion_sch ed u le_ov er r id e O action_schedule_override ] [ schedule_period act ion_sch ed u le_p er iod P action_schedule_period ] [ sch ed u le_com m en t action_schedule_comment K action_schedule_comment ] [ h ar d_lim it Time_after_action_starts_to_begin_terminating_all_activities H Time_after_action_starts_to_begin_terminating_all_activities ] [ sof t_lim it Time_after_action_starts_to_stop_starting_new_activities S Time_after_action_starts_to_stop_starting_new_activities ] [ ser v er

NetWorker 19.1.1 287

Maintenance Commands nsrpolicy ( 1m )

N e t W o r k e r_se r v e r_n a m e s NetWorker_server ] [ notication_action notication_command T notication_command ] [ n ot i cat ion_ex ecu t e_on n ot i cat ion_ev en t x notication_event ]

nsrpolicy action update check-connectivity ACTION_UPDATE_COMMON [ all_clients_must_succeed Yes/No m Yes/No ]

nsrpolicy action update probe ACTION_UPDATE_COMMON [ probe_must_succeed Yes/No m Yes/No ]

BACKUP_ACTION_UPDATE_COMMON [ storage_node st or age_n od e_n am e g storage_node_name ] [ retention_period b ack u p_r et en t ion_p er iod r backup_retention_period ] [ su ccess_t h r esh old Backup_action_child_success/failure_level u Backup_action_child_success/failure_level ] [ { d est in at ion_p ool pool_name o pool_name ]

nsrpolicy action update backup traditional ACTION_UPDATE_COMMON ACTION_BACKUP_UPDATE_COMMON [ backup_estimate Yes/No k Yes/No ] [ v er if y_sy n t h et ic_f u ll Yes/No v Yes/No ] [ revert_to_full Y es/N o z Yes/No ]

nsrpolicy action update backup snapshot ACTION_UPDATE_COMMON ACTION_BACKUP_UPDATE_COMMON [ m in im u m_r et en t ion m backup_minimum_retention_period ]

nsrpolicy action update backup vmware ACTION_UPDATE_COMMON ACTION_BACKUP_UPDATE_COMMON [ vba_name name_of_a_VBA v name_of_a_VBA ] [ u se_v b a_st or age Yes/No G Yes/No ] [ t y p e_of_v m w ar e_b ack u p VMDK/VirtualMachine V VMDK/VirtualMachine ]

nsrpolicy action update backup vmware vproxy ACTION_UPDATE_COMMON ACTION_BACKUP_UPDATE_COMMON [ vproxy_name name_of_a_vProxy v name_of_a_vProxy ] [ quiesce_app a ] [ quiesce_script_path p at h q path ]

nsrpolicy action update clone ACTION_UPDATE_COMMON [ destination_pool_name pool_name o pool_name ] [ retention r et en t ion_p er iod r retention_period ] [ d elet e_sou r ce u Yes/No ] [ st or age_n od e storage_node_name n storage_node_name ] [ d est in at ion_st or age_n od d est in at ion_st or age_n od e_n am e i destination_storage_node_name ] [ lt er_ex clu d e Yes/No G Yes/No ] [ lt er_clien t client_name1, client_name2... Q client_name1, client_name2... ] [ lt er_lev el level B level ] [ lter_start_time >= st ar t_t im e X >= start_time ] [ lt er_en d_t im e J <= end_time ] [ lt er_sav eset_t y p e sn ap sh ot /p r ot ect p oin t L snapshot/protectpoint ]

nsrpolicy action update discover-nas-snap ACTION_UPDATE_COMMON

nsrpolicy action update index-nas-snap ACTION_UPDATE_COMMON

nsrpolicy action update vba-checkpoint-discover ACTION_UPDATE_COMMON

nsrpolicy action update vba-checkpoint-backup ACTION_UPDATE_COMMON { destination_pool pool_name o

NetWorker 19.1.1 288

Maintenance Commands nsrpolicy ( 1m )

pool_name } { driven_by_action act ion_n am e d action_name } [ retention r et en t ion_p er iod r retention_period ]

nsrpolicy action list { policy_name policy_name p policy_name } { workow_name workow_name w workow_name } [ server server s server ]

nsrpolicy group create client { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ restricted_data_zone R est r ict ed_Dat a_Z on e Z Restricted_Data_Zone ] [ client_list clien t_list C client_list

nsrpolicy group create dynamic-client { group_name group_name ggroup_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ restricted_data_zone R est r ict ed_Dat a_Z on e Z Restricted_Data_Zone ] [ fetch_all_clients Y es/N o f Yes/No ] [ tag_list t tag1,tag2,tag3... ]

nsrpolicy group create saveset-id { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ ad d_ssid add_save-set- id_in_format_ssid/cloneid1,ssid/cloneid2... a add_save-set-id_in_format_ssid/cloneid1,ssid/cloneid2... ] [ m ax im u m_in st an ces maximum_instances_on_the_destination_pool m maximum_instances_on_the_destination_pool ] [ ser v er NetWorker_server_name s NetWorker_server ] [ r est r ict ed_d at a_z on e Restricted_Data_Zone Z Restricted_Data_Zone ]

nsrpolicy group create vmware { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ restricted_data_zone R est r ict ed_Dat a_Z on e Z Restricted_Data_Zone ] [ v cen t er_n am e vCenter_name V vCenter_name ] [ gr ou p_su b t y p e group_subtype[VirtualMachine/VMDK/All] u group_subtype[VirtualMachine/VMDK/All] ] [ v m w ar e_clien t_list client_path1, client_path2, eg./MyFolder, /DC/host/vm o client_path1, client_path2, eg./MyFolder,/DC/host/vm ] [ backup_optimization { capacity performance } z { capacity performance } ]

nsrpolicy group create query { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ ad d_gr ou p groups_to_be_included_in_query l groups_to_be_included_in_query ] [ ad d_clt_n am es client_name_to_be_included_in_query C client_name_to_be_included_in_query ] [ ad d_sav eset_n am e saveset_name_to_be_included_in_query n saveset_name_to_be_included_in_query ] [ add_level e levels_to_be_included_in_query ] [ add_pool_list p ool_n am e_t o_b e_in clu d ed_in_q u er y o pool_name_to_be_included_in_query ] [ ad d_p olicy_list policy_name_to_be_included_in_query p policy_name_to_be_included_in_query ] [ ad d_w or k ow_list workow_name_to_be_included_in_query w workow_name_to_be_included_in_query ] [ ad d_act ion_list action_name_to_be_included_in_query x action_name_to_be_included_in_query ] [ star_time t start_time_in_value_hours/days/months/years_ago_format ] [ end_time end_time_in_value hours/days/months/years ago_format T end_time_in_value_hours/days/months/years_ago_format ] [ m ax im u m_in st an ces maximum_instances_on_the_destination_pool m

NetWorker 19.1.1 289

Maintenance Commands nsrpolicy ( 1m )

maximum_instances_on_the_destination_pool ] [ ser v er NetWorker_server_name s NetWorker_server_name ] [ r est r ict ed_d at a_z on e Restricted_Data_Zone Z Restricted_Data_Zone ]

nsrpolicy group create nasdevice { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ restricted_data_zone R est r ict ed_Dat a_Z on e Z Restricted_Data_Zone ] [ n asd ev ice_list nasdevice_name1, nasdevice_name2... n nasdevice_name1, nasdevice_name2... ]

nsrpolicy group delete { group_name group_name g group_name } [ ser v er N et W or k er_ser v er_n am e s NetWorker_server ]

nsrpolicy group display { group_name group_name g group_name } [ ser v er N et W or k er_ser v er_n am e s NetWorker_server ]

nsrpolicy group update client { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ ad d_cln t_list new_client_list C new_client_list ] [ d el_cln t_list remove_existing_clients d remove_existing_clients ] [ ad d_cln t_id new_clients_resource_id_list r new_clients_resource_id_list ] [ d el_cln t_id remove_existing_clients_resource_id_list R remove_existing_clients_resource_id_list ]

nsrpolicy group update dynamic-client { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ restricted_data_zone R est r ict ed_Dat a_Z on e Z Restricted_Data_Zone ] [ f et ch_all_clien t s Yes/No f Yes/No ] [ ad d_t ag_list tag1,tag2,tag3... t tag1,tag2,tag3... ] [ del_tag_list t ag1,t ag2,t ag3... T tag1,tag2,tag3... ]

nsrpolicy group update saveset-id { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ ad d_ssid add_save-set- id_in_format_ssid/cloneid1,ssid/cloneid2... a add_save-set- id_in_format_ssid/cloneid1,ssid/cloneid2... ] [ d el_ssid del_save-set- id_in_format_ssid/cloneid1,ssid/cloneid2... d del_save-set- id_in_format_ssid/cloneid1,ssid/cloneid2... ] [ m ax im u m_in st an ces maximum_instances_on_the_destination_pool m maximum_instances_on_the_destination_pool ] [ ser v er NetWorker_server_name s NetWorker_server ] [ r est r ict ed_d at a_z on e Restricted_Data_Zone Z Restricted_Data_Zone ]

nsrpolicy group update vmware { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ v cen t er_n am e vCenter name V vCenter name ] [ ad d_v m w ar e_cln t_list client_path1, client_path2, eg. /MyFolder, /DC/host/vm o client_path1, client_path2, eg. /MyFolder, /DC/host/vm ] [ d el_v m w ar e_cln t_list client_path1, client_path2, eg. /MyFolder, /DC/host/vm O client_path1, client_path2, eg. /MyFolder, /DC/host/vm ] [ backup_optimization { capacity performance } z { capacity performance } ]

nsrpolicy group update query { group_name group_name g group_name } [ com m en t user_comment

NetWorker 19.1.1 290

Maintenance Commands nsrpolicy ( 1m )

c user_comment ] [ ad d_gr ou p groups_to_be_included_in_query l groups_to_be_included_in_query ] [ d el_gr ou p gr ou p s_t o_b e_r em ov ed_f r om_q u er y L groups_to_be_removed_from_query ] [ ad d_clt_n am es client_name_to_be_included_in_query C client_name_to_be_included_in_query ] [ d el_clt_n am es client_name_to_be_removed_from_query d client_name_to_be_removed_from_query ] [ ad d_sav eset_n am e saveset_name_to_be_included_in_query n saveset_name_to_be_included_in_query ] [ d el_sav eset_n am e saveset_name_to_be_removed_from_query N saveset_name_to_be_removed_from_query ] [ ad d_lev el_list lev els_t o_b e_in clu d ed_in_q u er y e levels_to_be_included_in_query ] [ d elet e_lev el_list levels_to_be_removed_from_query E levels_to_be_removed_from_query ] [ ad d_p ool_list p ool_n am e_t o_b e_in clu d ed_in_q u er y o pool_name_to_be_included_in_query ] [ d el_p ool_list pool_name_to_be_removed_from_query O pool_name_to_be_removed_from_query ] [ ad d_p olicy_list policy_name_to_be_included_in_query p policy_name_to_be_included_in_query ] [ d el_p olicy_list policy_name_to_be_removed_from_query P policy_name_to_be_removed_from_query ] [ ad d_w or k ow_list workow_name_to_be_included_in_query w workow_name_to_be_included_in_query ] [ d el_w or k ow_list workow_name_to_be_removed_from_query W workow_name_to_be_removed_from_query ] [ ad d_act ion_list action_name_to_be_included_in_query x action_name_to_be_included_in_query ] [ d el_act ion_list action_name_to_be_removed_from_query X action_name_to_be_removed_from_query ] [ st ar t_t im e start_time_in_value hours/days/months/years ago_format t start_time_in_value hours/days/months/years ago_format ] [ en d_t im e end_time_in_value hours/days/months/years ago_format T end_time_in_value hours/days/months/years ago_format ] [ m ax im u m_in st an ces maximum_instances_on_the_destination_pool m maximum_clone_instances_on_the_destination_pool ] [ ser v er N et W or k er_ser v er_n am e s NetWorker_server_name ]

nsrpolicy group update nasdevice { group_name group_name g group_name } [ com m en t user_comment c user_comment ] [ server N et W or k er_ser v er_n am e s NetWorker_server ] [ ad d_n asd ev ice_list nasdevice_name1, nasdevice_name2... b nasdevice_name1, nasdevice_name2... ] [ d el_n asd ev ice_list nasdevice_name1, nasdevice_name2... B nasdevice_name1, nasdevice_name2... ]

nsrpolicy start { policy_name policy_name p policy_name } { w or k ow_n am e workow_name w workow_name } [ client_list client_list c client_list ] [ server server s server ]

nsrpolicy stop { { policy_name policy_name p policy_name } { workow_name workow_name w workow_name } } { job_id job_id j job_id } [ server server s server ]

nsrpolicy monitor { policy_name policy_name p policy_name } [ { w or k ow_n am e workow_name w workow_name } ] [ { clien t_n am e client_name c client_name } ] [ { group_name gr ou p_n am e g group_name } ] [ details d ] [ non-tabular n ] [ job_id job_id j job_id ] [ ser v er

NetWorker 19.1.1 291

Maintenance Commands nsrpolicy ( 1m )

N et W or k er_ser v er_n am e s NetWorker_server ]

nsrpolicy input le { le_name le_n am e f le_name } [ stop_on_error bool S bool ]

nsrpolicy restart { policy_name policy_name p policy_name } { workow_name workow_name w workow_name } [ j ob_id job_id j job_id ] [ server server s server ]

nsrpolicy migrate

DESCRIPTION The nsrpolicy program executes NetWorker backup conguration and activities. nsrpol- icy performs the backup conguration through its three parameters: policy, workow and action.

Each NetWorker policy consists of a set of worklows, where a workow is dened as how the backup or restore activity, such as putting the application in a backup mode, deciding which data is backed up at what time and so on, is controlled.

Workow itself is composed of a sequence of actions, which are physical units execut- ing underlying operations such as probe, backup and clone, etc. The options of nsrpol- icy are listed level by level as follows:

nsrpolicy options: [ policy workow action group start stop monitor restart input le migrate ]

nsrpolicy policy options: [create delete display update list ]

nsrpolicy workow options: [ create delete display update list ]

nsrpolicy action options: [ create delete display update list ]

nsrpolicy action create options: [ check-connectivity probe backup clone discover-nas-snap index-nas-snap server-backup vba-checkpoint-discover vba-checkpoint- backup ]

nsrpolicy action update options: [ check-connectivity probe backup clone discover-nas-snap index-nas-snap server-backup vba-checkpoint-discover vba-checkpoint- backup ]

nsrpolicy group options: [ create delete display update ]

nsrpolicy group create options: [ client dynamic-client saveset-id vmware query nasdev- ice ]

nsrpolicy group update options: [ client dynamic-client saveset-id vmware query nasdev- ice ]

OPTIONS nsrpolicy policy create

p policy_name Species the policy name that will be created.

c user_comment Adds the user comment on the policy.

s NetWorker_server

NetWorker 19.1.1 292

Maintenance Commands nsrpolicy ( 1m )

Species a NetWorker server for the policy to back up save sets.

T notication_command Species the notication command for the policy. See the POLICY VARIABLES section for a list of supported variables that display custom information related to the status of a running policy.

x notication_event Species the event that should trigger the notication command. Supported events are completion, failure or ignore.

Z Restricted_Data_Zone Species the restricted data zone.

nsrpolicy policy delete

p policy_name Species the policy name that will be deleted.

s NetWorker_server Species a NetWorker server for the policy to delete save sets.

nsrpolicy policy display

p policy_name Species the policy name that will be displayed.

s NetWorker_server Species a NetWorker server for the policy to display save sets.

nsrpolicy policy update

p policy_name Species the policy name that will be updated.

c user_comment Updates the user comment on the policy.

s NetWorker_server Species a NetWorker server for the policy to update save sets.

T notication_command Species the notication command for the policy. See the POLICY VARIABLES section for a list of supported variables that display custom information related to the status of a running policy.

x notication_event Species the event that should trigger the notication command. Supported events are completion, failure or ignore.

nsrpolicy policy list

s server List policies from the NetWorker server server .

nsrpolicy workow create

p policy_name Species the policy name with which the workow associates.

w workow_name Species the workow name for creation.

c user_comment Adds the user comment on the workow.

S start_time The start time of executing the workow.

i interval

NetWorker 19.1.1 293

Maintenance Commands nsrpolicy ( 1m )

The time interval of executing the workow.

e end_time The end time of executing the workow.

u Yes/No Species if the workow starts automatically.

E Yes/No Species if the workow is enabled.

g group_name Species the name of a group with which the workow is associated.

r restart_window_time Species the maximum grace period from start time to restart a failed workow.

s NetWorker_server Species the NetWorker server executing the workow.

T notication_command Species the notication command for the policy. See the POLICY VARIABLES section for a list of supported variables that display custom information related to the status of a running policy.

x notication_event Species the event that should trigger the notication command. Supported events are completion, failure or ignore.

nsrpolicy workow delete

p policy_name Species the policy name with which the workow associates.

w workow_name Species the workow name for deletion.

s NetWorker_server Species the NetWorker server executing the workow.

nsrpolicy workow display

p policy_name Species the policy name with which the workow associates.

w workow_name Species the workow name for display.

s NetWorker_server Species the NetWorker server executing the workow.

nsrpolicy workow update

p policy_name Species the policy name with which the workow associates.

w workow_name Species the workow name for update.

W workow_newname Rename the workow to workow_newname.

c user_comment Adds the user comment on the workow.

S start_time The start time of the workow.

i interval

NetWorker 19.1.1 294

Maintenance Commands nsrpolicy ( 1m )

The interval of executing the workow.

e end_time The end time of the workow.

u Yes/No Species if the workow starts automatically.

E Yes/No Species if the workow is enabled.

g group_name Species the name of a group with which the workow is associated.

r restart_window_time Species the maximum grace period from start time to restart a failed workow.

s NetWorker_server Species the NetWorker server executing the workow.

T notication_command Species the notication command for the policy. See the POLICY VARIABLES section for a list of supported variables that display custom information related to the status of a running policy.

x notication_event Species the event that should trigger the notication command. Supported events are completion, failure or ignore.

nsrpolicy workow list

p policy_name List workows from the policy policy_name .

s server List workows from the NetWorker server server .

ACTION_CREATE_COMMON

p policy_name Species the policy name with which the action associates.

w workow_name Species the workow name with which the action associates.

A action_name Species the action name.

c user_comment Adds the user comment on the action.

e Yes/No Species if the action is enabled.

M action_start_time Species the start time of the action in the format hh:mm or +hh:mm. Where: hh:mm is the absolute time and denes when the action will start. +hh:mm is the relative time and indicates that the action will start in hh hours and mm minutes after the start of the workow.

C Yes/No Species if the action is concurrent.

d action_name Species this action is driven by which action.

F action_failure_impact

NetWorker 19.1.1 295

Maintenance Commands nsrpolicy ( 1m )

Species what to do when an action fails. It can be "continue, abort workow and abort action"

I action_inactivity_timeout Species how long an action should remain inactive in minutes before terminating itself.

j action_parallelism Species how many concurrent activities an action should undertake.

R action_retries Species the times the action can retry.

E action_retry_delay Species how long to delay in seconds before retrying a failure.

t action_schedule_activity Species action schedule activity, an array of items that may be full, 1(Cumulative Incremental), incr, incr_synth_full, txnlog( Logs Only), exec or skip. It can also be name of the NSR Schedule.

O action_schedule_override Action schedule override. Multiple action day pairs.

P action_schedule_period Length of the schedule period for this actions schedule. The period can be "week", "month", or "reference". If "reference" option is selected, provide the name of the NSR schedule under "action_schedule_activity".

K action_schedule_comment Adds the comment on the schedule.

H hard_limit Species the hours and minutes after the action starts to begin terminating all activities.

S soft_limit Species the hours and minutes after the action starts to stop starting new activities.

s NetWorker_server Species the NetWorker server executing the action.

T notication_command Species the notication command for the policy. See the POLICY VARIABLES section for a list of supported variables that display custom information related to the status of a running policy.

x notication_event Species the event that should trigger the notication command. Supported events are completion, failure or ignore.

nsrpolicy action create check-connectivity

ACTION_CREATE_COMMON

m Yes/No Species if all/any clients must pass for the result to be a success.

nsrpolicy action create probe

ACTION_CREATE_COMMON

m Yes/No Species if all probes must succeed before a backup will be performed.

BACKUP_ACTION_CREATE_COMMON

NetWorker 19.1.1 296

Maintenance Commands nsrpolicy ( 1m )

g storage_node_name Species the storage node name for backup.

r backup_retention_period Species the retention period of the backup data.

u success_threshold Species the backup action child success/failure level to its failure number.

o pool_name Species the destination pool name.

nsrpolicy action create backup traditional

ACTION_CREATE_COMMON

BACKUP_ACTION_CREATE_COMMON

k Yes/No Species if performing an estimate of the amount of data which will be generated by each save set before performing the backup.

v Yes/No Species if verifying synthetic full backups.

z Yes/No Species if reverting to a regular full backup when a synthetic full backup fails.

nsrpolicy action create backup snapshot.

ACTION_CREATE_COMMON

BACKUP_ACTION_CREATE_COMMON

m backup_minimum_retention_period Species the minimum retention period of backup.

nsrpolicy action create backup vmware

ACTION_CREATE_COMMON

BACKUP_ACTION_CREATE_COMMON

v vba_name Species the name of a VBA for the vmware backup to use.

V VMDK/VirtualMachine Species the type of the vmware backup.

nsrpolicy action create backup vmware vproxy

ACTION_CREATE_COMMON

ACTION_BACKUP_UPDATE_COMMON

v vproxy_name Species the name of a vProxy for the vmware backup to use.

a Turns on quiesce mode. When this mode is on and VMware Tools are installed on the target VM, the le system and applications will be quiesced during snapshot. A custom quiesce script may be specied by the q path option below.

q path Species a script path to invoke in quiesce mode

nsrpolicy action create clone

ACTION_CREATE_COMMON

o destination_pool_name Species the name of the destination pool.

NetWorker 19.1.1 297

Maintenance Commands nsrpolicy ( 1m )

r retention_period Species the backup retention period in a format understood by nsr_getdate.

u Yes/No Species if the source is required deleted.

n storage_node_name Species the storage node name.

i destination_storage_node_name Species the destination storage node name.

G Yes/No Option for ltering actions input work items.

Q client_name1, client_name2... Filters actions input work items by clients.

B full, 1-9 or incr Filters actions input work items by backup levels.

X start_time Filters work items by time range start in a format understood by nsr_getdate.

J end_time Filters work items by time range end in a format understood by nsr_getdate.

L snapshot/protectpoint Filters savesets based on saveset type - an array of items that may be snapshot/protectpoint"

nsrpolicy action create discover-nas-snap

ACTION_CREATE_COMMON

nsrpolicy action create index-nas-snap

ACTION_CREATE_COMMON

nsrpolicy action create vba-checkpoint-discover

ACTION_CREATE_COMMON

nsrpolicy action create vba-checkpoint-backup

ACTION_CREATE_COMMON

o destination_pool_name Species the name of the destination pool.

d action_name Species this action is driven by which action.

r backup_retention_period Species the retention period of the backup data.

nsrpolicy action delete

p policy_name Species the policy name with which the action associates.

w workow_name Species the workow name with which the action associates.

A action_name

s NetWorker_server Species the NetWorker server executing the action.

nsrpolicy action display

p policy_name Species the policy name with which the action associates.

NetWorker 19.1.1 298

Maintenance Commands nsrpolicy ( 1m )

w workow_name Species the workow name with which the action associates.

A action_name

s NetWorker_server Species the NetWorker server executing the action.

ACTION_UPDATE_COMMON

p policy_name Species the policy name with which the action associates.

w workow_name Species the workow name with which the action associates.

A action_name Species the action name.

N action_newname Rename the action to action_newname.

c user_comment Adds the user comment on the action.

e Yes/No Species if the action is enabled.

C Yes/No Species if the action is concurrent.

d action_name Species this action is driven by which action.

M action_start_time Species the start time of the action in the format hh:mm or +hh:mm. Where: hh:mm is the absolute time and denes when the action will start. +hh:mm is the relative time and indicates that the action will start in hh hours and mm minutes after the start of the workow.

F action_failure_impact Species what to do when an action fails. It can be "continue, abort workow and abort action".

I action_inactivity_timeout Species how long an action should remain inactive in minutes before terminating itself.

j action_parallelism Species how many concurrent activities an action should undertake.

R action_retries Species the times the action can retry.

E action_retry_delay Species how long to delay in seconds before retrying a failure.

t action_schedule_activity Species action schedule activity, an array of items that may be full, 1(Cumulative Incremental), incr, incr_synth_full, txnlog( Logs Only), exec or skip. It can also be name of the NSR Schedule.

O action_schedule_override Action schedule override. Multiple action day pairs.

P action_schedule_period Length of the schedule period for this actions schedule. The period can be "week", "month", or "reference". If "reference" option is selected, provide the

NetWorker 19.1.1 299

Maintenance Commands nsrpolicy ( 1m )

name of the NSR schedule under "action_schedule_activity".

K action_schedule_comment Adds the comment on the schedule.

H hard_limit Species the hours and minutes after the action starts to begin terminating all activities.

S soft_limit Species the hours and minutes after the action starts to stop starting new activities.

s NetWorker_server Species the NetWorker server executing the action.

T notication_command Species the notication command for the policy. See the POLICY VARIABLES section for a list of supported variables that display custom information related to the status of a running policy.

x notication_event Species the event that should trigger the notication command. Supported events are completion, failure or ignore.

nsrpolicy action update check-connectivity

ACTION_UPDATE_COMMON

m Yes/No Species if all/any clients must pass for the result to be a success.

nsrpolicy action update probe

ACTION_UPDATE_COMMON

m Yes/No Species if all probes must succeed before a backup will be performed.

BACKUP_ACTION_UPDATE_COMMON

n storage_node_name Species the storage node name.

r backup_retention_period Species the retention period of the backup data.

u success_threshold Species the backup action child success/failure level.

o pool_name Species the name of the destination pool.

nsrpolicy action update backup traditional

ACTION_UPDATE_COMMON

BACKUP_ACTION_UPDATE_COMMON

k Yes/No Species if performing an estimate of the amount of data which will be generated by each save set before performing the backup.

v Yes/No Species if verifying synthetic full backups.

z Yes/No Species if reverting to a regular full backup when a synthetic full backup fails.

nsrpolicy action update backup snapshot

NetWorker 19.1.1 300

Maintenance Commands nsrpolicy ( 1m )

ACTION_UPDATE_COMMON

BACKUP_ACTION_UPDATE_COMMON

m backup_minimum_retention_period Species the minimum retention period of backup.

nsrpolicy action update backup vmware

ACTION_UPDATE_COMMON

BACKUP_ACTION_UPDATE_COMMON

v vba_name Species the name of a VBA for the vmware backup to use.

V VMDK/VirtualMachine Species the type of the vmware backup.

nsrpolicy action update backup vmware vproxy

ACTION_UPDATE_COMMON

ACTION_BACKUP_UPDATE_COMMON

v vproxy_name Species the name of a vProxy for the vmware backup to use.

a Turns on quiesce mode. When this mode is on, applications will be quiesced during snapshot using a script that is specied by the q path option below.

q path Species a script path to invoke in quiesce mode

nsrpolicy action update clone

ACTION_UPDATE_COMMON

o destination_pool_name Species the name of the destination pool.

r backup_retention_period Species the retention period of the backup data.

u Yes/No Species if the source is required deleted.

n storage_node_name Species the storage node name.

i destination_storage_node_name Species the destination storage node name.

G Yes/No Option for ltering actions input work items.

Q client_name1, client_name2... Filters actions input work items by clients.

B full, 1-9 or incr Filters actions input work items by backup levels.

X start_time Filters work items by time range start in a format understood by nsr_getdate.

J end_time Filters work items by time range end in a format understood by nsr_getdate.

L snapshot/protectpoint Filters savesets based on saveset type - an array of items that may be snapshot/protectpoint".

nsrpolicy action update discover-nas-snap

NetWorker 19.1.1 301

Maintenance Commands nsrpolicy ( 1m )

ACTION_UPDATE_COMMON

nsrpolicy action update index-nas-snap

ACTION_UPDATE_COMMON

nsrpolicy action update vba-checkpoint-discover

ACTION_UPDATE_COMMON

nsrpolicy action update vba-checkpoint-backup

ACTION_UPDATE_COMMON

o destination_pool_name Species the name of the destination pool.

d action_name Species this action is driven by which action.

r backup_retention_period Species the retention period of the backup data.

nsrpolicy action list

p policy_name List actions from the policy policy_name .

w workow_name List actions from the workow workow_name .

s server List actions from the NetWorker server server .

nsrpolicy group create client

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

Z Restricted_Data_Zone Species the restricted data zone.

C client_list Species the client list in format of {client_name1 \"IPv6_addr1\"}[:save_set_path_1[;save_set_path_2]...][,{client_name2 \"IPv6_addr2

nsrpolicy group create dynamic-client

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

Z Restricted_Data_Zone Species the restricted data zone.

f Yes/No Species if all clients are fetched.

t tag_list Species tag1,tag2,tag3...

nsrpolicy group create saveset-id

NetWorker 19.1.1 302

Maintenance Commands nsrpolicy ( 1m )

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

a ssid Adds save-set-id in the format of ssid/cloneid1, ssid/cloneid2...

m maximum_instances Species the maximum number of backup instances in the destination pool.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

Z Restricted_Data_Zone Species the restricted data zone.

nsrpolicy group create vmware

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

Z Restricted_Data_Zone Species the restricted data zone.

V vCenter_name Species the vcenter name.

u group_subtype[VirtualMachine/VMDK/All] Species the group subtype. All should be specied to use the vProxy-based protection, where the group can have work items of both virtual machines and VMDKs at the same time. VirtualMachine or VMDK can be specied to use the legacy VBA-based protection.

o vmware_client_list Species client_path1, client_path2, eg./MyFolder,/DC/host/vm.

z capacity performance Species which backup optimization mode to use when protecting virtual machines and VMDKs of this protection group on a Data Domain system. To make the new mode take effect, after you change the mode perform a level full backup. When an option is not selected, capacity is used by default. Choose performance only when the Data Domain system runs DD OS 5.7 or higher. Note that deduplication can only occur on data that is stored on the same mode.

nsrpolicy group create query

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

l groups Adds groups to be included in the query.

C add_clt_names Adds client names to be included in query.

n add_saveset_name Adds saveset names to be included in query.

NetWorker 19.1.1 303

Maintenance Commands nsrpolicy ( 1m )

e add_level Adds levels to be included in query.

o add_pool_list Adds pool names to be included in query.

p add_policy_list Adds policy names to be included in query.

w workow_name_to_be_included_in_query. Adds workow names to be included in query.

x add_action_list Adds action names to be included in query.

t start_time Adds start time in the format of value_hours/days/months/years_ago.

T end_time Adds end time in the format of value_hours/days/months/years_ago.

m maximum_instances Adds the maximum number of instances on the destination pool.

s server Adds the NetWorker_server_name.

Z Restricted_Data_Zone Adds the restricted data zone.

nsrpolicy group create nasdevice

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

Z Restricted_Data_Zone Species the restricted data zone.

n nasdevice_name1, nasdevice_name2... Species the nas device list.

nsrpolicy group delete

g group_name Species the group name.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

nsrpolicy group display

g group_name Species the group name.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

nsrpolicy group update client

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

NetWorker 19.1.1 304

Maintenance Commands nsrpolicy ( 1m )

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

C client_list Adds the client list in the format of {client_name1 \"IPv6_addr1\"}[:save_set_path_1[;save_set_path_2]...][,{client_name2 \"IPv6

d client_list Deletes the client list in the format of {client_name1 \"IPv6_addr1\"}[:save_set_path_1[;save_set_path_2]...][,{client_name2 \"IPv6

r new_clients_resource_id_list Adds the client id list.

R remove_existing_clients_resource_id_list Removes existing client id list.

nsrpolicy group update dynamic-client

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s server Adds the NetWorker_server_name.

Z Restricted_Data_Zone Adds the restricted data zone.

f Yes/No Species if all clients are fetched.

t tag1,tag2,tag3... Adds the tag list

T tag1,tag2,tag3... Deletes the tag list.

nsrpolicy group update saveset-id

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

a ssid Adds save-set-id in the format of ssid/cloneid1, ssid/cloneid2...

d ssid Deletes save-set-id in the format of ssid/cloneid1, ssid/cloneid2...

m maximum_instances Species the maximum number of backup instances in the destination pool.

s NetWorker_server Species a NetWorker server for the policy to back up save sets.

Z Restricted_Data_Zone Species the restricted data zone.

nsrpolicy group update vmware

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s server Adds the NetWorker_server_name.

o client_path1, client_path2, eg. /MyFolder, /DC/host/vm

NetWorker 19.1.1 305

Maintenance Commands nsrpolicy ( 1m )

Adds the vmware client list.

O client_path1, client_path2, eg. /MyFolder, /DC/host/vm Deletes the vmware client list.

z capacity performance Species which backup optimization mode to use when protecting virtual machines and VMDKs of this protection group on a Data Domain system. To make the new mode take effect, after you change the mode perform a level full backup. When an option is not selected, capacity is used by default. Choose performance only when the Data Domain system runs DD OS 5.7 or higher. Note that deduplication can only occur on data that is stored on the same mode.

nsrpolicy group update query

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

l groups Species groups to be included in query.

L groups Species groups to be removed from query.

C client_name Species client names to be included in query.

d client_names Species client names to be removed from query.

n saveset_names Species saveset names to be included in query.

N saveset_names Species saveset names to be removed from query.

e level_list Species backup levels to be included in query.

E level_list Species backup levels to be removed from query.

o pool_list Species pool names to be included in query.

O pool_list Species pool names to be removed in query.

p policy_list Species pool names to be included in query.

P policy_list Species policy names to be removed from query.

w workow_list Species workow name to be included in query.

W workow_list Species workow name to be removed from query.

x action_list Species action names to be included in query.

X action_list Species action names to be removed from query.

NetWorker 19.1.1 306

Maintenance Commands nsrpolicy ( 1m )

t start_time Species start time in the format of value hours/days/months/years ago.

T end_time Species end time in the format of value hours/days/months/years ago.

m maximum_instances Species the maximum number of backup instances in the destination pool.

s server Adds the NetWorker_server_name.

nsrpolicy group update nasdevice

g group_name Species the group name.

c user_comment Adds the user comment on the policy.

s server Adds the NetWorker_server_name.

b nasdevice_name1, nasdevice_name2... Adds the nasdevice list into group resource.

B nasdevice_name1, nasdevice_name2... Deletes the nasdevice list from group resource.

nsrpolicy start

p policy_name The policy name associated with workow workow_name .

w workow_name The workow within policy policy_name to start.

c client_list A list of clients that is a subset of what would be selected from the respective group to start, in format of {client_name1 \"IPv6_addr1\"}[:save_set_path_1[;save_set_path_2]...][,{client_name2 \"IPv6

s server The NetWorker server to send the start command to.

nsrpolicy stop

p policy_name The policy name associated with workow workow_name .

w workow_name The workow within policy policy_name to stop.

j job_id Stop the workow with the job ID job_id .

s server The NetWorker server to send the stop command to.

nsrpolicy monitor

p policy_name Species the policy_name.

w workow_name Species the workow name.

c client_name Species the client name.

g group_name Species the group name.

d Shows monitor details.

n Shows the non-tabular format.

j job_id Shows job id.

NetWorker 19.1.1 307

Maintenance Commands nsrpolicy ( 1m )

s server Species the NetWorker_server.

nsrpolicy input le

f le_name Read the script from the absolute path le_name and execute the commands. The scripts format is the same as how the nsrpolicy command is specied, but without specifying nsrpolicy at the begining of each line.

EXAMPLE FILE policy create p Policy1 workow create p Policy1 w Workow1 policy delete p OtherPolicy

S bool Specify bool as 1 if execution must stop on error and 0 if it should continue. The default is to continue on error.

nsrpolicy restart

p policy_name The policy name associated with workow workow_name .

w workow_name The workow within policy policy_name to restart.

j job_id Restarts the workow with the job ID job_id .

s server The NetWorker server to send the restart command to.

nsrpolicy migrate

POLICY VARIABLES Use policy variables to display custom information about a policy conguration at run time. The variables are case-insensitive and denoted by ${var_name}, where "var_name" is the name of the variable. At run time, Networker expands the variable to the appropriate value. Non-existent variables are expanded to an empty string. If you require a literal ${var_name}, escape the variable with the \ charater. For exame- ple, \${var_name}. Networker supports the following variable expansions in the notication command:

${policy} Expands to the running policy name.

${workow} Expands to the running workow name.

${action} Expands to the running action name.

${name} Expands to the policy name and workow name for workow notications, or policy name, workow name and action name for action notications.

${server} Expands to the Networker server host name.

${status} Expands to the workow or action completion status.

${type} Expands to the action type for actions or workow for workows.

EXAMPLES To create a protection group called EngineeringClients, use the following command:

nsrpolicy group create client group_name EngineeringClients C "nemo-dev-50"

NetWorker 19.1.1 308

Maintenance Commands nsrpolicy ( 1m )

To create a policy called Gold, use the following command:

nsrpolicy policy create policy_name Gold

To update the policy Gold to send a mail notication on completion, use the following command on a Linux server:

nsrpolicy policy update policy_name Gold notication_execute_on completion notication_action "/bin/mailx -s \"\${type} \${name} \${status}\" root"

To update the policy Gold to send a mail notication on completion, use the following command on a Windows server:

nsrpolicy policy update policy_name Gold notication_execute_on completion notication_action "smtpmail -s \"\${type} \${name} \${status}\" -h mailserver recipient1@mailserver"

To create a workow called EngineeringDataProtection to protect EngineeringClients, use the following command:

nsrpolicy workow create policy_name Gold workow_name EngineeringDataProtection group_name EngineeringClients S 17:00

To create a backup called backupEngineeringData, use the following command:

nsrpolicy action create backup traditional -p Gold -w EngineeringDataProtection action_name backupEngineeringData

To update the start time of the backup action backupEngineeringData to 15:00, type the following command:

nsrpolicy action update backup traditional p Gold w EngineeringDataProtection action_starttime 15:00

To update the start time of the backup action backupEngineeringData to start 3 hours after the workow starts, type the following command:

nsrpolicy action update backup traditional p Gold w EngineeringDataProtection action_starttime +3:00

To start backup for EngineeringDataProtection workow, use the following command:

nsrpolicy start -p Gold -w EngineeringDataProtection

To monitor EngineeringDataProtection workow progress, use the following com- mand:

nsrpolicy monitor -p Gold -w EngineeringDataProtection

DIAGNOSTICS Exit Codes:

0 Normal exit.

1 Abnormal exit. The requested action failed.

SEE ALSO nsr_notication(5),

NetWorker 19.1.1 309

Maintenance Commands nsrports ( 1m )

NAME nsrports port conguration tool

SYNOPSIS nsrports [ s server ] [ S C ] [ range ... ]

nsrports a [ n ] [ f address_family ]

nsrports t name [ p port ]

DESCRIPTION The nsrports command is used to display and set ranges of ports used by the Net- Worker software. A range of ports may be either a single integer or two integers separated by a dash (-). Any integer used to dene a range of ports must be between 0 and 65535. The range 0-0 is treated equivalent to 0-65535. The port ranges are stored by nsrexecd(1m) in the NSR system port ranges resource. When nsrports is executed without any options, the program displays the congured port ranges for the system on which the command is being run.

Users executing nsrports can change the valid system port ranges. There are also two additional options for viewing and setting the port ranges. The rst is by using the NetWorker Management Console. The second is by using nsradmin(1m). Execute the program as follows:

# nsradmin -s server -p nsrexec

where server is the system for which ports are to be displayed. The administrator attri- bute for this resource can be modied with either the NetWorker Management Con- sole or nsradmin(1m) by any user currently on the administrator list.

OPTIONS a Show the state of all NetWorker socket connections.

C Sets the systems connection ports to the ranges specied. By default, Net- Worker denes a range of 0-0 for connection ports.

f address_family Limit display to connections of the given address family. The following address families are recognized: inet for AF_INET, inet6 for AF_INET6.

n Show network addresses and port numbers instead of resolving to host and service names respectively.

p port Override the default port used to make a connection to the given host.

s server Species the system to contact.

S Sets the systems service ports to the ranges specied. By default, NetWorker denes a range of 7937-9936 for service ports.

t name Perform DNS lookups on the given name and attempt to connect to the host on port 7938.

EXAMPLES Setting two service port ranges 7937-9936 and 9999 nsrports S 7937-9936 9999

SEE ALSO nsrexecd(5), nsradmin(1m)

NetWorker 19.1.1 310

Maintenance Commands NSRPSD ( 1m )

NAME nsrpsd - NetWorker daemon for snapshot related backup, recover and consistency checking.

SYNOPSIS nsrpsd [ w minutes ] [ D debug_level ] [ v ]

DESCRIPTION The nsrpsd daemon provides an RPC-based snapshot related save and recover service. This service allows users to save les using snapshots, recover their les across a net- work. It also acts as a consistency checker.

When nsrpsd is rst started it spawns another instance of itself. One instance runs as snapshot related save and recover service. The other instance runs as a consistency checker. The RPC program number provided by nsrpsd are 390408 and 390409.

Once a day nsrpsd runs consistency check. It makes sure that the snapshots taken by NetWorker on the client on which nsrpsd is running are accessible or valid. If not valid, the snapshots are removed and the corresponding snapset entry in media data- base is also removed.

Normally nsrpsd is invoked from a startup shell script at boot-time, and should never need to be started directly by the user.

OPTIONS This section describes the command options that are available across several usage scenarios.

w minutes By default, the parent nsrpsd process will automatically terminate after 30 minutes of no activity. Use this option to change the number of minutes to a value of 0 or more, where 0 causes nsrpsd to never automatically terminate.

D debug_level This is for debugging purposes only. It starts the nsrpsd in high debug mode. debug_level is a number between 0-9.

v This displays the build version information for nsrpsd.

LOGS /nsr/logs/daemon.log The le to which the nsrpsd daemon and other NetWorker daemons send information about various error conditions.

/nsr/logs/nwsnap.raw The le to which the nsrpsd child processes and other Snapshot Manage- ment executables send logging information about various error conditions at log level 3 or less.

Example nsrpsd log le names when logging level is greater than 3 are (1545 was the PID):

brc.2005_06_27.18_21_42.1545.1119910902.log brc.2005_06_27.18_21_48.1545.1119910902.trace brc.2005_06_27.18_22_20.1556.1119910940.debug brc.2005_06_27.18_22_20.1556.1119910940.log brc.2005_06_27.18_25_35.1567.1119911135.debug brc.2005_06_27.18_25_35.1567.1119911135.log

NetWorker 19.1.1 311

Maintenance Commands nsrpush ( 1m )

NAME nsrpush remotely distribute and install client software from a centralized server to NetWorker clients.

SYNOPSIS nsrpush i { all f le_listing_clients clients } nsrpush a { U W } p product v version P platform m media_kit_path [ R

repository_path ]

nsrpush r p product v version P platform

nsrpush u [ Tp temp_paths ][ To time_outs ] p product v version { all f le_listing_clients clients }

nsrpush l

nsrpush L { U W } m media_kit_path

nsrpush s [ t ] { all f le_listing_clients clients }

DESCRIPTION The nsrpush program discovers installed software on remote NetWorker clients and upgrades that software. Options are provided for specifying NetWorker packages for multiple platforms. A similar facility is provided by NMC.

Pressing Ctrl+C will provide the option to either cancel a long operation, or exit nsrpush. Selecting cancel will not terminate the current upgrade operation, but will prevent the next client in a sequence from being upgraded. Exiting nsrpush does not cancel the current operation, rather it continues to run in the background. Upgrades initiated by nsrpush can be monitored via the NMC GUI.

OPTIONS Options are separated into two groups. The rst are the options which specify the operation to be performed, e.g. inventory or upgrade clients. The second group list the additional options which provide arguments for the operation e.g. specifying the clients to be inventoried or upgrade.

OPERATION OPTIONS

i Probes all specied NetWorker clients in a datazone to determine what EMC software is installed on each client. This step is required before a NetWorker client can be upgraded.

a Adds software packages to the software repository. The software repository collects and organizes packages for distribution to clients. The software reposi- tory is organized by product, platform, version and packages.

r Removes software packages from the software repository.

u Upgrades NetWorker Client software. The inventory step must be run before a client can be upgraded.

l Lists all the software packages in the software repository.

L Lists the software packages on the distribution media kit. Details including the platform, package names and package versions are displayed.

s List the EMC software installed on each specied NetWorker client.

ADDITIONAL OPTIONS

p product This option is used in conjunction with repository and upgrade operations to specify the product name.

v version This option is used in conjunction with repository and upgrade operations to specify the version of the product.

P platform This option is used in conjunction with repository operations to specify the

NetWorker 19.1.1 312

Maintenance Commands nsrpush ( 1m )

platform of the software product.

R repository_path This option is used to specify the location of the repository. If the repository already exists then this option will be ignored.

m media_kit_path This option is used to specify the path (mount point) of the distribution media.

U This option is used in conjunction with a option to add Unix products from the distribution media in the repository.

W This option is used in conjunction with a option to add Windows products from the distribution media in the repository.

Tp temp_path This option is used to specify the NW clients temporary path to be used dur- ing the upgrade operation. The path should have enough available space to store the upgrade packages. If not specied the default OS temporary path will be used.

To time_out This option is used to specify the time out value in minutes during the upgrade operation. If not specied the default value of 10 minutes will be used.

all This option is used in conjunction with i and u option to perform inventory and upgrade operation for all applicable clients.

f le_listing_clients Instead of listing clients one at a time, all the clients names for a given opera- tion can be listed in a le. The le should specify one client per line. The le can include blank lines and comments preceded by #.

t This option is used in conjunction with s option and displays the output in tabular format.

EXAMPLES Inventoring clients : To inventory all of the clients known to NetWorker, use the all option:

nsrpush i all

To specify particular clients, specify the client names seperated by space: nsrpush i ledma153 ledma160

Adding to repository : To add Unix based products to the software repository on a NetWorker server running either Windows or Unix, use the a option in conjunction with the U option:

nsrpush -a -U p NetWorker v 8.2.4.1 P linux_x86_64 -m /cdrom/networker/linux_x84_64

To add Windows based products to the software repository on a either a Unix or a Windows NetWorker server, use the a option in conjunction with the W option:

nsrpush -a -W p NetWorker v 8.2.4.1 P win_x64 -m C:\networker\

Previous NetWorker versions required the specication of a proxy host to enable Unix servers to import Windows media kits, and to enable Windows servers to import Unix media kits. The proxy server requirement has been removed, cross platform import is now supported without the need for a proxy server.

Removing from repository :

NetWorker 19.1.1 313

Maintenance Commands nsrpush ( 1m )

To remove products from the repository, use the r option: nsrpush -r p NetWorker v 8.2.4.1 P linux_x86_64

Upgrading Clients To upgrade clients, use the u option:

nsrpush -u p NetWorker v 8.2.4.1 ledma170

FILES /nsr/res/cpdb The client push conguration database containing resource descrip- tors.

NetWorker 19.1.1 314

Maintenance Commands NSRRECCOMP ( 1m )

NAME nsrreccomp recover completion query program

SYNOPSIS nsrreccomp [ s server ] recover_job_name

nsrreccomp [ s server ] L [ recover_job_name ]

nsrreccomp [ s server ] [ Hio ] [ b number_of_bytes l number_of_lines ] [ c client_name ] [ d destination_client_name ] [ t start_time ] recover_job_name

nsrreccomp [ s server ] R jobid

DESCRIPTION The nsrreccomp command is a command-line based program used to query the Net- Worker servers jobs database and the recover log les in order to display a recover completion report. The jobs database is maintained by the nsrjobd(1m) daemon and can alternatively be queried using the jobquery(1m) command. The recover log les are located on the NetWorker server machine in the /nsr/logs/recover directory. Please note that manual recovers have a recover_job_name of recover.

OPTIONS H Print the summary headers i.e.: "destination host, recover command, comple- tion status".

L List a summary of the recover job records currently present in the jobs data- base. The results are sorted from least recent to most recent. Entries listed have the following columns: "name, start time, job id, completion status".

R jobid Retrieve the output generated by job jobid during the recover run.

b number_of_bytes Include at most the last number_of_bytes bytes of output per job. Do not include truncated lines. A number_of_bytes value of 1 means include all out- put.

c client_name Include only jobs that have the source client client_name . The source client is the machine that originally saved the le.

d destination_client_name Include only jobs that have the destination client destination_client_name . The destination client is the machine that the recover was run on.

i Include job indications.

l number_of_lines Include at most the last number_of_lines lines of output per job. A number_of_lines value of 1 means include all output.

o Include job output. Use b or l to modify the amount of output included. Specifying o alone is equivalent to o b 2048.

s server Specify which machine to use as the NetWorker server.

t start_time Query only the resources that have the start time start_time .

EXAMPLES Display recover completion report for the scheduled recover resource recover1. nsrreccomp recover1

The above command is equivalent to nsrreccomp H i o b 2048 recover1

NetWorker 19.1.1 315

Maintenance Commands NSRRECCOMP ( 1m )

Display recover completion report from a specic server. nsrreccomp -s example.server.com recover1

List all of the recover records in the jobs database nsrreccomp L

List the recover records for scheduled recover recover1 presently in jobs database. nsrreccomp L recover1

Display recover completion report for scheduled recover recover1 started at time start_time.

nsrreccomp t start_time recover1

Display only information about a specic source client for the most recent scheduled recover run.

nsrreccomp c example.client.com recover1

The above command is equivalent to nsrreccomp H i o b 2048 -c example.client.com recover1

Display only the header. nsrreccomp H recover1

Display at most the last 50 lines of output for the most recent recover job recover1. nsrreccomp l 50 recover1

Display at most the last 1024 bytes of output for the most recent recover job recover1. nsrreccomp b 1024 recover1

NOTE: The b option does not include partial lines, so this will likely result in less than 1024 bytes of output from the job.

SEE ALSO jobquery(1m), nsrjobd(1m), recover(1m).

NetWorker 19.1.1 316

Maintenance Commands nsrrecopy ( 1m )

NAME nsrrecopy NetWorker backend program for Synthetic full and rehydrated tape out

SYNOPSIS nsrrecopy [ v ] s server c client N saveset

DESCRIPTION nsrrecopy is the backend program spawned by nsrconsolidate to perform the recover pipe to save operation for the synthetic full, or rehydrating an Avamar deduplication save set id. Manual invocation of this command is not supported.

nsrrecopy performs the recover pipe to save operation using the XDR encoded restore list (rlist) sent by nsrconsolidate to contact NetWorker server to retrieve the recover stream (rs), associated nsrmmd program/version number and hostname. The recover side of nsrrecopy creates a thread per recover stream (rs) to bind to the nsrmmd in the rs and initiates the recover from that nsrmmd, see nsrmmd(1m) for more information. The save side of nsrrecopy creates a save thread for binding to the save nsrmmd and starts saving data. The recover thread reads the data and writes to a communication channel established for save thread to get and write to the target volume.

The completion status, progress and any error messages of nsrrecopy are sent back to nsrconsolidate program for display using communication channel setup with Net- Worker jobs monitoring daemon, see nsrjobd(1m) for more information.

OPTIONS c client Species the name of the client for the recover pipe to save.

N saveset-name Species the name of saveset for the recover pipe to save.

s server Species a NetWorker server.

v Enable verbose operation. In this mode, additional messages are written to stderr/stdout for nsrconsolidate to display regarding the recover pipe to save operation.

SEE ALSO nsrconsolidate(1m), ansrd(1m), nsr_data(5), nsr_device(5), nsr_directive(5), mminfo(1m), nsr(1m), nsrd(1m), nsrmmd(1m), nsrjobd(1m)

NetWorker 19.1.1 317

Maintenance Commands nsrretrieve ( 1m )

NAME nsrretrieve retrieve NetWorker archive save sets

SYNOPSIS nsrretrieve [ fnqu ] [ i {nNyYrR} ] [ d destination ] [ s server ] [ p pass-phrase ]. . . [ S ssid[/cloneid] ]. . . [ A annotation ]. . . [ path . . . ]

DESCRIPTION nsrretrieve is used to restore archive save sets from a NetWorker server. No browsing is available via nsrretrieve. Use of nsrretrieve is restricted to listed administrators and users of an archive client resource. See the nsr_client(5) man page for further details. When not running as root, only the les that the user owns can be retrieved.

When no path arguments are specied, the entire save set contents will be retrieved. To restrict the archive save set retrieval to only particular directories or les matching a given path prex, exact matching paths can be specied to limit which directories and les are retrieved.

OPTIONS -A annotation The annotation is a regular expression which uniquely identies a single archive save set. See nsrarchive(1m). The regular expression is in the form of one used by grep(1). At least one annotation or ssid (see below) must be specied.

-S ssid[/cloneid] The ssid species the save set IDs for the save sets to be retrieved. When there are multiple clone instances for an archive save set, you can specify the cloneid to select the particular clone instance to be retrieved. At least one annotation (see above) or ssid must be specied.

-d destination Species the destination directory that the retrieved les will be relocated to.

-s server Selects which NetWorker server to use.

p pass-phrase Species an additional pass phrase to use when attempting to recover les backed up using the aes directive. By default the current datazone encryption key is tried as well as the key generated from the default pass phrase. Using this option causes nsrretrieve to generate an encryption key from the pass phrase and try it if the default and datazone pass phrase keys do not work. This option can be specied multiple times.

-q The nsrretrieve command normally runs with verbose output. This ag turns off the verbose output.

-f Indicates that retrieved les will overwrite existing les whenever a name conict occurs.

-n Performs a dry run, which means it consumes the input save stream and per- forms basic sanity checks, but does not create or modify any directories or les when recovering le data.

-i {nNyYrR} Species the initial default overwrite response to use when retrieving les and there is a name conict. You may specify only one letter. 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.

-u Stop when an error occurs during retrieval. Normally, nsrretrieve treats errors as warnings and tries to continue to retrieve the rest of the les requested. However, when this option is used, nsrretrieve will stop recovering on the rst error it encounters.

NetWorker 19.1.1 318

Maintenance Commands nsrretrieve ( 1m )

SEE ALSO grep(1), nsrarchive(1m), nsr_client(5), nsr_service(5), nsr(1m), nsrd(1m), uasm(1m)

DIAGNOSTICS Exit Codes: 0 Normal exit. This means that all of the requested data was successfully

retrieved. <>0 Abnormal exit.

Messages:

The nsrretrieve command reports invalid options by printing a usage message describing the available options.

Cannot contact media database on server This message indicates that some problem was encountered connecting to the NetWorker server on the named machine.

cannot retrieve backup save sets The nsrretrieve command can only be used to restore archive save set data.

cannot retrieve migration save sets The nsrretrieve command can only be used to restore archive save set data.

more than one saveset have the annotation The specied annotation matched more than one archive save set.

cannot nd saveset with unique annotation The specied annotation matched no archive save set.

NetWorker 19.1.1 319

Maintenance Commands NSRRPCINFO ( 1m )

NAME nsrrpcinfo report NetWorker RPC information

SYNOPSIS nsrrpcinfo p [ host ]

nsrrpcinfo [ n portnum ] u host program [ version ]

nsrrpcinfo [ n portnum ] t host program [ version ]

nsrrpcinfo b portnum version

nsrrpcinfo d portnum version

DESCRIPTION nsrrpcinfo makes an RPC call to a NetWorker RPC server and reports what it nds.

OPTIONS p Probe the NetWorker portmapper on host and print a list of all registered RPC programs. If host is not specied, it defaults to the value returned by host- name(1).

u Make an RPC call to procedure 0 of program on the specied host using UDP, and report whether a response was received.

t Make an RPC call to procedure 0 of program on the specied host using TCP, and report whether a response was received.

n Use portnum as the port number for the t and u options instead of the port number given by the NetWorker portmapper.

b Make an RPC broadcast to procedure 0 of the specied program and version using UDP and report all hosts that respond.

d Delete registration for the RPC service of the specied program and version. This option can be exercised only by the super-user.

The program argument can be either a name or a number.

If a version is specied, nsrrpcinfo attempts to call that version of the specied program. Otherwise, nsrrpcinfo attempts to nd all the registered version numbers for the specied program by calling version 0 (which is presumed not to exist; if it does exist, nsrrpcinfo attempts to obtain this information by calling an extremely high version number instead) and attempts to call each registered version. Note: the version number is required for b and d options.

EXAMPLES To show all of the NetWorker RPC services registered on the local machine use:

$ nsrrpcinfo p

To show all of the NetWorker RPC services registered on the machine named jupiter use:

$ nsrrpcinfo p jupiter

To show all machines on the local network that are running version 2 of the Net- Worker Remote Exec service use:

$ nsrrpcinfo b nsrexec 2

SEE ALSO rpc(5), nsr(1m)

NetWorker 19.1.1 320

Maintenance Commands NSRSNAP ( 1m )

NAME nsrsnap NetWorker client side module to perform snapshot management

SYNOPSIS nsrsnap [ BEiLnqvxr ] [ s server ] [ c client ] < g group > [ m masquerade ] [ x save-options ] [ path . . . ]

DESCRIPTION nsrsnap command is a NetWorker client side binary and is used by savegrp to per- form snapshot management related commands for le system and application backups. NOTE: running nsrsnap directly is not recommended; use savegrp(1m) instead which is invoked by nsrworkow(1m).

savegrp invokes nsrsnap on the NetWorker Client instead save for Networker group which are congured to use sanpshots. nsrsnap performs four key functions namely retention, snapshot based backup, live-backup and retry mechanism.

nsrsnap queries media database for enforcing retention policy. It uses nsrsnapck binary for performing snapshot deletion and snapset expiration.

If nsrsnap is started with "-r" option, nsrsnap will perform a live-backup operation after the snapshot based backup. And, nsrsnap always use nsrsnap_save to do a live- backup.

A snapshot based NetWorker group will start nsrsnap to perform its retry logical. nsrsnap will follow the same steps to create snapshot based backups and live-backup.

OPTIONS c client-name Species the client name for starting the save session. If the client-name is specied, retention will be based on that name, otherwise, it will use localhost as the client name.

f dirle The le from which to read prototype default directives (see nsr(5)). A dirle of - causes the default directives to be read from standard input.

g group This option is used by savegrp(1m) and savefs(1m) to denote the group of the save (see nsr_client(5) and nsr_protection_group(5)) and is used by the Net- Worker server to select the specic media pool.

r backup the saveset to tape following a snapshot creation.

s server Species which machine to use as the NetWorker server.

v Verbose. Causes the save program to provide great detail about the save as it proceeds.

x save-options Savegrp can pass extra options to nsrsnap_save or the application with this argument, and nsrsnap will pass down the save-option to nsrsnap_save or the application without parsing.

L If nsrsnap is started from savegrp, this ag will be set and users should not use this ag if they start nsrsnap from the command line. The savegrp is spawned by nsrworkow.

m masquerade nsrsnap will ignore this option.

B nsrsnap will ignore this option.

E nsrsnap will ignore this option.

i nsrsnap will ignore this option.

NetWorker 19.1.1 321

Maintenance Commands NSRSNAP ( 1m )

n nsrsnap will ignore this option.

q nsrsnap will ignore this option.

path Specify the path names to be backed up. For a le system backup, it should be a valid le system, raw device, directory or le name.

SEE ALSO save(1m), nsr_client(5), nsr_protection_group(5), nsrd(1m), recover(1m), savefs(1m), savegrp(1m), nsrworkow(1m), nsrsnap_save(1m), nsrsnap_recover(1m), nsrpsd(1m) nsrsnapadmin(1m)

DIAGNOSTICS Exit Codes 0 Normal exit. This means that a save set was correctly created on the server.

<>0 Abnormal exit. A save set was not correctly created on the server.

NetWorker 19.1.1 322

Maintenance Commands NSRSNAPADMIN ( 1m )

NAME nsrsnapadmin - print, delete, backup, browse, recover NetWorker snapsets.

SYNOPSIS nsrsnapadmin [ s server ] [ c remote_client/cluster_node ]

nsrsnapadmin B [ s server ] [ c cluster_node] [ Fv ] [ M mount_host ] S ssid m path

nsrsnapadmin d [ s server ] [ c cluster_node] [ v ] [ a ] [ y ] S ssid (or "ssid ssid ...")

nsrsnapadmin e time [ s server ] [ c cluster_node] [ v ] S ssid (or "ssid ssid ...")

nsrsnapadmin p [ s server ] [ c remote_client/cluster_node ] [ v ] [ -S ssid ] [ path ]

nsrsnapadmin r [ s server ] [ c remote_client/cluster_node ] [ M mount_host ] [ T recover_host ] S ssid

nsrsnapadmin R [ s server ] [ c cluster_node ] [ v ] [ t destination ] [ M mount_host ] [ T recover_host ] S ssid m path

DESCRIPTION The nsrsnapadmin command is a command-line based program to perform operations on NetWorker snapsets.

You can do the following: Print snapsets. Delete snapsets. Change the expiration time of snapsets. Restore all the contents of the snapset. Rollback from the snapset. Browse the contents of the snapset and perform a le-by-le restore.

nsrsnapadmin provides a set of commands. Each command is further controlled by a set of options. nsrsnapadmin can operate in interactive mode or non-interactive mode. nsrsnapadmin runs in interactive mode if no command is specied or the -r command is specied for a le-by-le restore.

COMMAND SUMMARY

Here are brief descriptions of all the commands of nsrsnapadmin: B Rollback from a snapset to the original path. d Delete snapsets. e Set the expiration time snapsets. p List all the snapsets of the client on a NetWorker server. r Browse the contents of the snapset and recover les. R Restore the content of the snapset.

COMMAND OPTIONS

This section describes the command options that are available across several nsrsnapadmin commands. Every command does not support all of the options. How- ever, when an aption is supported with multiple commands the meaning is always the same.

c cluster_node cluster_node is the name of the virtual cluster host in a cluster setup, of which this host is just one of the nodes. If this option is not specied, the local

NetWorker 19.1.1 323

Maintenance Commands NSRSNAPADMIN ( 1m )

machine is assumed as the client. Those nsrsnapadmin commands that take only this option cannot perform operations on remote clients.

c remote_client remote_client is the name of the machine that saved the les. If this option is not specied, the local machine is assumed as the client.

c remote_client/cluster_node The argument can either be a remote_client or a cluster_node.

F Force. This option is used with rollback to force a rollback. If this option is not specied nsrsnapadmin tries to nd if it is safe to do a rollback.

m path Species the path to recover.

M mount_host The name of the machine that would be used to mount/access the snapshots. If this option is not specied, the local machine is assumed to be the mount host.

t directory Species the destination directory to relocate the recovered les.

T recover_target_client Species the name of the remote machine to direct the recovery. If this option is not specied, the les are recovered on the local machine.

s server Selects which NetWorker server to use. The default value is the local machine.

S ssid Species which Snapset ID to operate on. Some commands can take multiple ssids enclosed in double quotes.

v Verbose. More information is printed if this option is specied.

A attr=val Adds specic attributes and values to commands. No error checking is done. Not all commands take attribute value pairs. Multiple -A attr=val are allowed.

DETAILED COMMANDS AND

OPTIONS

Here are details on the options of nsrsnapadmin commands. This section refers to the standard options and some of the special options/arguments that each command sup- ports.

B [ s server ] [ c cluster_node] [ Fv ] [ M mount_host ] S ssid A attr=val m path

This command takes the standard options.

d [ s server ] [ c cluster_node] [ v ] [ a ] [ y ] S ssid (or "ssid ssid ...")

This command takes the standard options and deletes the specied snapshot saveset(s).

Use the -a option to delete all snapshot savesets associated with the specied snapshot saveset as well as the physical snapshot. This list of associated snapshot savesets is displayed and you must conrm that you want to do this. Add the -y option to delete these savesets and the snapshot without conrmation.

e time [ s server ] [ c cluster_node] [ v ] S ssid (or "ssid ssid ...")

This command takes the standard options.

NetWorker 19.1.1 324

Maintenance Commands NSRSNAPADMIN ( 1m )

time is a mandatory argument. The expiration time will be reset to this time. The expiration time should be specied in the format that is accepted by the the function nsr_getdate(1m).

p [ s server ] [ c remote_client/cluster_node ] [ v ] [ S ssid ] [ path ]

This command takes standard options.

If the -S option is specied, it prints the saveset ids of all snapshot savesets associated with the specied saveset id.

If the -v option is specied it prints an extra eld: snap ID.

If path is specied, it prints only those snapsets whose names start with the path. If path is omitted all snapsets for the client on the NetWorker server are printed.

r [ s server ] [ c remote_client/cluster_node ] [ M mount_host ] [ T recover_host ] [ S ssid ] A attr=val

This command takes the standard options. This command starts an interactive session. The interactive session is controlled by a totally different set of commands.

R [ s server ] [ c cluster_node ] [ v ] [ t destination ] [ M mount_host ] [ T recover_host ] S ssid m path A attr=val

This command takes standard options.

SNAPSET BROWSING

COMMANDS

The -r command of nsrsnapadmin takes you to an interactive session: the browsing session. The browsing session presents the image of the lesystem (that was backed up) as it existed at the time of backup. The browsing session is controlled by another set of commands. In all of the commands that take a name argument pattern matching characters can be used. The pattern matching characters and regular expression for- mat are the same as for the UNIX shell sh(1). The commands are listed below. The short form of the command can be used which is enough letters to uniquely identify a command.

ls [ options ] [ name ... ] List information about the given les and directories. When no name argu- ments are given, ls lists the contents of the current directory. When a name is given and name is a directory, its contents are displayed. If name is a le, then just that le is displayed. The current directory is represented by a . (period). The options to this command correspond to those of the UNIX com- mand, ls(1). Files that have been added to the recover list are preceded by a +.

lf [ name ... ] Is the same as ls F. Directories are marked with a trailing /, symbolic links with a trailing @, sockets with a trailing =, FIFO special les with a trailing , and executable les with a trailing .

ll [ name ... ] Is the same as ls lgsF. Generates a long format listing of les and directories. This command can be used to nd the value of a symbolic link.

NetWorker 19.1.1 325

Maintenance Commands NSRSNAPADMIN ( 1m )

cd [ directory ] Change the current working directory to [ directory ]. The default directory is the mount point of the lesystem that was backed up. If directory is a simple symbolic link, cd will follow the symbolic link. However, if directory is a path containing symbolic links anywhere but at the end of the path, the cd com- mand will fail; you should cd one component of the path at a time instead.

pwd Print the full pathname of the current working directory.

add [ name ... ] Add the current directory, or the named le(s) or directory(s) to the recover list. If a directory is specied, it and all of its descendent les are added to the recover list. Symbolic links are not followed, though the link le itself will be recovered.

debug [ level ] Turn on or turn off debugging. Level must be a number. If level is 0, debug- ging is off. As the debug level goes higher, the recover command prints out more messages. By default, debugging is off.

delete [ name ... ] Delete the current directory, or the named le(s) or directory(s) from the recover list. If a directory is specied, that directory and all its descendents are deleted from the list. The most expedient way to recover a majority of les from a directory is to add the directory to the recover list, and then delete the unwanted les.

dir [ /w ] [ lename... ] This command is similar to the "ll" command with the following differences. The dir command uses the display format used by "dir" command in the DOS command prompt. Also, this command does not add a + to the les selected for recovery. With /w option, the names of the les or directories only are displayed.

list [ l ] [ c ] Display the les on the recover list. With no arguments the recover list is displayed as a list of full path names, one per line, followed by a total count of the les to be recovered. The -c argument prints just the total count of les to be recovered. The -l argument prints the les in the same format as the ll command with the dS options.

recover Recover all of the les on the recover list from the NetWorker server. Upon completion the recover list is empty.

relocate [ directory ] Change the target recover location to directory . If directory is not specied then the user will be prompted for a destination directory. Relative paths are inter- preted relative to the current working directory within the recover program. The recovered les will be placed into this directory, which will be created if necessary. When les from multiple directories are being recovered, they will be placed below this directory with a path relative to the rst common parent of all the les to be recovered. For example, if /usr/include/sys/errno.h and /usr/include/stdio.h are being recovered, and the relocation directory is set to /tmp , then the rst common parent of these two les is included, so the recovered les will be named /tmp/sys/errno.h and /tmp/stdio.h .

destination Print the destination location for the recovered le.

NetWorker 19.1.1 326

Maintenance Commands NSRSNAPADMIN ( 1m )

quit Exit from the browsing session. Files on the recover list are not recovered.

exit Exit from the browsing session.

help Display a summary of the available commands.

? Same as help.

SEE ALSO ls(1), nsr_getdate(3)

NetWorker 19.1.1 327

Maintenance Commands nsrsnapck ( 1m )

NAME nsrsnapck - NetWorker snapset validation and deletion utility.

SYNOPSIS nsrsnapck [ s server ] [ vy ] [ c cluster_node ]

[ s server ] [ c cluster_node ] [ vxy ] d S ssid [ S ssid ]...

DESCRIPTION nsrsnapck is a NetWorker client side utility to delete and validate snapsets.

If the d option is not specied, the binary nds all the snapsets corresponding to the client on which the binary is run. It then validates the snapsets and if the snapsets are not valid, they are deleted.

OPTIONS c cluster_node cluster_node is the name of the virtual cluster host in a cluster setup, of which this host is just one of the nodes. If this option is not specied, the local machine is assumed as the client.

d Delete the specied snapsets.

s server Selects which NetWorker server to use. The default value is the local machine.

S ssid Species which Snapset ID to operate on.

v Verbose. More information is printed if this option is specied.

x Do not prune the application catalog. Currently applicable to Oracle catalogs. By default, application catalog pruning is switched on.

y Dont prompt for user input for deletion. By default the user is prompted before deleting the snapset.

EXAMPLES To delete snapset IDs: 2654636090 7637858874 for a client of the NetWorker server jupiter, the command will be:

nsrsnapck -s jupiter -d -S 2654636090 -S 7637858874

NetWorker 19.1.1 328

Maintenance Commands NSRSNAP_RECOVER ( 1m )

NAME nsrsnap_recover recover NetWorker les created from snapshot based backups.

SYNOPSIS nsrsnap_recover [ R ] [ b basepath ] [ c client_name ] [ d destination ] [ f metadata_le ] [ n namespace ] [ s server ] [ A RESTORE_TYPE_ORDER=restore_type_order ] [ o restore_type_order ] [ i {NYR} ] [ D debug_level ] [ I input_le ] [ M mount_host ] [ K metadata_key ] S ssid t savetime ] path . . .

DESCRIPTION nsrsnap_recover can be used to recover data from a snap set or a save set.

nsrsnap_recover allows users to recover data from tape or a point-in-time snapshot. It is not mandatory to specify an attribute list to nsrsnap_recover. The default "restore_type_order" for save set restores is conventional. NOTE: running nsrsnap_recover directly is not recommended for snap set or save set recovery; use nsrsnapadmin(1m) instead.

The user needs to specify either the snap set or save set ID or the snap set or save set time.

The user has to specify the les to be recovered on the command line. However all the les have to belong to the same snap set or save set.

OPTIONS b basepath Species the base pathname to use for relative path names. Used with the -I option.

c client_name Species the client name for starting the recover session.

d destination Species the destination directory to relocate recovered les.

f metadata_le Species the le name to which metadata information is recovered.

n namespace Species a namespace for recover.

s server Selects which NetWorker server to use.

t savetime Species a savetime of save set for the save set to be recovered.

A RESTORE_TYPE_ORDER=restore_type_order

o restore_type_order Default is pit:conventional. Uses a colon separated string.

i conicting le action Species the overwrite response to use when recovering existing les. Only one letter may be specied. The default behavior will be to overwrite the les, if this option is not provided. 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. Valid values are N, Y, and R.

D debug_level Species the debug level to use. debug_level is a number between 0-9.

I input_le Species an input le of les to recover. See also -b.

In addition to taking the paths to recover from the command line, read paths

NetWorker 19.1.1 329

Maintenance Commands NSRSNAP_RECOVER ( 1m )

to recover from the named le. The paths must be listed one per line. If no paths are specied on the command line, then only those paths specied in the le will be recovered.

nsrsnap_recover allows the restore of more than one saveset per restore ses- sion. Use of the "-I" command line option allows input le specication of saveset IDs and associated le paths to be recovered.

If neither the -S or -t option is specied on the command line with -I, the con- tents of the specied input le will be expected to have a different format, and will be interpreted differently. In such cases, nsrsnap_recover will expect each line of the input le to have the following format: ssid=

Each line of the le must identify a single le path to be restored, and the ID of the saveset that it will be restored from. For example: ssid=4145682356 /etc/hosts ssid=4145682356 /etc/vfstab ssid=4188238921 /etc/motd

White space will be the delimiter for the two values specied on each line. In cases where a le path contains white space, the path must be surrounded by double quotes. For example: ssid=4874309231 "/My File Directory/mytestdoc.doc"

Other than -S and -t, all options that are available on the nsrsnap_recover com- mand line will apply to all saveset restores for savesets listed in the input le. For example, if an alternate destination path is specied with "-d", all les from all the specied savesets will be restored to the same alternate destina- tion. Also, if the -b option is specied, the value specied will be used as the base path for all les specied in the input le.

When using this feature, you must ensure that all the savesets specied in the input are of the same type, since what you specify on the command line will apply to all savesets that are listed in the le. The type of storage array must be the same for all savesets listed as well. Errors will likely occur if you do not follow this guideline.

M mount_host The name of the computer that would be used to mount/access the snapshots. If this option is not specied, the local computer is assumed to be the mount host.

K metadata_key Species metadata key for recover metadata.

S ssid Species the save set ids for the save set to be recovered.

R Rollback the contents of the snap set or save set to the original source LUN(s).

SEE ALSO save(1m), nsr_client(5), nsr_protection_group(5), nsrd(1m), recover(1m), savefs(1m), savegrp(1m), nsrworkow(1m), nsrsnap(1m) nsrsnapadmin(1m), nsrsnap_save(1m), nsrpsd(1m)

EXAMPLES OF USAGE

nsrsnap_recover s ledma243 M ledma011 S 4088878394 o pit:conventional D9 /FS1

NetWorker 19.1.1 330

Maintenance Commands NSRSNAP_RECOVER ( 1m )

(Setting the restore_type_order as shown above uses pit recover followed by conven- tional recover. Note that this option could also have been specied with A RESTORE_TYPE_ORDER=pit:conventional)

OR

nsrsnap_recover s ledma243 M ledma011 S 4088878394 D9 /data3

(The above example uses the default restore_type_order of pit:conventional)

DIAGNOSTICS Exit Codes 0 Normal exit.

<>0 Abnormal exit. The command failed.

NetWorker 19.1.1 331

Maintenance Commands NSRSNAP_SAVE ( 1m )

NAME nsrsnap_save create a snapshot based backup for le system

SYNOPSIS nsrsnap_save [ BCEdniKLnquSVvx ] [ s server ] [ c client-name ] [ N name ] [ e expiration ] [ f dirle ] [ b pool ] [ F le ] [ I input_le ] [ g group ] [ l level ] [ t date ] [ m masquerade ] [ w browse_time ] [ y retention_time ] [ D debug_level ] [ W width ] [ path . . . ]

DESCRIPTION nsrsnap_save can be used to backup data to a snap set or a save set.

If no path arguments are specied on the command line or via the -I option, the current directory will be used as the default path.

OPTIONS b pool Species a particular destination pool for the save.

c client-name Species the client name for starting the save session.

e expiration Set the date (in nsr_getdate(3) format) when the saved data will expire.

f dirle The le from which to read prototype default directives (see nsr(5)). A dirle of - causes the default directives to be read from standard input.

g group This option is used by savegrp(1m) and savefs(1m) to denote the group of the save (see nsr_client(5) and nsrworkow(1m)) and is used by the NetWorker server to select the specic media pool.

i nsrsnap_save will ignore this option.

l level The level of the save. This option is used by savegrp(1m) and savefs(1m) to specify a particular level for a scheduled save.

m masquerade nsrsnap_save will ignore this option.

n nsrsnap_save will ignore this option.

q Quiet. Displays only summary information and error messages.

s server Species which machine to use as the NetWorker server.

t date The date (in nsr_getdate(3) format) by which les must have been modied for them to be saved. This option is used by savegrp(1m) and savefs(1m) to per- form scheduled saves by consulting with the media database to determine the appropriate time value based on the previous saves for the save set and the level of the scheduled save.

u Stop the save if an error occurs. The save program normally treats errors as warnings and continues to save the rest of the les in the backup. When this option is set, errors will cause save to exit and abort the save. This option is not recommended for general use, although it can be useful when a group of les needs to be backed up as a set.

v Verbose. Causes the save program to provide great detail about the save as it proceeds.

y retention Sets the date (in nsr_getdate(3) format) when the saved data will become recyclable. The special value forever is used to indicate that a volume that never expires (i.e. an archive or a migration volume) must be used. By default,

NetWorker 19.1.1 332

Maintenance Commands NSRSNAP_SAVE ( 1m )

the server determines this date for the save set based on the retention policies in effect. This option allows overriding the existing policies on a save by save basis.

w browse_time Sets 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. This option allows overriding the existing policies on a save by save basis.

x nsrsnap_save will ignore this option.

B nsrsnap_save will ignore this option.

E nsrsnap_save will ignore this option.

-F le Only save les whose change time is newer than the modication date of the le.

I input_le In addition to taking the paths to save from the command line, read paths to save from the named le. The paths must be listed one per line. If no paths are specied on the command line, then only those paths specied in the le will be saved.

K Does not build connecting directory index entries.

L causes an extra line to be printed at the end of the completion output of the form complete savetime=number, where number is the savetime of the save set created by this backup. This option is meant to be used by the nsrsnap to return the backup status back to savegrp(1m) command.

M name Species which machine to use as the mount host.

N name nsrsnap_save will ignore this option.

P Create a snapset.

S nsrsnap_save will ignore this option.

V nsrsnap_save will ignore this option.

W width The width used when formatting the summary information output. Valid values for width are integer values from 1 to 10000. If the supplied width is too small for the summary to t in, the width will be silently adjusted upwards as necessary. If the supplied width is larger than the minimum needed, then spaces will be used to pad the summary to the correct width. Note that if no -W argument is supplied then there is no xed width used, and the summary simply expands to whatever minimum width is necessary.

path Specify the saveset names to be backed up. For a le system backup, it should be a valid le system, raw device, directory or le name.

SEE ALSO save(1m), nsr_client(5), nsrworkow(1m), nsrd(1m), recover(1m), savefs(1m), savegrp(1m), nsrsnap(1m) nsrsnapadmin(1m), nsrsnap_recover(1m), nsrpsd(1m)

EXAMPLES OF USAGE

nsrsnap_save s ledma243 M ledma011 /fs1

DIAGNOSTICS

NetWorker 19.1.1 333

Maintenance Commands NSRSNAP_SAVE ( 1m )

Exit Codes 0 Normal exit. This means that a save set was correctly created on the server. <>0 Abnormal exit. A save set was not correctly created on the server.

NetWorker 19.1.1 334

Maintenance Commands NSRSNMD ( 1m )

NAME nsrsnmd the NetWorker daemon that manages device operations and nsrmmd processes on the storage node.

SYNOPSIS nsrsnmd n number N version number M MAX nsrmmd processes s server [ D debug level ] [ v ]

DESCRIPTION The nsrsnmd daemon provides an RPC-based service that manages all device opera- tions nsrmmd processes on behalf of the nsrd NetWorker server.

The nsrd server maintains all of the RAP resources that describe the state of all devices and operations. The nsrsnmd daemon is the process that is responsible for ensuring that the necessary device operations actually get performed when needed by nsrd.

There is one nsrsnmd process running on each congured storage node. The nsrsnmd daemon is invoked automatically by nsrd when needed, and never needs to be started directly by a user. The RPC program number for nsrsnmd is 390111.

OPTIONS n number nsrsnmd daemon number.

N version number nsrsnmd program version number.

M MAX nsrmmd processes The maximum number of nsrmmd processes allowd on this storage node.

s server The controlling NetWorker server.

D debug level Sets the debug level.

v Increments the verbosity level of the output. This option can be provided mul- tiple times and its effects are additive.

/nsr/logs/daemon.raw The le to which nsrsnmd and other NetWorker daemons send information about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

SEE ALSO nsr(1m), nsr_service(5), nsrd(1m),

NetWorker 19.1.1 335

Maintenance Commands nsrsqliteasm ( 1m )

NAME nsrsqliteasm NetWorker module for backing up internal SQLite databases

SYNOPSIS nsrsqliteasm [standard-asm-arguments]

DESCRIPTION The nsrsqliteasm is a standard, external ASM (Application Specic Module). It assists in the online backup of SQLite databases used internally in NetWorker.

See uasm(1m) for a general description of ASM and the [standard-asm-arguments].

It is intended that nsrsqliteasm be invoked automatically during bootstrap backup and recovery. It is not intended to be a general-purpose SQLite application module.

SEE ALSO nsrdr(1m), savegrp(1m), nsrworkow(1m), uasm(1m)

NetWorker 19.1.1 336

Maintenance Commands nsrstage ( 1m )

NAME nsrstage NetWorker save set staging command

SYNOPSIS nsrstage [ v ] [ F ] [ d ] [ s server ] [ J storage-node ] [ b pool ] [ y retention ] m S { f le ssid[/cloneid]... }

nsrstage [ v ] [ s server ] [ J storage-node ] [ y retention ] C V volume

DESCRIPTION The nsrstage program is used to migrate existing save sets on a manual basis. Migra- tion is the process of moving one or more save sets between storage volumes. The process begins by making a clone of the specic save sets to the new volume specied, and then deleting the cloned save set entries from the media database (see the -S description). Finally, if necessary, the save sets will be removed from the original source volumes. The second and the third operations are triggered by the successful completion of the previous operation. The data is moved to new media volumes, mak- ing room for new data on the original volumes.

Migration can be onto any media type (for example: save sets on a disk family volume can be migrated to a tape volume). The nsrstage program does not perform simple volume migration; it migrates full save sets.

You can specify exactly which copy (clone) of a save set to use as the source. See the S option description.

If the nsrstage program encounters an error after successfully cloning some of the specied save sets, then it will delete only those successful save sets from the source volume before it gets aborted.

OPTIONS b pool Species the name of the media pool to which the data should migrate. The pool specifed may be any pool currently registered with nsrd(1m). You can view acceptable values by selecting Media Pools from the left pane of Net- Worker Management Consoles Media display. If you omit this option, the cloned save sets are automatically assigned to the Clone pool corresponding to the original pool. E.g.- if staging a save set from the Default pool, it is assigned to the Default Clone pool; if staging a save set from an Archive pool, it is assigned to the Archive Clone pool.

m Performs the actual migration operation. For Block based backup save sets, this option does not migrate save sets to the new media volumes. For volumes that have a combination of Block based backup save sets and regular Net- Worker save sets, nsrstage -m will skip over the Block based backup save sets with an error. For Data Domain retention locked save sets, this option does not migrate save sets to the new media volumes. For volumes that have a combination of Data Domain retention locked save sets and regular NetWorker save sets, nsrstage -m will skip over the Data Domain retention locked save sets with an error. Bootstrap savesets are cloned to target media and the source saveset entry is removed from the media database, but the data does not get deleted from source media.

s server Species a NetWorker server with save sets to migrate. See nsr(1m) for a description of server selection. The default is the current system.

J storage-node Species which host to use as the storage node for the recovery part of the staging process (see nsr_storage_node(5)).

v Enables verbose operation. In this mode, additional messages are displayed about the operation of nsrstage, such as: save sets that cross volumes or save set series expansions. If concurrent nsrstage operations are performed on the

NetWorker 19.1.1 337

Maintenance Commands nsrstage ( 1m )

same savesets, it is possible for the volume names to be inaccurate. If this hap- pens, nsrstage will issue a warning. Please see DIAGNOSTICS for the exact warning message.

y retention Sets the date (in nsr_getdate(3) format) when the staged data will become recyclable. The special value forever is used to indicate that a volume which never expires (i.e. an archive volume) must be used. By default, the server determines this date for the save set based on the retention policies in effect. This option allows for the overriding of the existing policies. Note: If nsrstage is run without specifying a retention time and if the stage pool does not have a retention policy congured in the RAP resource, the newly created saveset clone instance in the associated stage volume will have its clone reten- tion set to the saveset retention(maximum value of clone retention among the savesets existing clones).

d Deletes the input le that species the save set identiers to be staged. This option must always be specied in conjunction with a -f option.

C Instructs nsrstage to perform a volume cleaning operation. This will scan a volume for save sets lacking media database entries, and then recover their space. Along with the save sets being removed from the media database, space for recyclable and aborted save sets are also recovered from the volume. You can perform this operation on disk family volumes. Bootstrap savesets data does not get deleted from the media during volume cleaning.

S ssid Causes nsrstage to treat subsequent command line parameters as save set identiers. Save set identiers are unsigned numbers. You can nd out the save set identier of a save set using the mminfo -v command (see mminfo(1m)). Be sure this is the nal option specied, since all following entries are treated as a ssid. The S option is useful when you want to migrate individual save sets from a volume, or to migrate all save sets match- ing some mminfo query. The save set identiers also specify exactly which copy of a save set to use as the source. To specify exact copies, use the ssid/cloneid format for each save set identier. In this case, the ssid and the cloneid are unsigned numbers, separated by a single slash (/). You can nd out the cloneid for a particular copy by referring to the mminfo -S report. Notes: If the -S ssid/cloneid format is used, then only the specic ssid instances will be removed from media database. If the -S ssid is specied, and no cloneid is specied, then all cloned instances of the ssid will be deleted from the media database (except the one being staged). If other disk family device clone instances were removed from the media data- base as a result of staging, then those save sets will also be removed from their respective volumes, and space will be recovered.

f le Instructs nsrstage to read the save set identiers from the le specied, instead of listing them on the command line. The values must be listed one per line in the input le. The le may be -, in which case the values are read from stan- dard input.

F If specied will force nsrstage to skip all invalid savesets and continue staging.

V volume Species the name of the volume to be cleaned. This option cannot be used with S or m options.

NetWorker 19.1.1 338

Maintenance Commands nsrstage ( 1m )

EXAMPLES Migrate save sets 1234 and 4568 to a volume in the Offsite Clone pool: nsrstage b Offsite Clone -m -S 1234 4567

Migrate clone instance 12345678 of save set 1234 to a volume in the Default Clone pool: nsrstage m S 1234/12345678

Migrate all save sets created since last Saturday to a volume in the Default Clone pool: nsrstage m S mminfo r ssid \

-q savetime>last saturday

Recover space from volume jupiter.013: nsrstage C V jupiter.013

Only complete save sets can be migrated by nsrstage(1m).

DIAGNOSTICS The exit status is zero if all of the requested save sets migrated successfully; otherwise status is non-zero.

Several messages are printed denoting a temporary unavailability of nsrd(1m) for migrating data. These are self-explanatory. In addition, you may see one of the fol- lowing messages:

Adding save set series which includes ssid If running in verbose mode, this message prints when nsrstage notices that a requested save set is continued and requires the entire series to be migrated (even if only part of the series was specied by the command line parameters).

Cannot contact media database on server The media database (and probably other NetWorker services as well) on the named server is not answering queries. The server may need to be started. Or if it was just started, it needs to nish its startup checks before answering queries.

Cannot open nsrstage session with server This message prints when the server is not accepting migration sessions. A more detailed reason prints on the previous line.

number is not a valid save set The given save set identier is not valid. Two forms are understood: simple save set identiers and those with a cloneid specied. Simple save set identiers are unsigned numbers. You can specify the save set with the cloneid as two unsigned numbers separated by a single slash (/).

save set number does not exist The given save set (from a S save set list) does not exist. Verify your save set identiers using mminfo(1m).

save set clone number/cloneid does not exist You specied a specic clone of a save set, but that save has no clones with that clone identier. Verify your save set identiers using mminfo(1m).

volume name does not exist The given volume (if you specied the V option) does not exist in the media database.

waiting 30 seconds then retrying A temporary error occur. nsrstage automatically retries its request until the condition is cleared. For example, if all of the devices are busy saving or recovering, nsrstage cannot use these devices and must wait for two of them to become free.

Space can only be recovered from disk family devices. The given volume (if you specied the V option) is not a disk family volume. This message is also printed after a successful migration of data from volumes

NetWorker 19.1.1 339

Maintenance Commands nsrstage ( 1m )

of type other than disk family.

WARNING: Multiple concurrent cloning operations on the same savesets have been detected. The list of volumes reported below may not be accurate. nsrstage prints this message when it detects more clone instances than it expected. This happens when more than one nsrstage commands are run on same saveset concurrently. Verify the clone volumes using mminfo(1m). Please note that the result of the staging operation is not affected by this warn- ing.

SEE ALSO nsr_stage(5), nsrclone(1m), nsr_getdate(3), mminfo(1m), nsr(1m), nsr_device(5), nsr_pool(5), nsrd(1m), nsrmmd(1m)

NetWorker 19.1.1 340

Maintenance Commands nsrtask ( 1m )

NAME nsrtask execute an action based on a NetWorker resource

SYNOPSIS nsrtask [ Cnv ] [ t resource_type ] NSR_resource_name

DESCRIPTION The nsrtask program executes actions on a periodic basis. It is normally run automati- cally by nsrd(1m) as specied by a nsr_task(5) resource or other applicable resources.

The nsrtask program will query the NetWorker server for a resource of type resource_type and name NSR_resource_name . If resource_type is not specied, then nsr_task is the assumed resource type. From there nsrtask will access the information from the respective resource it needs and spawn the command accordingly by setting up an RPC connection with nsrjobd(1m) to request the execution of its desired com- mand.

OPTIONS C Causes nsrtask to check the plan attribute to determine if it should run or not. This is only applicable to nsr_task resource operations.

i index For internal use, applicable only to recover operations - indicates which item from the multivalued recover options should be used for a given run.

m For internal use, applicable only to recover operations - indicates to the nsrtask subsystem that it is permitted for multiple instances of nsrtask with a given name to run concurrently.

t resource_type Species what type of resource to use for guring out the task to be run. If nothing is specied then the resource is assumed to be a nsr_task resource.

v Increments the verbosity level of the output. This option can be provided mul- tiple times and its effects are additive.

RESOURCE TYPES NSR task The attribute plan determines whether the tasks actions are executed or skipped. The attribute action determines what command resources are to be used for execution.

NSR recover The task action is built by combining the recover command and recover options in that order. It is spawned on the machine referenced in the attribute destination client.

FILES /nsr/logs/daemon.raw Log le containing messages from running the nsrtask pro- gram. daemon.raw also contains other log messages from other NetWorker binaries.

SEE ALSO nsr_service(5), nsr_hypervisor(5), nsr_task(5), nsr_recover(5), nsr_resource(5), nsr(1m), nsradmin(1m), nsrjobd(1m), nsrvim(1m)

NetWorker 19.1.1 341

Maintenance Commands nsrtrap ( 1m )

NAME nsrtrap snmp notication scheme for NetWorker messages

SYNOPSIS nsrtrap [ c community ] [ i version ] [ t trap-type ] [ s specic-type ] [ v ] network_management_station

DESCRIPTION nsrtrap is a mechanism to send NetWorker notications using the Simple Network Management Protocol(SNMP) trap mechanism. A NetWorker administrator could create a custom NetWorker notication scheme based on nsrtrap by conguring the NetWorker events and priorities.

A NetWorker administrator could create notication schemes to receive messages on different network management consoles by conguring the events and priorities and specifying the desired network management station as the location to receive the trap messages.

To create a new SNMP notication, follow the steps below:

1. Open the Notications window from the Customize menu.

2. Choose the Details option under the View menu.

3. Click on the Create button.

4. Enter the name of the new notication in the Name eld.

5. In the Action eld, enter the command nsrtrap along with the network management station name to which the networker SNMP notication should be sent. For example: /usr/sbin/nsrtrap -c networker SNMPhost where SNMPhost is the hostname of the SNMP network management station.

6. Set the events and priorities desired.

7. Click on the Apply button.

OPTIONS c community The SNMP community string. This option allows you to specify the SNMP community that is authorized to receive traps from the Net- Worker server. SNMP communities are congured on the SNMP server. This option defaults to "public".

i version The SNMP version. This option allows you to specify the SNMP ver- sion. The value 1 for SNMPv1 and the value 2 for SNMPv2. This options defaults to "2".

s specic-type This option is a generic setting that can be used to identify the type of trap the NetWorker server is sending. This option can be set to any integer value and may be used in conjunction with different SNMP notications to distinguish different traps coming from the NetWorker server. For example, you can create multiple SNMP notications: one for critical messages, another for warnings and another for other events or priorities. You can then use the -s option to differentiate the various notications so that the SNMP management software can determine which type of trap is being sent.

t trap-type One of the SNMP trap types[0-6]. The default is 6, the "enterprise- specic" trap type.

v Sets the Output mode to verbose. In verbose mode, nsrtrap echoes the community, trap type, specic trap type, and the hostname or IP address to the command line.

NetWorker 19.1.1 342

Maintenance Commands nsrtrap ( 1m )

SEE ALSO nsr(1m) nsr_notication(5) nsr_resource(5)

NetWorker 19.1.1 343

Maintenance Commands nsrtund ( 1m )

NAME nsrtund NetWorker tunnel daemon

SYNOPSIS nsrtund

DESCRIPTION nsrtund is managed by nsrexecd(1m). For each NSR tunnel resource congured and enabled in a hosts NSRLA RAP database, nsrexecd spawns a nsrtund process. nsrtund manages one end of a NetWorker tunnel.

SEE ALSO nsr(5), nsr_tunnel(5), nsr_la(5), nsr(1m), nsrexecd(1m),

NetWorker 19.1.1 344

Maintenance Commands nsrvbar ( 1m )

NAME nsrvbar VMware File Level Recovery application

SYNOPSIS nsrvbar [ vba hostname IP v hostname IP ] [ adminuser username g username ] [ adminpass password e password ] [ locallogin username

l username ] [ localpass password s password ] [ backups B ] [ backup backup b backup ] [ sourceclients C ] [ sourceclient clientFQN c clientFQN ] [ targetclient clientFQN z clientFQN ] [ targetpath path d path ] [ targetuser username N username ] [ targetpass password O password ] [ add path n path ] [ recover [path] r [path] ] [ status t ] [ activity o ] [ automatic a ] [ help [command] h [command] ]

DESCRIPTION The VMware-FLR program recovers le(s) and/or folder(s) from backups on a Virtual Backup Appliance (VBA) and restores them to a virtual machine client. If the user provides login credentials for a user on the current client on which this VMware-FLR program is running, they will only be able to restore les to the current client, from backups taken of the current client. However if the user provides login credentials for an administrative user on a vCenter, they will be able to restore les to any client, from backups taken of any client on that vCenter.

VMware-FLR operates in one of two modes: interactive or command line. While in interactive mode, the VMware-FLR enters a command loop and executes one com- mand at a time. While in command line mode, VMware-FLR executes a single com- mand, issued from the OS command shell and then automatically exits.

Note: Every option listed below can also be a command (unless otherwise specied). A command is nothing more than the rst option on the command line. A command does not require the leading dash(s).

OPTIONS ad d path n path Add path from the selected backup to the recover queue.

activity o Display the status of all recover requests.

ad m in p ass password e password Enter the password for the vCenter username (command line mode only).

ad m in u ser username g username Enter the login username for the vCenter (command line mode only).

automatic a Execute the specied command and then exit the application (command line mode only).

b ack u p backup b backup Set the backup that will be browsed and used for restore operations.

backups B List all backups for the source client.

clearclients F Clears both the selected source and target clients.

d elet e path i path Remove path from the recover queue.

h elp [command] h [command] Display this help text or the help text of the specied command .

localp ass password s password Enter the password for the local client username (command line mode only).

NetWorker 19.1.1 345

Maintenance Commands nsrvbar ( 1m )

localu ser username f username Enter the login username for the local client (command line mode only).

r ecov er [path] r [path] Execute a recover operation using path. path can be set using add option.

queue u List all of the paths added to the recover queue.

quit q Exit from the VMware-FLR application.

sourceclients C List all available source clients on the vCenter that are protected by the VBA.

sou r ceclien t clientFQN c clientFQN Set the client whose backups will be browsed and that will be used as the source for the restore operation.

status t Display the status of the VMware-FLR application.

t ar get clien t clientFQN z clientFQN Set the client that will be the target of the restore operation.

targetclients E List all clients on the vCenter that are protected by the VBA.

t ar get p ass password O password Enter the password for the local client username (command line mode only).

t ar get p at h path d path Set the le system target path on the target client.

t ar get u ser username N username Enter the login username for the local client (command line mode only).

v b a hostname IP v hostname IP Set the hostname or IP address for the Virtual Backup Appliance (VBA).

version w Display the VBA version number.

COMMANDS When in interactive mode all options (unless otherwise specied) can be used can be used as commands. The following commands can only be used in interactive mode. The dashes are optional when using them interactively.

ad m in login username p username Enter vCenter login credentials.

cd path j path Change the backup working folder.

locallogin username l username Enter client login credentials.

ls m List the les in the backup working folder.

pwd k Display the backup working folder.

t ar get login username M username Enter client login credentials.

t cd path A path Change the selected target clients working folder.

tdir X

NetWorker 19.1.1 346

Maintenance Commands nsrvbar ( 1m )

List only the folders in the selected target clients working folder.

tls L List only the folders in the selected target clients working folder.

tpwd P Display the selected target clients working folder.

EXAMPLE The following command allows you to restore a le or a directory that was backed up on the Virtual Backup appliance. # nsrvbar vba 10.7.84.200 adminuser root adminpass vmware sourceclient /10.7.84.219/VirtualMachines/test targetclient /10.7.84.219/VirtualMachines/test-win targetpath C: targetuser Administrator targetpass Test123 recover [Disk#1] Successfully connected to VBA: (10.7.84.200) Successfully logged in as adminstrator: (root) Source client: (/10.7.84.219/VirtualMachines/test) selected. Target client: (/10.7.84.219/VirtualMachines/lava12204-win) selected. Successfully logged into target client: (/10.7.84.219/VirtualMachines/test-win) as user: (Administrator). The restore request has been successfully issued to the VBA. vmware-r>

The following command adds a path into the restore queue. #nsrvba add /tmp/test (for Linux Client) #nsrvba add [Disk#1]\\cli\\rexmaple.txt (for Window Client)

SEE ALSO nsrvbapmgr(1m), nsrvbarecover(1m)

NetWorker 19.1.1 347

Maintenance Commands nsrvbapmgr ( 1m )

NAME nsrvbapmgr Proxy Manager application

SYNOPSIS nsrvbapmgr [ vba hostname IP v hostname IP ] [ vcenter hostname IP z hostname IP ] [ vcuser username c username ] [ vcpass password C password ] [ vbauser username e username ] [ vbapass password E password ] [ esxdatastore esx_datastore n esx_datastore ] [ esxhost esx_hostnamepath j esx_hostnamepath ] [ esxnetwork esx_network k esx_network ] [ health proxyname p proxyname ] [ proxyname proxyname i proxyname ] [ proxydns DNS m DNS ] [ proxygateway gateway_IP s gateway_IP ] [ proxies b ] [ proxyip proxy_IP l proxy_IP ] [ proxynetmask network_mask o network_mask ] [ proxyuser username U username ] [ proxypass password P password ] [ register proxyname f proxyname ] [ targetvba vba_hostname IP u vba_hostname IP ] [ vbadomain vba_domain g vba_domain ] [ vcdatacenter datacentername B datacentername ] [ status w ] [ tasks x ] [ deploy d ] [ automatic a ] [ delete proxyname [ force] t proxyname [ force] ] [ help [command] h [command] ]

DESCRIPTION The PMGR-CLI program allows the user to manage VBA proxies. You can deploy new proxies as well as check the health status or delete existing proxies, all from the command line. The PMGR-CLI operates in one of two modes: interactive or command line. While in interactive mode, the PMGR-CLI enters a command loop and executes one command at a time. While in command line mode, PMGR-CLI executes a single command, issued from the OS command shell and then automatically exits.

Note: Every option listed below can also be a command (unless otherwise specied). A command is nothing more than the rst option on the command line. A command does not require the leading dash(s).

OPTIONS automatic a Exit the Proxy Manager application (command line mode only).

changepass proxyname r proxyname Change the password on a proxynames user account.

d elet e proxyname [ force] t proxyname [ force] Delete/retire an existing proxy. If the proxy is used in groups, it cannot be deleted. Use the force ag to delete an assigned proxy.

deploy d Deploys and powers on the new proxy.

esx d at ast or e esx_datastore n esx_datastore Set the ESX datastore on which the proxy is to be deployed.

esx h ost esx_hostnamepath j esx_hostnamepath Set the ESX server that is to host the new proxy.

esx n et w or k esx_network k esx_network Set the ESXs network that the new proxy will use.

h ealt h proxyname p proxyname Display the health status of the specied proxy.

h elp [command] h [command] Display this help text or the help text of the specied command.

p r ox y n am e proxyname i proxyname Set the new proxies name using short name or fully qualied domain name.

NetWorker 19.1.1 348

Maintenance Commands nsrvbapmgr ( 1m )

p r ox y d n s DNS m DNS Set the DNS(s) for the new proxy. This is comma delimited list.

p r ox y gat ew ay gateway_IP s gateway_IP Set the network gateway for the new proxy.

proxies b List all of the deployed proxies.

p r ox y ip proxy_IP l proxy_IP Set the proxies IP address.

p r ox y n et m ask network_mask o network_mask Set the network mask for the new proxy.

p r ox y u ser username U username Set the proxy username of the account whos password is to be changed.

p r ox y p ass password P password Set the new password on the proxy account that is to have its password changed.

quit q Exit from the Proxy Manager application.

r egist er proxyname f proxyname Register a deployed proxy with the VBA.

t ar get v b a vba_hostname IP u vba_hostname IP Set the VBA on which the proxy is to be deployed. The default is the connec- tion VBA.

status w Display that current status of the Proxy Manager application.

tasks x Check on the status of all tasks.

v b a hostname IP v hostname IP Connect to the Virtual Backup Appliance (VBA).

v b ad om ain vba_domain g vba_domain Specify the VBA domain for the proxy. The default is "clients".

v b ap ass password E password Enter the password for the VBA password (command line mode only).

v b au ser username e username Enter the username for the VBA username (command line mode only).

v cen t er hostname IP z hostname IP Set the vCenter where the proxy will be deployed.

v cd at acen t er datacentername B datacentername Set the datacenter where the proxy is to be deployed.

v cp ass password C password Enter the password for the vCenter username (command line mode only).

v cu ser username c username Enter the username for the vCenter username (command line mode only).

COMMANDS When in interactive mode all options (unless otherwise specied) can be used can be used as commands. The following commands can only be used in interactive mode. The dashes are optional when using them interactively.

v b alogin username L username Enter the VBA login credentials.

NetWorker 19.1.1 349

Maintenance Commands nsrvbapmgr ( 1m )

v clogin username y username Enter the vCenter login credentials.

EXAMPLE The following command deploys a proxy in the automatic mode. # nsrvbapmgr vba 10.7.84.200 vcenter 10.7.84.219 vcuser root vcpass vmware vcdatacenter Datacenter esxhost lava246017 esxdatastore datastore1 esxnetwork subnet184 proxyname lava12207 proxyip 10.7.84.207 proxydns 10.7.1.1 proxygateway 10.7.1.2 proxynetmask 255.255.255.0 vbauser root vbapass test12345 deploy automatic Successfully connected to VBA: (10.7.84.200:8543) Successfully set vCenter to: (10.7.84.219). Successfully set vCenter user to: (root). Successfully set vCenter user password.

Successfully logged into vCenter: (10.7.84.219). Successfully set VBA user to: (root). Successfully set VBA user password. Successfully logged into VBA : (10.7.84.200:8543). Successfully set datacenter to : (Datacenter). Successfully set ESX host to: (lava246017). Successfully set ESX datastore to: (datastore1). Successfully set ESX network to: (subnet184). Successfully set proxies name to: (lava12207) Successfully set proxies IP address to: (10.7.84.208) Successfully set DNS(s) for the new proxy to: (10.7.1.1) Successfully set network gateway for the new proxy to: (10.7.1.2). Successfully set network mask for the new proxy to: (255.255.255.0) Successfully requested deployment of proxy (lava12208.dtlt.local). Task ID: (task-1690).

The following example illustrates the use of a username with \ in the automatic mode. C:>nsrvbapmgr vba 10.7.84.200 vcenter 10.7.84.219 vcuser namedir\nemo (Windows) #nsrvbapmgr vba 10.7.84.200 vcenter 10.7.84.219 vcuser namedir\\\\nemo (Linux)

If a host is in the cluster, use /hostName. Double quotation marks are used for parameters with spaces. #nsrvbapmgr vba 10.7.84.200 vcenter 10.7.84.219 esxhost Cluster/lava12204.dtlt.local esxnetwork \"VM Network\"

The following command delete the registered and assigned proxy. #nsrvbapmgr delete force lava12207

SEE ALSO nsrvbar(1m), nsrvbarecover(1m)

NetWorker 19.1.1 350

Maintenance Commands nsrvbarecover ( 1m )

NAME nsrvbarecover Networker System Recovery application

SYNOPSIS nsrvbarecover [ vba hostname IP v hostname IP ] [ vbauser username f username ] [ vbapass password b password ] [ vcenter hostname IP V hostname IP ][ vcuser username g username ] [ vcpass password e password ] [ clients C ] [ client name

c name ] [ overwrite [ yes no ] o [ yes no ] ] [ destination id d id ] [ datastores L ] [ datastore name E name [ savesets S ] [ saveset id s id ] [ vmdks Z ] [ vmdk id K id ] [ diskids I ] [ diskid id i id ] [ vms M ] [ newname newname u newname ] [ poweron [ yes no ] n [ yes no ] ] [ reconnectnic [ yes no ] R [ yes no ] ] [ status t ] [ tasks T ] [ vbaversion N ] [ vcversion O ] [ restore r ][ automatic a ] [ help [command] h [command] ]

DESCRIPTION The NWS-CLI program allows you to recover a lost VM or VMDK from savesets and restore them to a VM. NWS-CLI operates in two modes: interactive or automatic.

Interactive mode: In interactive mode, NWS-CLI enters a command loop and executes one command at a time. Each command sets some state in the program and/or exe- cutes an operation. For example, command: (vbalogin username password) sets the client credentials state in the program and executes a connection operation with the VBA server.

Automatic mode: In automatic mode, NWS-CLI executes a single command, issued from the OS command shell and then automatically exits. To run NWS-CLI in automatic mode, the command line must contain the a or automatic option. If the automatic option is not present, the command executes and NWS-CLI enters interac- tive mode. NWS-CLI automatic mode command lines are comprised of tokens. Every token can either be a command or an option to a command. The command is always the very rst token on the command line and is never preceded with or . If the token appears after the command token, it must be preceded by if the short form is used or for the long version. Most automatic commands, for example recover(1m), require that specic options be present on the command line like (vba) and (saveset) in order to execute successfully.

OPTIONS automatic a Execute the specied command, then exit nws.

clien t name c name Set the source VM for recover operation.

clients C List all VM clients on vCenter protected by the VBA.

d at ast or e name E name Set the datastore for the restore operation. Should set the datastore in the Host/Cluster when destination is specied.

datastores L List all the datastores in the vCenter.

debug D Toggles the debug mode of the NWS-CLI application.

d est in at ion id d id Set the target for the restore operation (path)/(type)/(path)(object name).

NetWorker 19.1.1 351

Maintenance Commands nsrvbarecover ( 1m )

d isk id id i id Set the VMDK SCSI ID for the restore operation.

diskids I List the valid SCSI IDs for the destination VM.

h elp [command] h [command] Display this help text or the help text of the specied command.

n ew n am e newname u newname Set the new name for the restore.

ov er w r it e [yes no] o [yes no] Specify whether the VM or VMDK will be overwritten on restore (yes/no). The Default is no. Automatic mode only.

p ow er on [[yes no] n [yes no] Specify whether the VM is powered on after restore (yes/no). Ignored for vmdks. Default is no.

quit q Exit from the NWS application.

r econ n ect n ic [yes no] R [yes no] Specify whether to reconnect the network interface card after restore. Default is yes.

restore r Perform the restore operation.

sav eset id s id Set the saveset for the restore operation.

savesets S List all savesets for the specied client. It always set the most current backup to the saveset.

status t Display the values of the various restore parameters and user selections.

tasks T Display the list of queued and running tasks.

v b a host IP v host IP Set the Virtual Backup Appliance (VBA).

v b ap ass password b password Enter the password for the VBA username (automatic mode only).

v b au ser username f username Enter the login username for the VBA (automatic mode only).

vbaversion N Display the VBA version.

v cen t er host IP V host IP Set the vCenter host.

v cp ass password e password Enter the password for the vCenter username (automatic mode only).

v cu ser username g username Enter the login username for the vCenter (automatic mode only).

vcversion O Display the vCenter version.

v m d k id K id

NetWorker 19.1.1 352

Maintenance Commands nsrvbarecover ( 1m )

Specify the name of the VMDK to restore.

vmdks Z List all the Virtual Machines Disks in the saveset.

vms M List all the Virtual Machines in the vCenter.

COMMANDS When in interactive mode all options (unless otherwise specied) can be used can be used as commands. The following commands can only be used in interactive mode. The dashes are only to be used when disambiguating them from optional parameters.

cd path A path Change the vCenter working folder.

clear yes no z yes no Clear values of the various restore parameters and user selections.

dir x List the objects in the current vCenter folder.

ls m List the objects in the current vCenter folder.

pwd k Display the vCenter working object path.

v b alogin username l username Enter the VBA login credentials.

v clogin username p username Enter vCenter login credentials.

EXAMPLE The following command allows you to recover a Virtual Backup appliance. #nsrvbarecover vba 10.7.84.200 vcenter 10.7.84.219 vcpass vmware vcuser root vbauser root vbapass test12345 d Datacenter/host/lava246017 datastores datastore 1 clients client 1 newname test restore VBA successfully set to: (10.7.84.200) Successfully logged into the VBA as: (root) vCenter successfully set to: (10.7.84.219) Successfully logged into the vCenter as: (root) 1) Client Name: lava120203_OpenSLES11, Availability: Current, Path: /Datacenter/lava246017/lava120203_OpenSLES11 2) Client Name: lava12208-test-win7, Availability: Current, Path: /Datacenter/lava246017/lava12208-test-win7 3) Client Name: lava12209-win, Availability: Historic, Path: /Datacenter/lava246017/lava12209-win Selected Client Name: lava120203_OpenSLES11 Destination successfully set to: (Datacenter/host/lava246017) Datastores:

1) datastore1 2) datastore2

Datastore successfully set to (datastore1) New name successfully set to: (test) The restore request has been successfully issued to the VBA.

Examples of how to set a destination are provided below: Esx host : path/host/pathhostName destination Datacenter/host/lava111.dtlt.local destination Datacenter2/host/lava24619

NetWorker 19.1.1 353

Maintenance Commands nsrvbarecover ( 1m )

destination Datacenter/host/folder1/lava111.dtlt.local

Cluster: path/host/pathclusterName destination Datacenter/host/Cluster

Esx host in the Cluster: path/host/clusterName/hostnName -destination Datacenter/host/Cluster2/lava222.dtlt.local

Pool : path/host/hostName/Resources/poolName destination Datacenter/host/lava111.dtlt.local/Resources/privatePool

VM : path/vm/vmName destination Datacenter/vm/lava12208-win7-machine

A sample interactive session might look like the following: nws vba 10.20.30.40 nws vbalogin nancy password nws clients nws client 50127039-6b36-53d2-c991-6cf3e69e812d nws savesets nws saveset fe00df95a231e6ecef819136de0b6094300f3e87 nws destination mv-47 nws recover

SEE ALSO nsrvbar(1m), nsrvbapmgr(1m)

NetWorker 19.1.1 354

Maintenance Commands nsrvba_cpsave ( 1m )

NAME nsrvba_cpsave backup VBA nodes at a particular checkpoint

SYNOPSIS nsrvba_cpsave [ -s networker_server_name ] [ -j parent_jobid ] -p policy_name -b destination_pool -f lename [ -y retention_time ] [ -w browse_time ] [ -D debug_level ]

DESCRIPTION nsrvba_cpsave starts checkpoint save jobs on each VMware backup appliance (VBA) associated with a data protection policy, then monitors each checkpoint save job until completion. The destination pool attribute of the named action resource determines the destination media pool for the backup of the VBA checkpoint.

nsrvba_cpsave reads the checkpoint backup path input from standard in and places most of its output on standard error. When a saveset of a VBA checkpoint is com- pleted the saveset id and clone id are written to standard out. The input to nsrvba_cpsave is provided from nsrdiscover on standard in.

OPTIONS -s networker_server_name The name of the networker server used to assist in performing the backup. If this option is omitted the default networker server is discovered and used.

-j parent_jobid nsrvba_cpsave operates within the Networker job hierarchy managed with nsrjobd. This ag species the id of nsrvba_cpsaves parent job.

-p policy_name The name of the data protection policy resource that will be added as a saveset attribute. This is needed for NMC reporting purposes.

-b destinatio_pool The name of the media pool where the VBA checkpoint will be backed up.

-f lename The input lename consisting of VBA checkpoint paths to backup. If - is specied, input will be read from STDIN.

-y retention_time Data retention time for the VBA checkpoint backups.

-w browse_time Browse retention time for the VBA checkpoint backups.

-D debug_level A number from 0 to 9 species the amount of debug tracing information to display to standard error. A higher value displays more information.

FILES /nsr/logs/policy/POLICYNAME The directory where logs for VBA checkpoint backup will be placed.

/nsr/res/nsrdb

NetWorker 19.1.1 355

Maintenance Commands nsrvba_cpsave ( 1m )

The resource database that contains the NetWorker service and its resources (See nsr_service(5)).

SEE ALSO nsrpolicy(1m), nsrdiscover(1m)

NetWorker 19.1.1 356

Maintenance Commands nsrvim ( 1m )

NAME nsrvim NetWorker server binary for communicating with VMware vCenter

SYNOPSIS nsrvim [ options ] [ v ] [ d ] [ s server ] [ D debuglevel ] [ -help ] [ -version ] hypervisor

DESCRIPTION The nsrvim program communicates over SOAP with a VMware vCenter server using the VMware Infrastructure Methodology API. It is normally run automatically by nsrd(1m) following specication in the nsr_hypervisor(5) resource.

The nsrvim program will query the NetWorker server for a nsr_hypervisor(5) resource with the same name as passed on its command line. From that resource, nsrvim will access the username, password, and endpoint attributes and use them to connect to VMware vCenter server via SOAP.

Once connected, the nsrvim program will query the vCenter server inventory (Data- centers, Clusters, Hosts, VirtualMachines, and other important objects). The program will also setup an RPC connection to nsrjobd (1m) and send the inventory data back to the server through that connection.

OPTIONS s Hostname of the NetWorker server to query for the nsr_hypervisor resource.

v Increments the verbosity level of the output. This option can be provided mul- tiple times and its effects are additive.

D Set the debug output level.

d Dump the vCenter inventory and Hosts to Datastores mapping information to les in /nsr/cores/nsrvim folder. The inventory le name is the name of the nsr_hypervisor resource with a .xml extension.

-help Print the usage statement and exit.

-version Print the version string and exit.

hypervisor Species the NetWorker nsr_hypervisor resource to use.

RESOURCE TYPES NSR hypervisor The attributes username and password are used to log into the vCenter server. The attribute endpoint is used to connect to the SOAP interface of the vCenter server. The attribute environment is used to store an XML document describing elements of the vCenter inventory as needed by NetWorker.

FILES /nsr/logs/daemon.raw Log le containing execution messages routed through nsrd.

SEE ALSO nsr_service(5), nsr_hypervisor(5), nsr_notication(5), nsr_resource(5), nsr(1m), nsradmin(1m), nsrjobd(1m), nsrd(1m)

NetWorker 19.1.1 357

Maintenance Commands NSRVMWSD ( 1m )

NAME nsrvmwsd NetWorker VMware Web Service daemon

SYNOPSIS nsrvmwsd

DESCRIPTION The nsrvmwsd daemon provides a SOAP-based web service for managing VMware virtual machine backups as part of the NetWorker VMware protection.

The nsrvmwsd daemon is managed by nsrd, and its conguration settings are stored in NSR resource attributes, which have a VMWS prex. The nsradmin command may be used to modify the attributes. When these attributes are modied, nsrvmwsd will reload new settings automatically.

NOTES Changing nsrvmwsd settings such as the listening port or user credentials requires corresponding changes in the client, EMC Backup and Recovery (EBR). For details of changing EBR settings, consult the NetWorker Administration guide.

FILES /nsr/logs/daemon.raw The le to which nsrvmwsd and other NetWorker daemons send informa- tion about various error conditions that cannot otherwise be logged using the NetWorker event mechanism.

SEE ALSO nsr_resource(5), nsr_service(5), nsradmin(1m), nsrd(1m)

NetWorker 19.1.1 358

Maintenance Commands NSRVPROXY_FLR ( 1m )

NAME nsrvproxy_r NetWorker vProxy FLR Session management program

SYNOPSIS nsrvproxy_r [ s S er v er] c v Center m T a r getV M M or ef v T a r getV M N a m e u T a r getV M User [ p T a r getV M P a ssw or d] [ U T a r getV M A dm inistr a tor User] [ P T a r getV M A dm inistr a tor P a ssw or d] [ A T a r getDa ta center M or ef] ( S ssid[ /cloneid] N ssna m e t sstim e) [ e B a ck upDev iceEx por tP a th] [ w M onitor Inter v a l] [ ir h V]

DESCRIPTION The nsrvproxy_r command is a command line based program used to establish and maintain NetWorker vProxy FLR Sessions. The program is typically launched as a Job from NMC or through NetWorker REST API.

OPTIONS s Server Set the NetWorker Server host name. Default local host.

c vCenter Set the vCenter host where FLR is performed.

m TargetVMMoref Set the VM Moref Id where the FLR Session recovers les to.

v TargetVMName Set the VM Name where the FLR Session recovers les to.

u TargetVMUser Set the VM user ID who performs the FLR.

p TargetVMPassword Set the password of the user who performs the FLR. When no password is provided it is retrieved from the Jobs DB from the corresponding to the pro- cess Job instance record.

U TargetVMAdministratorUser Provide the VM Administrator user ID to install Guest FLR Agent on the VM.

P TargetVMAdministratorPassword Provide the VM Administrator user password to install Guest FLR Agent on the VM.

A TargetDatacenterMoref Set the target datacenter Moref ID where the target VM resides.

S ssid[/cloneid] Species the save set ID for the save set to be recovered. When there are mul- tiple clone instances for a save set, the cloneid can also be specied to select the particular clone instance to be recovered from.

N ssname Must be used in conjunction with sstime to specify the save set to be recovered. Cannot be used with ssid option.

e BackupDeviceExportPath Precongured Data Domain Device export path where the recovered save set is mounted. When the path is not provided it can be retrieved from RAP for this device.

w MonitorInterval Species the time in seconds between monitoring requests while the mount session is active. Default is 5 seconds.

i This option authorizes Guest FLR Agent installation on the target VM. When TargetVMAdministratorUser and TargetVMAdministratorPassword are provided

NetWorker 19.1.1 359

Maintenance Commands NSRVPROXY_FLR ( 1m )

the credentials are used to install the Agent. When they are not provided the credentials are retrieved from the Jobs DB from the corresponding to the pro- cess Job instance record. In the case when the credentials are not available in the Jobs DB either, the TargetVMName and TargetVMPassword credentials are used.

r This option authorizes Guest FLR Agent removal. When TargetVMAdministra- torUser and TargetVMAdministratorPassword are provided the credentials are used to remove the Agent. When they are not provided the credentials are retrieved from the Jobs DB from the corresponding to the process Job instance record. In the case when the credentials are not available in the Jobs DB either, the TargetVMName and TargetVMPassword credentials are used.

V Switch verbose logging mode to ON.

h Print Help.

DIAGNOSTICS Exit Codes:

0 Normal exit.

1 Abnormal exit. Error occurred during the workow execution.

SEE ALSO nsrvproxy_r_browse(1m), nsrvproxy_r_recover(1m)

NetWorker 19.1.1 360

Maintenance Commands NSRVPROXY_FLR_BROWSE ( 1m )

NAME nsrvproxy_r_browse NetWorker vProxy FLR Browse Session backend program

SYNOPSIS nsrvproxy_r_browse [ s S er v er] m M ountJ obId [ w M onitor Inter v a l] [ t B r ow seIna ctiv ity T im eout]

DESCRIPTION The nsrvproxy_r_browse command is a command line based program used to main- tain and operate NetWorker vProxy FLR Browse Sessions. The program is launched as a Job in the NMC FLR recovery workow. It is not intended to be ran manually.

OPTIONS m MountJobId Species the job id of the nsrvproxy_r job managing the FLR session to attach to.

s Server Set the NetWorker Server host name. Default local host.

t BrowseInactivityTimeout Species the time in seconds after which the browse session will be terminated if no browse requests are made during that time. Default is 3600 (one hour).

w MonitorInterval Species the time in seconds between monitoring requests while the browse session is active. Default is 60 seconds.

DIAGNOSTICS Exit Codes:

0 Normal exit.

1 Abnormal exit. Error occurred during the workow execution.

SEE ALSO nsrvproxy_r(1m), nsrvproxy_r_recover(1m)

NetWorker 19.1.1 361

Maintenance Commands NSRVPROXY_FLR_RECOVER ( 1m )

NAME nsrvproxy_r_recover NetWorker vProxy FLR Recover backend program

SYNOPSIS nsrvproxy_r_recover [ s S er v er] m M ountJ obId d Destina tion [ fI t]

DESCRIPTION The nsrvproxy_r_recover command is a command line based program used to request and monitor vProxy FLR recovery. The program is launched as a Job in the NMC FLR recovery workow. It is not intended to be ran manually. The list of les to be recovered is provided either as the nal arguments to the command or via stdin.

OPTIONS d Destination Species the destination on the target VM to which the recovered les will be copied.

f Species whether the les should be forcefully overwritten if they are present in the destination directory. Default is false.

I Species whether the stdin should be read for the list of les to be recovered. Default is false and the les are listed as the nal arguments on command line.

m MountJobId Species the job id of the nsrvproxy_r job managing the FLR session to attach to.

s Server Set the NetWorker Server host name. Default local host.

t Species whether the mount session should be terminated at the end of recovery. Default is false.

DIAGNOSTICS Exit Codes:

0 Normal exit.

1 Abnormal exit. Error occurred during the workow execution.

SEE ALSO nsrvproxy_r(1m), nsrvproxy_r_browse(1m)

NetWorker 19.1.1 362

Maintenance Commands nsrvproxy_mgmt ( 1m )

NAME nsrvproxy_mgmt NetWorker vProxy management application.

SYNOPSIS nsrvproxy_mgmt redeploy h vProxy-host-name [ t vProxy-active-sessions-timeout ][ x same admin-root-password ][ z vProxy-root-password ][ f disable-conrm- prompt ][ u comments ][ D debug_level ]

nsrvproxy_mgmt register [ s server ] v vCenter h vProxy-host-name p port a vProxy- admin-password q datastores j hotadd k nbd [ u comments ][ D debug_level ]

DESCRIPTION nsrvproxy_mgmt allows you to manage different operations related to vProxy OVA redeployment in vCenter, and registration to NetWorker server.

OPTIONS s server NetWorker server to use. If not provided, the NetWorker server where the job runs will be used.

v vCenter vCenter resource name.

e ESXi-host ESXi host moref where vProxy will run after deployment.

r resource-pool Resource pool moref or Cluster moref where to put the vProxy.

d datastore Datastore moref where to put the vProxy les.

w network vCenter network to assign to the vProxy VM.

n vProxy-VM-name vProxy VM name.

i static-ip vProxy guest OS static IP.

h vProxy-host-name vProxy host name.

p port vProxy API communication port.

g gateway vProxy guest OS gateway.

m netmask vProxy guest OS netmask.

o DNS-servers vProxy guest OS coma separated list of DNS servers.

t Value

register cmd: Timezone

redeploy cmd: Timeout in minutes for active vProxy sessions to complete to start redeploy- ment.

j hotadd Maximum number of hotadd sessions, must not exceed 25.

NetWorker 19.1.1 363

Maintenance Commands nsrvproxy_mgmt ( 1m )

k nbd Maximum number of nbd sessions.

q datastores Comma separated list of datastores where vProxy will operate.

a vProxy-admin-password Admin password for registration to NetWorker server.

z vProxy-root-password Root password for access to Linux machine. For redeploy cmd use either of x option or z option but not both.

f

register cmd: Flag to force registration of a vProxy already registered to a NetWorker server.

redeploy cmd: Flag to disable conrmation prompt to start redeployment.

c Flag to run pre-check instead of registration.

x Flag to indicate that root password is same as admin for vProxy to start rede- ployment.

u comments Optional parameter for user comments..

EXAMPLES The following command redeploys (with a conrmation prompt) vProxy vproxy-1 on same vCenter and with same existing conguration and register to same NetWorker Server (one used for invoking cmd). Default value of option t is 10 minutes if not specied. vProxy hostname should be same as existing in RAP. Note: vProxy OVA should be placed in predened paths before starting redeployment. For Linux: /nsr/vproxy_ova/ovas For Windows: /vProxy/vProxy_ova/ovas

nsrvproxy_mgmt redeploy -h vproxy-1 -x

The following command redeploys vProxy vproxy-1 with existing conguration and root password as rootpw(without any conrmation prompt) and setting a timeout of 20 min for active sessions to complete followed by registration to same NetWorker Server (one used for invoking cmd). Debug level being set to 9.

nsrvproxy_mgmt redeploy -h vproxy-1 -z rootpw -t 20 -f -D9

The following command registers vProxy vproxy-1 (which is not yet registered to Net- Worker).

nsrvproxy_mgmt register -v vc.emc.com -h vproxy-1 -p 1234 -a adminpw -q datastore1,datastore2 -j 10 -k 10

The following command re-registers vProxy vproxy-1 with NetWorker (force registra- tion of vProxy already registered to NetWorker).

nsrvproxy_mgmt register -f -v vc.emc.com -h vproxy-host-1 -p 1234 -a adminpw -q datastore1,datastore2 -j 10 -k 10

The following command checks if vProxy vproxy-1 is registered to NetWorker. nsrvproxy_mgmt register -c -v vc.emc.com -h vproxy-1 -p 1234 -a adminpw -j 10 -k 10

SEE ALSO nsrvproxy_r(1m), nsrvproxy_recover(1m)

DIAGNOSTICS Exit Codes:

0 Normal exit.

1 Abnormal exit. The requested action failed.

NetWorker 19.1.1 364

Maintenance Commands nsrvproxy_recover ( 1m )

NAME nsrvproxy_recover NetWorker Recovery application for vProxy-based VM recovery

SYNOPSIS nsrvproxy_recover c vCenter [ s server ] { S ssid[/cloneid] N ssname [ t sstime ] } [ m R I D N E ] [ o P N M V[v Center ] H C ]... [ A Datacenter-Moref ] [ C ComputeResource-Moref ] [ L ClusterComputeResource-Moref ] [ E Datastore-Moref ] [ M VM- Moref ] [ V VM-name ] [ r ResourcePool-Moref ] [ H Host-Moref ] [ T datastore ] [ e export-path ] [ d disk ] [ p vProxy ] [ b pool ] [ v ] [ l ]

DESCRIPTION nsrvproxy_recover allows you to recover a VM or VMDKs from a save set, and restore them to either an existing VM or a new VM. The instant recovery mode ( m I option ) allows a VM to be powered on from the save set in the Data Domain device, without restoring the VM to a VMware datastore. For details of the recovery modes, see m option.

OPTIONS c vCenter Specify which vCenter to use

s server Specify which NetWorker server to use. If not specied, the localhost is used by default.

S ssid[/cloneid] Specify a save set id to restore the VM or VMDKs from. When there are mul- tiple clone instances of the save set, the cloneid can also be specied to select a particular clone instance to use.

N ssname Specify a save set name to restore the VM or VMDKs from. When there are multiple save set instances with the same name, the t sstime option can be used to specify a particular save set instance. This option cannot be used with the S option.

t sstime Specify a save set time to select a particular save set instance to use. This option can be used only with the N option.

m R I D N E Select a recovery mode as follows.

R (Revert Virtual Machine): Revert an existing virtual machine back to a point-in-time. If CBT is enabled, it moves only the data that have changed.

I (Virtual Machine Image Recovery): Recover the selected virtual machine, as a new virtual machine.

D (Virtual Machine Disk Recovery): Recover one or more disks to an existing virtual machine.

N (Instant Recovery): Use instant access to recover the selected virtual machine, as a new virtual machine. The datastore will be located in the Data Domain device that the save set is stored. Once the nsrvproxy_recover process is terminated, the datastore is reclaimed automatically. In order to preserve the virtual machine, use Storage vMotion to migrate the virtual machine to another datastore.

E (Emergency Recovery): Recover the selected virtual machine to an ESX host.

o P N M V[v C en t er] H C Specify a recovery option. This option may be repeated to choose multiple

NetWorker 19.1.1 365

Maintenance Commands nsrvproxy_recover ( 1m )

recovery options.

P is to power on the virtual machine after recovery.

N is to reconnect NICs.

M is to leave IA session mounted.

V[v Center] is to delete the vProxy resource at the end of Emergency Recovery or re-associate it with the specied vCenter resource. Note that if re- associating with another vCenter, the vCenter name must immediately follow V without any whitespace.

H is to delete the vCenter resource at the end of Emergency Recovery.

C is to delete the vCenters NSR client resource at the end of Emergency Recovery. This option is only valid when o H is also specied, otherwise it is ignored.

A Datacenter-Moref Specify which Datacenter to use

C ComputeResource-Moref Specify a ComputeResource where the VM is restored

L ClusterComputeResource-Moref Specify a ClusterComputeResource where the VM is restored

E Datastore-Moref Specify a Datastore where the VM is restored

M VM-Moref Specify a VM of being recovered

V VM-name Specify a VM name of being recovered in Revert Virtual Machine, Virtual Machine Disk Recovery, or Emergency Recovery mode. It is the restored VM name in Virtual Machine Image Recovery, or Instant Recovery mode.

r ResourcePool-Moref Specify a ResourcePool where the VM is restored

H Host-Moref Specify a ESX host where the VM is restored

T datastore Specify a datastore where the VM is restored

e export-path Override the export path congured in NSR Data Domain. It species a path relative to the base path that will be exported, via NFS, by the Data Domain.

d disk disk is specied as label/diskid or label/diskid/datastore-moref.

p vProxy Specify which vProxy to use. If not specied, the NetWorker server will choose one automatically.

b pool Override the default staging pool when resurrecting a clone from non-DD to a DD device.

v Turns on the verbose output.

l Redirect all output to a log le located in /nsr/logs/recover with the lename {jobname}_{date}{time}.log. Date and time are in the format YYYYMMDDHHMMSS.

NetWorker 19.1.1 366

Maintenance Commands nsrvproxy_recover ( 1m )

EXAMPLES The following command restores an existing VM jupiter back to a point-in-time. $ nsrvproxy_recover -c vc.emc.com -S 3860342295 -m R -M vm-1826 -V jupiter

The following command restores a VM image to a new VM mars. $ nsrvproxy_recover -c vc.emc.com -S 3860342295 -m I -M vm-1826 -V mars -A datacenter-2 -C domain-s336 -H host-338 -E datastore-340

The following command restores a VMDK to an existing VM jupiter. $ nsrvproxy_recover -c vc.emc.com -S 3860342295 -m D -M vm-1826 -V jupiter -A datacenter-2 -C domain-s336 -H host-338 -d Hard disk 1/2000/datastore-340

The following command restores a new VM mars from the save set without moving the data to a VM datastore.

$ nsrvproxy_recover -c vc.emc.com -S 3860342295 -m N -o P -o N -M vm-1826 -V mars -A datacenter-2 -C domain-s7 -H host-9

The following command performs a emergency recovery. $ nsrvproxy_recover -c vce.emc.com -S 3692638578 -m E -o V -o H -V jupiter -p vproxy.emc.com -d Hard disk 1/2000/5554bba7-07abb8b6-6dd6-d89d676180a8 -d Hard disk 2/2001/5554bba7-07abb8b6-6dd6-d89d676180a8 -E 5554bba7-07abb8b6-6dd6-d89d676180a8

SEE ALSO nsrvproxy_r(1m)

NetWorker 19.1.1 367

Maintenance Commands NSRVPROXY_SAVE ( 1m )

NAME nsrvproxy_save backup VMware clients using NetWorker vProxy

SYNOPSIS nsrvproxy_save p PolicyName a ActionName [ s NetworkerServerName ] [ V vProxy ] [ j Jobid ] [ l LogDirectory ] [ L Level ]

DESCRIPTION nsrvproxy_save starts backup jobs on NetWorker vProxy congured to protect virtual machines in a data protection policy, then monitors each backup job until completion. The action parallelism attribute of the action resource limits the number of concurrent backups. nsrvproxy_save is not intended to be ran manually.

OPTIONS a ActionName The name of an action resource. This resource contains the congureation information for the backup.

j Jobid nsrvproxy_save operates within the Networker job hierarchy managed with nsrjobd. This ag species the Job id of the nsrvproxy_saves parent job.

l LogDirectory Logs for failed backups are placed in this directory. If you do not specify a path, the logs are placed in /nsr/logs/policy/POLICYNAME , where POLI- CYNAME is replaced by the value supplied with the p command line argu- ment. If the directory does not exist, nsrvproxy_save will create it with 0755 permissions.

L Level Backup level. Possible values are "full" and "incr".

p PolicyName The name of the data protection policy resource.

s NetWorkerServerName The name of the NetWorker server. If omitted it is derived using the usual NetWorker heuristics.

V vProxyName The name of the vProxy to use for the operation. If omitted, the best available vProxy will be chosen by the broker.

FILES /nsr/logs/policy/POLICYNAME The directory where logs from the vProxy for a failed backup will be placed.

/nsr/res/nsrdb The resource database that contains the NetWorker service and its resources (See nsr_service(5)).

SEE ALSO nsrpolicy(1m), nsrjobd(1m)

NetWorker 19.1.1 368

Maintenance Commands nsrwatch ( 1m )

NAME nsrwatch terminal-based monitoring and operation of NetWorker servers

SYNOPSIS nsrwatch [ s server ]

DESCRIPTION The nsrwatch command is used to monitor and operate NetWorker servers. The servers name is specied by the optional s server argument. If no server is specied, a heuristic is used to nd a NetWorker server on the local network.

The nsrwatch program gets its information via Remote Procedure Calls to the specied server. This way it can be used from any machine that can access the server over a net- work. To improve performance, nsrwatch may cache certain server data. This informa- tion may become stale after a server conguration change. For example, it may take some time before a newly created device is displayed. Press Ctrl-r to force nsradmin to refresh its data.

By default, the server polling interval used by nsrwatch is 5 seconds. The polling inter- val can be adjusted within nsrwatch using the + and - keys when no subwindow has focus. nsrwatch runs continuously until the user presses the q key to quit the pro- gram. To view the nsrwatch Help window, press the h key.

Subwindows By default the nsrwatch display is divided into six subwindows: the Overview window, the Devices window, the Groups window, the Sessions window, the Messages window, and the Alerts window. Subwindow sizes are initially set according to the size of the terminal or window being used.

Each window has an associated window key used to toggle its visibility (lower case) or to lter the subwindows information (upper case). For example, the lower case key d is used to toggle the visibility of the Devices window. Additionally, the upper case D can be used to lter the Devices window to show only mounted devices. If D is pressed again, the display is further ltered to only show devices with active sessions.

The following is the list of available subwindows:

Alerts Displays messages requiring operator action. Has window key a.

Clones Displays a list of congured scheduled clones and their progress. Has window key c.

Data Domain Displays a list of congured Data Domain devices and their active stream counts. Has window key t.

Devices Displays a list of congured devices and their status. For jukebox devices, a (J) appears after the device name. Has window key d.

Groups Displays a list of congured save groups and their progress. Has window key g.

Jobs Displays a list of active jobs. Has window key j.

Job Stats Displays a running graph of active job counts. Has window key b.

Libraries Displays a list of congured tape libraries (jukeboxes). Has window key l.

Messages

NetWorker 19.1.1 369

Maintenance Commands nsrwatch ( 1m )

Displays a history of messages of general interest to the operator. Has window key m.

Overview Displays several pieces of information about the server including: NetWorker version, the boot time of server, approximate response times for nsrd, nsrjobd, nsrexecd, and nsrmmdbd, and save and recover session totals. Has window key o.

Policies Displays a list of congured Virtual Backup Appliance (VBA) policies and their progress. Has window key p.

Sessions Displays a list of current save set information for each active session (saving, recovering, cloning or browsing). Has window key s.

Volumes Displays all volumes found in the media database. Has window key v.

Navigation Use the Tab key to bring a subwindow into focus. Successive presses of the Tab key will iterate through the displayed subwindows. Shift-Tab moves the subwindow focus backward.

The height of a subwindow in focus can be adjusted using the + or - keys. Addition- ally, its content can be scrolled using the arrow keys. Ctrl-a and Ctrl-e can be used to quickly skip to the beginning or end of a subwindows content respectively. As well, use Ctrl-b and Ctrl-f to page up or down respectively.

To move the position of a subwindow, bring the subwindow into focus, then use the < and > keys to move the subwindow up and down respectively.

Subwindow Actions Most subwindows have actions. Actions can be executed by pressing the Enter key on a selected row. For some subwindows, the action may display a context menu to per- form an operation on the selected row. Other actions may just open a dialog with for- matted content of the row. Use the Esc key to dismiss dialogs and menus.

Merging

Subwindows

Use the ( and ) keys to merge subwindows. For example, to merge a subwindow with the one below it, bring the top subwindow into focus and press the ) key. To unmerge the same subwindow, move the focus to the same subwindow, which occu- pies the left side of the merged window, and press the ( key.

OPTIONS s server Sets the current NetWorker server to server.

ENVIRONMENT VARIABLES

nsrwatch uses the following environment variables:

NSRWATCH Use this environment variable to change the list of default windows displayed by nsrwatch at startup. For exmaple, to display the Overview and Groups win- dows, set NSRWATCH to og. Additionally, an optional height value can pre- cede a window key. For example, o10g20m displays the Overview window, the Groups window with a height of 10 rows and the Messages window with a height of 20 rows.

NCURSES_NO_UTF8_ACS

NetWorker 19.1.1 370

Maintenance Commands nsrwatch ( 1m )

In some environments, to ensure that nsrwatch displays curses UI elements correctly, set this variable to 1.

SEE ALSO nsr_notication(5), nsr_device(5), nsr_service(5), nsradmin(1m), nsr(1m), nsrd(1m) nsrjobd(1m) nsrexecd(1m) nsrmmdbd(1m)

NetWorker 19.1.1 371

Maintenance Commands nsrworkow ( 1m )

NAME nsrworkow run an workow in a data protection policy RAP resource

SYNOPSIS nsrworkow p policy_name w work_ow_name [ s networker_server_name ] [ D debug_level ] [ R { jobid mostrecent servercrash } ] [ c workitems ] [ A action_overrides ] [ a ] [ L ] [ j my_jobid ]

DESCRIPTION nsrworkow reads the denition of a data protection policy resource from the Net- Worker RAP resource database. Locates the denition of the named workow and its contained actions. The actions are then run sequentially or concurrently as dened in the workow until all actions complete. nsrworkow runs all actions using the ser- vices of nsrjobd to start actions, to gather their standard output to forward to follow- ing actions, to gather their standard error for logging to one le per action in /nsr/logs/policy, and to monitor each action until completion. Actions that are marked as disabled and any actions that follow the disabled action will not be run. Each action may have a schedule that dictates which days the action should run. If an action is to be skipped on the day nsrworkow is run it and any actions that depend on it will not be run. If an action is not the rst action in the policy and it has no schedule it will run any day its preceding action runs.

When an action produces anything on standard output for consumption by a following action on its standard input, nsrworkow imposes no structure on this data. It is assumed that this data is a list of saveset ids with one saveset id per line. By conven- tion an action will not place a saveset id on its standard output until after that saveset is complete.

nsrworkow places all of its output on standard error.

OPTIONS p policyname The name of the data protection policy resource containing the workow to be run.

w workow_name The name of the workow containing the actions to be run.

s networker_server_name The name of the NetWorker server containing the denition of the data protec- tion policy resource and its associated action resource(s). Any action started by nsrworkow will use the services of the same NetWorker server. If this option is omitted the default networker server is discovered and used.

D debug_level A number from 0 to 9 species the amount of debug tracing information to display to standard error. A higher value displays more information. This debug_level is propagated to all actions started.

R { jobid mostrecent servercrash } The -R ag tells nsrworkow that it is to restart a failed or interrupted workow. Which instance to restart is specied by the value following the ag. jobid is the id of an instance of nsrworkow that is to be restarted. If a more recent run of that workow was successful, the restart will not be attempted. mostrecent means the most recent failed instance of the specied workow is to be restarted. If the most recent instance of the workow run was successful a restart will not be attempted. servercrash is used by nsrd to restart the most recent instance of an workow run that was interrupted by a NetWorker server crash.

c workitems To run a workow with a different list of input items to the head action. A

NetWorker 19.1.1 372

Maintenance Commands nsrworkow ( 1m )

comma seperated list of items is expected. The actual values depend on the input expected by the head action in the workow. Currently supported item types are client, nasdevice and vmware. For items of type client, the client names specied must be a subset of the clients associated with the workow being run (via the NSR protection group resource). This option has similar semantics to the c option of the nsrpolicy start command.

A action_overrides Specify individual action setting overrides. The argument format is:

action_name

The cmd_line_ags will be passed to the executable implementing action action_name. Use escaped double quotes or single quotes for action names or parameters that contain spaces or special characters. For example:

-A "\"action name\" -l full"

or

-A "action name -l full"

Please see man pages of specic executables for more details.

Note: cmd_line_ags do not support collapsed parameters of the form ab or carg. Specify -a -b or -c arg instead. Multiple A options can be specied.

a Run in adhoc mode. Adhoc mode differs from normal execution as follows:

actionStarttime setting for all actions in a workow (if set) is ignored.

Action schedule activity of skip is converted to actions default schedule activity (incr for backup actions, 1(Cumulative Incremental) for server backup and exec for the remaining action types). This is to allow adhoc exe- cution of workows on days where the schedule is congured to level skip. The caller can use the A option to specify a different schedule activity if the action supports it.

L Redirect workow debug messages from the console to the log le named as workow_{workow_name}_{job_id} located in /nsr/logs/policy/{policy_name}/.

j my_jobid Have nsrworkow use my_jobid as its jobid in place of creating its own jobid.

FILES /nsr/logs/policy/POLICYNAME/WORKFLOW_NAME/ The directory where logs from the actions run are stored. Where the name of policy being run is substituted for POLICYNAME and the name of the workow being run is substituted for WORKFLOW_NAME. The actions name and its nsrjobd jobid assigned to an action will be the name of the actions log le. When jobd database records for a policy and its actions are purged from the jobd database the logs in this directory associated with the purged jobs will also be deleted.

/nsr/tmp/policy/POLICYNAME/ nsrworkow can forward the standard output of an action to the standard input of a following action. Standard output from an action is always stored in a le named actionname.stdout.timestamp in this directory. nsrworkow deletes these les as part of cleanup during program termina- tion.

/nsr/res/nsrdb The resource database that contains the NetWorker service and its resources (See nsr_service(5)).

NetWorker 19.1.1 373

Maintenance Commands nsrworkow ( 1m )

SEE ALSO nsrpolicy(1), nsrjobd(1m) nsrvba_save(1m), nsrclone(1m)

DIAGNOSTICS The exit status is zero if the operation is successful and non-zero otherwise. Sample errors and their reasons are listed as follows:

You are not authorized to run Only a user with superuser privileges, such as the root user on a UNIX system, is allowed to run the nsrworkow command.

NetWorker 19.1.1 374

Standards, Environments, and Macros nsr_archive_request ( 5 )

NAME nsr_archive_request NetWorker resource type NSR archive request

SYNOPSIS type: NSR archive request

DESCRIPTION Each NSR archive request is described by a single resource of type NSR archive request (see nsr_resource(5)). To edit the NSR archive request resources for a Net- Worker server type:

nsradmin -c "type:NSR archive request"

See the nsradmin(8) manual page for more information on using the NetWorker administration program. The archive request resource may also be edited using Net- Worker Management Console.

This resource allows administrators to set up an archive to occur later or to set up fre- quent archives of a set of data. The administrator can run an archive on a specied client within the next 24 hours. The archive is executed via the nsralist(8)) command.

ATTRIBUTES The following attributes are dened for resource type NSR archive request. The infor- mation in parentheses describes how the attribute values are accessed. Read-only indi- cates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts. Hidden attributes can only be seen when the hidden option is turned on in nsradmin(8). Choice means that the value of the attribute can only be one from a list specic to that attribute (for example, status can be start now or start later). Dynamic attributes have values which change rapidly. Encrypted attributes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).

comment (read/write) This attribute is provided for the administrator to keep any explanatory remarks or supplementary information about the archive request.

annotation (read/write) This attribute contains the annotation text associated with the archive save set generated from this archive request. Example: annotation: Product Release 4.1;

archive clone pool (read/write) This attribute indicates the archive clone media pool the archive request should use when cloning the archive save set generated by this archive request. Example: archive clone pool: Archive clone;

archive completion (read/write) A notication action to be executed to send status of the archive request to. Example: archive completion: /usr/ucb/mail -s "Product Archive" systemadmin;

archive pool (read/write) This attribute can be used to override the normal media pool selection applied to the archive save set generated from the archive request. Selecting a pool will direct the archive to that media pool. Example: archive pool: Archive;

client (read/write) This attribute indicates what NetWorker archive client the archive request is to be executed on.

NetWorker 19.1.1 375

Standards, Environments, and Macros nsr_archive_request ( 5 )

Example: client: neptune;

clone (read/write) This attribute controls whether the archive save set generated by the archive request is to be cloned. A value of Yes implies the archive save set should be cloned. A value of No does not imply cloning. Example: clone: No;

cloned (read/write, hidden) This attribute is unused. Example: cloned: No;

completion time (read/write, hidden) This attribute indicates when the archive request completed. The format is "day-of-week month day hours:minutes:seconds year". Example: "Thu Oct 22 17:00:37 1994";;

directive (read/write) This attribute species the directive to use when running the archive. The default value is nothing selected. The valid choices for the directive resource are names of the currently dened NSR directive resources, see nsr_directive(5). Example: directive: Default with compression;

grooming (read/write) This attribute indicates any grooming actions to be taken once the archive save set generated by the archive request has been created, veried, and cloned. A value of none implies no action. A value of remove implies the les and direc- tories specied in the save set attribute will be removed via the rmdir(2) and unlink(2) system calls. Example: grooming: none;

log (read/write, hidden) This attribute contains any information pertaining to the execution of the nsral- ist command. Example: log:; name (read/write) This attribute species the name of this NetWorker archive request. Example: name: Product Source Tree;

save set (read/write) This attribute lists the path names to be archived on the archive client. The names should be separated by a comma and a space (", "). Example: save set: /product/src, /accounting/db;

start time (read/write) This attribute determines when the archive request will be run. The status attribute (see above) must be set to start later for the archive request to be scheduled. The 24 hour clock format is "hours:minutes". Example: start time: 3:33;

status (read/write, choice) This attribute determines if an archive request should be run. No value implies the archive request is not scheduled. Selecting start now causes the archive request to be run immediately. Selecting start later causes the archive request to be run at the time specied by the start time attribute. Example: status:;

veried (read/write, hidden) This attribute is unused. Example: veried: No;

NetWorker 19.1.1 376

Standards, Environments, and Macros nsr_archive_request ( 5 )

verify (read/write, choice) This attribute indicates the archive request should verify the archive. See nsr_archive(5) for more information on archiving. Selecting the Yes choice causes the verication to occur. Selecting the No choice will not cause any verication. If the user also requests that the archive save set be cloned, the verication is done on the clone since the cloning operation will have veried the original archive save set. Example: verify: Yes;

Save operations (read/write, string) This attribute species the save operation instructions in the form of: KEYWORD:TOKEN=STATE

This attribute is required if save set attribute of the archive client contains non-ASCII names. Specify:

I18N:mode=nativepath (for NetWorker 7.4 or later clients on UNIX plat- forms with non-ASCII save set names)

I18N:mode=utf8path (for pre-7.4 clients and NetWorker clients on Windows platforms with non-ASCII save set names)

Example: Save operations: I18N:mode=nativepath;

EXAMPLE Note: the hidden options are not shown in this example.

A resource to dene an archive request, called Product:

type: NSR archive request; name: Product Source;

annotation: Product Release 3.0; status: Start later;

start time: "2:00"; client: space;

save set: /product/source; directive: Default with compression;

archive pool: Archive; verify: Yes; clone: Yes;

archive clone pool: Archive Clone; grooming: none;

archive completion: mail -s Product Source Archive productteam;

SEE ALSO nsr(5), nsr_directive(5), nsr_resource(5), nsradmin(8), rmdir(2), unlink(2)

NetWorker 19.1.1 377

Standards, Environments, and Macros nsr_auditlog ( 5 )

NAME nsr_auditlog NetWorker resource type NSR auditlog

SYNOPSIS type: NSR auditlog

DESCRIPTION Use the NSR auditlog RAP resource to congure the security audit log service. The NetWorker software creates the NSR auditlog resource by default. Only users with the Security Administrator role can change the resource. The resource cannot be deleted. To edit the NSR auditlog resource for a NetWorker server, type:

nsradmin c "type:NSR auditlog" or use the NetWorker Management Console. See the nsradmin(8) manual page for more information on using the NetWorker administration program.

Use this resource to dene the client that acts as the host for the nsrlogd daemon, the level of detail, the maximum log size and how the log le is rendered. See the nsrlogd(8) manual page for additional details describing the logging daemon.

ATTRIBUTES Use the NSR auditlog RAP resource to modify the nsrlogd daemon properties. The information in parentheses describes how the attribute values are accessed. Read-only indicates that an administrator cannot change the value. Read/write indicates that you can read and modify the value. Choice list indicates that you can choose any number of values from a given list. Static indicates that the attributes values rarely change.

name (read-only, static) This attribute species the name of the le where security related audit mes- sages are logged. The security audit log lename is in the format <NetWorker_server_name>_sec_audit.raw.

auditlog hostname (read/write, static) This attribute species the hostname where the security audit log daemon nsrlogd runs and where the security audit log le is stored. By default, nsrlogd will run on the NetWorker server. For typical scenarios, this default conguration is the recommended conguration.

auditlog lepath (read/write, static) This attribute species where the security audit log daemon writes the log le. The default location is the NetWorker logs directory, C:[rs]Program Files[rs]EMC NetWorker[rs]nsr[rs]logs on Windows and /nsr/logs on UNIX.

auditlog severity (choice, read/write, static) This attribute species the level of logging detail that each client provides to the security audit log server. When you set the level to information, nsrlogd records information level and higher security related events in the audit log le. When you set the level to critical, nsrlogd records only the most severe security related events.

auditlog rendered service (choice, read/write, static) By default, nsrlogd records information in the security audit log, <NetWorker_server_hostname>_sec_audit.raw in an unrendered raw format. If you set this attribute to local, nsrlogd creates a rendered .log le in addition to the .raw le. Rendered versions can also be directed to either the Windows eventlog, or the UNIX syslog.

auditlog rendered locale (read/write, static) This attribute species the locale, or language, of the rendered security audit log le. By default, the en_US (English) locale is used.

auditlog maximum le size MB (read/write, static) This attribute species the maximum size of the security audit log le, in megabytes (MB). The default maximum is 2 megabytes. When the log le

NetWorker 19.1.1 378

Standards, Environments, and Macros nsr_auditlog ( 5 )

reaches the maximum size, nsrlogd renames the le by appending the current date and time to the default name. The nsrlogd daemon then creates a new security audit log le with the default name.

auditlog maximum le version (read/write, static) This attribute species the maximum number of archived security audit logs that nsrlogd maintains. When the number of archived logs reaches the max- imum value, nsrlogd removes the oldest archived le. When this value is zero, all versions are maintained. Zero is the default value.

SEE ALSO nsradmin(8), nsrlogd(8), nsr_render_log(8)

NetWorker 19.1.1 379

Standards, Environments, and Macros nsr_client ( 5 )

NAME nsr_client NetWorker resource type NSR client

SYNOPSIS type: NSR client

DESCRIPTION Each NSR client is described by a single resource of type NSR client (see nsr_resource(5)). To edit the NSR client resources for a NetWorker server type:

nsradmin -c "type:NSR client"

See the nsradmin(8) manual page for more information on using the NetWorker administration program. The Client resource may also be edited using NetWorker Management Console.

For each NetWorker client, this resource describes which les should be saved, the schedule used to save these les, which directive should be used to omit les from the save, how long the les index entries should be kept in the online le index and the media index, and who is allowed to back up, browse, and recover this clients les. A client may have more than one resource describing it.

ATTRIBUTES The following attributes are dened for resource type NSR client. The information in parentheses describes how the attribute values are accessed. Read-only indicates that the value cannot be changed by an administrator. Read/write means the value can be set as well as read. Hidden means it is an attribute of interest only to programs or experts. Hidden attributes can only be seen when the hidden option is turned on in nsradmin(8). Dynamic attributes have values which change rapidly. Encrypted attri- butes contain data that is not displayed in its original form. The assumption is that the data is sensitive in nature and needs to be protected from accidental disclosure. Several additional attributes (for example, administrator) are common to all resources, and are described in nsr_resource(5).

Certain client attributes (such as "Client OS type", "CPUs", "NetWorker version" and "Enabler in use") do not get populated in the Client Setup/Information window of the NetWorker interface, when the NetWorker Server is running under Eval mode or an Enterprise license. However, when the NetWorker server has a Workgroup/NetWork/Power Edition enabler, these client attributes are refreshed appropriately in the window after the client backup.

name (read-only, single string) This attribute species the hostname of this NetWorker client. Example: name: venus;

client id (read-only) The client id is used by the media database and for index backups to identify a save set with a specic client. Each client has a unique client id which is automatically generated by the NetWorker server (nsrd).

server (constant, single string) This attribute species the hostname of this clients NetWorker server. The servers hostname will be used as the default value. Example: server: jupiter;

comment (read/write) This attribute is provided for the administrator to keep any explanatory remarks or supplementary information about this NetWorker client. Example: comment: machine located in room 243;

scheduled backup (read/write, choice) This attribute is provided for the administrator to disable this client for

NetWorker 19.1.1 380

Standards, Environments, and Macros nsr_client ( 5 )

scheduled backups. This value is specic to this client resource, it does not pro- pagate to any other existing resources for the same client. By default this attri- bute is Enabled. Example: scheduled backup: Disabled;

archive services (read/write, choice) This attribute determines if this system can use archive services. This attribute can only be set if archive support has been enabled on the server. The choices are enabled or disabled. Example: archive services: enabled;

schedule (read/write, choice) This attribute species the name of the schedule controlling the backup levels for the save sets listed in the save set attribute. The default value is Default. Any currently dened schedule names, with activity type backup, may be used. See nsr_schedule(5). Example: schedule: Default;

Client determines level (read/write, choice) Enabling this option passes the responsibility of backup level determination to the client application. The server will pass the proposed level (as determined by schedule or policy settings) through the -o REQUESTED_LEVEL:level= option to the client application. If this option is enabled and requested level evaluates to incr_synth_full the server will not invoke the nsrconsolidate process.

browse policy (read-only, hidden) This attribute species the name of the policy controlling how long entries will remain in this clients online le index. This is set to the clients retention pol- icy automatically and cannot be changed, see nsr_policy(5).

retention policy (read/write, choice) This attribute species the name of the policy controlling how long entries will remain in the media index before they are marked as recyclable. The default value is Year, see ns