puredisk cli guide

Symantec NetBackupPureDisk™ Command LineInterface Reference Guide

Linux

Release 6.6.1

Publication release 6.6.1, revision 1

The software described in this book is furnished under a license agreement andmay be usedonly in accordance with the terms of the agreement.

Documentation version: 6.6.1, revision 1

Legal NoticeCopyright © 2010 Symantec Corporation. All rights reserved.

Symantec, the Symantec Logo, NetBackup, and PureDisk are trademarks or registeredtrademarks of Symantec Corporation or its affiliates in the U.S. and other countries. Othernames may be trademarks of their respective owners.

This Symantec product may contain third party software for which Symantec is requiredto provide attribution to the third party (“Third Party Programs”). Some of the Third PartyPrograms are available under open source or free software licenses. The LicenseAgreementaccompanying the Software does not alter any rights or obligations you may have underthose open source or free software licenses. Please see theThird Party LegalNoticeAppendixto this Documentation or TPIP ReadMe File accompanying this Symantec product for moreinformation on the Third Party Programs.

The product described in this document is distributed under licenses restricting its use,copying, distribution, and decompilation/reverse engineering. No part of this documentmay be reproduced in any form by any means without prior written authorization ofSymantec Corporation and its licensors, if any.

THEDOCUMENTATIONISPROVIDED"ASIS"ANDALLEXPRESSORIMPLIEDCONDITIONS,REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OFMERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TOBELEGALLYINVALID.SYMANTECCORPORATIONSHALLNOTBELIABLEFORINCIDENTALOR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINEDIN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.

The Licensed Software andDocumentation are deemed to be commercial computer softwareas defined in FAR12.212 and subject to restricted rights as defined in FARSection 52.227-19"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights inCommercial Computer Software or Commercial Computer Software Documentation", asapplicable, and any successor regulations. Any use, modification, reproduction release,performance, display or disclosure of the Licensed Software andDocumentation by theU.S.Government shall be solely in accordance with the terms of this Agreement.

Symantec Corporation350 Ellis StreetMountain View, CA 94043

http://www.symantec.com

http://www.symantec.com

Technical SupportSymantec Technical Support maintains support centers globally. TechnicalSupport’s primary role is to respond to specific queries about product featuresand functionality. TheTechnical Support group also creates content for our onlineKnowledge Base. The Technical Support group works collaboratively with theother functional areas within Symantec to answer your questions in a timelyfashion. For example, theTechnical Support groupworkswithProductEngineeringand Symantec Security Response to provide alerting services and virus definitionupdates.

Symantec’s support offerings include the following:

■ A range of support options that give you the flexibility to select the rightamount of service for any size organization

■ Telephone and/or Web-based support that provides rapid response andup-to-the-minute information

■ Upgrade assurance that delivers software upgrades

■ Global support purchased on a regional business hours or 24 hours a day, 7days a week basis

■ Premium service offerings that include Account Management Services

For information about Symantec’s support offerings, you can visit our Web siteat the following URL:

www.symantec.com/business/support/

All support services will be delivered in accordance with your support agreementand the then-current enterprise technical support policy.

Contacting Technical SupportCustomers with a current support agreement may access Technical Supportinformation at the following URL:


Before contacting Technical Support, make sure you have satisfied the systemrequirements that are listed in your product documentation. Also, you should beat the computer onwhich theproblemoccurred, in case it is necessary to replicatethe problem.

When you contact Technical Support, please have the following informationavailable:

■ Product release level



■ Hardware information

■ Available memory, disk space, and NIC information

■ Operating system

■ Version and patch level

■ Network topology

■ Router, gateway, and IP address information

■ Problem description:

■ Error messages and log files

■ Troubleshooting that was performed before contacting Symantec

■ Recent software configuration changes and network changes

Licensing and registrationIf yourSymantecproduct requires registrationor a licensekey, access our technicalsupport Web page at the following URL:


Customer serviceCustomer service information is available at the following URL:


Customer Service is available to assist with non-technical questions, such as thefollowing types of issues:

■ Questions regarding product licensing or serialization

■ Product registration updates, such as address or name changes

■ General product information (features, language availability, local dealers)

■ Latest information about product updates and upgrades

■ Information about upgrade assurance and support contracts

■ Information about the Symantec Buying Programs

■ Advice about Symantec's technical support options

■ Nontechnical presales questions

■ Issues that are related to CD-ROMs or manuals



Support agreement resourcesIf youwant to contact Symantec regarding an existing support agreement, pleasecontact the support agreement administration team for your region as follows:

[email protected] and Japan

[email protected], Middle-East, and Africa

[email protected] America and Latin America

mailto:[email protected]



Technical Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Appendix A Command Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

PureDisk CLI ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15pdactivateagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21pdbackup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22pdbackupstop .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26pdcreatebackuppolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27pdcreatedataremovalpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33pdcreatedepartment ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37pdcreateds ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 38pdcreatedstemplate ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40pdcreateeventescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42pdcreategroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44pdcreatelocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45pdcreatembgarbagecollectionpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46pdcreatepolicyescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49pdcreatepolicyescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50pdcreatereplicationpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52pdcreateSMTPeventescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56pdcreateSNMPeventescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58pdcreateuser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60pddeactivateagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62pddeleteagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63pddeletedepartment ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 64pddeleteds ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65pddeletedstemplate ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66pddeleteeventescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67pddeleteeventescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68pddeletegroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69pddeletejob .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70pddeletelicense .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71pddeletelocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72pddeletepolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73pddeletepolicyescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74pddeletepolicyescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75

Contents

pddeleteuser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76pdexit ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77pdexport2nbu .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 78pdfindfiles ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79pdgetagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82pdgetdepartment ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83pdgetds ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84pdgetdstemplate ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85pdgeteventescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86pdgeteventescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87pdgetgroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88pdgetjob .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89pdgetjobstat ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91pdgetjobsteps ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93pdgetlicense .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95pdgetlocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96pdgetpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97pdgetpolicyescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98pdgetpolicyescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99pdgetstoragepool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100pdgetuser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101pdlistagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103pdlistdepartment ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104pdlistds ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105pdlistdstemplate ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106pdlistevent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107pdlisteventescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108pdlisteventescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109pdlistgroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110pdlistjob .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 111pdlistlicense .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112pdlistlocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113pdlistpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114pdlistpolicyescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116pdlistpolicyescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117pdlistuser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118pdlogonuser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119pdpasswd .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120pdrestore ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122pdrunpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125pdsetagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126pdsetbackuppolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 128pdsetcrgarbagecollectionpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133

Contents8

pdsetdatalock .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136pdsetdataminingpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137pdsetdataremovalpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140pdsetdebugagent ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144pdsetdepartment ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145pdsetds ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146pdsetdsremovalpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148pdsetdstemplate ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151pdseteventescalation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153pdseteventescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154pdsetgroup .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156pdsetlicense .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157pdsetlocation .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158pdsetmaintenancepolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 160pdsetmbgarbagecollectionpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 163pdsetperm .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 166pdsetpolicyescalationaction .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 168pdsetreplicationpolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 170pdsetserverdbmaintenancepolicy ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175pdsetstoragepool ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178pdsetuser ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179pdstatlicensing .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181pdupgrade .... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Appendix B Third-party legal notices . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Third-party legal notices for the Symantec NetBackup PureDiskproduct family ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Third-party trademarks for the Symantec NetBackup PureDiskproduct family ... . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 185

Glossary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 187

9Contents

Contents10

Command Line Interface

This appendix includes the following topics:

■ General MAN page for PureDisk CLI

■ pdactivateagent

■ pdbackup

■ pdbackupstop

■ pdcreatebackuppolicy

■ pdcreatedataremovalpolicy

■ pdcreatedepartment

■ pdcreateds

■ pdcreatedstemplate

■ pdcreateeventescalation

■ pdcreategroup

■ pdcreatelocation

■ pdcreatembgarbagecollectionpolicy

■ pdcreatepolicyescalation

■ pdcreatepolicyescalationaction

■ pdcreatereplicationpolicy

■ pdcreateSMTPeventescalationaction

■ pdcreateSNMPeventescalationaction

AAppendix

■ pdcreateuser

■ pddeactivateagent

■ pddeleteagent

■ pddeletedepartment

■ pddeleteds

■ pddeletedstemplate

■ pddeleteeventescalation

■ pddeleteeventescalationaction

■ pddeletegroup

■ pddeletejob

■ pddeletelicense

■ pddeletelocation

■ pddeletepolicy

■ pddeletepolicyescalation

■ pddeletepolicyescalationaction

■ pddeleteuser

■ pdexit

■ pdexport2nbu

■ pdfindfiles

■ pdgetagent

■ pdgetdepartment

■ pdgetds

■ pdgetdstemplate

■ pdgeteventescalation

■ pdgeteventescalationaction

■ pdgetgroup

■ pdgetjob

Command Line Interface12

■ pdgetjobstat

■ pdgetjobsteps

■ pdgetlicense

■ pdgetlocation

■ pdgetpolicy

■ pdgetpolicyescalation

■ pdgetpolicyescalationaction

■ pdgetstoragepool

■ pdgetuser

■ pdlistagent

■ pdlistdepartment

■ pdlistds

■ pdlistdstemplate

■ pdlistevent

■ pdlisteventescalation

■ pdlisteventescalationaction

■ pdlistgroup

■ pdlistjob

■ pdlistlicense

■ pdlistlocation

■ pdlistpolicy

■ pdlistpolicyescalation

■ pdlistpolicyescalationaction

■ pdlistuser

■ pdlogonuser

■ pdpasswd

■ pdrestore

13Command Line Interface

■ pdrunpolicy

■ pdsetagent

■ pdsetbackuppolicy

■ pdsetcrgarbagecollectionpolicy

■ pdsetdatalock

■ pdsetdataminingpolicy

■ pdsetdataremovalpolicy

■ pdsetdebugagent

■ pdsetdepartment

■ pdsetds

■ pdsetdsremovalpolicy

■ pdsetdstemplate

■ pdseteventescalation

■ pdseteventescalationaction

■ pdsetgroup

■ pdsetlicense

■ pdsetlocation

■ pdsetmaintenancepolicy

■ pdsetmbgarbagecollectionpolicy

■ pdsetperm

■ pdsetpolicyescalationaction

■ pdsetreplicationpolicy

■ pdsetserverdbmaintenancepolicy

■ pdsetstoragepool

■ pdsetuser

■ pdstatlicensing

■ pdupgrade

Command Line Interface14

General MAN page for PureDisk CLIGeneral MAN page for PureDisk CLI – A text-based interface for managingSymantec NetBackup PureDisk.

DESCRIPTIONNetBackupPureDiskoffers customers a software-baseddatadeduplication solutionthat integrates with NetBackup. It provides customers with the critical featuresrequired to protect all their data – from remote office to virtual environment todatacenter. It reduces the size of backups with a deduplication engine that can bedeployed for storage reduction. It uses integrationwithNetBackup, for bandwidthreductionusingPureDisk clients. Anopenarchitecture allows customers to easilydeploy and scale NetBackup PureDisk using standard storage and servers.

NOTES■ The command line interface commands are found only on the storage pool

authority in the /opt/pdcli/calls directory.

■ All man pages that are associated with the commands are located in the/opt/pdcli/man directory.

■ Precede special symbols in arguments with an escape character. In the bashshell, use the single quotation mark (') to accomplish that. See the example.Example: '"any argument can fit in here, even arguments with a ¦

symbol"'

■ The command line interface commands can be used to script activities. Be surethe first command that is entered in the script is the pdlogonuser command.If youdonot run pdlogonuser, you are prompted for a user nameandpasswordbefore each command is executed.

■ The contents of allmanpages are collected in a PDF format for offline viewing.See the PureDisk Command Line Interface Guide.

PUREDISK COMMANDS GROUPED BY FUNCTIONGeneral commands

■ pdactivateagent - Activates the agent software on a client computer.

■ pdbackup - Creates a backup job for the client specified.

■ pdbackupstop - Used to stop any running job.

15Command Line InterfaceGeneral MAN page for PureDisk CLI

■ pddeactivateagent - Deactivates the agent software on a client computer soit is no longer backed up by active PureDisk policies.

■ pdexit - Removes any locally saved credentials.

■ pdexport2nbu - Exports a data selection to a NetBackup files list for use witha NetBackup policy.

■ pdfindfiles - Used to find the files that have been backed up.

■ pdlogonuser - Saves the credentials locally to avoid interaction during calls.

■ pdpasswd - Used to set or change a user password.

■ pdrestore - Start a restore job from the specified parameters.

■ pdrunpolicy - Executes the specified policy.

■ pdstatlicensing - Collects and displays extra information about the licensekeys.

■ pdupgrade - Used to initiate the upgrade of client software on the specifiedclient.

Create functions

■ pdcreatebackuppolicy - Creates a new backup policy.

■ pdcreatedataremovalpolicy - Creates a policy to remove data froma contentrouter.

■ pdcreatedepartment - Creates anewdepartment that is used to organize clientsystems.

■ pdcreateds - Creates a new selection of files and directories on a PureDiskclient for backup.

■ pdcreatedstemplate - Used to create data selection templates.

■ pdcreateeventescalation - Creates a new event escalation .

■ pdcreategroup - Creates a new group that is used to organize users with thesame permissions.

■ pdcreatelocation - Creates a new logical grouping for one or moredepartments.

■ pdcreatembgarbagecollectionpolicy - Creates a new metabase garbagecollection policy.

■ pdcreatepolicyescalation - Creates a new policy escalation.

■ pdcreatepolicyescalationaction - Creates a new policy escalation action.

Command Line InterfaceGeneral MAN page for PureDisk CLI

16

■ pdcreatereplicationpolicy - Creates a new replication policy.

■ pdcreatesmtpeventescalationaction - Creates an SMTP event escalationaction.

■ pdcreatesnmpeventescalationaction - Creates an SNMP event escalationaction.

■ pdcreateuser - Creates a newuserwithin PureDisk that can be assigned rightsand permissions.

Delete functions

■ pddeleteagent - Deletes an agent from the PureDisk database.

■ pddeletedepartment - Deletes a department from the storage pool authority(SPA).

■ pddeleteds - Deletes a data selection from a PureDisk policy.

■ pddeletedstemplate - Deletes a data selection template.

■ pddeleteeventescalation - Unbinds an event escalation action from theagent or the storage pool.

■ pddeleteeventescalationaction - Deletes an SMTP action or SNMP action.

■ pddeletegroup - Deletes a user group from the storage pool authority (SPA).

■ pddeletejob - Raises an error and tries to kill the job. If the job is running, itdoes not delete the job. If the job is not running, it deletes the job.

■ pddeletelicense - Deletes a license key.

■ pddeletelocation - Deletes a location from the storage pool authority (SPA).

■ pddeletepolicy - Deletes a policy.

■ pddeletepolicyescalation - Links a policy with a policy escalation action.

■ pddeletepolicyescalationaction - Deletes a policy escalation action.

■ pddeleteuser - Deletes a user from the storage pool authority (SPA).

Get functions

■ pdgetagent - Provides additional information about the agent object specified.

■ pdgetdepartment - Provides additional information about the departmentobject specified.

■ pdgetds - Provides additional information about the data selection objectspecified.


■ pdgetdstemplate - Provides information about the data selection templatespecified.

■ pdgeteventescalation - Provides information about the event escalationspecified.

■ pdgeteventescalationaction - Provides information about the eventescalation action specified.

■ pdgetgroup - Provides additional information about the group object specified.

■ pdgetjob - Provides additional information about the job object specified.

■ pdgetjobstat - Retrieves the job statistics from the PureDisk database.

■ pdgetjobsteps - Used to list the steps that are associated with the specifiedjob.

■ pdgetlicense - Collects information about the specified license key.

■ pdgetlocation - Provides additional information about the location objectspecified.

■ pdgetpolicy - Provides additional informationabout thepolicy object specified.

■ pdgetpolicyescalation - Provides information about the policy escalationobject.

■ pdgetpolicyescalationaction - Provides information about the policyescalation action.

■ pdgetstoragepool - Provides information about the storage pool.

■ pdgetuser - Provides information about the user object specified.

List functions

■ pdlistagent -Displays all agents that are associatedwith aparticular PureDiskenvironment.

■ pdlistdepartment - Displays all departments that are associated with aparticular PureDisk environment.

■ pdlistds - Displays all data selections that are associated with a particularPureDisk environment.

■ pdlistdstemplate - Displays all the data selection templates.

■ pdlistevent -Displays all events that are associatedwith aparticular PureDiskenvironment.

■ pdlisteventescalation - Displays all the event escalations.


18

■ pdlisteventescalationaction - Displays a list of all the event escalationactions.

■ pdlistgroup - Displays all the user groups that are associatedwith a particularPureDisk environment.

■ pdlistjob - Displays all jobs that are associated with a particular PureDiskenvironment.

■ pdlistlicense - Displays all the installed license keys.

■ pdlistlocation -Displays all the locations that are associatedwith aparticularPureDisk environment.

■ pdlistpolicy - Displays all the policies that are associated with a particularPureDisk environment.

■ pdlistpolicyescalation - Displays the policy escalations that are attachedto a policy.

■ pdlistpolicyescalationaction - Displays all the actions that are attachedto a policy.

■ pdlistuser - Displays all the users that are associated with a particularPureDisk environment.

Set functions

■ pdsetagent - Changes and updates the details that are associated with anexisting agent.

■ pdsetbackuppolicy - Change the parameters of an existing backup policy.

■ pdsetcrgarbagecollectionpolicy - Change the parameters of an existingcontent router garbage collection policy.

■ pdsetdatalock - Resets the data lock password.

■ pdsetdataminingpolicy - Change the parameters of an existing data miningpolicy.

■ pdsetdataremovalpolicy - Change theparameters of an existing data removalpolicy.

■ pdsetdebugagent - Change the debugging parameters for the agent.

■ pdsetdepartment - Changes and updates the details that are associated withan existing department.

■ pdsetds - Changes and updates the details that are associatedwith an existingdata selection.


■ pdsetdsremovalpolicy - Change the parameters of an existing data selectionremoval policy.

■ pdsetdstemplate - Changes and updates a data selection template.

■ pdseteventescalationaction - Change the parameters of an existingescalation action.

■ pdsetgroup - Changes and updates the details that are associated with anexisting user group.

■ pdsetlicense - Adds a license key.

■ pdsetlocation - Changes and updates the details that are associated with anexisting location.

■ pdsetmaintenancepolicy - Change theparameters of an existingmaintenancepolicy.

■ pdsetmbgarbagecollectionpolicy - Change the parameters of an existingmetabase garbage collection policy.

■ pdsetperm - Sets the permissions for a user.

■ pdsetpolicyescalationaction - Change the parameters of an existing policyescalation action.

■ pdsetreplicationpolicy - Change the parameters of an existing replicationpolicy.

■ pdsetserverdbmaintenancepolicy - Change the parameters of an existingserver database maintenance policy.

■ pdsetstoragepool - Changes and updates the specified parameters for astorage pool.

■ pdsetuser - Changes and updates the details that are associated with anexisting user.


20

pdactivateagentpdactivateagent – Activates the agent software on a client computer.

SYNOPSISpdactivateagent --id=number

DESCRIPTIONThis command isused to activate thePureDisk agent softwareona client computer.

PARAMETERSid - Agent identifier.

RETURN VALUES/opt/pdcli/calls # ./pdactivateagent --id=2

Activated the agent.

SEE ALSOpddeleteagent

pddeactivateagent

pdgetagent

pdlistagent

pdsetagent

21Command Line Interfacepdactivateagent

pdbackuppdbackup – Creates a backup job for the client specified.

SYNOPSISpdbackup --agentid=number --dsid=number [--backupacl=0|1]

[--bandwidth=number] [--changeaccesstime=number]

[--changedetection=number] [--compress=number] [--encrypt=number]

[--endtime=number] [--endupload=number] [--followjunction=0|1] [--

followsymboliclink=0|1] [--includenetworkshares=0|1]

[--leavearchivebit=0|1] [--nrbackupstreams=number]

[--postscript=string] [--prescript=string] [--retryverify=0|1]

[--runpostonerr=0|1] [--segmentsize=number] [--sort=size|dirname,size]

[--starttime=number] [--usesnapshot=0|1] [--verifylevel=number]

DESCRIPTIONThis command creates a backup job for the client specified.

PARAMETERSagentid - Agent identifier.

backupacl - Lets you choose to back up the access control list information. If setto 0 (zero), the ACL is not backed up. If set to 1 (one), the list is backed up. Thedefault value is 0.

bandwidth - The amount of bandwidth that is allocated to the policy, expressedin kilobytes per second (kb/sec). Use this option to limit the amount of bandwidththe policy uses.

changeaccesstime - This parameter allows theuser to define if the backup changesthe access time of the file. Acceptable values are 0 (zero) - do not change accesstime, or 1 (one) - change access time. The default value is 0.

changedetection - This parameter instructs PureDisk to verify if the file waschanged betweenwhen the file systemwas initially scanned for newandmodifiedfiles andwhenPureDisk beganwriting the backup. If changedetection is enabled,PureDisk logs a warning message for each file that changes during the backup. Ifthis option is not enabled, PureDisk only detects and logs file size changes.Acceptable values are 0 (zero) - do not detect changes or 1 (one) - detect changes.The default value is 0.

Command Line Interfacepdbackup

22

compress - Enables compression on the policy. Acceptable values are 0 (zero) - donot compress or 1 (one) - compress. The default value is 0.

dsid - Data selection identifier.

encrypt - This parameter enables encryption for the policy. Acceptable valuesare 0 (zero), disabled, and 1 (one), enabled. The default value is 0.

endtime - The end time of the backup window. This value is specified in hoursaccording to a 24-hour clock. For example, 2:00 A.M. is 2, and 3:00 P.M. is 15.Acceptable values are 0 (midnight) through 23 (11:00 P.M.).

endupload - The end of the time frame in which data can be sent from the clientto the server. This value is specified in hours according to a 24-hour clock. Forexample, 2:00 A.M. is 2, and 3:00 P.M. is 15. The differences between endtime andendupload are the point in the backup where operations are stopped and whatoperations are stopped. In a backup, the three major steps are scanning for files,uploading data to the content router, and storing the metadata in the metabase.The endupload time is when the upload from the client to the content router isstopped. The backup may still be running, as it is possible metadata is still beingwritten to the metabase. The endtime is when the entire backup operation ishalted.

followjunction -When enabled on anNTFS file system, the backup flow followsthe junctions that reference other data. One (1) is enabled, zero (0) is disabled.The default value is 0.

followsymboliclink -When enabled, the backup flow follows the symbolic linksthat reference other data. One (1) is enabled, zero (0) is disabled. The default valueis 0.

includenetworkshares - This option instructs PureDisk to include or excludenetwork shares at backup. The values for this parameter are 0 (disabled) and 1(enabled). The default value is 0.

leavearchivebit - When enabled, this parameter instructs PureDisk to leavearchive bit untouchedduringbackup. Thevalues for this parameter are 0 (disabled)and 1 (enabled). The default value is 0.

nrbackupstreams - The number of streams to use for backup. The default valueis 1.

postscript - The full path to a user-defined script that PureDisk should runwhenthe policy run finishes.

prescript - The full patch to a user-defined script that PureDisk should runbeforepolicy starts.

23Command Line Interfacepdbackup

retryverify - When enabled, this option instructs PureDisk to retry the backupif it fails. The values for this parameter are 0 (disabled) and 1 (enabled). The defaultvalue is 0.

runpostonerr -When this option is set and the job fails, the script that is definedin the postscript parameter is run at the end of the policy. The values for thisparameter are 0 (do not run the script) and 1 (run the script). The default valueis 0.

segmentsize - The size of each part of a file when the file is broken into smallerparts for backup. NOTE: The segmentsize parameter is specified in bytes, notkbytes.

sort - The sorting algorithm that is used to determine what should be backed upfirst. Acceptable parameters are size, sort by size, and dirname,size, sort bydirectory with the smallest files first. The default is no sorting.

starttime - The start time of the backup window. This value is specified in hoursaccording to a 24-hour clock. For example, 2:00 A.M. is 2, and 3:00 P.M. is 15.Acceptable values are 0 (midnight) through 23 (11:00 P.M.).

usesnapshot - When enabled, this option instructs PureDisk to use snapshottechnology (such asVSS orVSP) to back up the data. The values for this parameterare 0 (disabled) and 1 (enabled). The default value is 0.

verifylevel - Specifies what verification level is used during backup. Acceptablevalues are: 1 (no verification), 2 (confirm the file exists on the content router), 3(check the validity of the file contents), and 4(simulate retrieve and re-fingerprint).The default value is 0.

RETURN VALUES/opt/pdcli/calls # ./pdbackup --dsid=2 --agentid=2

The job with id (7) has the following properties:

____________________________________________________________

The associated agent is: linux (2).

It has run for the workflow: Files and Folders Backup.

The execution status is: 1.

The job timeouts are:

- Warning: 10080 minutes.

- Error: 20160 minutes.

The following job specific parameters are used:

acl = 0.

bandwidth = 0.

Command Line Interfacepdbackup

24

checkifexists = .

compression = .

doafteraction = .

dobeforeaction = .

dontsegmentthreshold = client default.

dontsegmenttypes = client default.

encryption = 1.

followjunction = 0.

followsymboliclink = 0.

includenetworkshares = 1.

job_window_end = -1.

job_window_start = -1.

max_streams = .

noarchivebit = .

preserveatime = 1.

rundoafteronerror = 1.

segmentsize = 131072.

servercrypt = .

sortrule = .

usesvss = 0.

verifylevel = .

SEE ALSOpdbackupstop

25Command Line Interfacepdbackup

pdbackupstoppdbackupstop – Used to stop any running job.

SYNOPSISpdbackupstop --id=number [--graceful=0¦1]

DESCRIPTIONThis command is used to stop any running job.

PARAMETERSid - The job identifier to be changed or updated.

graceful - Accepts either a 1 or a 0. If --graceful=1 the job is stopped gracefully.If --graceful=0 the job is forcefully stopped. The default value is 1.

RETURN VALUES/opt/pdcli/calls # ./pdbackupstop --id=2

Sent signal to job.

SEE ALSOpdbackup

Command Line Interfacepdbackupstop

26

pdcreatebackuppolicypdcreatebackuppolicy – Creates new backup policy.

SYNOPSISpdcreatebackuppolicy --dsfind=string --name=string --schedule=string

[--backupacl=number] [--bandwidth=number] [--changeaccesstime=0|1]

[--changedetection=0|1] [--compress=0|1] [--enabled=0|1]

[--encrypt=0|1] [--endtime=number] [--endupload=number]

[--errorescalationperiod=number] [--includenetworkshares=0|1]

[--leavearchivebit=number] [--nrbackupstreams=number]

[--postscript=string] [--prescript=string] [--retryverify=0|1]

[--runpostonerr=number] [--segmentsize=number]

[--sort=size|dirname,size]] [--starttime=number]

[--usesnapshot=number] [--verifylevel=number]

[--warningescalationperiod=number]

DESCRIPTIONThis command creates a new backup policy.

PARAMETERSdsfind - A data selection filter that is used in all data selection-related policies.That determineswhichdata selections a certainpolicyuses.Adsfind filter consistsof one or more dsfind lines. The syntax for the dsfind parameter is<identifier>=<value>. Itemswithin a dsfind line are separated with a comma.The dsfind lines are separated with the pipe symbol (¦). Supported dsfind valuesare as follows:

■ agentid: All data selections for the specified agent.

■ dataselectionid: The one data selection with the specified ID.

■ dstype: The type of the data selection created. 1 is normal, 6 MicrosoftExchange, 7Microsoft SQL, 8 ShadowCopy (systembackup), 9NetBackupOST(PDDO), 11 UNC path, 14 Oracle, 15 Oracle UDJ (User Directed Job, used foruser to back up or restore directly through a script), 16 DLO.

■ storagepoolid: All data selections in the specified storage pool.

■ agentlocationid: All data selections for all agents for a specified location ID.

27Command Line Interfacepdcreatebackuppolicy

■ agentdepartmentid: All data selections for all agents for a specifieddepartmentID.Example dsfind parameter:

--dsfind='dataselectionid=2,dstypeid=1|dataselectionid=3,dstypeid=1'

The dsfind selects a data selection that meets any of the following criteria:

■ Data selection with a dataselectionid of 2 and a dstypeid of 1.

■ Data selection with a dataselectionid of 3 and a dstypeid of 1.

name - The name of the new backup policy.

schedule - Defines how often a policy should run. The format of the argumentinvolves two values: an interval and a time period. The interval can be hourly (H),daily (D), weekly (W), or monthly (M). The time period value accepts integers andcolons (:) and is expressed differently depending on the interval. Enclose theargument inquotationmark characters, as follows:--schedule="interval:time"

■ For hourly, the time period is offset:period. The offset sets which minute inthe hour the policy should run. The period defines how often the policy runs.So the parameter --schedule="H5:4" indicates the job should start at fiveminutes past the hour and run every four hours.

■ For daily, the time period is hour:minute:period. The hour and minute are thehour and minute when the policy should run. The period defines how oftenthe policy runs. So the parameter --schedule="D13:15:7" indicates the policyshould execute at 1:15 P.M. every seven days.

■ For weekly, the time period is hour:minute:period. The hour and minute arethe hour and minute when the policy should run. The period is a bitmap thatindicates the days of the week when the policy should run. The bitmap is astring of seven zeros or ones. The first character indicates the first day of theweek (Monday). The second character indicates the second day of the week(Tuesday), and so on. If the character is 1, thatmeans that the schedule shouldrun that day. If it is a 0 the schedule does not run. For example: 1000000meansthat the schedule should run only on Monday. 1010101means the policy runson Monday, Wednesday, Friday, and Sunday.

■ Formonthly, the timeperiod is hour:minute:offset:period. Thehour andminuteare the hour andminute when the policy should run. The offset determine theday of the month the policy should run. The period is a bitmap that indicatesthe months when the policy should run. This bitmap is a string of 12 zeros orones. The first character indicates the first month of the year (January). Thesecond the second month of the year (February), and so on. If the character is1, that means that the schedule should run that month. If it is 0 the scheduledoes not run. For example: 100000000000means that the schedule should run

Command Line Interfacepdcreatebackuppolicy

28

in January. 100000000001 means that this schedule runs in January andDecember. So the parameter --schedule="M10:0:12:11000000000" indicatesa policy that executes at 10:00 on the 12th day of the months January andFebruary.

■ The CLI can create more flexible schedules than the GUI can. Some schedulescannot be properly displayed in theGUI but are saved properly. To display theschedule information you can use pdgetpolicy.

backupacl - Allows the user to choose to back up the access control listinformation. If set to 0, the ACL is not backed up. If set to 1, the list is backed up.The default value is 0.

bandwidth - The amount of bandwidth that is allocated to the policy, expressedin kilobytes per second (kb/sec). Use this option to limit the amount of bandwidththe policy uses.


changedetection - This parameter instructs PureDisk to verify if the file waschanged betweenwhen the file systemwas initially scanned for newandmodifiedfiles and when PureDisk began writing the backup. Acceptable values are 0 - donot detect changes or 1 - detect changes. The default value is 0.

compress - Enables compression on the policy. Acceptable values are 0 - do notcompress or 1 - compress. The default value is 0.

enabled - Use of this parameter enables the policy. Acceptable values are 0 (zero),disabled, and 1 (one), enabled. The default value is 1.



endupload - The end of the time frame in which data can be sent from the clientto the server. This value is specified in hours according to a 24-hour clock. Forexample, 2:00 A.M. is 2, and 3:00 P.M. is 15. The differences between endtime andendupload are the point in the backup where operations are stopped and whatoperations are stopped. In a backup, the three major steps are scanning for files,uploading data to the content router, and storing the metadata in the metabase.The endupload time is when the upload from the client to the content router isstopped. The backup may still be running, as it is possible metadata is still being


written to the metabase. The endtime is when the entire backup operation ishalted.

errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified in minutes) after which an email is sent. The emailindicates a job has been running for more than the specified error time frame.Additionally, the backup job is stopped. More information about error escalationis available. See the Creating policy escalation actions section in the SymantecNetBackup PureDisk Backup Operator’s Guide.

includenetworkshares - This option instructs PureDisk to include or excludenetwork shares in a backup. Acceptable values are 0 (zero - do not include networkshares) and 1 (one - include network shares). The default value is 0.

leavearchivebit - When enabled, this parameter instructs PureDisk to leavearchive bit untouched during backup. The values for this parameter are zero (0,disabled) and one (1, enabled). The default value is 0.

nrbackupstreams - The number of streams to use for backup. The default valueis 1.

postscript - The user-defined script that PureDisk should run at the end of apolicy.

prescript - The user-defined script that PureDisk should run at the start of apolicy.

retryverify - When enabled, this option instructs PureDisk to retry the backupif it fails.Acceptable values are 0 (zero), disabled, and 1 (one), enabled.

runpostonerr - When this option is set, a user-defined script is run at the end ofthe policy if the job fails. Acceptable values are 0 (zero), do not run the script, and1 (one), run the script on error. The default is 0.


sort - The sorting algorithm that is used to determine what should be backed upfirst. Acceptable parameters are size, sort by size, and dirname,size, sort bydirectory with the smallest files first. The default is no sorting.



30

usesnapshot - When enabled, this option instructs PureDisk to use snapshottechnology (such as VSS or VSP) to back up the data. Acceptable values are 0(zero), disabled, and 1 (one), enabled. The default value is 0.

verifylevel - Specifies what verification level is used during backup. Acceptablevalues are 1 (no verification), 2 (confirm the file exists on the content router), 3(check the validity of the file contents), and 4(simulate retrieve and re-fingerprint).The default value is 0.

warningescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The warningescalationperiodis the period of time (specified in minutes) after which an email is sent, warninga job has been running for more than the specified warning time frame. Moreinformation about error escalation is available. See the Creating policy escalationactions section in the Symantec NetBackup PureDisk Backup Operator’s Guide.

RETURN VALUES/opt/pdcli/calls # ./pdcreatebackuppolicy

--name='"Backup of entire storagepool"'

--dsfind=storagepoolid=1 --schedule=D0:20:1 --compress=1

--usesnapshot=1

Created a new backup policy with the following properties:

__________________________________________________________

The policy identifier: 107.

The policy name: Backup of entire storagepool.




The following policy specific parameters were found:

usesvss = 1.

compression = 1.

SEE ALSOpddeletepolicy

pdgetpolicy

pdlistpolicy


pdsetbackuppolicy


32

pdcreatedataremovalpolicypdcreatedataremovalpolicy – Creates a policy to remove data from a contentrouter.

SYNOPSISpdcreatedataremovalpolicy --dsfind=string --name=string

--schedule=string [--enabled=0¦1] [--errorescalationperiod=number]

[--kmaxnfiles=number] [--kmaxnfilesdel=number] [--mbfindfile=string]

[--pdel=number] [--pnewer=number] [--registertime=string]


DESCRIPTIONThis command creates a policy to remove data from the content router.

PARAMETERSdsfind - A data selection filter that is used in all data selection-related policies.That determineswhich data selections are handled by a certain policy. The syntaxfor the dsfindparameter is <identifier>=<value>.Separatemultiple identifierswith a comma. Supported dsfind values are as follows:





■ agentdepartmentid: All data selections for all agents for a specifieddepartmentID.

name - The name of the policy.

schedule - Defines howoften a policy should execute. The format of the argumentinvolves two values: an interval and a time period. The interval can be hourly (H),daily (D), weekly (W), or monthly (M). The time period value accepts integers andcolons (:) and is expressed differently depending on the interval. Enclose theargument inquotationmark characters, as follows:--schedule="interval:time"

■ For hourly, the time period is offset:period. The offset sets which minute inthe hour the policy should run. The period defines how often the policy runs.

33Command Line Interfacepdcreatedataremovalpolicy

So the parameter --schedule="H5:4" indicates the job should start at fiveminutes past the hour and run every four hours.



■ Formonthly, the timeperiod is hour:minute:offset:period. Thehour andminuteare the hour andminute when the policy should run. The offset determine theday of the month the policy should run. The period is a bitmap that indicatesthe months when the policy should run. This bitmap is a string of 12 zeros orones. The first character indicates the first month of the year (January). Thesecond the second month of the year (February), and so on. If the character is1, that means that the schedule should run that month. If it is 0 the scheduledoes not run. For example: 100000000000means that the schedule should runin January. 100000000001 means that this schedule runs in January andDecember. So the parameter --schedule="M10:0:12:11000000000" indicatesa policy that executes at 10:00 on the 12th day of the months January andFebruary.


enabled - Use of this parameter enables the policy. Acceptable values are 0 (zero),disabled, and 1 (one), enabled. The default value is 1

errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified in minutes) after which an email is sent. The emailindicates a job has been running for more than the specified error time frame.Additionally, the backup job is stopped.

kmaxnfiles - The maximum number of file versions to retain.

Command Line Interfacepdcreatedataremovalpolicy

34

kmaxnfilesdel - The maximum number of file versions to retain after the file isdeleted on source.

mbfindfile - The file name of the file containing themetadata filters used by thepolicy. The file this parameter specifies contains one or more filters that helpdetermine what file or files are selected. The filters consist of an mbfind field andits associated value. An example of an mbfile file is located in/opt/pdcli/defaultMBFind.dat.

Supported mbfields are as follows:

■ basename: The name of the object, not including the directory name.

■ dirname: The directory location of the object. That is specified as an absolutepath

■ extension: The object extension (.doc, .xls, .jpg, .mp3, and so on).

■ fromsize: The smallest object size that is included in the search.

■ tosize: The largest object size that is included in the search.

■ fromregistertime: The earliest time indicatingwhen the objectwas registeredin the metabase. That is expressed in "seconds since epoch", when the objectwas introduced on the storage pool. So if a file was registered in the metabaseat 10:00 P.M. on January 25, 2009, the seconds since epoch is 1232920800. Avalue of --fromregistertime=1232834400 would capture this object.

■ toregistertime: The latest time indicating when the object was registered inthe metabase. That is expressed in "seconds since epoch". So if a file wasregistered in themetabase at 10:00 P.M. on January 24, 2009, the seconds sinceepoch is 1232834400.Avalueof--toregistertime=1232920800would capturethis object.Both the fromregistertime and the toregistertime parameters also allowfor the following input where # is a number. For example, -24dmeans 24 daysago.

■ -#h: Number of hours ago

■ -#d: Number of days ago

■ -#w: Number of weeks ago

■ -#y: Number of years ago

pdel - Thenumber of days to retain the last version of a file after the file is deletedfrom source.

pnewer - The number of days to retain older or obsolete file versions.

35Command Line Interfacepdcreatedataremovalpolicy

registertime - When a file's metadata is saved into the metadata database, thetime it is saved is recorded. That is considered the registertime. When usingtime-based data removal, you can specifywhat data is selected to be deleted basedon the registration time using the --registertime parameter. The format forthis parameter is seconds since epoch.

warningescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The warningescalationperiodis the period of time (specified inminutes) after which an email is sent. The emailis a warning that a job has been running formore than the specifiedwarning timeframe.

RETURN VALUES/opt/pdcli/calls # ./pdcreatedataremovalpolicy

--name='"Data removal of entire storagepool"'

--dsfind=storagepoolid=1 --schedule=D20:0:1 --kmaxnfilesdel=2

Created a new data removal policy with the following properties:

________________________________________________________________


The policy name: Data removal of entire storagepool.


kMaxNFilesDel = 2.

rType = 1.

SEE ALSOpdgetpolicy

pdsetdataremovalpolicy

Command Line Interfacepdcreatedataremovalpolicy

36

pdcreatedepartmentpdcreatedepartment –Creates a new department that is used to organize agents.

SYNOPSISpdcreatedepartment --name=string [--description=string]

DESCRIPTIONThis command creates a new department that is used to organize agents.

PARAMETERSdescription - The description of the object.

name - - The name of the new department.

RETURN VALUES/opt/pdcli/calls # ./pdcreatedepartment --name=Testing

--description='"Internal Q/A Department"'

A department with the following parameters has been created:

____________________________________________________________

The identifier is 3.

The name is Testing.

The description is Internal Q/A Department.

SEE ALSOpdcreatelocation

pddeletedepartment

pdgetdepartment

pdlistdepartment

pdsetdepartment

37Command Line Interfacepdcreatedepartment

pdcreatedspdcreateds – Creates a new selection of files and directories on a PureDisk clientfor backup.

SYNOPSISpdcreateds --agentid=number --dsrules='string' --name=string

[--description=string] [--dstype=number] [--originaltemplateid=number]

DESCRIPTIONThis command creates a new selection of files anddirectories on aPureDisk clientfor backup.

PARAMETERSagentid - Agent identifier

dsrules - A comma-separated file that is used on a client for selecting data forbackup. The structure of the file is: path|filename|include (include being 0 toexclude, 1 to include the files selected). This parametermust be enclosed in single(') quotation marks.

name - Name of the object.

description - Description of the object.

dstype - The type of the data selection created. 1 is normal, 6Microsoft Exchange,7 Microsoft SQL, 8 Shadow Copy (system backup), 9 NetBackup OST (PDDO), 11UNC path, 14 Oracle, 15 Oracle UDJ (User Directed Job, used for user to back upor restore directly through a script), 16 DLO.

originaltemplateid - The data selection template ID for a data selection thatinherits from a data selection template.

RETURN VALUES/opt/pdcli/calls # ./pdcreateds --dsrules='/etc/*|*|1'

--name=nam --agentid=2

Created a DataSelection with the following properties:

______________________________________________________

The identifier is 3. The name is nam.

This data selection applies to the agent with id 2.

Command Line Interfacepdcreateds

38

Created on May 20, 2009; last changed on May 20, 2009.

The file selection rules for this data selection are:

This following rule includes:

file pattern: *.

directory pattern: /etc/*.

SEE ALSOpddeleteds

pdgetds

pdlistds

pdsetds

39Command Line Interfacepdcreateds

pdcreatedstemplatepdcreatedstemplate – Used to create data selection templates.

SYNOPSISpdcreatedstemplate --dstrules='string' --name=string --ostypeid=number

[--description=string] [--inheritancemap='containerid|containertype']

DESCRIPTIONThis command is used to create data selection templates.

PARAMETERSdstrules - The criteria that is used to determinewhich files the templates selects.The criteria is specified as 'path|filename|include' (include being 0 to exclude, 1to include). Wildcard characters can be used for the path and filename values.See the PureDisk Backup Operators Guide for more information on wild cards. Adstrulesparameter of '/etc/*|*|1'would include all files in the /etc directory.Separate multiple include and exclude rules with commas. Be aware that in thebash shell, the options must be enclosed in apostrophes, as show in the ReturnValues section.

description - The description of the data selection template.

name - The name of the data selection template.

ostypeid - Used to define the operating system of the data selection. Operatingsystem types are 0=unknown, 10=Windows, 20=Linux, 30=Solaris, 40 =HP-UX,50 = AIX, 60 = MacOS.

inheritancemap - The containers to which the new template applies. Theparameter is specified as --inheritancemap='containerid|containertype' andmust be enclosed in apostrophes. Separate multiple IDs and types with commas(--inheritancemap'containerid|containertype,containerid|containertype').Acceptablevaluesfor containertype are as follows: Agent = 1, Location= 2, Department = 3, Storagepool = 4, OS Type = 5. The container ID is found by using the pdlist commandthat is associated with the desired container (pdlistagent, pdlistlocation, andso on).

Command Line Interfacepdcreatedstemplate

40

RETURN VALUES/opt/pdcli/calls # ./pdcreatedstemplate --dstrules='/*|*|1,

/lib/*|*|0' --name=nam --ostypeid=20

Created a DataSelection template with the following properties:

_______________________________________________________________



The file selection rules for this data selection template are:


file pattern: *.

directory pattern: /*.

This following rule excludes:

file pattern: *.

directory pattern: /lib/*.

SEE ALSOpddeletedstemplate

pdgetdstemplate

pdlistdstemplate

pdsetdstemplate

41Command Line Interfacepdcreatedstemplate

pdcreateeventescalationpdcreateeventescalation – Creates a new event escalation.

SYNOPSISpdcreateeventescalation --bindid=number --escalationactionid=number

--eventtype=number --maxseveritylevel=number --minseveritylevel=number

DESCRIPTIONThis command creates a new event escalation.

PARAMETERSbindid - The identifier that is used to bind items. Used to bind the event to theevent escalation. The two types of event escalation actions are: agent eventescalation actions and storage pool event escalation actions. Agent escalationactions are run for a specific agent. Storage pool event escalation actions are runfor the entire storage pool. The bindid references the identifier of either an agentaction or a storage pool action.

escalationactionid - The escalation action identifier.

eventtype - The type of event escalation action being created. The two types ofevent escalation actions are: agent event escalation (denoted by the number 1)and a storage pool event escalation (denoted by the number 0).

maxseveritylevel - Thehighest severity level the event escalation action catches.Acceptable values are: 1 Debug, 2 Informational, 3 Authorization, 4 Warning, 5Error, 6 Critical, and 7 Bug.

minseveritylevel - The lowest severity level the event escalation action catches.Acceptable values are: 1 Debug, 2 Informational, 3 Authorization, 4 Warning, 5Error, 6 Critical, and 7 Bug.

RETURN VALUES/opt/pdcli/calls # ./pdcreateeventescalation --eventtype=0 --bindid=1

--escalationactionid=1 --minseveritylevel=1 --maxseveritylevel=4

Bound the action to the agent/storagepool.

Command Line Interfacepdcreateeventescalation

42

SEE ALSOpddeleteeventescalation

pdgeteventescalation

43Command Line Interfacepdcreateeventescalation

pdcreategrouppdcreategroup –Creates anewgroup that is used to organize userswith the samepermissions.

SYNOPSISpdcreategroup --name=string [--description=string]

DESCRIPTIONThis command creates a new group that is used to organize users with the samepermissions.

PARAMETERSdescription - Description of the group.

name - Name of the group.

RETURN VALUES/opt/pdcli/calls # ./pdcreategroup --name=Backup_Admin

Successfully created group:

Backup_Admin (86425a4a-d97c-102d-93f7-d93d3c16bc52).

SEE ALSOpddeletegroup

pdgetgroup

pdlistgroup

pdsetgroup

Command Line Interfacepdcreategroup

44

pdcreatelocationpdcreatelocation – Creates a new logical grouping for one or more agents.

SYNOPSISpdcreatelocation --name=string [--address=string]

[--description=string]

DESCRIPTIONThis command creates a new logical grouping for one or more agents.

PARAMETERSaddress - The address that is associated with the location. That can be a physicaladdress or a virtual address.

description - Description of the location.

name - Name of the location.

RETURN VALUES/opt/pdcli/calls # ./pdcreatelocation --name=Belgium

Successfully created a new location:

Belgium (2) with description:

SEE ALSOpdcreatedepartment

pddeletelocation

pdgetlocation

pdlistlocation

pdsetlocation

45Command Line Interfacepdcreatelocation

pdcreatembgarbagecollectionpolicypdcreatembgarbagecollectionpolicy–Createsanewmetabasegarbagecollectionpolicy.

SYNOPSISpdcreatembgarbagecollectionpolicy --dsfind=string --name=string

--schedule=string [--enabled=0¦1] [--enableextensivecleanup=number]

[--errorescalationperiod=number] [--logdeletedrecords=0¦1]


DESCRIPTIONThis command creates a new metabase garbage collection policy.

PARAMETERSdsfind - A data selection filter that is used in all data selection-related policies.That determines which data selections a certain policy uses. The syntax for thedsfind parameter is <identifier>=<value>. Separate multiple identifiers witha comma. Supported dsfind values are as follows:






name - The name of the policy.



Command Line Interfacepdcreatembgarbagecollectionpolicy

46





enabled - - Use of this parameter enables the policy. Acceptable values are 0 (zero),disabled, and 1 (one), enabled. The default value is 1

enableextensivecleanup - This parameter is used to enable and disable moreextensive cleanupduring themetabase garbage collection.Duringnormal cleanup,only dereferenced file names are removed. When this parameter is enabled, thepolicy also attempts to remove expired file names. Acceptable values for thisparameter are 0 (zero), disabled, and 1 (one), enabled. The default value is 0.

errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified in minutes) after which an email is sent. The email

47Command Line Interfacepdcreatembgarbagecollectionpolicy

indicates a job has been running for more than the specified error time frame.Additionally, the backup job is stopped.

logdeletedrecords -When this parameter is enabled, PureDisk keeps the historyon the metabase garbage collection policies. The acceptable values for thisparameter are zero (0 - disabled) and one (1 - enabled). The default value is 0.

warningescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The warningescalationperiodis the period of time (specified inminutes) after which an email is sent. The emailwarns that a job has been running formore than the specifiedwarning time frame.

RETURN VALUES/opt/pdcli/calls # ./pdcreatembgarbagecollectionpolicy --name='"mbgc"'

--dsfind=storagepoolid=1 --schedule=D20:0:1 --enableextensivecleanup=1

Created a new MB garbage collection policy with the following properties:

_________________________________________________________________________


The policy name: mbgc.





removeExp = 1.

SEE ALSOpdsetmbgarbagecollectionpolicy

Command Line Interfacepdcreatembgarbagecollectionpolicy

48

pdcreatepolicyescalationpdcreatepolicyescalation – Creates a new policy escalation.

SYNOPSISpdcreatepolicyescalation --escalationactionid=number --policyid=number

DESCRIPTIONThis command creates a new policy escalation.

PARAMETERSescalationactionid - The escalation action identifier. When a policy escalationaction is created using the pdcreatepolicyescalationaction command anidentifier is created. You can use pdlistpolicyescalationaction to get a list ofall the policyescalation actions.

policyid - The policy identifier.

RETURN VALUES/opt/pdcli/calls # ./pdcreatepolicyescalation --policyid=105

--escalationactionid=1

Bound the action to the policy.

SEE ALSOpddeletepolicyescalation

pdgetpolicyescalation

pdlistpolicyescalation

49Command Line Interfacepdcreatepolicyescalation

pdcreatepolicyescalationactionpdcreatepolicyescalationaction – Creates a new policy escalation action.

SYNOPSISpdcreatepolicyescalationaction --description=string

--emailalarm=string [--createevent=0¦1] [--emailwarning=string]

[--eventseveritylevel=number] [--message=string]

DESCRIPTIONThis command creates a new policy escalation action.

PARAMETERSdescription - Description of the policy escalation action.

emailalarm - The email address that is used for sending an email when a policyescalation occurs and the error escalation time for a policy is expired.

createevent - This parameter instructs PureDisk to send an event if the job hasreached its expiration date. Acceptable values are 0 (zero) - donot create an event,and 1 (one) - create an event. The default value is 1.

emailwarning - The email address that is used for sending an email when a policyescalation occurs and the warning escalation time for a policy is expired.

eventseveritylevel - Defines the severity level for the newly created policyescalation action. The levels are: 1 Debug, 2 Informational, 3 Authorization, 4Warning, 5 Error, 6 Critical, and 7Bug.Acceptable values for eventseveritylevelare 1 (one) through 7 (seven). The default value if not specified is 1.

message - The message that is associated with the escalation action. That is thetext that is emailed when the escalation action is thrown.

RETURN VALUES/opt/pdcli/calls # ./pdcreatepolicyescalationaction

--description='"Escalation to Emy"'

[email protected] --eventseveritylevel=5

Created a policy escalation action with the following properties:

_________________________________________________________________

The action identifier is 1.

Command Line Interfacepdcreatepolicyescalationaction

50

The description is Escalation to Emy.

If a policy reaches the error escalation timeout an email message is sent to [email protected].

When it reaches the warning escalation timeout an email message is sent to [email protected].

SEE ALSOpddeletepolicyescalationaction

pdgetpolicyescalationaction

pdlistpolicyescalationaction

pdsetpolicyescalationaction

51Command Line Interfacepdcreatepolicyescalationaction

pdcreatereplicationpolicypdcreatereplicationpolicy – Creates a new replication policy.

SYNOPSISpdcreatereplicationpolicy --dsfind=string --name=string

--remoteaddress=string --remotelogin=string --remotepwd=string

--schedule=string [--bandwidth=number] [--crport=number]

[--enabled=0¦1] [--errorescalationperiod=number] [--forcecrypt=number]

[--endtime=number] [--starttime=number] [--mbfindfile=string]

[--typeofrep=number] [--warningescalationperiod=number]

DESCRIPTIONThis command creates a new replication policy.







remoteaddress - The TCP/IP address of the remote storage pool authority.

remotelogin - The login ID for the remote storage pool authority.

remotepwd - The password for the login ID for the remote storage pool authority.


Command Line Interfacepdcreatereplicationpolicy

52






bandwidth - The amount of bandwidth that is allocated to the policy, expressedin kilobytes per second (kb/sec). Use this option to limit the amount of bandwidtha policy uses.

crport - The port number that the content router uses for backup and restoreoperations.

enabled - Specifieswhether the policy is created in an enabled (default) or disabledstate. Specify --enabled=0 to create a policy in a disabled state.

53Command Line Interfacepdcreatereplicationpolicy



forcecrypt - This parameter forces encryption during replication.



■ basename: The name of the object, no including the directory name.

■ dirname: The directory location of the object. It is specified as an absolute path





■ toregistertime: The latest time indicating when the object was registered inthe metabase. That is expressed in "seconds since epoch". So if a file wasregistered in themetabase at 10:00 P.M. on January 24, 2009, the seconds sinceepoch is 1232834400.Avalueof--toregistertime=1232920800would capturethis object.Both the fromregistertime and toregistertime parameters also allow forthe following input where # is a number. For example, -24d means 24 daysago.



Command Line Interfacepdcreatereplicationpolicy

54



name - The name of the replication policy.

starttime - The timewhen the job window starts. This value is specified in hoursaccording to a 24-hour clock. For example, 2:00 A.M. is 2, and 3:00 P.M. is 15.Acceptable values are 0 (midnight) through 23 (11:00 P.M.).

typeofrep - The type of replication to perform. Values are either 0 (zero), full, or1 (one), incremental. The default is 1.


RETURN VALUES/opt/pdcli/calls # ./pdcreatereplicationpolicy

--name='"replication to slowpoke"' --dsfind=storagepoolid=1

--schedule=D20:0:1 --remoteaddress=10.31.82.141 --remotelogin=root

--remotepwd=root

Created a new replication policy with the following properties:

_______________________________________________________________


The policy name: replication to slowpoke.


typeofrep = 1.

bandwidth = 0.

crport = 10082.

forcecrypt = 1.

remoteaddress = 10.31.82.141.

remotelogin = root.

remotepassword = root.

SEE ALSOpdsetreplicationpolicy

55Command Line Interfacepdcreatereplicationpolicy

pdcreateSMTPeventescalationactionpdcreateSMTPeventescalationaction–Creates anSMTPevent escalationaction.

SYNOPSISpdcreateSMTPeventescalationaction --description=string

--emailaddress=string [--message=string] --subject=string

DESCRIPTIONThis command creates an SMTP event escalation action.

PARAMETERS

Note: The text of the parameter needs to be enclosed in quotation marks if thetext includes spaces. Precede special symbols in arguments with an escapecharacter. In the bash shell, use the single quotation mark (') to accomplish that.

description - The description of the event escalation action.

emailaddress - The SMTP address associated with the escalation action

message - The message that is associated with the escalation action. That text isemailed when the escalation action is detected.

subject - The subject of the email message the escalation action sends.

RETURN VALUES/opt/pdcli/calls # pdcreateSMTPeventescalationaction

[email protected]

--message='"PureDisk has encountered a problem"'

--description='"A problem occurred on slowpoke"'

--subject='"PureDisk has encountered a problem"'

Created an action with the following properties:

_________________________________________________

Identifier: 1.

The email subject: PureDisk has encountered a problem.

Description: A problem occurred on slowpoke.

Command Line InterfacepdcreateSMTPeventescalationaction

56

Message: PureDisk has encountered a problem.

Email address: [email protected].

SEE ALSOpdcreateSNMPeventescalationaction

pddeleteeventescalationaction

pdgeteventescalationaction

pdlisteventescalationaction

57Command Line InterfacepdcreateSMTPeventescalationaction

pdcreateSNMPeventescalationactionpdcreateSNMPeventescalationaction–Creates anSNMPevent escalationaction.

SYNOPSISpdcreateSNMPeventescalationaction --address='string'

--community=string --description='string'

DESCRIPTIONThis command creates an SNMP event escalation action. To send event by usingSNMP, make sure that you have configured and enabled the SNMP software. Formore information, see the PureDisk Backup Operator's Guide.

PARAMETERS


address - The SNMP address that is associated with the escalation action. Thisparameter must be enclosed in apostrophes.

community - The group of devices and management stations running SNMP.

description - The description of the event escalation action. This parametermust be enclosed in apostrophes.

RETURN VALUES/opt/pdcli/calls # ./pdcreateSNMPeventescalationaction

--address='local.snmp.server' --community=communityroot

--description='"SNMP action"'

Created an action with the following properties:

_________________________________________________

Identifier: 2.

Description: SNMP action.

The SNMP address: local.snmp.server.

The SNMP community: communityroot.

Command Line InterfacepdcreateSNMPeventescalationaction

58

SEE ALSOpdcreateSMTPeventescalationaction




59Command Line InterfacepdcreateSNMPeventescalationaction

pdcreateuserpdcreateuser – Creates a new user within PureDisk that can be assigned rightsand permissions.

SYNOPSISpdcreateuser --departmentid=number --locationid=number --login=string

--name=string --pwd=string [--description=string] [--email=string]

[--mobile=string] [--telephone=string]

DESCRIPTIONThis command creates a new user within PureDisk that can be assigned rightsand permissions.

PARAMETERS


departmentid - Department identifier.

locationid - Location identifier.

login - The logon name of a user.

name - The name of the user.

pwd - The password for the new user. If the parameter is left blank, it defaults to"password".

description - A description of the user.

email - The email address of a user. An email address can be specified for eachuser.

mobile - The mobile telephone number of a user.

telephone - The telephone number for a user.

Command Line Interfacepdcreateuser

60

RETURN VALUES/opt/pdcli/calls # ./pdcreateuser --login=jsmith --name='"John Smith"'

--pwd='default' --departmentid=2 --locationid=2

Successfully created user:

jsmith (bd31bd06-d97d-102d-93f9-d93d3c16bc52).

SEE ALSOpddeleteuser

pdgetuser

pdlistuser

pdlogonuser

pdsetuser

61Command Line Interfacepdcreateuser

pddeactivateagentpddeactivateagent – Deactivates the agent software on a client computer so itis no longer backed up by active PureDisk policies.

SYNOPSISpddeactivateagent --id=number

DESCRIPTIONThis command deactivates the agent software on a client computer so it is nolonger backed up by active PureDisk policies.

PARAMETERSid - The ID number for the agent you want to deactivate.

RETURN VALUES/opt/pdcli/calls # ./pddeactivateagent --id=2

Deactivated the agent.

SEE ALSOpddeactivateagent

pddeleteagent

pdgetagent

pdlistagent

pdsetagent

Command Line Interfacepddeactivateagent

62

pddeleteagentpddeleteagent – Deletes the agent from the PureDisk database.

SYNOPSISpddeleteagent --id=number [--noconfirm=1]

DESCRIPTIONThis command deletes an agent from the PureDisk database.

Warning: An agent's backups cannot be recovered once an agent is deleted. Usecaution when deleting agents.

PARAMETERSid - The ID for the agent you want to delete.

noconfirm - When you delete an agent, you are prompted to confirm the delete.If --noconfirm=1 is specified, the confirmation prompt is suppressed.

RETURN VALUES/opt/pdcli/calls # ./pddeleteagent --id=4 --noconfirm=1

Deleted the agent.

SEE ALSOpdactivateagent

pddeactivateagent

pdgetagent

pdlistagent

pdsetagent

63Command Line Interfacepddeleteagent

pddeletedepartmentpddeletedepartment – Deletes a department from the storage pool authority(SPA).

SYNOPSISpddeletedepartment --id=number

DESCRIPTIONThis command deletes a department from the storage pool authority.

PARAMETERSid - The ID for the department you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeletedepartment --id=2

Deleted the department.


pdgetdepartment

pdlistdepartment

pdsetdepartment

Command Line Interfacepddeletedepartment

64

pddeletedspddeleteds – Deletes a data selection from a PureDisk policy.

SYNOPSISpddeleteds --id=number [--noconfirm=1]

DESCRIPTIONThis command deletes a data selection from a PureDisk policy.

Warning:The backups of a data selection cannot be recovered once a data selectionis deleted. Use caution when deleting data selections.

PARAMETERSid - The ID for the data selection you want to delete.

noconfirm - When you delete a data selection, you are prompted to confirm thedelete. If --noconfirm=1 is specified, the confirmation prompt is suppressed.

RETURN VALUESThis command has no return value. Unless the command is entered incorrectly.

SEE ALSOpdcreateds

pdgetds

pdlistds

pdsetds

65Command Line Interfacepddeleteds

pddeletedstemplatepddeletedstemplate – Deletes a data selection template.

SYNOPSISpddeletedstemplate --id=number

DESCRIPTIONThis command deletes a data selection template.

PARAMETERSid - The ID for the data selection template you want to delete.

RETURN VALUESThis command has no return value. Unless the command is entered incorrectly.

SEE ALSOpdcreatedstemplate

pdgetdstemplate

pdlistdstemplate

pdsetdstemplate

Command Line Interfacepddeletedstemplate

66

pddeleteeventescalationpddeleteeventescalation – Unbinds an event escalation action from the agentor the storage pool.

SYNOPSISpddeleteeventescalation --id=number --escalationtype=0|1

DESCRIPTIONThis command unbinds an event escalation action from the agent or the storagepool.

PARAMETERSid - The ID for the agent escalation action or the storage pool escalation actionyou want to delete.

escalationtype - Specifies if the event escalation is an agent (1) or storage poolescalation (0).

RETURN VALUES/opt/pdcli/calls # ./pddeleteeventescalation --id=3 --escalationtype=0

Unbound the action to the agent/storagepool.

SEE ALSOpdcreateeventescalation


pdlisteventescalation

pdseteventescalation

67Command Line Interfacepddeleteeventescalation

pddeleteeventescalationactionpddeleteeventescalationaction – Deletes an SMTP or an SNMP action.

SYNOPSISpddeleteeventescalationaction --id=number

DESCRIPTIONThis command deletes an SMTP or an SNMP action.

PARAMETERSid - The ID for the SMTP action or SNMP action that you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeleteeventescalationaction --id=1

Removed the action.


pdcreateSNMPeventescalationaction




Command Line Interfacepddeleteeventescalationaction

68

pddeletegrouppddeletegroup – Deletes a user group from the storage pool authority.

SYNOPSISpddeletegroup --name=string

DESCRIPTIONThis command deletes a user group from the storage pool authority (SPA).

PARAMETERSname - The ID for the user group that you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeletegroup --name=Backup_Admin

Deleted the group.

SEE ALSOpdcreategroup

pdgetgroup

pdlistgroup

69Command Line Interfacepddeletegroup

pddeletejobpddeletejob – Raises an error and deletes the job if the job is finished (success,error, success_with_error, aborted by user, aborted by watchdog). If the job is ina running, queued, or running_hold state, the command attempts to stop the job,but does not delete the job.

SYNOPSISpddeletejob --id=number

DESCRIPTIONThis command raises an error and tries to kill the job if the job is in a running,queued, or running_hold state. But it does not delete the job. If the job is executed(success, error, success_with_error, aborted by user, aborted by watchdog) thenthe command deletes the job.

PARAMETERSid - The ID of the job that you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeletejob --id=20

Deleted the job.

SEE ALSOpdgetjob

pdgetjobstat

pdlistjob

Command Line Interfacepddeletejob

70

pddeletelicensepddeletelicense – Deletes a license key.

SYNOPSISpddeletelicense --key=string

DESCRIPTIONThis command deletes a license key.

PARAMETERSkey - The alphanumeric license key you want to delete.

RETURN VALUESThis command has no return value unless the command is entered incorrectly.

/opt/pdcli/calls # ./pddeletelicense

--key=OEXP-R3DR-VC86-POZ2-866P-PPPN-3PRR-PP8C-PPP8-P

/opt/pdcli/calls #

SEE ALSOpdgetlicense

pdlistlicense

pdsetlicense

pdstatlicensing

71Command Line Interfacepddeletelicense

pddeletelocationpddeletelocation – Deletes a location from the storage pool authority (SPA).

SYNOPSISpddeletelocation --id=number

DESCRIPTIONThis command deletes a location from the storage pool authority (SPA).

PARAMETERSid - The ID for the location you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeletelocation --id=2

Deleted the location.


pdgetlocation

pdlistlocation

pdsetlocation

Command Line Interfacepddeletelocation

72

pddeletepolicypddeletepolicy – Deletes a policy.

SYNOPSISpddeletepolicy --id=number

DESCRIPTIONThis command deletes a policy.

PARAMETERSid - The ID for the policy you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeletepolicy --id=103

Deleted the policy.

SEE ALSOpdcreatepolicy

pdgetpolicy

pdlistpolicy

pdsetpolicy

73Command Line Interfacepddeletepolicy

pddeletepolicyescalationpddeletepolicyescalation –Deletes a policy escalation that is linked to a policy.

SYNOPSISpddeletepolicyescalation --policyid=number --escalationactionid=number

DESCRIPTIONThis command deletes a policy escalation that is linked to a policy

PARAMETERSpolicyid - The policy identifier.


RETURN VALUES/opt/pdcli/calls # ./pddeletepolicyescalation --policyid=10

--escalationactionid=2

Unlinked the policy escalation.

SEE ALSOpdcreatepolicyescalation



pdsetpolicyescalation

Command Line Interfacepddeletepolicyescalation

74

pddeletepolicyescalationactionpddeletepolicyescalationaction – Deletes a policy escalation action.

SYNOPSISpddeletepolicyescalationaction --id=number

DESCRIPTIONThis command deletes a policy escalation action.

PARAMETERSid - The ID of the policy escalation action that you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeletepolicyescalationaction --id=1

Deleted the action.

SEE ALSOpdcreatepolicyescalationaction




75Command Line Interfacepddeletepolicyescalationaction

pddeleteuserpddeleteuser – Deletes a user from the storage pool authority.

SYNOPSISpddeleteuser --name=string

DESCRIPTIONThis command deletes a user from the storage pool authority.

PARAMETERS

Note: If the text for the name parameter include spaces, the text needs to beenclosed in quotationmarks. Precede special symbols in argumentswith an escapecharacter. In the bash shell, use the single quotation mark (') to accomplish that.

name - The name of the user you want to delete.

RETURN VALUES/opt/pdcli/calls # ./pddeleteuser --name='"John Smith"'

Deleted the user.

SEE ALSOpdcreateuser

pdgetuser

pdlistuser

pdlogonuser

pdsetuser

Command Line Interfacepddeleteuser

76

pdexitpdexit – Removes any locally saved credentials.

SYNOPSISpdexit

DESCRIPTIONThis command removes any locally saved credentials.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdexit

Cached user data cleared.

SEE ALSOpdlogonuser

77Command Line Interfacepdexit

pdexport2nbupdexport2nbu – Exports a data selection to a NetBackup file list for use with aNetBackup policy.

SYNOPSISpdexport2nbu --id=number --nbugatewayid=string --nbupolicyname=string

--pointintime=string

DESCRIPTIONThis command exports a data selection to a NetBackup file list for use with aNetBackup policy.

PARAMETERSdsid - The ID for the data selection that you want to export to NetBackup.

nbugatewayid - The NetBackup gateway identifier.

To retrieve the NetBackup gateway information

1 Log into the PureDisk administrative Web UI.

2 Select the Settings > Topology tab.

3 In the left pane, expand tree view and click the NBU Export Engine node.

4 The right pane, under Properties:NBUExportEngine, use the AgentOwnervalue for the nbugatewayid argument.

nbupolicyname - The policy name in NetBackup configured to receive the dataselection information.

pointintime - Seconds since epoch to indicate the point in time. The secondssince epoch time for a point in time of 10:00 P.M. on January 25, 2009 is1232920800.

RETURN VALUESThis command has no return value unless the command is entered incorrectly.

SEE ALSON/A

Command Line Interfacepdexport2nbu

78

pdfindfilespdfindfiles – Used to find the files that have been backed up.

SYNOPSISpdfindfiles --dsfind=string --mbfindfile=string [--restorepwd=string]

[--offset=string]

DESCRIPTIONThis command is used to find the files that have been backed up.







mbfindfile - - The file name of the file containing the metadata filters used tofind files. The file this parameter specifies contains one or more filters that helpdetermine what file or files are selected. The filters consist of an mbfind field andits associated value. An example of an mbfile file is located in/opt/pdcli/defaultMBFind.dat.



■ dirname: The directory location of the object. That is specified as an absolutepath



79Command Line Interfacepdfindfiles








offset - The number of records to skip in the find file process. To avoid displayingtoomany records, the number of records that is shown is limited to the first 1024.Toview records beyond the first 1024, the offset parameter is used.Offset indicatesto skip the number of records indicated, and show the records after the value.

restorepwd - The data lock password that is used for the restore.

RETURN VALUES/opt/pdcli/calls # ./pdfindfiles

--dsfind=dataselection=2 --mbfindfile=/opt/pdcli/defaultMBFind.dat

The following pos have been found:

filename(content fingerprint) : backup time

-------------------------------------------

/etc/.pwd.lock ( f1450306517624a57eafbbf81266a67a ) :

1242740349

/etc/DIR_COLORS ( 190dd434ca07ae373bd9a7c1f3f3d9c0 ) :

1242740349

Command Line Interfacepdfindfiles

80

SEE ALSON/A

81Command Line Interfacepdfindfiles

pdgetagentpdgetagent – Provides additional information about the agent object specified.

SYNOPSISpdgetagent --id=number

DESCRIPTIONThis command provides additional information about the agent object specified.

PARAMETERSid - The ID for the agent.

RETURN VALUES/opt/pdcli/calls # ./pdgetagent --id=2

The agent has the following properties:

_______________________________________

The agent identifier is 2.

The host name is linux and runs on the following

IP/FQDN: 10.31.82.160.

Mac address: 0050561C2103.

This agent is running against version 6.6.64.2084.

The associated metabase engine runs on 10.31.82.144.

The associated controller runs on 10.31.82.144.

The OS extension(Windows machines only) is '' and the

OS identifier is 20.


pddeactivateagent

pddeleteagent

pdlistagent

pdsetagent

Command Line Interfacepdgetagent

82

pdgetdepartmentpdgetdepartment – Provides additional information about the departmentspecified.

SYNOPSISpdgetdepartment --id=number

DESCRIPTIONThis command provides additional information about the department objectspecified.

PARAMETERSid - The ID number for the department.

RETURN VALUES/opt/pdcli/calls # ./pdgetdepartment --id=2

This department has the following properties:

_____________________________________________


The name is Support.

The description is .


pddeletedepartment

pdlistdepartment

pdsetdepartment

83Command Line Interfacepdgetdepartment

pdgetdspdgetds – Provides additional information about the data selection specified.

SYNOPSISpdgetds --id=number

DESCRIPTIONThis command provides additional information about the data selection objectspecified.

PARAMETERSid - The ID number for the data selection

RETURN VALUES/opt/pdcli/calls # ./pdgetds --id=2

This DataSelection has the following properties:

______________________________________________________

The identifier is 2. The name is etc.





file pattern: *.


SEE ALSOpdcreateds

pddeleteds

pdlistds

pdsetds

Command Line Interfacepdgetds

84

pdgetdstemplatepdgetdstemplate – Provides information about the data selection templatespecified.

SYNOPSISpdgetdstemplate --id=number

DESCRIPTIONThis command provides information about the data selection template specified.

PARAMETERSid - The ID of the data selection template.

RETURN VALUES/opt/pdcli/calls # ./pdgetdstemplate --id=1

The data selection template has the following properties:

________________________________________________________

The identifier is 1. The name is "My Documents" Folders.




file pattern: *.

directory pattern: /*/My Documents/*.


pddeletedstemplate

pdlistdstemplate

pdsetdstemplate

85Command Line Interfacepdgetdstemplate

pdgeteventescalationpdgeteventescalation – Provides information about the event escalationspecified.

SYNOPSISpdgeteventescalation --id=number --escalationtype=number

DESCRIPTIONThis command provides information about the event escalation specified.

PARAMETERSid - The ID number of the event escalation.

escalationtype - Specifies if the event escalation is an agent (1) or storage poolescalation (0).

RETURN VALUES/opt/pdcli/calls # ./pdgeteventescalation --id=1

--escalationtype=0

This event escalation has the following properties:

The identier is: 1.

This escalation binds the action with id 1.

It will send an event for a minimal severity of level 1 and a

maximum severity of 4.


pddeleteeventescalation

pdlisteventescalation


Command Line Interfacepdgeteventescalation

86

pdgeteventescalationactionpdgeteventescalationaction–Provides informationabout the event escalationaction specified.

SYNOPSISpdgeteventescalationaction --id=number

DESCRIPTIONThis command provides information about the event escalation action specified.

PARAMETERSid - The ID of the event escalation action.

RETURN VALUES/opt/pdcli/calls # ./pdgeteventescalationaction --id=3

The event escalation action has the following properties:

_________________________________________________________

community = root.

creationDate = 1222684912.

description = my snmp action.

id = 3.

managerAddress = www.qe.

modDate = 1222684912.





pdseteventescalationaction

87Command Line Interfacepdgeteventescalationaction

pdgetgrouppdgetgroup – Provides additional information about the group specified.

SYNOPSISpdgetgroup --name=string

DESCRIPTIONThis command provides additional information about the group specified.

PARAMETERSname - The ID number of the group.

RETURN VALUES/opt/pdcli/calls # ./pdgetgroup --name=Backup_Admin

This group has the following properties:

________________________________________

Name(identifier): Backup_Admin (86425a4a-d97c-102d-93f7-d93d3c16bc52).


pddeletegroup

pdlistgroup

pdsetgroup

Command Line Interfacepdgetgroup

88

pdgetjobpdgetjob – Provides additional information about the job specified.

SYNOPSISpdgetjob --id=number

DESCRIPTIONThis command provides additional information about the job specified.

PARAMETERSid - The ID of the job.

RETURN VALUES/opt/pdcli/calls # ./pdgetjob --id=2


____________________________________________________________


It has run for the workflow: Maintenance.





The current progress is: 100 %.

The job is scheduled to start on: May 19, 2009.

The actual creation date for this job is: May 19, 2009.

The finish date for this job is: May 19, 2009.


deleteEvents = 1.

deleteJobs = 1.

deletetmpfiles = 1.

tmpDirAge = 7.

tmpEventAge = 14.

tmpJobAge = 14.

vacuumDB = 1.

89Command Line Interfacepdgetjob

SEE ALSOpddeletejob

pdgetjobstat

pdlistjob

Command Line Interfacepdgetjob

90

pdgetjobstatpdgetjobstat – Retrieves the job statistics from the PureDisk database.

SYNOPSISpdgetjobstat --id=number

DESCRIPTIONThis command retrieves the job statistics from the PureDisk database.

PARAMETERSid - (Required) The identifier of the job for which you want to display statistics.

RETURN VALUES/opt/pdcli/calls # ./pdgetjobstat --id=51

The job has the following statistics:

_____________________________________

statistics_po_import_duration = 16.

statistics_average_transfer_rate = 68861168.944409.

statistics_bytes_deleted_on_source = 0.

statistics_bytes_modified_on_source = 0.

statistics_bytes_new_on_source = 30923025.

statistics_bytes_not_modified_on_source = 0.

statistics_bytes_selected_on_source = 30923025.

statistics_bytes_transferred = 30957778.

statistics_files_deleted_on_source = 0.

statistics_files_modified_on_source = 0.

statistics_files_new_on_source = 2524.

statistics_files_not_modified_on_source = 0.

statistics_files_selected_on_source = 2524.

statistics_global_sis_factor = 0.99887740651154.

statistics_global_sis_savings = -0.1123855120901.

statistics_po_deleted = 0.

statistics_po_modified = 0.

statistics_po_new = 2524.

statistics_source_bytes_backed_up = 30923025.

statistics_source_bytes_with_error = 0.

statistics_source_files_backed_up = 2524.

91Command Line Interfacepdgetjobstat

statistics_source_files_with_error = 0.

statistics_unique_bytes_backed_up = 30825914.

statistics_unique_files_backed_up = 2310.

OTHERPlease note that statistics are only available for the following job types:

- Jobs that have finished running.

- Backup jobs that have successfully run the job statistics step.

- Jobs that generate statistics. Some jobs, such as database maintenance jobs, donot have statistics. See thePureDiskAdministrator'sGuide for information aboutjob statistics and how to interpret them.

SEE ALSOpddeletejob

pdgetjob

pdlistjob

Command Line Interfacepdgetjobstat

92

pdgetjobstepspdgetjobsteps – Used to list the steps that are associated with the specified job.

SYNOPSISpdgetjobsteps --id=number

DESCRIPTIONThe command is used to list all steps that are associated with any job.

PARAMETERSid - The job identifier for the job being reviewed.

RETURN VALUESpdgetjobsteps --id=1

The job has the following jobsteps:

_______________________________________

agentId = 1000000.

jobId = 1.

log =

[2009-Mar-28 00:00:04 CET] *** Start: CRProcessQueue ***

[2009-Mar-28 00:00:04 CET]Start CR Queue Processing

[2009-Mar-28 00:00:04 CET] command: /opt/pdcr/bin/crcontrol --processqueue

[2009-Mar-28 00:00:05 CET]OK

[2009-Mar-28 00:00:05 CET]Waiting till Queue Processing is finished

Queue successfully processed at March 28 00:00:07

[2009-Mar-28 00:05:06 CET] *** Stop: CRProcessQueue ***

*** Supportability Summary ***

jobid = 1

jobstepid = 1

agentid = 1000000

hostname = 10.31.82.144

93Command Line Interfacepdgetjobsteps

starttimejobstep = March 28, 2009, 12:00 am

endtimejobstep = March 28, 2009, 12:05 am

workflowstepname = Process Queue

status = SUCCESS

workflowStepId = 32500.

workflowStepName = Process Queue.

_______________________________________

agentId = 1000000.

jobId = 1.

log = Execute WFAction: Mark Exit

Execute WFAction: Mark Success

Execute WFAction: Exit

Job exited with 0 errors, 0 warnings, 2 successes

*** Supportability Summary ***

jobid = 1

jobstepid = 2

agentid = 1000000

hostname = 10.31.82.144

starttimejobstep = March 28, 2009, 12:05 am

endtimejobstep = March 28, 2009, 12:05 am

workflowstepname = MarkExit

status = SUCCESS

workflowStepId = 32501.

workflowStepName = Exit Job.

SEE ALSOpddeletejob

pdgetjob

pdgetjobstat

pdlistjob

Command Line Interfacepdgetjobsteps

94

pdgetlicensepdgetlicense – Collects information about the specified license key.

SYNOPSISpdgetlicense --key=string

DESCRIPTIONThis command collects information about the specified license key.

PARAMETERSkey - The alphanumeric value for the key you want to review.

RETURN VALUES/opt/pdcli/calls # ./pdgetlicense

--key=OENC-CRKI-ZVDL-6NCZ-PRXX-OG94-9G77-4GOP-PN2P

The license has the following properties:

_______________________________________

expireTime = 1230678000.

key = OENC-CRKI-ZVDL-6NCZ-PRXX-OG94-9G77-4GOP-PN2P.

keyDescriptors =

storagePoolVersion = 6.5.

timeRestrictionType = 103.

SEE ALSOpddeletelicense

pdlistlicense

pdsetlicense

pdstatlicensing

95Command Line Interfacepdgetlicense

pdgetlocationpdgetlocation – Provides additional information about the location specified.

SYNOPSISpdgetlocation --id=number

DESCRIPTIONThis command provides additional information about the location specified.

PARAMETERSid - The ID for the location you want to review.

RETURN VALUES/opt/pdcli/calls # ./pdgetlocation --id=1

This location has the following properties:

Name(identifier): Default location (1).

Description: 'Location for storagepool 1'.


pddeletelocation

pdlistlocation

pdsetlocation

Command Line Interfacepdgetlocation

96

pdgetpolicypdgetpolicy – Provides additional information about the policy specified.

SYNOPSISpdgetpolicy --id=number

DESCRIPTIONThis command provides additional information about the policy specified.

PARAMETERSid - The ID for the policy you want to review.

RETURN VALUES/opt/pdcli/calls # ./pdgetpolicy --id=105

This policy has the following properties:

_________________________________________


The policy name: Default policy for Server DB Maintenance.





vacuumCA = 1.

vacuumMB = 1.

vacuumCRDB = 1.


pdlistpolicy

97Command Line Interfacepdgetpolicy

pdgetpolicyescalationpdgetpolicyescalation – Provides information about the policy escalation.

SYNOPSISpdgetpolicyescalation --id=number

DESCRIPTIONEvery policy can have a policy escalation attached to it. This command providesinformation about the escalation.

PARAMETERSid - The ID for the policy escalation you want to review.

RETURN VALUES/opt/pdcli/calls # ./pdgetpolicyescalation --id=1

This policy escalation has the following properties:

____________________________________________________


The escalation binds the policy escalation action with id 1

to a policy with id: 105.


pddeletepolicyescalation



Command Line Interfacepdgetpolicyescalation

98

pdgetpolicyescalationactionpdgetpolicyescalationaction–Provides informationabout thepolicy escalationaction.

SYNOPSISpdgetpolicyescalationaction --id=number

DESCRIPTIONThis command provides information about the policy escalation action.

PARAMETERSid - The ID for the policy escalation action you want to review.

RETURN VALUES/opt/pdcli/calls # ./pdgetpolicyescalationaction --id=1

This policy escalation action has the following properties:

___________________________________________________________



If a policy reaches the error escalation timeout an email message is

sent to [email protected].

When it reaches the warning escalation timeout an email message is



pddeletepolicyescalationaction

pslistpolicyescalationaction


99Command Line Interfacepdgetpolicyescalationaction

pdgetstoragepoolpdgetstoragepool – Provides information about the storage pool.

SYNOPSISpdgetstoragepool

DESCRIPTIONThis command provides information about the storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdgetstoragepool

The storagepool has the following properties:

_____________________________________________

The storage pool identifier: 1.

The storage pool description: Development.

The storage pool name: default.

The storage pool version: darrieus-bugfix(6.0.0.0).

SEE ALSOpdsetstoragepool

Command Line Interfacepdgetstoragepool

100

pdgetuserpdgetuser – Provides information about the user specified.

SYNOPSISpdgetuser --name=string

DESCRIPTIONThis command provides information about the specified user.

PARAMETERS

Note: If the text for the name parameter includes spaces, the text needs to beenclosed in quotationmarks. Precede special symbols in argumentswith an escapecharacter. In the bash shell, use the single quotation mark (') to accomplish that.

name - The name of the user you want to review.

RETURN VALUES/opt/pdcli/calls # ./pdgetuser --name='"John Smith"'

This user has the following properties:

Identifier: bd31bd06-d97d-102d-93f9-d93d3c16bc52.

Login: jsmith.

Name: John Smith.

Telephone: .

Mobile: .

Email: .

Department identifier: 2.

Location identifier: 2.


pddeleteuser

pdlistuser

101Command Line Interfacepdgetuser

pdlogonuser

pdsetuser

Command Line Interfacepdgetuser

102

pdlistagentpdlistagent – Displays all agents that are associated with a particular PureDiskstorage pool.

SYNOPSISpdlistagent

DESCRIPTIONThis command displays all agents that are associated with a particular PureDiskstorage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistagent

The following agents have been found:

hostname (id):

--------------

- 10.31.82.144 (1000000)

- linux (2)

- Virtual CA Agent ()


pddeactivateagent

pddeleteagent

pdgetagent

pdsetagent

103Command Line Interfacepdlistagent

pdlistdepartmentpdlistdepartment –Displays all departments that are associatedwith aparticularPureDisk storage pool.

SYNOPSISpdlistdepartment

DESCRIPTIONThis command displays all departments that are associated with a particularPureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistdepartment

The following departments have been found:

name (id):

--------------

- Testing (3)

- Support (2)

- Default department (1)

- Unknown department ()


pddeletedepartment

pdgetdepartment

pdsetdepartment

Command Line Interfacepdlistdepartment

104

pdlistdspdlistds – Displays all data selections that are associated with a particularPureDisk storage pool.

SYNOPSISpdlistds

DESCRIPTIONThis command displays all data selections that are associated with a particularPureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistds

The following data selections have been found:

name (id):

--------------

- dstbased (4)

- nam (3)

- etc (2)

- System DS for STP 1 (1)

SEE ALSOpdcreateds

pddeleteds

pdgetds

pdsetds

105Command Line Interfacepdlistds

pdlistdstemplatepdlistdstemplate –Displays all the data selection templates that are associatedwith a particular PureDisk storage pool.

SYNOPSISpdlistdstemplate

DESCRIPTIONThis command displays a listing of all the data selection templates that areassociated with a particular PureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistdstemplate

The following data selection templates have been found:

name (id):

--------------

- nam (5)

- Linux full system (4)

- Outlook .pst and .ost files (3)

- "My Documents" Folders (1)


pddeletedstemplate

pdgetdstemplate

pdsetdstemplate

Command Line Interfacepdlistdstemplate

106

pdlisteventpdlistevent – Displays all events that are associated with a particular PureDiskstorage pool.

SYNOPSISpdlistevent

DESCRIPTIONThis command displays all events that are associated with a particular PureDiskstorage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistevent

The following events have been found:

description (id):

---------------------

- Startup of the Symantec PureDisk Content Router, Version

6.0.0.0, completed successfully at Mon Sep 29 19:30:25 2008 (16)

SEE ALSON/A

107Command Line Interfacepdlistevent

pdlisteventescalationpdlisteventescalation – Displays all the event escalations that are associatedwith a particular PureDisk storage pool.

SYNOPSISpdlisteventescalation

DESCRIPTIONThis command displays a list of all event escalations that are associated with aparticular PureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlisteventescalation

The following escalations have been found:

The escalations have the following properties:

______________________________________________

agentId = 3.


escalationActionId = 3.

id = 4.

maxSeverityLevel = 4.

minSeverityLevel = 1.

modDate = 1222689236.





Command Line Interfacepdlisteventescalation

108

pdlisteventescalationactionpdlisteventescalationaction –Displays a list of all the event escalation actionsthat are associated with a particular PureDisk storage pool.

SYNOPSISpdlisteventescalationaction

DESCRIPTIONThis commanddisplays a list of all the event escalation actions that are associatedwith a particular PureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlisteventescalationaction

The following actions have been found:

name (id):

--------------

- SNMP action (2)

- A problem occurred on slowpoke (1)





109Command Line Interfacepdlisteventescalationaction

pdlistgrouppdlistgroup – Displays all the user groups that are associated with a particularPureDisk storage pool.

SYNOPSISpdlistgroup

DESCRIPTIONThis command displays all the user groups that are associated with a particularPureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistgroup

The following groups have been found:

name (id):

--------------

- administrators (903f46e0-d8ad-102d-9f15-970bd5801bd4)

- users (9040a940-d8ad-102d-9f16-970bd5801bd4)

- reporters (9041f976-d8ad-102d-9f17-970bd5801bd4)

- Backup_Admin (86425a4a-d97c-102d-93f7-d93d3c16bc52)


pddeletegroup

pdgetgroup

pdsetgroup

Command Line Interfacepdlistgroup

110

pdlistjobpdlistjob –Displays all jobs that are associatedwith aparticular PureDisk storagepool.

SYNOPSISpdlistjob

DESCRIPTIONThis command displays all jobs that are associated with a particular PureDiskstorage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistjob

The following jobs have been found:

id - progress - status - agent - workflow.

7 - 0 % - Scheduled - linux - Files and Folders Backup.

6 - 100 % - Success - 10.31.82.144 - CR Queue Processing.

5 - 100 % - Success - 10.31.82.144 - Server DB Maintenance.

4 - 100 % - Success - 10.31.82.144 - CR Queue Processing.

3 - 100 % - Success - 10.31.82.144 - Maintenance.

2 - 100 % - Success - linux - Maintenance.

1 - 100 % - Success - linux - Files and Folders Backup.

SEE ALSOpddeletejob

pdgetjob

pdgetjobstat

111Command Line Interfacepdlistjob

pdlistlicensepdlistlicense – Displays all the installed license keys that are associated witha particular PureDisk storage pool.

SYNOPSISpdlistlicense

DESCRIPTIONThis command displays all the installed license keys that are associated with aparticular PureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistlicense

The following license(s) have been found:

The license has the following properties:

_______________________________________

expireTime = 1230678000.

key = OENC-CRKI-ZVDL-6NCZ-PRXX-OG94-9G77-4GOP-PN2P.

keyDescriptors =


timeRestrictionType = 103.


pdgetlicense

pdsetlicense

pdstatlicensing

Command Line Interfacepdlistlicense

112

pdlistlocationpdlistlocation – Displays all the locations that are associated with a particularPureDisk storage pool.

SYNOPSISpdlistlocation

DESCRIPTIONThis command displays all the locations that are associated with a particularPureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistlocation

The following locations have been found:

name (id):

--------------

- Belgium (2)

- Default location (1)

- Unknown location ()

Note: The location "Unknown" is created with the storage pool authority isinstalled. If a location is not specified when an agent is installed, PureDisk placesthe new agent in the "Unknown" location. Once all agents are moved out of the"Unknown" location, it should no longer appear in the administrative Web UI.


pddeletelocation

pdgetlocation

pdsetlocation

113Command Line Interfacepdlistlocation

pdlistpolicypdlistpolicy – Displays all the policies that are associated with a particularPureDisk storage pool.

SYNOPSISpdlistpolicy

DESCRIPTIONThis command displays all the policies that are associated with a particularPureDisk storage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistpolicy

The following policies have been found:

name (id):

--------------

- replication to slowpoke (112)

- mbgc (111)

- Data removal of entire storagepool (110)



- Backup of entire storagepool (107)

- Default policy for Server DB Maintenance (105)

- Example policy: All ds based on the Full linux template (104)

- Example policy: All ds based on the Outlook files template (103)

- Default policy for MB Garbage Collection (101)

- System policy for CR Queue Processing (16)

- System policy for PDDO data removal (15)

- System policy for Syncing external LDAP users (14)

- System policy for incremental DR Backup (12)

- System policy for Data Selection Removal (11)

- System policy for Data Mining (10)

- System policy for CR Garbage Collection (9)

Command Line Interfacepdlistpolicy

114

- System policy for Maintenance (8)

- System policy for full DR Backup (7)

- System policy for Rerouting (5)

SEE ALSOpdgetpolicy

115Command Line Interfacepdlistpolicy

pdlistpolicyescalationpdlistpolicyescalation – Displays the policy escalations that are attached toall policies.

SYNOPSISpdlistpolicyescalation

DESCRIPTIONThis command displays the policy escalations that are attached to all policies.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistpolicyescalation

The following escalations have been found:

id - action id - policy id.

1 - 1 - 105


pddeletepolicyescalation



Command Line Interfacepdlistpolicyescalation

116

pdlistpolicyescalationactionpdlistpolicyescalationaction – Displays all the actions that are attached toall policies.

SYNOPSISpdlistpolicyescalationaction

DESCRIPTIONThis command displays all the actions that are attached to all policies.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistpolicyescalationaction

The following policy escalation actions have been found:

id - description - email

1 - Escalation to Emy - [email protected]





117Command Line Interfacepdlistpolicyescalationaction

pdlistuserpdlistuser –Displays all the users that are associatedwith a particular PureDiskstorage pool.

SYNOPSISpdlistuser

DESCRIPTIONThis commanddisplays all the users that are associatedwith a particular PureDiskstorage pool.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlistuser

The following users have been found:

name (id):

--------------

- root (90372172-d8ad-102d-9f12-970bd5801bd4)

- John Smith (bd31bd06-d97d-102d-93f9-d93d3c16bc52)


pddeleteuser

pdgetuser

pdlogonuser

pdsetuser

Command Line Interfacepdlistuser

118

pdlogonuserpdlogonuser – Saves the credentials locally to avoid interaction during calls.

SYNOPSISpdlogonuser

DESCRIPTIONThis command saves the credentials locally to avoid interaction during calls.

You can use the pdlogonuser command in scripting activities. Use pdlogonuserto eliminate prompts for user name and password before each command that isexecuted in a script.

PARAMETERSN/A

RETURN VALUES/opt/pdcli/calls # ./pdlogonuser

Please insert the login credentials:

username: root

password:

/opt/pdcli/calls #


pddeleteuser

pdexit

pdgetuser

pdlistuser

pdsetuser

119Command Line Interfacepdlogonuser

pdpasswdpdpasswd – Used to set or change a user password.

SYNOPSISpdpasswd --name=string [--oldpwd=string] [--newpwd=string]

DESCRIPTIONThis command sets the password for a user. Used to change a user's password.

PARAMETERS

Note: The text of the parameter needs to be enclosed in quotation marks if itincludes spaces. Precede special symbols in arguments with an escape character.In the bash shell, use the single quotation mark (') to accomplish that.

name - (Required) User name.

oldpwd - The current password for the user.

newpwd - The new password for the user.

RETURN VALUESExample 1

/opt/pdcli/calls # ./pdpasswd --name='"John Smith"'

Old password: default

New password: password

New password(verification): password

Password changed successfully.

Example 2

/opt/pdcli/calls # ./pdpasswd --name='"John Smith"'

--newpwd=pass --oldpwd=pwd

Password changed successfully.

Command Line Interfacepdpasswd

120


pdsetuser

121Command Line Interfacepdpasswd

pdrestorepdrestore – Start a restore job from the specified parameters.

SYNOPSISpdrestore --agentid=number [--destination=string]

[--destinationagent=number] [--dsid=number] [--maxstreams=number]

[--mbfindfile=string] [--overwrite_junction_symlink=number]

[--restore_overwrite=number] [--restorecommonroot=number]

[--restorepwd=string]

DESCRIPTIONThis command starts a restore job from the specified parameters.

PARAMETERSagentid - (Required) Agent identifier.

destination - The destination directory for the files being restored. The defaultis the original location.

destinationagent - The agent to receive the restored files. By default, it is theagent that backedup the files. Use the pdlistagent command to for a list of agentidentifiers for this parameter.

dsid - The data selection identifier.

maxstreams - The number of streams used during the restore operation.

mbfindfile - The file name of the file containing the metadata filters used withrestores. If this parameter is not specified, PureDisk defaults to a toregistertimeof the current time, and selects all directories and files.

The file this parameter specifies contains one ormore filters that help determinewhat file or files are selected. The filters consist of an mbfind field and itsassociated value. An example of an mbfile file is located in/opt/pdcli/defaultMBFind.dat.

Supported mbfind fields are as follows:




Command Line Interfacepdrestore

122









restorepwd - The data lock password that is used for the restore.

overwrite_junction_symlink - This allows the restore to overwrite symboliclinks with the same name during restore operations. Specifying 0 enables theoverwrite (default) and 1 prevents the link from being overwritten.

restore_overwrite - This causes the restore to overwrite an existing file withthe same name during restore operations. Acceptable values are:

■ 0 - Overwrite (default value)

■ 1 - Use alternate name

■ 2 - Do not overwrite

restorecommonroot - Restores the shared directory structure. Specifying 0indicates the restore should not restore the shared directory structure. Specifying1 indicates the restore should restore the shared directory structure (default).

RETURN VALUES/opt/pdcli/calls # ./pdrestore --agentid=2

--mbfindfile=/opt/pdcli/defaultMBFind.dat

123Command Line Interfacepdrestore


____________________________________________________________


It has run for the workflow: Files and Folders Restore.






pdrunpolicy --policyid=105

1 Job(s) started.

SEE ALSOpdbackup

Command Line Interfacepdrestore

124

pdrunpolicypdrunpolicy – Runs the specified policy.

SYNOPSISpdrunpolicy --id=number

DESCRIPTIONThis command runs the specified policy.

PARAMETERSid (Required) - The policy identifier

RETURN VALUES/opt/pdcli/calls # ./pdrunpolicy --id=102

1 Job(s) started.


pdgetpolicy

pdlistpolicy

pdsetpolicy

125Command Line Interfacepdrunpolicy

pdsetagentpdsetagent –Changes andupdates the details that are associatedwith an existingagent.

SYNOPSISpdsetagent --id=number [--hostname=string] [--locationid=number]

[--departmentid=number] [--description=string]

DESCRIPTIONThis commandchanges andupdates thedetails that are associatedwith an existingagent.

PARAMETERSid - The ID number for the agent.

hostname - The hostname of an agent (the display name in the GUI).

locationid - Location identifier.

departmentid - Department identifier.


RETURN VALUES/opt/pdcli/calls # ./pdsetagent --id=2

The updated agent has the following properties:

_______________________________________________

The agent identifier is 2.

The host name is linux and runs on the following

IP/FQDN: 10.31.82.160.

Mac address: 0050561C2103.

This agent is running against version 6.6.64.2084.

The associated meta base engine runs on 10.31.82.144.

The associated controller runs on 10.31.82.144.

The OS extension(Windows machines only) is '0' and

the OS identifier is 20.

Command Line Interfacepdsetagent

126


pddeactivateagent

pddeleteagent

pdgetagent

pdlistagent

127Command Line Interfacepdsetagent

pdsetbackuppolicypdsetbackuppolicy – Change the parameters of an existing backup policy.

SYNOPSISpdsetbackuppolicy --id=number [--backupacl=number]

[--bandwidth=number] [--changeaccesstime=0¦1] [--changedetection=0¦1]

[--compress=number] [--dsfind=string] [--enabled=0¦1]

[--encrypt=number] [--endtime=number] [--endupload=number]

[--errorescalationperiod=number] [--includenetworkshares=0¦1]

[--leavearchivebit=number] [--name=string] [--nrbackupstreams=number]

[--postscript=string] [--prescript=string] [--retryverify=0¦1]

[--runpostonerr=number] [--schedule=string] [--segmentsize=number]

[--sort=string] [--starttime=number] [--usesnapshot=number]

[--verifylevel=number] [--warningescalationperiod=number]

DESCRIPTIONThis command changes the parameters of an existing backup policy.

PARAMETERSbackupacl - Allows the user to choose to back up the access control listinformation. If backupacl is set to "0", the ACL is not backed up. If backupacl isset to "1", the list is backed up. The default value is 0.

bandwidth - The amount of bandwidth that is allocated to the policy, expressedin kilobytes per second (kb/sec). This option limits the bandwidth the policy uses.


changedetection - This parameter instructs PureDisk to verify if the file waschanged betweenwhen the file systemwas initially scanned for newandmodifiedfiles and when PureDisk began writing the backup. Acceptable values are 0 (zero)- do not detect changes or 1 (one) - detect changes. The default value is 0.

compress - Enables compression on the policy. Acceptable values are 0 (zero) - donot compress or 1 (one) - compress. The default value is 0.

dsfind - A data selection filter that is used in all data selection-related policies.That determines which data selections a certain policy uses. The syntax for the

Command Line Interfacepdsetbackuppolicy

128

dsfind parameter is <identifier>=<value>. Separate multiple identifiers witha comma. Supported dsfind values are as follows:









endupload - The end of the time frame in which data can be sent from the clientto the server. This value is specified in hours according to a 24-hour clock. Forexample, 2:00 A.M. is 2, and 3:00 P.M. is 15. The differences between endtime andendupload are the point in the backup where operations are stopped and whatoperations are stopped. The three major steps in a backup are: scanning for files,uploading data to the content router, and storing the metadata in the metabase.The endupload time is when the upload from the client to the content router isstopped. The backup may still be running, as it is possible metadata is still beingwritten to the metabase. The endtime is when the entire backup operation ishalted.


id The ID for a backup policy.

includenetworkshares - This option instructs PureDisk to include or excludenetwork shares in a backup. Acceptable values are 0 (zero - do not include networkshares) and 1 (one - include network shares). The default value is 0.

129Command Line Interfacepdsetbackuppolicy

leavearchivebit - When enabled, this parameter instructs PureDisk to leavearchive bit untouched during backup. The values for this parameter are zero (0,disabled) and one (1, enabled). The default value is 0.

name - The name of the backup policy.

nrbackupstreams - The number of streams to use for backup. By default, the valuefor that is 1.

postscript - The user-defined script that PureDisk should run at the end of apolicy.

prescript - The user-defined script that PureDisk should run at the start of apolicy.

retryverify - When enabled, this option instructs PureDisk to retry the backupif it fails. Acceptable values are 0 (zero), disabled, and 1 (one), enabled. The defaultvalue is 0.

runpostonerr -When this option is set and the job fails, the script that is definedin the postscript parameter is run at the end of the policy. The values for thisparameter are 0 (do not run the script) and 1 (run the script). The default valueis 0.




■ For weekly, the time period is hour:minute:period. The hour and minute arethe hour and minute when the policy should run. The period is a bitmap thatindicates the days of the week when the policy should run. The bitmap is astring of seven zeros or ones. The first character indicates the first day of theweek (Monday). The second character indicates the second day of the week(Tuesday), and so on. If the character is 1, thatmeans that the schedule shouldrun that day. If it is a 0 the schedule does not run. For example: 1000000means


130

that the schedule should run only on Monday. 1010101means the policy runson Monday, Wednesday, Friday, and Sunday.




sort - The sorting algorithm that is used to determine what should be backed upfirst. Acceptable parameters are "" (or empty), do not sort, size, sort by size, anddirname,size, sort by directorywith the smallest files first. By default the backupis not sorted.


usesnapshot - When enabled, this option instructs PureDisk to use snapshottechnology (such as VSS or VSP) to back up the data. Acceptable values are 0(zero), disabled, and 1 (one), enabled. The default value is 0.

verifylevel - Specifies what verification level is used during backup. Acceptablevalues are 1 (no verification), 2 (confirm the file exists on the content router), 3(check the validity of the file contents), and 4(simulate retrieve and re-fingerprint).


131Command Line Interfacepdsetbackuppolicy

RETURN VALUES/opt/pdcli/calls # ./pdsetbackuppolicy --id=107

The updated backup policy has the following properties:

_______________________________________________________


The policy name: Backup of entire storagepool.





usesvss = 1.

compression = 1.

SEE ALSOpdcreatebackuppolicy

pdsetbackuppolicy


132

pdsetcrgarbagecollectionpolicypdsetcrgarbagecollectionpolicy–Change theparameters of the content routergarbage collection policy.

SYNOPSISpdsetcrgarbagecollectionpolicy [--enabled=0¦1]

[--errorescalationperiod=number] [--name=string] [--schedule=string]


DESCRIPTIONThis command changes the parameters of the content router garbage collectionpolicy. Pdsetcrgarbagecollectionpolicy is a systempolicy, so there is only onepolicy of this type.

PARAMETERSenabled - Use of this parameter enables the policy. Acceptable values are 0 (zero),disabled, and 1 (one), enabled. The default value is 1


name - The name of the garbage collection policy.



■ For daily, the time period is hour:minute:period. The hour and minute are thehour and minute when the policy should run. The period defines how often

133Command Line Interfacepdsetcrgarbagecollectionpolicy

the policy runs. So the parameter --schedule="D13:15:7" indicates the policyshould execute at 1:15 P.M. every seven days.





RETURN VALUES/opt/pdcli/calls # ./pdsetcrgarbagecollectionpolicy

Updated the CR garbage collection policy with the following properties:

_______________________________________________________________________


The policy name: System policy for CR Garbage Collection.

Command Line Interfacepdsetcrgarbagecollectionpolicy

134




SEE ALSON/A

135Command Line Interfacepdsetcrgarbagecollectionpolicy

pdsetdatalockpdsetdatalock – Resets the data lock password.

SYNOPSISpdsetdatalock --agentid=number --oldpwd=string --newpwd=string

DESCRIPTIONThis command resets the data lock password.

PARAMETERSagentid - The agent identifier.

oldpwd - The old data lock password.

newpwd - The new data lock password.

RETURN VALUES./pdsetdatalock --agentid=2 --oldpwd=welcome --newpwd=testnbu

Successfully changed the data lock password.

SEE ALSON/A

Command Line Interfacepdsetdatalock

136

pdsetdataminingpolicypdsetdataminingpolicy – Change the parameters of the data mining policy.

SYNOPSISpdsetdataminingpolicy [--enabled=0|1] [--errorescalationperiod=number]

[--full=0|1] [--name=string] [--schedule=string]


DESCRIPTIONThis command changes the parameters of the data mining policy.Pdsetdataminingpolicy is a systempolicy, so there is only one policy of this type.


errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified inminutes) afterwhich an email is sent. That indicatesa job has been running formore than the specified error time frame. Additionally,the backup job is stopped.

full -When enabled, this forces PureDisk doperforma full datamining operation.Values for that are zero (not enabled) and 1 (enabled). The default value is 0.

name - The name of the data mining policy.



■ For daily, the time period is hour:minute:period. The hour and minute are thehour and minute when the policy should run. The period defines how often

137Command Line Interfacepdsetdataminingpolicy

the policy runs. So the parameter --schedule="D13:15:7" indicates the policyshould execute at 1:15 P.M. every seven days.




warningescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The warningescalationperiodis the period of time (specified inminutes) after which an email is sent. The emailis a warning that a job has been running formore than the specifiedwarning timeframe.

RETURN VALUES/opt/pdcli/calls # ./pdsetdataminingpolicy

Updated the data mining policy with the following properties:

_____________________________________________________________


Command Line Interfacepdsetdataminingpolicy

138

The policy name: System policy for Data Mining.





full = 0.

SEE ALSOpdcreatedataminingpolicy

139Command Line Interfacepdsetdataminingpolicy

pdsetdataremovalpolicypdsetdataremovalpolicy – Change the parameters of an existing data removalpolicy.

SYNOPSISpdsetdataremovalpolicy --id=number [--dsfind=string] [--enabled=0¦1]

[--errorescalationperiod=number] [--kmaxnfiles=number]

[--kmaxnfilesdel=number] [--mbfindfile=string] [--name=string]

[--pdel=number] [--pnewer=number] [--registertime=string]

[--schedule=string] [--warningescalationperiod=number]

DESCRIPTIONThis command changes the parameters of an existing data removal policy.








errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified inminutes) afterwhich an email is sent. That indicatesa job has been running formore than the specified error time frame. Additionally,the backup job is stopped.

id The ID for a data removal policy.

Command Line Interfacepdsetdataremovalpolicy

140

kmaxnfiles - The maximum number of file versions to retain.

kmaxnfilesdel - The maximum number of file versions to retain after the file isdeleted on source.














name - The name of the data removal policy.

pdelThe number of days to retain the last version of a file after the file is deletedfrom source.

141Command Line Interfacepdsetdataremovalpolicy

pnewer - The number of days to retain older or obsolete file versions.

registertime - When a file's metadata is saved into the metadata database, thetime it is saved is recorded. That is considered the registertime. When usingtime-based data removal, you can specifywhat data is selected to be deleted basedon the registration time using the --registertime parameter. The format forthis parameter is seconds since epoch.






Command Line Interfacepdsetdataremovalpolicy

142


warningescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The warningescalationperiodis the period of time (specified inminutes) afterwhich an email is sent. That emailwarns a job has been running for more than the specified warning time frame.

RETURN VALUES/opt/pdcli/calls # ./pdsetdataremovalpolicy --id=110

The data removal policy has the following properties:

_____________________________________________________


The policy name: Data removal of entire storagepool.


- Warning: minutes.

- Error: minutes.


kMaxNFilesDel = 2.

rType = 1.

SEE ALSOpdcreatedataremovalpolicy

143Command Line Interfacepdsetdataremovalpolicy

pdsetdebugagentpdsetdebugagent – Change the debugging parameters for the agent.

SYNOPSISpdsetdebugagent --id=number --debugmode=0¦1

DESCRIPTIONThis command changes the debugging parameters for the PureDisk agent.

PARAMETERSid - The ID for an agent.

debugmode - Enables or disables debug mode. Acceptable values are 0 (zero) -disabled, and 1 (one) - enabled. By default, agents do not run in debug mode.

A PureDisk agent in debug mode provides detailed log information for the jobsteps that are run on that client agent or server agent. Also, when enabled,temporary scripts and log files remain in place on a client agent or server agent.Typically, PureDisk removes these files after they are no longer needed, butwhenyou enable debug mode, PureDisk leaves them in place. For example, you canenable debug mode to troubleshoot failing jobs for a particular client agent.

Typically, Symantec CFT or technical support requests that you enable thiscapability in the storage pool while troubleshooting. Do not enable debug modefor general use.

RETURN VALUES/opt/pdcli/calls # ./pdsetdebugagent --id=6 --debugmode=1

The agent debug request has been sent.

SEE ALSON/A

Command Line Interfacepdsetdebugagent

144

pdsetdepartmentpdsetdepartment – Changes and updates the details that are associated with anexisting department.

SYNOPSISpdsetdepartment --id=number [--description=string] [--name=string]

DESCRIPTIONThis commandchanges andupdates thedetails that are associatedwith an existingdepartment.

PARAMETERSid - The ID of the department.

description - The department's description.

name - The department's name.

RETURN VALUES/opt/pdcli/calls # ./pdsetdepartment --id=2

The updated department now has the following properties:

________________________________________________________


The name is Support.

The description is .


pddeletedepartment

pdgetdepartment

pdlistdepartment

145Command Line Interfacepdsetdepartment

pdsetdspdsetds – Changes and updates the details that are associated with an existingdata selection.

SYNOPSISpdsetds --id=number [--dsrules=string] [--description=string]

[--name=string] [--ostypeid=number] [--agentid=number]

[--dstype=number] [--originaltemplateid=number]

DESCRIPTIONThis commandchanges andupdates thedetails that are associatedwith an existingdata selection.

PARAMETERSid - The ID of the data selection.

dsrules - A comma-separated file that is used on a client for selecting data forbackup. The structure of the file is: path|filename|include (include being 0 toexclude, 1 to include the files selected). This parametermust be enclosed in single(') quotation marks.

description - Description of the data selection.

name - Name of the data selection.

ostypeid - The operating system of the data selection. Operating system typesare 0 = unknown, 10 = Windows, 20 = Linux, 30 = Solaris, 40 = HP-UX, 50 = AIX,60 = MacOS.

agentid - The ID for the agent upon which this data selection resides.

dstype - The type of the data selection created. 1 is normal, 2 is system, 3 VFS, 4DR, 6 Microsoft Exchange, 7 Microsoft SQL, 8 Shadow Copy (system backup), 11UNC path, 9 NetBackup OST (PDDO), 14 DLO.

originaltemplateid - The data selection template ID for a data selection thatinherits from another data selection template.

RETURN VALUES/opt/pdcli/calls # ./pdsetds --id=2

Command Line Interfacepdsetds

146

The changed data selection has the following properties:

________________________________________________________

The identifier is 2. The name is etc.





file pattern: *.


SEE ALSOpdcreateds

pddeleteds

pdgetds

pdlistds

147Command Line Interfacepdsetds

pdsetdsremovalpolicypdsetdsremovalpolicy – Change the parameters of the data selection removalpolicy.

SYNOPSISpdsetdsremovalpolicy [--enabled=0¦1] [--errorescalationperiod=number]

[--name=string] [--schedule=string] [--warningescalationperiod=number]

DESCRIPTIONThis command changes the parameters of the data selection removal policy.



name - The name of the data selection removal policy.




Command Line Interfacepdsetdsremovalpolicy

148




warningescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The warningescalationperiodis the period of time (specified inminutes) after which an email is sent. The emailwarns a job has been running for more than the specified warning time frame.

RETURN VALUES/opt/pdcli/calls # ./pdsetdsremovalpolicy

The updated DS removal policy has the following properties:

__________________________________________________________


The policy name: System policy for Data Selection Removal.




149Command Line Interfacepdsetdsremovalpolicy

SEE ALSON/A

Command Line Interfacepdsetdsremovalpolicy

150

pdsetdstemplatepdsetdstemplate – Changes and updates a data selection template.

SYNOPSISpdsetdstemplate --id=number [--dstrules=string] [--description=string]

[--name=string] [--ostypeid=number] [--inheritancemap=string]

DESCRIPTIONThis command changes and updates a data selection template.

PARAMETERSid - The ID for a data selection template.

dstrules - The criteria that is used to determinewhich files the templates selects.The criteria is specified as '<path>|<filename>|<include>' (include being 0 toexclude/ 1 to include). A dstrules parameter of '/etc/*|*|1' would include allfiles in the /etc directory. Separate multiple include and exclude rules withcommas.

description - Description of the template.

name - Name of the template.

ostypeid - Used to define the operating system of the data selection. Operatingsystem types are 0=unknown, 10=Windows, 20=Linux, 30=Solaris, 40 =HP-UX,50 = AIX, 60 = Darwin.

inheritancemap - Indicates the containers to which the template applies. Theparameter is specified as --inheritancemap='containerid|containertype'. Separatemultiple IDs and types with commas (--inheritancemap'containerid|containertype,containerid|containertype'). Acceptable values forcontainertype are as follows: Agent = 1, Location = 2, Department = 3, Storagepool = 4, OS Type = 5. The container ID is found by using the pdlist commandthat is associated with the desired container (pdlistagent, pdlistlocation, andso on).

RETURN VALUES/opt/pdcli/calls # ./pdsetdstemplate --id=5

151Command Line Interfacepdsetdstemplate

The updated data selection template has the following properties:

_________________________________________________________________





file pattern: *.

directory pattern: /*.

This following rule excludes:

file pattern: *.

directory pattern: /lib/*.


pddeletedstemplate

pdgetdstemplate

pdlistdstemplate

Command Line Interfacepdsetdstemplate

152

pdseteventescalationpdseteventescalation – Updates an event escalation.

SYNOPSISpdseteventescalation --id=number --escalationactionid=number

--eventtype=number --maxseveritylevel=number --minseveritylevel=number

DESCRIPTIONThis command updates an event escalation.

PARAMETERSid - The identifier of the event escalation.

eventtype - The type of event escalation action that is created. The two types ofevent escalation actions are: an agent event escalation (denoted by the number1) and a storage pool event escalation (denoted by the number 0).


maxseveritylevel - Thehighest severity level the event escalation action catches.Acceptable values are: 1 Debug, 2 Informational, 3 Authorization, 4 Warning, 5Error, 6 Critical, and 7 Bug.

minseveritylevel - The lowest severity level the event escalation action catches.Acceptable values are: 1 Debug, 2 Informational, 3 Authorization, 4 Warning, 5Error, 6 Critical, and 7 Bug.

RETURN VALUES/opt/pdcli/calls # ./pdseteventescalation --id=1 --escalationtype=1

Successfully updated the escalation.





153Command Line Interfacepdseteventescalation

pdseteventescalationactionpdseteventescalationaction –Change the parameters of an existing escalationaction.

SYNOPSISpdseteventescalationaction --id=number [--address=string]

[--community=string] [--description=string] [--message=string]

[--subject=string]

DESCRIPTIONThis command changes the parameters of an existing escalation action. To sendevent by using SNMP,make sure that you have configured and enabled the SNMPsoftware. For more information, see the PureDisk Backup Operator's Guide.

PARAMETERSaddress - The email address to which the event escalation action should send amessage.

community - The group of devices and management stations running SNMP.


id (Required) - Generic identifier type.

message - The message that is associated with the escalation action. That is thetext that is emailed when the escalation action is sent.

subject - The subject of the email message the escalation action sends.

RETURN VALUES/opt/pdcli/calls # ./pdseteventescalationaction --id=1

The action now has the following properties:

____________________________________________


description = desc.

emailAddress = [email protected].

id = 1.

message =

modDate = 1225119315.

subject = subj.

Command Line Interfacepdseteventescalationaction

154

SEE ALSOpdcreateeventescalationaction




155Command Line Interfacepdseteventescalationaction

pdsetgrouppdsetgroup –Changes andupdates the details that are associatedwith an existinguser group.

SYNOPSISpdsetgroup --name=string [--description=string] [--newname=string]

DESCRIPTIONThis commandchanges andupdates thedetails that are associatedwith an existinguser group.

PARAMETERS


name - The name of the group.

description - The description of the group.

newname - The new name of the group.

RETURN VALUES/opt/pdcli/calls # ./pdsetgroup --name=Backup_Operators

--description='"People who run backups"' --newname=Backup_Admins

Successfully updated group:

Backup_Admins (eb789218-1099-102e-9dbb-c1d4d1c63f30).


pddeletegroup

pdgetgroup

pdlistgroup

Command Line Interfacepdsetgroup

156

pdsetlicensepdsetlicense – Adds a license key.

SYNOPSISpdsetlicense --key=string

DESCRIPTIONThis command adds a license key.

PARAMETERSkey - The alphanumeric PureDisk license key.

RETURN VALUESThe command has no return value unless it is entered incorrectly.


pdgetlicense

pdlistlicense

pdstatlicensing

157Command Line Interfacepdsetlicense

pdsetlocationpdsetlocation – Changes and updates the details that are associated with anexisting location.

SYNOPSISpdsetlocation --id=number [--address=string] [--description=string]

[--name=string]

DESCRIPTIONThis commandchanges andupdates thedetails that are associatedwith an existinglocation.

PARAMETERSid - The ID of the location.

address - The address that is associated with the location.

description - The description of the location.

name - The name of the location.

RETURN VALUES/opt/pdcli/calls # ./pdsetlocation --id=1

The updated location now has the following properties:

Default location (1) with description:

Location for storagepool 1.

Note: The location "Unknown" is created with the storage pool authority isinstalled. If a location is not specifiedwhen the agent is installed, PureDisk placesthe new agent in the "Unknown" location. Once all agents are moved out of the"Unknown" location, it should no longer appear in the administrative Web UI.


pddeletelocation

pdgetlocation

Command Line Interfacepdsetlocation

158

pdlistlocation

159Command Line Interfacepdsetlocation

pdsetmaintenancepolicypdsetmaintenancepolicy – Change the parameters of the maintenance policy.

SYNOPSISpdsetmaintenancepolicy [--daysevents=number] [--daysfiles=number]

[--daysjobs=number] [--enabled=0¦1] [--errorescalationperiod=number]


DESCRIPTIONThis command changes the parameters of the maintenance policy.Pdsetmaintenancepolicy is a system policy, so there is only one policy of thistype.

PARAMETERSdaysevents - The number of days that should pass before an event is deleted inmaintenance.

daysfiles - The number of days that should pass before temporary files aredeleted in maintenance.

daysjobs - The number of days that should pass before a job is deleted inmaintenance.



name - The name of the maintenance policy.


Command Line Interfacepdsetmaintenancepolicy

160







161Command Line Interfacepdsetmaintenancepolicy

RETURN VALUES/opt/pdcli/calls # ./pdsetmaintenancepolicy

The updated maintenance policy has the following properties:

____________________________________________________________


The policy name: System policy for Maintenance.





deletetmpfiles = 1.

tmpDirAge = 7.

deleteJobs = 1.

tmpJobAge = 14.

deleteEvents = 1.

tmpEventAge = 14.

vacuumDB = 1.

SEE ALSON/A

Command Line Interfacepdsetmaintenancepolicy

162

pdsetmbgarbagecollectionpolicypdsetmbgarbagecollectionpolicy – Change the parameters of an existingmetabase garbage collection policy.

SYNOPSISpdsetmbgarbagecollectionpolicy --id=number [--dsfind=string]

[--enabled=0¦1] [--enableextensivecleanup=number]

[--errorescalationperiod=number] [--logdeletedrecords=0¦1]


DESCRIPTIONThis command changes the parameters of an existingmetabase garbage collectionpolicy.








enableextensivecleanup - This parameter is used to enable and disable moreextensive cleanupduring themetabase garbage collection.Duringnormal cleanup,only dereferenced file names are removed. When this parameter is enabled, thepolicy also attempts to remove expired file names. Acceptable values for thisparameter are 0 (zero), disabled, and 1 (one), enabled. The default value is 0.

errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,

163Command Line Interfacepdsetmbgarbagecollectionpolicy

that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified in minutes) after which an email is sent. The emailindicates a job has been running for more than the specified error time frame.Additionally, the backup job is stopped.

id (Required) - Generic identifier type.

logdeletedrecords -When this parameter is enabled, PureDisk keeps the historyon the metabase garbage collection policies. The acceptable values for thisparameter are zero (0 - disabled) and one (1 - enabled). The default value is 0.Moreinformation about this log file is available. See the Editing the Parameters tab onthe default metabase engine garbage collection policy section in the SymantecNetBackup PureDisk Backup Operator’s Guide.

name - The name of the metabase garbage collection policy.





■ Formonthly, the timeperiod is hour:minute:offset:period. Thehour andminuteare the hour andminute when the policy should run. The offset determine theday of the month the policy should run. The period is a bitmap that indicatesthe months when the policy should run. This bitmap is a string of 12 zeros orones. The first character indicates the first month of the year (January). The

Command Line Interfacepdsetmbgarbagecollectionpolicy

164

second the second month of the year (February), and so on. If the character is1, that means that the schedule should run that month. If it is 0 the scheduledoes not run. For example: 100000000000means that the schedule should runin January. 100000000001 means that this schedule runs in January andDecember. So the parameter --schedule="M10:0:12:11000000000" indicatesa policy that executes at 10:00 on the 12th day of the months January andFebruary.



RETURN VALUES/opt/pdcli/calls # ./pdsetmbgarbagecollectionpolicy --id=111

The updated MB garbage collection policy has the following properties:

_______________________________________________________________________


The policy name: mbgc.





removeExp = 1.

SEE ALSOpdcreatembgarbagecollectionpolicy

pdgetpolicy

165Command Line Interfacepdsetmbgarbagecollectionpolicy

pdsetpermpdsetperm – Sets the permissions for a user.

SYNOPSISpdsetperm --resourcetype --resourceid --consumerid --consumertype

--permissionaction --permissiontype

DESCRIPTIONThis command sets the permissions for a user.

PARAMETERSresourcetype - The resource type being modified. Acceptable values are: 1 =Agent, 2 = Department, 3 = Location, 4= Storage pool, 5= World.

resourceid - The resource identifier.

consumerid - The consumer identifier.

consumertype - Theobject typehaving its permissionsmodified.Acceptable valuesare 1 = User, 2 = User group.

permissionaction - Indicates if permissions are added or removed. Acceptablevalues are 0 = remove a permission 1= add permission.

permissiontype - The permission being added or removed. Acceptable values are1 = View, 2 = Add, 3 = Edit, 4 = Delete, 5 = Activate, 6 = Dstemplate management,7 = Configuration management, 8 = Workflow management, 9 = Eventmanagement, 10 = Topology management, 11 = Find files, 12 = Backup , 13 =Restore, 14 = Install, 15 = Reroute, 16 Agent upgrade, 17 = Replicate, 18 = Report,19 = Central Report, 20 Access control list management, 21 = Data management,22 = Deref, 23 = System, 24 = Agent management, 25 = Use.

RETURN VALUESThe command has no return value unless the command is entered incorrectly.

/opt/pdcli/calls # ./pdsetperm --consumerid=f51192be-3883-102d-8489-e94f1c132461 --consumertype=1 --permissionaction=1 --permissiontype=1 --resourcetype=3 --resourceid=11

/opt/pdcli/calls #

Command Line Interfacepdsetperm

166


167Command Line Interfacepdsetperm

pdsetpolicyescalationactionpdsetpolicyescalationaction – Change the parameters of an existing policyescalation action.

SYNOPSISpdsetpolicyescalationaction --id=number [--createevent=0¦1]

[--description=string] [--emailalarm=string] [--emailwarning=string]

[--eventseveritylevel=number] [--message=string]

DESCRIPTIONThis command changes the parameters of an existing policy escalation action.

PARAMETERSid - The ID of the policy escalation action.

createevent - This parameter instructs PureDisk to send an event if the job hasreached its expiration date. Acceptable values are 0 (zero) - donot create an event,and 1 (one) - create an event. The default value is 1.

description - Description of the policy escalation action.

emailalarm - The email address that is used for sending an email when a policyescalation occurs and the error escalation time for a policy is expired.

emailwarning - The email address that is used for sending an email when a policyescalation occurs and the warning escalation time for a policy is expired.

eventseveritylevel - Defines the severity level for the newly created policyescalation action. The levels are: 1 Debug, 2 Informational, 3 Authorization, 4Warning, 5 Error, 6 Critical, and 7Bug.Acceptable values for eventseveritylevelare 1 (one) through 7 (seven). The default value if not specified is 1.

message - The message that is associated with the escalation action. That is thetext that is emailed when the escalation action is sent.

RETURN VALUES/opt/pdcli/calls # ./pdsetpolicyescalationaction --id=1

The updated policy escalation action has the following properties:

_________________________________________________________________

Command Line Interfacepdsetpolicyescalationaction

168



If a policy reaches the error escalation timeout an email message is


When it reaches the warning escalation timeout an email message is






169Command Line Interfacepdsetpolicyescalationaction

pdsetreplicationpolicypdsetreplicationpolicy – Change the parameters of an existing replicationpolicy.

SYNOPSISpdsetreplicationpolicy --id=number [--bandwidth=number]

[--crport=number] [--dsfind=string] [--enabled=0¦1]

[--errorescalationperiod=number] [--forcecrypt=number]

[--endtime=number] [--starttime=number] [--mbfindfile=string]

[--name=string] [--remoteaddress=string] [--remotelogin=string]

[--remotepwd=string] [--schedule=string] [--typeofrep=number]


DESCRIPTIONThis command changes the parameters of an existing replication policy.

PARAMETERSid - The ID of the replication policy.

bandwidth - The amount of bandwidth that is allocated to the policy, expressedin kilobytes per second (kb/sec). This option limits the bandwidth that a policyuses.

crport - The port number the content router uses for backup and restoreoperations.

dsfind - A data selection filter that is used in all data selection-related policies.That determines which data selections a certain policy uses. The syntax for thedsfind parameter is <identifier>=<value>. Separate multiple identifiers witha comma. Supported dsfind values are as follows:






Command Line Interfacepdsetreplicationpolicy

170


endtime - The end time of the backup window. This value is specified in hoursaccording to a 24-hour clock. For example, 2:00A.M. is 2, and3PM is 15.Acceptablevalues are 0 (midnight) through 23 (11:00 P.M.).

errorescalationperiod - Within PureDisk, there is a watchdog service whichmakes sure jobs do not run for days on end. When backups run for multiple days,that usually indicates that something is wrong. The errorescalationperiod isthe period of time (specified in minutes) after which an email is sent. The emailindicates that a job has been running formore than the specified error time frame.Additionally, the backup job is stopped.

forcecrypt - This parameter forces encryption during replication.

mbfindfile - The file name of the file containing themetadata filters used by thepolicy. The file this parameter specifies contains one or more filters that helpdetermine what file or files are selected. The filters consist of an mbfind field andits associated value. An example of an mbfindfile file is located in/opt/pdcli/defaultMBFind.dat.


■ basename: The name of the object, not including the directory name.







171Command Line Interfacepdsetreplicationpolicy





name - The name of the replication policy.

remoteaddress - The TCP/IP address of the remote storage pool authority.

remotelogin - The login ID for the remote storage pool authority.

remotepwd - The password for the login ID for the remote storage pool authority.





■ Formonthly, the timeperiod is hour:minute:offset:period. Thehour andminuteare the hour andminute when the policy should run. The offset determine theday of the month the policy should run. The period is a bitmap that indicatesthe months when the policy should run. This bitmap is a string of 12 zeros orones. The first character indicates the first month of the year (January). Thesecond the second month of the year (February), and so on. If the character is1, that means that the schedule should run that month. If it is 0 the schedule


172

does not run. For example: 100000000000means that the schedule should runin January. 100000000001 means that this schedule runs in January andDecember. So the parameter --schedule="M10:0:12:11000000000" indicatesa policy that executes at 10:00 on the 12th day of the months January andFebruary.



typeofrep - The type of replication to perform. Values are either 0 (zero), full, or1 (one), incremental. The default is 1.


RETURN VALUES/opt/pdcli/calls # ./pdsetreplicationpolicy --id=112

The adjusted replication policy has the following properties:

_______________________________________________________________


The policy name: replication to slowpoke.


typeofrep = 1.

bandwidth = 0.

crport = 10082.

forcecrypt = 1.

remoteaddress = 10.31.82.141.

remotelogin = root.

remotepassword = root.

173Command Line Interfacepdsetreplicationpolicy

puredisk cli guide

Documents

symantec product

party software

symantec logo

free software licenses

party programs

documentation version

support centers

commercial computer