PureDisk CLI Guide

Symantec NetBackup
PureDisk Command Line

Interface 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 and may be used
only in accordance with the terms of the agreement.
Documentation version: 6.6.1, revision 1
Legal Notice
Copyright 2010 Symantec Corporation. All rights reserved.
Symantec, the Symantec Logo, NetBackup, and PureDisk are trademarks or registered
trademarks of Symantec Corporation or its affiliates in the U.S. and other countries. Other
names may be trademarks of their respective owners.
This Symantec product may contain third party software for which Symantec is required
to provide attribution to the third party (Third Party Programs). Some of the Third Party
Programs are available under open source or free software licenses. The License Agreement
accompanying the Software does not alter any rights or obligations you may have under
those open source or free software licenses. Please see the Third Party Legal Notice Appendix
to this Documentation or TPIP ReadMe File accompanying this Symantec product for more
information 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 document
may be reproduced in any form by any means without prior written authorization of
Symantec Corporation and its licensors, if any.
THE DOCUMENTATION IS PROVIDED "AS IS" AND ALL EXPRESS OR IMPLIED CONDITIONS,
REPRESENTATIONS AND WARRANTIES, INCLUDING ANY IMPLIED WARRANTY OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE OR NON-INFRINGEMENT,
ARE DISCLAIMED, EXCEPT TO THE EXTENT THAT SUCH DISCLAIMERS ARE HELD TO
BE LEGALLY INVALID. SYMANTEC CORPORATION SHALL NOT BE LIABLE FOR INCIDENTAL
OR CONSEQUENTIAL DAMAGES IN CONNECTION WITH THE FURNISHING,
PERFORMANCE, OR USE OF THIS DOCUMENTATION. THE INFORMATION CONTAINED
IN THIS DOCUMENTATION IS SUBJECT TO CHANGE WITHOUT NOTICE.
The Licensed Software and Documentation are deemed to be commercial computer software
as defined in FAR 12.212 and subject to restricted rights as defined in FAR Section 52.227-19
"Commercial Computer Software - Restricted Rights" and DFARS 227.7202, "Rights in
Commercial Computer Software or Commercial Computer Software Documentation", as
applicable, and any successor regulations. Any use, modification, reproduction release,
performance, display or disclosure of the Licensed Software and Documentation by the U.S.
Government shall be solely in accordance with the terms of this Agreement.
Symantec Corporation
350 Ellis Street
Mountain View, CA 94043
http://www.symantec.com
Technical Support
Symantec Technical Support maintains support centers globally. Technical
Supports primary role is to respond to specific queries about product features
and functionality. The Technical Support group also creates content for our online
Knowledge Base. The Technical Support group works collaboratively with the
other functional areas within Symantec to answer your questions in a timely
fashion. For example, the Technical Support group works with Product Engineering
and Symantec Security Response to provide alerting services and virus definition
updates.
Symantecs support offerings include the following:
A range of support options that give you the flexibility to select the right
amount of service for any size organization
Telephone and/or Web-based support that provides rapid response and

up-to-the-minute information
Upgrade assurance that delivers software upgrades
Global support purchased on a regional business hours or 24 hours a day, 7

days a week basis
Premium service offerings that include Account Management Services
For information about Symantecs support offerings, you can visit our Web site
at the following URL:
www.symantec.com/business/support/
All support services will be delivered in accordance with your support agreement
and the then-current enterprise technical support policy.
Contacting Technical Support

Customers with a current support agreement may access Technical Support
information at the following URL:
Before contacting Technical Support, make sure you have satisfied the system
requirements that are listed in your product documentation. Also, you should be
at the computer on which the problem occurred, in case it is necessary to replicate
the problem.
When you contact Technical Support, please have the following information
available:
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 registration

If your Symantec product requires registration or a license key, access our technical
support Web page at the following URL:
Customer service
Customer service information is available at the following URL:
Customer Service is available to assist with non-technical questions, such as the
following 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 resources

If you want to contact Symantec regarding an existing support agreement, please
contact the support agreement administration team for your region as follows:
Asia-Pacific and Japan
customercare_apac@symantec.com
Europe, Middle-East, and Africa
semea@symantec.com
North America and Latin America
supportsolutions@symantec.com
Contents
Technical Support ............................................................................................... 4

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

PureDisk CLI ...............................................................................
pdactivateagent ...........................................................................
pdbackup ....................................................................................
pdbackupstop ..............................................................................
pdcreatebackuppolicy ...................................................................
pdcreatedataremovalpolicy ............................................................
pdcreatedepartment .....................................................................
pdcreateds ..................................................................................
pdcreatedstemplate ......................................................................
pdcreateeventescalation ................................................................
pdcreategroup .............................................................................
pdcreatelocation ..........................................................................
pdcreatembgarbagecollectionpolicy .................................................
pdcreatepolicyescalation ...............................................................
pdcreatepolicyescalationaction .......................................................
pdcreatereplicationpolicy ..............................................................
pdcreateSMTPeventescalationaction ...............................................
pdcreateSNMPeventescalationaction ...............................................
pdcreateuser ...............................................................................
pddeactivateagent ........................................................................
pddeleteagent ..............................................................................
pddeletedepartment .....................................................................
pddeleteds ..................................................................................
pddeletedstemplate ......................................................................
pddeleteeventescalation ................................................................
pddeleteeventescalationaction .......................................................
pddeletegroup .............................................................................
pddeletejob .................................................................................
pddeletelicense ............................................................................
pddeletelocation ..........................................................................
pddeletepolicy .............................................................................
pddeletepolicyescalation ...............................................................
pddeletepolicyescalationaction .......................................................
15
21
22
26
27
33
37
38
40
42
44
45
46
49
50
52
56
58
60
62
63
64
65
66
67
68
69
70
71
72
73
74
75
Contents
pddeleteuser ............................................................................... 76
pdexit ........................................................................................ 77
pdexport2nbu .............................................................................. 78
pdfindfiles .................................................................................. 79
pdgetagent .................................................................................. 82
pdgetdepartment ......................................................................... 83
pdgetds ...................................................................................... 84
pdgetdstemplate .......................................................................... 85
pdgeteventescalation .................................................................... 86
pdgeteventescalationaction ........................................................... 87
pdgetgroup ................................................................................. 88
pdgetjob ..................................................................................... 89
pdgetjobstat ................................................................................ 91
pdgetjobsteps .............................................................................. 93
pdgetlicense ................................................................................ 95
pdgetlocation .............................................................................. 96
pdgetpolicy ................................................................................. 97
pdgetpolicyescalation ................................................................... 98
pdgetpolicyescalationaction ........................................................... 99
pdgetstoragepool ........................................................................ 100
pdgetuser .................................................................................. 101
pdlistagent ................................................................................ 103
pdlistdepartment ....................................................................... 104
pdlistds .................................................................................... 105
pdlistdstemplate ........................................................................ 106
pdlistevent ................................................................................ 107
pdlisteventescalation .................................................................. 108
pdlisteventescalationaction .......................................................... 109
pdlistgroup ............................................................................... 110
pdlistjob ................................................................................... 111
pdlistlicense .............................................................................. 112
pdlistlocation ............................................................................ 113
pdlistpolicy ............................................................................... 114
pdlistpolicyescalation ................................................................. 116
pdlistpolicyescalationaction ......................................................... 117
pdlistuser ................................................................................. 118
pdlogonuser .............................................................................. 119
pdpasswd .................................................................................. 120
pdrestore .................................................................................. 122
pdrunpolicy ............................................................................... 125
pdsetagent ................................................................................ 126
pdsetbackuppolicy ...................................................................... 128
pdsetcrgarbagecollectionpolicy ..................................................... 133
Contents
pdsetdatalock ............................................................................
pdsetdataminingpolicy ................................................................
pdsetdataremovalpolicy ..............................................................
pdsetdebugagent ........................................................................
pdsetdepartment ........................................................................
pdsetds .....................................................................................
pdsetdsremovalpolicy .................................................................
pdsetdstemplate .........................................................................
pdseteventescalation ..................................................................
pdseteventescalationaction ..........................................................
pdsetgroup ................................................................................
pdsetlicense ..............................................................................
pdsetlocation .............................................................................
pdsetmaintenancepolicy ..............................................................
pdsetmbgarbagecollectionpolicy ...................................................
pdsetperm .................................................................................
pdsetpolicyescalationaction .........................................................
pdsetreplicationpolicy .................................................................
pdsetserverdbmaintenancepolicy ..................................................
pdsetstoragepool ........................................................................
pdsetuser ..................................................................................
pdstatlicensing ..........................................................................
pdupgrade .................................................................................
Appendix B
136
137
140
144
145
146
148
151
153
154
156
157
158
160
163
166
168
170
175
178
179
181
183
Third-party legal notices .................................................. 185

Third-party legal notices for the Symantec NetBackup PureDisk
product family ..................................................................... 185
Third-party trademarks for the Symantec NetBackup PureDisk
product family ..................................................................... 185
Glossary ............................................................................................................. 187
10
Contents
Appendix
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
12
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
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
13
14
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


General MAN page for PureDisk CLI A text-based interface for managing
Symantec NetBackup PureDisk.
DESCRIPTION
NetBackup PureDisk offers customers a software-based data deduplication solution
that integrates with NetBackup. It provides customers with the critical features
required to protect all their data from remote office to virtual environment to
datacenter. It reduces the size of backups with a deduplication engine that can be
deployed for storage reduction. It uses integration with NetBackup, for bandwidth
reduction using PureDisk clients. An open architecture allows customers to easily
deploy 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 bash

shell, 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 sure
the first command that is entered in the script is the pdlogonuser command.
If you do not run pdlogonuser, you are prompted for a user name and password
before each command is executed.
The contents of all man pages are collected in a PDF format for offline viewing.
See the PureDisk Command Line Interface Guide.
PUREDISK COMMANDS GROUPED BY FUNCTION

General 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.
15
16

pddeactivateagent - Deactivates the agent software on a client computer so
it 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 with
a 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 license
keys.
pdupgrade - Used to initiate the upgrade of client software on the specified
client.
Create functions
pdcreatebackuppolicy - Creates a new backup policy.
pdcreatedataremovalpolicy - Creates a policy to remove data from a content
router.
pdcreatedepartment - Creates a new department that is used to organize client
systems.
pdcreateds - Creates a new selection of files and directories on a PureDisk
client 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 the
same permissions.
pdcreatelocation - Creates a new logical grouping for one or more
departments.
pdcreatembgarbagecollectionpolicy - Creates a new metabase garbage
collection policy.
pdcreatepolicyescalation - Creates a new policy escalation.
pdcreatepolicyescalationaction - Creates a new policy escalation action.

pdcreatereplicationpolicy - Creates a new replication policy.
pdcreatesmtpeventescalationaction - Creates an SMTP event escalation
action.
pdcreatesnmpeventescalationaction - Creates an SNMP event escalation
action.
pdcreateuser - Creates a new user within PureDisk that can be assigned rights
and 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 the
agent 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, it
does 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 department
object specified.
pdgetds - Provides additional information about the data selection object
specified.
17
18

pdgetdstemplate - Provides information about the data selection template
specified.
pdgeteventescalation - Provides information about the event escalation
specified.
pdgeteventescalationaction - Provides information about the event
escalation 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 specified
job.
pdgetlicense - Collects information about the specified license key.
pdgetlocation - Provides additional information about the location object
specified.
pdgetpolicy - Provides additional information about the policy object specified.
pdgetpolicyescalation - Provides information about the policy escalation
object.
pdgetpolicyescalationaction - Provides information about the policy
escalation action.
pdgetstoragepool - Provides information about the storage pool.
pdgetuser - Provides information about the user object specified.
List functions
pdlistagent - Displays all agents that are associated with a particular PureDisk
environment.
pdlistdepartment - Displays all departments that are associated with a
particular PureDisk environment.
pdlistds - Displays all data selections that are associated with a particular
PureDisk environment.
pdlistdstemplate - Displays all the data selection templates.
pdlistevent - Displays all events that are associated with a particular PureDisk
environment.
pdlisteventescalation - Displays all the event escalations.

pdlisteventescalationaction - Displays a list of all the event escalation
actions.
pdlistgroup - Displays all the user groups that are associated with a particular
pdlistjob - Displays all jobs that are associated with a particular PureDisk
environment.
pdlistlicense - Displays all the installed license keys.
pdlistlocation - Displays all the locations that are associated with a particular
pdlistpolicy - Displays all the policies that are associated with a particular
pdlistpolicyescalation - Displays the policy escalations that are attached
to a policy.
pdlistpolicyescalationaction - Displays all the actions that are attached
to a policy.
pdlistuser - Displays all the users that are associated with a particular
Set functions
pdsetagent - Changes and updates the details that are associated with an
existing agent.
pdsetbackuppolicy - Change the parameters of an existing backup policy.
pdsetcrgarbagecollectionpolicy - Change the parameters of an existing
content router garbage collection policy.
pdsetdatalock - Resets the data lock password.
pdsetdataminingpolicy - Change the parameters of an existing data mining
policy.
pdsetdataremovalpolicy - Change the parameters of an existing data removal
policy.
pdsetdebugagent - Change the debugging parameters for the agent.
pdsetdepartment - Changes and updates the details that are associated with
an existing department.
pdsetds - Changes and updates the details that are associated with an existing
data selection.
19
20

pdsetdsremovalpolicy - Change the parameters of an existing data selection
removal policy.
pdsetdstemplate - Changes and updates a data selection template.
pdseteventescalationaction - Change the parameters of an existing
escalation action.
pdsetgroup - Changes and updates the details that are associated with an
existing user group.
pdsetlicense - Adds a license key.
pdsetlocation - Changes and updates the details that are associated with an
existing location.
pdsetmaintenancepolicy - Change the parameters of an existing maintenance
policy.
pdsetmbgarbagecollectionpolicy - Change the parameters of an existing
metabase garbage collection policy.
pdsetperm - Sets the permissions for a user.
pdsetpolicyescalationaction - Change the parameters of an existing policy
escalation action.
pdsetreplicationpolicy - Change the parameters of an existing replication
policy.
pdsetserverdbmaintenancepolicy - Change the parameters of an existing
server database maintenance policy.
pdsetstoragepool - Changes and updates the specified parameters for a
storage pool.
pdsetuser - Changes and updates the details that are associated with an
existing user.

pdactivateagent
pdactivateagent
pdactivateagent Activates the agent software on a client computer.
SYNOPSIS
pdactivateagent --id=number
DESCRIPTION
This command is used to activate the PureDisk agent software on a client computer.
PARAMETERS
id - Agent identifier.
RETURN VALUES
/opt/pdcli/calls # ./pdactivateagent --id=2
Activated the agent.
SEE ALSO
pddeleteagent
pddeactivateagent
pdgetagent
pdlistagent
pdsetagent
21
22

pdbackup
pdbackup
pdbackup Creates a backup job for the client specified.
SYNOPSIS
pdbackup --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]
DESCRIPTION
This command creates a backup job for the client specified.
PARAMETERS
agentid - Agent identifier.
backupacl - Lets you choose to back up the access control list information. If set
to 0 (zero), the ACL is not backed up. If set to 1 (one), the list is backed up. The
default value is 0.
bandwidth - The amount of bandwidth that is allocated to the policy, expressed
in kilobytes per second (kb/sec). Use this option to limit the amount of bandwidth
the policy uses.
changeaccesstime - This parameter allows the user to define if the backup changes
the access time of the file. Acceptable values are 0 (zero) - do not change access
time, or 1 (one) - change access time. The default value is 0.
changedetection - This parameter instructs PureDisk to verify if the file was
changed between when the file system was initially scanned for new and modified
files and when PureDisk began writing the backup. If changedetection is enabled,
PureDisk logs a warning message for each file that changes during the backup. If
this 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.

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

dsid - Data selection identifier.
encrypt - This parameter enables encryption for the policy. Acceptable values
are 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 hours
according 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 client
to the server. This value is specified in hours according to a 24-hour clock. For
example, 2:00 A.M. is 2, and 3:00 P.M. is 15. The differences between endtime and
endupload are the point in the backup where operations are stopped and what
operations 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 is
stopped. 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 is
halted.
followjunction - When enabled on an NTFS file system, the backup flow follows
the junctions that reference other data. One (1) is enabled, zero (0) is disabled.
followsymboliclink - When enabled, the backup flow follows the symbolic links
that reference other data. One (1) is enabled, zero (0) is disabled. The default value
is 0.
includenetworkshares - This option instructs PureDisk to include or exclude
network 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 leave
archive bit untouched during backup. The values 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 value
is 1.
postscript - The full path to a user-defined script that PureDisk should run when
the policy run finishes.

prescript - The full patch to a user-defined script that PureDisk should run before
policy starts.
23
24

pdbackup
retryverify - When enabled, this option instructs PureDisk to retry the backup
if it fails. The values for this parameter are 0 (disabled) and 1 (enabled). The default
value is 0.
runpostonerr - When this option is set and the job fails, the script that is defined
in the postscript parameter is run at the end of the policy. The values for this
parameter are 0 (do not run the script) and 1 (run the script). The default value
is 0.
segmentsize - The size of each part of a file when the file is broken into smaller
parts for backup. NOTE: The segmentsize parameter is specified in bytes, not
kbytes.
sort - The sorting algorithm that is used to determine what should be backed up
first. Acceptable parameters are size, sort by size, and dirname,size, sort by
directory with the smallest files first. The default is no sorting.
starttime - The start time of the backup window. This value is specified in hours
usesnapshot - When enabled, this option instructs PureDisk to use snapshot
technology (such as VSS or VSP) to back up the data. The values for this parameter
are 0 (disabled) and 1 (enabled). The default value is 0.
verifylevel - Specifies what verification level is used during backup. Acceptable
values 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).
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.

pdbackup
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 ALSO
pdbackupstop
25
26

pdbackupstop
pdbackupstop
pdbackupstop Used to stop any running job.
SYNOPSIS
pdbackupstop --id=number [--graceful=01]
DESCRIPTION
This command is used to stop any running job.
PARAMETERS
id - 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 ALSO
pdbackup

pdcreatebackuppolicy Creates new backup policy.
SYNOPSIS
pdcreatebackuppolicy --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]
DESCRIPTION
This command creates a new backup policy.
PARAMETERS
dsfind - A data selection filter that is used in all data selection-related policies.
That determines which data selections a certain policy uses. A dsfind filter consists
of one or more dsfind lines. The syntax for the dsfind parameter is
<identifier>=<value>. Items within a dsfind line are separated with a comma.
The dsfind lines are separated with the pipe symbol (). Supported dsfind values
are 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 Microsoft
Exchange, 7 Microsoft SQL, 8 Shadow Copy (system backup), 9 NetBackup OST

(PDDO), 11 UNC path, 14 Oracle, 15 Oracle UDJ (User Directed Job, used for
user 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.
27
28

agentdepartmentid: All data selections for all agents for a specified department
ID.
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 argument
involves 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 and
colons (:) and is expressed differently depending on the interval. Enclose the
argument in quotation mark characters, as follows: --schedule="interval:time"
For hourly, the time period is offset:period. The offset sets which minute in
the 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 five
minutes past the hour and run every four hours.
For daily, the time period is hour:minute:period. The hour and minute are the
hour and minute when the policy should run. The period defines how often
the policy runs. So the parameter --schedule="D13:15:7" indicates the policy
should execute at 1:15 P.M. every seven days.
For weekly, the time period is hour:minute:period. The hour and minute are
the hour and minute when the policy should run. The period is a bitmap that
indicates the days of the week when the policy should run. The bitmap is a
string of seven zeros or ones. The first character indicates the first day of the
week (Monday). The second character indicates the second day of the week
(Tuesday), and so on. If the character is 1, that means that the schedule should
run that day. If it is a 0 the schedule does not run. For example: 1000000 means
that the schedule should run only on Monday. 1010101 means the policy runs
on Monday, Wednesday, Friday, and Sunday.
For monthly, the time period is hour:minute:offset:period. The hour and minute
are the hour and minute when the policy should run. The offset determine the
day of the month the policy should run. The period is a bitmap that indicates
the months when the policy should run. This bitmap is a string of 12 zeros or
ones. The first character indicates the first month of the year (January). The
second the second month of the year (February), and so on. If the character is
1, that means that the schedule should run that month. If it is 0 the schedule
does not run. For example: 100000000000 means that the schedule should run

in January. 100000000001 means that this schedule runs in January and

December. So the parameter --schedule="M10:0:12:11000000000" indicates
a policy that executes at 10:00 on the 12th day of the months January and
February.
The CLI can create more flexible schedules than the GUI can. Some schedules
cannot be properly displayed in the GUI but are saved properly. To display the
schedule information you can use pdgetpolicy.
backupacl - Allows the user to choose to back up the access control list
information. If set to 0, the ACL is not backed up. If set to 1, the list is backed up.
the policy uses.
files and when PureDisk began writing the backup. Acceptable values are 0 - do
not detect changes or 1 - detect changes. The default value is 0.
compress - Enables compression on the policy. Acceptable values are 0 - do not
compress 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.


operations are stopped. In a backup, the three major steps are scanning for files,
29
30

halted.
errorescalationperiod - Within PureDisk, there is a watchdog service which
makes sure jobs do not run for days on end. When backups run for multiple days,
that usually indicates that something is wrong. The errorescalationperiod is
the period of time (specified in minutes) after which an email is sent. The email
indicates a job has been running for more than the specified error time frame.
Additionally, the backup job is stopped. More information about error escalation
is available. See the Creating policy escalation actions section in the Symantec
NetBackup PureDisk Backup Operators Guide.
network shares in a backup. Acceptable values are 0 (zero - do not include network
shares) and 1 (one - include network shares). The default value is 0.
archive 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 value
is 1.
postscript - The user-defined script that PureDisk should run at the end of a
policy.
prescript - The user-defined script that PureDisk should run at the start of a
policy.
if 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 of
the policy if the job fails. Acceptable values are 0 (zero), do not run the script, and
1 (one), run the script on error. The default is 0.
kbytes.
first. Acceptable parameters are size, sort by size, and dirname,size, sort by
directory with the smallest files first. The default is no sorting.

technology (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.
values are 1 (no verification), 2 (confirm the file exists on the content router), 3
warningescalationperiod - Within PureDisk, there is a watchdog service which
that usually indicates that something is wrong. The warningescalationperiod
is the period of time (specified in minutes) after which an email is sent, warning
a job has been running for more than the specified warning time frame. More
information about error escalation is available. See the Creating policy escalation
actions section in the Symantec NetBackup PureDisk Backup Operators 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 ALSO
pddeletepolicy
pdgetpolicy
pdlistpolicy
31
32

pdsetbackuppolicy

pdcreatedataremovalpolicy Creates a policy to remove data from a content
router.
SYNOPSIS
pdcreatedataremovalpolicy --dsfind=string --name=string
--schedule=string [--enabled=01] [--errorescalationperiod=number]
[--kmaxnfiles=number] [--kmaxnfilesdel=number] [--mbfindfile=string]
[--pdel=number] [--pnewer=number] [--registertime=string]
DESCRIPTION
This command creates a policy to remove data from the content router.
PARAMETERS
That determines which data selections are handled by a certain policy. The syntax
for the dsfind parameter is <identifier>=<value>. Separate multiple identifiers
with a comma. Supported dsfind values are as follows:
ID.
name - The name of the policy.
schedule - Defines how often a policy should execute. The format of the argument
33
34


February.
disabled, and 1 (one), enabled. The default value is 1

Additionally, the backup job is stopped.
kmaxnfiles - The maximum number of file versions to retain.

kmaxnfilesdel - The maximum number of file versions to retain after the file is
deleted on source.
mbfindfile - The file name of the file containing the metadata filters used by the
policy. The file this parameter specifies contains one or more filters that help
determine what file or files are selected. The filters consist of an mbfind field and
its 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 absolute
path
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 indicating when the object was registered
in the metabase. That is expressed in "seconds since epoch", when the object
was introduced on the storage pool. So if a file was registered in the metabase
at 10:00 P.M. on January 25, 2009, the seconds since epoch is 1232920800. A
value of --fromregistertime=1232834400 would capture this object.
toregistertime: The latest time indicating when the object was registered in
the metabase. That is expressed in "seconds since epoch". So if a file was

registered in the metabase at 10:00 P.M. on January 24, 2009, the seconds since
epoch is 1232834400. A value of --toregistertime=1232920800 would capture
this object.
Both the fromregistertime and the toregistertime parameters also allow
for the following input where # is a number. For example, -24d means 24 days
ago.
-#h: Number of hours ago
-#d: Number of days ago
-#w: Number of weeks ago
-#y: Number of years ago
pdel - The number of days to retain the last version of a file after the file is deleted
from source.
pnewer - The number of days to retain older or obsolete file versions.
35
36

registertime - When a file's metadata is saved into the metadata database, the
time it is saved is recorded. That is considered the registertime. When using

time-based data removal, you can specify what data is selected to be deleted based
on the registration time using the --registertime parameter. The format for
this parameter is seconds since epoch.
is the period of time (specified in minutes) after which an email is sent. The email
is a warning that a job has been running for more than the specified warning time
frame.
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 ALSO
pdgetpolicy

pdcreatedepartment
pdcreatedepartment
pdcreatedepartment Creates a new department that is used to organize agents.
SYNOPSIS
pdcreatedepartment --name=string [--description=string]
DESCRIPTION
This command creates a new department that is used to organize agents.
PARAMETERS
description - 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 ALSO
pdcreatelocation
pddeletedepartment
pdgetdepartment
pdlistdepartment
pdsetdepartment
37
38

pdcreateds
pdcreateds
pdcreateds Creates a new selection of files and directories on a PureDisk client
for backup.
SYNOPSIS
pdcreateds --agentid=number --dsrules='string' --name=string
[--description=string] [--dstype=number] [--originaltemplateid=number]
DESCRIPTION
This command creates a new selection of files and directories on a PureDisk client
for backup.
PARAMETERS
agentid - Agent identifier
dsrules - A comma-separated file that is used on a client for selecting data for
backup. The structure of the file is: path|filename|include (include being 0 to

exclude, 1 to include the files selected). This parameter must 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, 6 Microsoft Exchange,
7 Microsoft SQL, 8 Shadow Copy (system backup), 9 NetBackup OST (PDDO), 11

UNC path, 14 Oracle, 15 Oracle UDJ (User Directed Job, used for user to back up
or restore directly through a script), 16 DLO.
originaltemplateid - The data selection template ID for a data selection that
inherits 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.

pdcreateds
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 ALSO
pddeleteds
pdgetds
pdlistds
pdsetds
39
40

pdcreatedstemplate
pdcreatedstemplate
pdcreatedstemplate Used to create data selection templates.
SYNOPSIS
pdcreatedstemplate --dstrules='string' --name=string --ostypeid=number
[--description=string] [--inheritancemap='containerid|containertype']
DESCRIPTION
This command is used to create data selection templates.
PARAMETERS
dstrules - The criteria that is used to determine which files the templates selects.
The criteria is specified as 'path|filename|include' (include being 0 to exclude, 1

to include). Wildcard characters can be used for the path and filename values.
See the PureDisk Backup Operators Guide for more information on wild cards. A
dstrules parameter of '/etc/*|*|1' would include all files in the /etc directory.
Separate multiple include and exclude rules with commas. Be aware that in the
bash shell, the options must be enclosed in apostrophes, as show in the Return
Values 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. Operating
system 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. The
parameter is specified as --inheritancemap='containerid|containertype' and

must be enclosed in apostrophes. Separate multiple IDs and types with commas
(--inheritancemap
'containerid|containertype,containerid|containertype'). Acceptable values
for containertype are as follows: Agent = 1, Location = 2, Department = 3, Storage
pool = 4, OS Type = 5. The container ID is found by using the pdlist command
that is associated with the desired container (pdlistagent, pdlistlocation, and
so on).

pdcreatedstemplate
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 ALSO
pddeletedstemplate
pdgetdstemplate
pdlistdstemplate
pdsetdstemplate
41
42

pdcreateeventescalation Creates a new event escalation.
SYNOPSIS
pdcreateeventescalation --bindid=number --escalationactionid=number
--eventtype=number --maxseveritylevel=number --minseveritylevel=number
DESCRIPTION
This command creates a new event escalation.
PARAMETERS
bindid - The identifier that is used to bind items. Used to bind the event to the
event escalation. The two types of event escalation actions are: agent event
escalation actions and storage pool event escalation actions. Agent escalation
actions are run for a specific agent. Storage pool event escalation actions are run
for the entire storage pool. The bindid references the identifier of either an agent
action or a storage pool action.
escalationactionid - The escalation action identifier.
eventtype - The type of event escalation action being created. The two types of
event escalation actions are: agent event escalation (denoted by the number 1)
and a storage pool event escalation (denoted by the number 0).
maxseveritylevel - The highest severity level the event escalation action catches.
Acceptable values are: 1 Debug, 2 Informational, 3 Authorization, 4 Warning, 5

Error, 6 Critical, and 7 Bug.
minseveritylevel - The lowest severity level the event escalation action catches.

RETURN VALUES
/opt/pdcli/calls # ./pdcreateeventescalation --eventtype=0 --bindid=1
--escalationactionid=1 --minseveritylevel=1 --maxseveritylevel=4
Bound the action to the agent/storagepool.

SEE ALSO
43
44

pdcreategroup
pdcreategroup
pdcreategroup Creates a new group that is used to organize users with the same
permissions.
SYNOPSIS
pdcreategroup --name=string [--description=string]
DESCRIPTION
This command creates a new group that is used to organize users with the same
permissions.
PARAMETERS
description - 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 ALSO
pddeletegroup
pdgetgroup
pdlistgroup
pdsetgroup

pdcreatelocation
pdcreatelocation
pdcreatelocation Creates a new logical grouping for one or more agents.
SYNOPSIS
pdcreatelocation --name=string [--address=string]
[--description=string]
DESCRIPTION
This command creates a new logical grouping for one or more agents.
PARAMETERS
address - The address that is associated with the location. That can be a physical
address 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 ALSO
pdcreatedepartment
pddeletelocation
pdgetlocation
pdlistlocation
pdsetlocation
45
46

pdcreatembgarbagecollectionpolicy Creates a new metabase garbage collection
policy.
SYNOPSIS
pdcreatembgarbagecollectionpolicy --dsfind=string --name=string
--schedule=string [--enabled=01] [--enableextensivecleanup=number]
[--errorescalationperiod=number] [--logdeletedrecords=01]
DESCRIPTION
This command creates a new metabase garbage collection policy.
PARAMETERS
That determines which data selections a certain policy uses. The syntax for the
dsfind parameter is <identifier>=<value>. Separate multiple identifiers with
a comma. Supported dsfind values are as follows:
ID.
name - The name of the policy.

February.
enabled - - Use of this parameter enables the policy. Acceptable values are 0 (zero),

enableextensivecleanup - This parameter is used to enable and disable more
extensive cleanup during the metabase garbage collection. During normal cleanup,
only dereferenced file names are removed. When this parameter is enabled, the
policy also attempts to remove expired file names. Acceptable values for this
parameter are 0 (zero), disabled, and 1 (one), enabled. The default value is 0.
47
48

logdeletedrecords - When this parameter is enabled, PureDisk keeps the history
on the metabase garbage collection policies. The acceptable values for this
parameter are zero (0 - disabled) and one (1 - enabled). The default value is 0.
warns that a job has been running for more than the specified warning 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 ALSO

pdcreatepolicyescalation Creates a new policy escalation.
SYNOPSIS
pdcreatepolicyescalation --escalationactionid=number --policyid=number
DESCRIPTION
This command creates a new policy escalation.
PARAMETERS
escalationactionid - The escalation action identifier. When a policy escalation
action is created using the pdcreatepolicyescalationaction command an

identifier is created. You can use pdlistpolicyescalationaction to get a list of
all the policyescalation actions.
policyid - The policy identifier.
RETURN VALUES
/opt/pdcli/calls # ./pdcreatepolicyescalation --policyid=105
--escalationactionid=1
Bound the action to the policy.
SEE ALSO
49
50

pdcreatepolicyescalationaction Creates a new policy escalation action.
SYNOPSIS
pdcreatepolicyescalationaction --description=string
--emailalarm=string [--createevent=01] [--emailwarning=string]
[--eventseveritylevel=number] [--message=string]
DESCRIPTION
This command creates a new policy escalation action.
PARAMETERS
description - Description of the policy escalation action.
emailalarm - The email address that is used for sending an email when a policy
escalation occurs and the error escalation time for a policy is expired.
createevent - This parameter instructs PureDisk to send an event if the job has
reached its expiration date. Acceptable values are 0 (zero) - do not 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 policy
escalation occurs and the warning escalation time for a policy is expired.
eventseveritylevel - Defines the severity level for the newly created policy
escalation action. The levels are: 1 Debug, 2 Informational, 3 Authorization, 4

Warning, 5 Error, 6 Critical, and 7 Bug. Acceptable values for eventseveritylevel
are 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 the
text that is emailed when the escalation action is thrown.
RETURN VALUES
/opt/pdcli/calls # ./pdcreatepolicyescalationaction
--description='"Escalation to Emy"'
--emailalarm=emy@company.com --eventseveritylevel=5
Created a policy escalation action with the following properties:
_________________________________________________________________
The action identifier is 1.

51
The description is Escalation to Emy.

If a policy reaches the error escalation timeout an email message is sent t
When it reaches the warning escalation timeout an email message is sent to e
SEE ALSO
52

pdcreatereplicationpolicy Creates a new replication policy.
SYNOPSIS
pdcreatereplicationpolicy --dsfind=string --name=string
--remoteaddress=string --remotelogin=string --remotepwd=string
--schedule=string [--bandwidth=number] [--crport=number]
[--enabled=01] [--errorescalationperiod=number] [--forcecrypt=number]
[--endtime=number] [--starttime=number] [--mbfindfile=string]
[--typeofrep=number] [--warningescalationperiod=number]
DESCRIPTION
This command creates a new replication policy.
PARAMETERS
ID.
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.

February.
a policy uses.
crport - The port number that the content router uses for backup and restore
operations.
enabled - Specifies whether the policy is created in an enabled (default) or disabled
state. Specify --enabled=0 to create a policy in a disabled state.
53
54

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

this object.
Both the fromregistertime and toregistertime parameters also allow for
the following input where # is a number. For example, -24d means 24 days
ago.

name - The name of the replication policy.

starttime - The time when the job window starts. This value is specified in hours
typeofrep - The type of replication to perform. Values are either 0 (zero), full, or
1 (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 ALSO
55
56

pdcreateSMTPeventescalationaction Creates an SMTP event escalation action.
SYNOPSIS
pdcreateSMTPeventescalationaction --description=string
--emailaddress=string [--message=string] --subject=string
DESCRIPTION
This command creates an SMTP event escalation action.
PARAMETERS
Note: The text of the parameter needs to be enclosed in quotation marks if the
text includes spaces. Precede special symbols in arguments with an escape
character. 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 is
emailed when the escalation action is detected.

subject - The subject of the email message the escalation action sends.
RETURN VALUES
/opt/pdcli/calls # pdcreateSMTPeventescalationaction
--emailaddress=email@company.com
--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.

Message: PureDisk has encountered a problem.

Email address: email@company.com.
SEE ALSO
57
58

pdcreateSNMPeventescalationaction Creates an SNMP event escalation action.
SYNOPSIS
pdcreateSNMPeventescalationaction --address='string'
--community=string --description='string'
DESCRIPTION
This command creates an SNMP event escalation action. To send event by using
SNMP, make sure that you have configured and enabled the SNMP software. For
more information, see the PureDisk Backup Operator's Guide.
PARAMETERS
address - The SNMP address that is associated with the escalation action. This
parameter must be enclosed in apostrophes.

community - The group of devices and management stations running SNMP.
description - The description of the event escalation action. This parameter
must 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.

SEE ALSO
59
60

pdcreateuser
pdcreateuser
pdcreateuser Creates a new user within PureDisk that can be assigned rights
and permissions.
SYNOPSIS
pdcreateuser --departmentid=number --locationid=number --login=string
--name=string --pwd=string [--description=string] [--email=string]
[--mobile=string] [--telephone=string]
DESCRIPTION
This command creates a new user within PureDisk that can be assigned rights
and 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 each
user.
mobile - The mobile telephone number of a user.
telephone - The telephone number for a user.

pdcreateuser
61
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 ALSO
pddeleteuser
pdgetuser
pdlistuser
pdlogonuser
pdsetuser
62

pddeactivateagent
pddeactivateagent
pddeactivateagent Deactivates the agent software on a client computer so it
is no longer backed up by active PureDisk policies.
SYNOPSIS
pddeactivateagent --id=number
DESCRIPTION
This command deactivates the agent software on a client computer so it is no
longer backed up by active PureDisk policies.
PARAMETERS
id - The ID number for the agent you want to deactivate.
RETURN VALUES
/opt/pdcli/calls # ./pddeactivateagent --id=2
Deactivated the agent.
SEE ALSO
pddeactivateagent
pddeleteagent
pdgetagent
pdlistagent
pdsetagent

pddeleteagent
pddeleteagent
pddeleteagent Deletes the agent from the PureDisk database.
SYNOPSIS
pddeleteagent --id=number [--noconfirm=1]
DESCRIPTION
This command deletes an agent from the PureDisk database.
Warning: An agent's backups cannot be recovered once an agent is deleted. Use
caution when deleting agents.
PARAMETERS
id - 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 ALSO
pdactivateagent
pddeactivateagent
pdgetagent
pdlistagent
pdsetagent
63
64

pddeletedepartment
pddeletedepartment
pddeletedepartment Deletes a department from the storage pool authority
(SPA).
SYNOPSIS
pddeletedepartment --id=number
DESCRIPTION
This command deletes a department from the storage pool authority.
PARAMETERS
id - The ID for the department you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeletedepartment --id=2
Deleted the department.
SEE ALSO
pdcreatedepartment
pdgetdepartment
pdlistdepartment
pdsetdepartment

pddeleteds
pddeleteds
pddeleteds Deletes a data selection from a PureDisk policy.
SYNOPSIS
pddeleteds --id=number [--noconfirm=1]
DESCRIPTION
This command deletes a data selection from a PureDisk policy.
Warning: The backups of a data selection cannot be recovered once a data selection
is deleted. Use caution when deleting data selections.
PARAMETERS
id - The ID for the data selection you want to delete.
noconfirm - When you delete a data selection, you are prompted to confirm the
delete. If --noconfirm=1 is specified, the confirmation prompt is suppressed.
RETURN VALUES
This command has no return value. Unless the command is entered incorrectly.
SEE ALSO
pdcreateds
pdgetds
pdlistds
pdsetds
65
66

pddeletedstemplate
pddeletedstemplate
pddeletedstemplate Deletes a data selection template.
SYNOPSIS
pddeletedstemplate --id=number
DESCRIPTION
This command deletes a data selection template.
PARAMETERS
id - The ID for the data selection template you want to delete.
RETURN VALUES
This command has no return value. Unless the command is entered incorrectly.
SEE ALSO
pdcreatedstemplate
pdgetdstemplate
pdlistdstemplate
pdsetdstemplate

67
pddeleteeventescalation Unbinds an event escalation action from the agent
or the storage pool.
SYNOPSIS
pddeleteeventescalation --id=number --escalationtype=0|1
DESCRIPTION
This command unbinds an event escalation action from the agent or the storage
pool.
PARAMETERS
id - The ID for the agent escalation action or the storage pool escalation action
you want to delete.

escalationtype - Specifies if the event escalation is an agent (1) or storage pool
escalation (0).
RETURN VALUES
/opt/pdcli/calls # ./pddeleteeventescalation --id=3 --escalationtype=0
Unbound the action to the agent/storagepool.
SEE ALSO
68

pddeleteeventescalationaction Deletes an SMTP or an SNMP action.
SYNOPSIS
pddeleteeventescalationaction --id=number
DESCRIPTION
This command deletes an SMTP or an SNMP action.
PARAMETERS
id - 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.
SEE ALSO

pddeletegroup
pddeletegroup
pddeletegroup Deletes a user group from the storage pool authority.
SYNOPSIS
pddeletegroup --name=string
DESCRIPTION
This command deletes a user group from the storage pool authority (SPA).
PARAMETERS
name - The ID for the user group that you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeletegroup --name=Backup_Admin
Deleted the group.
SEE ALSO
pdcreategroup
pdgetgroup
pdlistgroup
69
70

pddeletejob
pddeletejob
pddeletejob 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 in

a running, queued, or running_hold state, the command attempts to stop the job,
but does not delete the job.
SYNOPSIS
pddeletejob --id=number
DESCRIPTION
This 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) then
the command deletes the job.
PARAMETERS
id - The ID of the job that you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeletejob --id=20
Deleted the job.
SEE ALSO
pdgetjob
pdgetjobstat
pdlistjob

pddeletelicense
pddeletelicense
pddeletelicense Deletes a license key.
SYNOPSIS
pddeletelicense --key=string
DESCRIPTION
This command deletes a license key.
PARAMETERS
key - The alphanumeric license key you want to delete.
RETURN VALUES
This 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 ALSO
pdgetlicense
pdlistlicense
pdsetlicense
pdstatlicensing
71
72

pddeletelocation
pddeletelocation
pddeletelocation Deletes a location from the storage pool authority (SPA).
SYNOPSIS
pddeletelocation --id=number
DESCRIPTION
This command deletes a location from the storage pool authority (SPA).
PARAMETERS
id - The ID for the location you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeletelocation --id=2
Deleted the location.
SEE ALSO
pdcreatelocation
pdgetlocation
pdlistlocation
pdsetlocation

pddeletepolicy
pddeletepolicy
pddeletepolicy Deletes a policy.
SYNOPSIS
pddeletepolicy --id=number
DESCRIPTION
This command deletes a policy.
PARAMETERS
id - The ID for the policy you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeletepolicy --id=103
Deleted the policy.
SEE ALSO
pdcreatepolicy
pdgetpolicy
pdlistpolicy
pdsetpolicy
73
74

pddeletepolicyescalation Deletes a policy escalation that is linked to a policy.
SYNOPSIS
pddeletepolicyescalation --policyid=number --escalationactionid=number
DESCRIPTION
This command deletes a policy escalation that is linked to a policy
PARAMETERS
policyid - The policy identifier.
RETURN VALUES
/opt/pdcli/calls # ./pddeletepolicyescalation --policyid=10
--escalationactionid=2
Unlinked the policy escalation.
SEE ALSO
pdsetpolicyescalation

pddeletepolicyescalationaction Deletes a policy escalation action.
SYNOPSIS
pddeletepolicyescalationaction --id=number
DESCRIPTION
This command deletes a policy escalation action.
PARAMETERS
id - The ID of the policy escalation action that you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeletepolicyescalationaction --id=1
Deleted the action.
SEE ALSO
75
76

pddeleteuser
pddeleteuser
pddeleteuser Deletes a user from the storage pool authority.
SYNOPSIS
pddeleteuser --name=string
DESCRIPTION
This command deletes a user from the storage pool authority.
PARAMETERS
Note: If the text for the name parameter include spaces, the text needs to be
enclosed in quotation marks. Precede special symbols in arguments with an escape
name - The name of the user you want to delete.
RETURN VALUES
/opt/pdcli/calls # ./pddeleteuser --name='"John Smith"'
Deleted the user.
SEE ALSO
pdcreateuser
pdgetuser
pdlistuser
pdlogonuser
pdsetuser

pdexit
pdexit
pdexit Removes any locally saved credentials.
SYNOPSIS
pdexit
DESCRIPTION
This command removes any locally saved credentials.
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdexit
Cached user data cleared.
SEE ALSO
pdlogonuser
77
78

pdexport2nbu
pdexport2nbu
pdexport2nbu Exports a data selection to a NetBackup file list for use with a
NetBackup policy.
SYNOPSIS
pdexport2nbu --id=number --nbugatewayid=string --nbupolicyname=string
--pointintime=string
DESCRIPTION
This command exports a data selection to a NetBackup file list for use with a
NetBackup policy.
PARAMETERS
dsid - The ID for the data selection that you want to export to NetBackup.
nbugatewayid - The NetBackup gateway identifier.
To retrieve the NetBackup gateway information
Log into the PureDisk administrative Web UI.
Select the Settings > Topology tab.
In the left pane, expand tree view and click the NBU Export Engine node.
The right pane, under Properties: NBU Export Engine, use the Agent Owner
value for the nbugatewayid argument.
nbupolicyname - The policy name in NetBackup configured to receive the data
selection information.
pointintime - Seconds since epoch to indicate the point in time. The seconds
since epoch time for a point in time of 10:00 P.M. on January 25, 2009 is
1232920800.
RETURN VALUES
This command has no return value unless the command is entered incorrectly.
SEE ALSO
N/A

pdfindfiles
pdfindfiles
pdfindfiles Used to find the files that have been backed up.
SYNOPSIS
pdfindfiles --dsfind=string --mbfindfile=string [--restorepwd=string]
[--offset=string]
DESCRIPTION
This command is used to find the files that have been backed up.
PARAMETERS
ID.
mbfindfile - - The file name of the file containing the metadata filters used to
find files. The file this parameter specifies contains one or more filters that help
dirname: The directory location of the object. That is specified as an absolute
path
79
80

pdfindfiles

this object.
ago.
offset - The number of records to skip in the find file process. To avoid displaying
too many records, the number of records that is shown is limited to the first 1024.
To view records beyond the first 1024, the offset parameter is used. Offset indicates
to 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

pdfindfiles
SEE ALSO
N/A
81
82

pdgetagent
pdgetagent
pdgetagent Provides additional information about the agent object specified.
SYNOPSIS
pdgetagent --id=number
DESCRIPTION
This command provides additional information about the agent object specified.
PARAMETERS
id - 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.
SEE ALSO
pdactivateagent
pddeactivateagent
pddeleteagent
pdlistagent
pdsetagent

pdgetdepartment
pdgetdepartment
pdgetdepartment Provides additional information about the department
specified.
SYNOPSIS
pdgetdepartment --id=number
DESCRIPTION
This command provides additional information about the department object
specified.
PARAMETERS
id - 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 .
SEE ALSO
pdcreatedepartment
pddeletedepartment
pdlistdepartment
pdsetdepartment
83
84

pdgetds
pdgetds
pdgetds Provides additional information about the data selection specified.
SYNOPSIS
pdgetds --id=number
DESCRIPTION
This command provides additional information about the data selection object
specified.
PARAMETERS
id - 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 ALSO
pdcreateds
pddeleteds
pdlistds
pdsetds

pdgetdstemplate
pdgetdstemplate
pdgetdstemplate Provides information about the data selection template
specified.
SYNOPSIS
pdgetdstemplate --id=number
DESCRIPTION
This command provides information about the data selection template specified.
PARAMETERS
id - 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/*.
SEE ALSO
pdcreatedstemplate
pddeletedstemplate
pdlistdstemplate
pdsetdstemplate
85
86

pdgeteventescalation Provides information about the event escalation
specified.
SYNOPSIS
pdgeteventescalation --id=number --escalationtype=number
DESCRIPTION
This command provides information about the event escalation specified.
PARAMETERS
id - The ID number of the event escalation.
escalationtype - Specifies if the event escalation is an agent (1) or storage pool
escalation (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.
SEE ALSO

pdgeteventescalationaction Provides information about the event escalation
action specified.
SYNOPSIS
pdgeteventescalationaction --id=number
DESCRIPTION
This command provides information about the event escalation action specified.
PARAMETERS
id - 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.
SEE ALSO
87
88

pdgetgroup
pdgetgroup
pdgetgroup Provides additional information about the group specified.
SYNOPSIS
pdgetgroup --name=string
DESCRIPTION
This command provides additional information about the group specified.
PARAMETERS
name - 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).
SEE ALSO
pdcreategroup
pddeletegroup
pdlistgroup
pdsetgroup

pdgetjob
pdgetjob
pdgetjob Provides additional information about the job specified.
SYNOPSIS
pdgetjob --id=number
DESCRIPTION
This command provides additional information about the job specified.
PARAMETERS
id - 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.
89
90

pdgetjob
SEE ALSO
pddeletejob
pdgetjobstat
pdlistjob

pdgetjobstat
pdgetjobstat
pdgetjobstat Retrieves the job statistics from the PureDisk database.
SYNOPSIS
pdgetjobstat --id=number
DESCRIPTION
This command retrieves the job statistics from the PureDisk database.
PARAMETERS
id - (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.
91
92

pdgetjobstat
statistics_source_files_with_error = 0.
statistics_unique_bytes_backed_up = 30825914.
statistics_unique_files_backed_up = 2310.
OTHER
Please 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, do
not have statistics. See the PureDisk Administrator's Guide for information about
job statistics and how to interpret them.
SEE ALSO
pddeletejob
pdgetjob
pdlistjob

pdgetjobsteps
93
pdgetjobsteps
pdgetjobsteps Used to list the steps that are associated with the specified job.
SYNOPSIS
pdgetjobsteps --id=number
DESCRIPTION
The command is used to list all steps that are associated with any job.
PARAMETERS
id - The job identifier for the job being reviewed.
RETURN VALUES
pdgetjobsteps --id=1
The job has the following jobsteps:

_______________________________________
agentId = 1000000.
jobId = 1.
log =
[2009-Mar-28
[2009-Mar-28
[2009-Mar-28
[2009-Mar-28
[2009-Mar-28
00:00:04
00:00:04
00:00:04
00:00:05
00:00:05
CET] *** Start: CRProcessQueue ***

CET]Start CR Queue Processing
CET] command: /opt/pdcr/bin/crcontrol --processqueue
CET]OK
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
94

pdgetjobsteps
starttimejobstep
endtimejobstep
workflowstepname
status
=
=
=
=
March 28, 2009, 12:00 am

March 28, 2009, 12:05 am
Process Queue
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 ALSO
pddeletejob
pdgetjob
pdgetjobstat
pdlistjob

pdgetlicense
pdgetlicense
pdgetlicense Collects information about the specified license key.
SYNOPSIS
pdgetlicense --key=string
DESCRIPTION
This command collects information about the specified license key.
PARAMETERS
key - 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 ALSO
pddeletelicense
pdlistlicense
pdsetlicense
pdstatlicensing
95
96

pdgetlocation
pdgetlocation
pdgetlocation Provides additional information about the location specified.
SYNOPSIS
pdgetlocation --id=number
DESCRIPTION
This command provides additional information about the location specified.
PARAMETERS
id - 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'.
SEE ALSO
pdcreatelocation
pddeletelocation
pdlistlocation
pdsetlocation

pdgetpolicy
pdgetpolicy
pdgetpolicy Provides additional information about the policy specified.
SYNOPSIS
pdgetpolicy --id=number
DESCRIPTION
This command provides additional information about the policy specified.
PARAMETERS
id - 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.
The following
vacuumCA =
vacuumMB =
vacuumCRDB
policy specific parameters were found:

1.
1.
= 1.
SEE ALSO
pddeletepolicy
pdlistpolicy
97
98

pdgetpolicyescalation Provides information about the policy escalation.
SYNOPSIS
pdgetpolicyescalation --id=number
DESCRIPTION
Every policy can have a policy escalation attached to it. This command provides
information about the escalation.
PARAMETERS
id - 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.
SEE ALSO

pdgetpolicyescalationaction Provides information about the policy escalation
action.
SYNOPSIS
pdgetpolicyescalationaction --id=number
DESCRIPTION
This command provides information about the policy escalation action.
PARAMETERS
id - 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 emy@company.com.
When it reaches the warning escalation timeout an email message is
SEE ALSO
pslistpolicyescalationaction
99
100

pdgetstoragepool
pdgetstoragepool
pdgetstoragepool Provides information about the storage pool.
SYNOPSIS
pdgetstoragepool
DESCRIPTION
This command provides information about the storage pool.
PARAMETERS
N/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 ALSO
pdsetstoragepool

pdgetuser
pdgetuser
pdgetuser Provides information about the user specified.
SYNOPSIS
pdgetuser --name=string
DESCRIPTION
This command provides information about the specified user.
PARAMETERS
Note: If the text for the name parameter includes spaces, the text needs to be
enclosed in quotation marks. Precede special symbols in arguments with an escape
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.
SEE ALSO
pdcreateuser
pddeleteuser
pdlistuser
101
102

pdgetuser
pdlogonuser
pdsetuser

pdlistagent
pdlistagent
pdlistagent Displays all agents that are associated with a particular PureDisk
storage pool.
SYNOPSIS
pdlistagent
DESCRIPTION
This command displays all agents that are associated with a particular PureDisk
storage pool.
PARAMETERS
N/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 ()
SEE ALSO
pdactivateagent
pddeactivateagent
pddeleteagent
pdgetagent
pdsetagent
103
104

pdlistdepartment
pdlistdepartment
pdlistdepartment Displays all departments that are associated with a particular
PureDisk storage pool.
SYNOPSIS
pdlistdepartment
DESCRIPTION
This command displays all departments that are associated with a particular
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdlistdepartment
The following departments have been found:
name (id):
-------------- Testing (3)
- Support (2)
- Default department (1)
- Unknown department ()
SEE ALSO
pdcreatedepartment
pddeletedepartment
pdgetdepartment
pdsetdepartment

pdlistds
pdlistds
pdlistds Displays all data selections that are associated with a particular
SYNOPSIS
pdlistds
DESCRIPTION
This command displays all data selections that are associated with a particular
PARAMETERS
N/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 ALSO
pdcreateds
pddeleteds
pdgetds
pdsetds
105
106

pdlistdstemplate
pdlistdstemplate
pdlistdstemplate Displays all the data selection templates that are associated
with a particular PureDisk storage pool.
SYNOPSIS
pdlistdstemplate
DESCRIPTION
This command displays a listing of all the data selection templates that are
associated with a particular PureDisk storage pool.
PARAMETERS
N/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)
SEE ALSO
pdcreatedstemplate
pddeletedstemplate
pdgetdstemplate
pdsetdstemplate

pdlistevent
pdlistevent
pdlistevent Displays all events that are associated with a particular PureDisk
storage pool.
SYNOPSIS
pdlistevent
DESCRIPTION
This command displays all events that are associated with a particular PureDisk
storage pool.
PARAMETERS
N/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 ALSO
N/A
107
108

pdlisteventescalation Displays all the event escalations that are associated
SYNOPSIS
DESCRIPTION
This command displays a list of all event escalations that are associated with a
particular PureDisk storage pool.
PARAMETERS
N/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.
SEE ALSO

pdlisteventescalationaction Displays a list of all the event escalation actions
that are associated with a particular PureDisk storage pool.
SYNOPSIS
DESCRIPTION
This command displays a list of all the event escalation actions that are associated
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdlisteventescalationaction
The following actions have been found:
name (id):
-------------- SNMP action (2)
- A problem occurred on slowpoke (1)
SEE ALSO
109
110

pdlistgroup
pdlistgroup
pdlistgroup Displays all the user groups that are associated with a particular
SYNOPSIS
pdlistgroup
DESCRIPTION
This command displays all the user groups that are associated with a particular
PARAMETERS
N/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)
SEE ALSO
pdcreategroup
pddeletegroup
pdgetgroup
pdsetgroup

pdlistjob
pdlistjob
pdlistjob Displays all jobs that are associated with a particular PureDisk storage
pool.
SYNOPSIS
pdlistjob
DESCRIPTION
This command displays all jobs that are associated with a particular PureDisk
storage pool.
PARAMETERS
N/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 ALSO
pddeletejob
pdgetjob
pdgetjobstat
111
112

pdlistlicense
pdlistlicense
pdlistlicense Displays all the installed license keys that are associated with
a particular PureDisk storage pool.
SYNOPSIS
pdlistlicense
DESCRIPTION
This command displays all the installed license keys that are associated with a
particular PureDisk storage pool.
PARAMETERS
N/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.
SEE ALSO
pddeletelicense
pdgetlicense
pdsetlicense
pdstatlicensing

pdlistlocation
pdlistlocation
pdlistlocation Displays all the locations that are associated with a particular
SYNOPSIS
pdlistlocation
DESCRIPTION
This command displays all the locations that are associated with a particular
PARAMETERS
N/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 is
installed. If a location is not specified when an agent is installed, PureDisk places
the 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.
SEE ALSO
pdcreatelocation
pddeletelocation
pdgetlocation
pdsetlocation
113
114

pdlistpolicy
pdlistpolicy
pdlistpolicy Displays all the policies that are associated with a particular
SYNOPSIS
pdlistpolicy
DESCRIPTION
This command displays all the policies that are associated with a particular
PARAMETERS
N/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)

pdlistpolicy
- System policy for Maintenance (8)

- System policy for full DR Backup (7)
- System policy for Rerouting (5)
SEE ALSO
pdgetpolicy
115
116

pdlistpolicyescalation Displays the policy escalations that are attached to
all policies.
SYNOPSIS
DESCRIPTION
This command displays the policy escalations that are attached to all policies.
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdlistpolicyescalation
The following escalations have been found:
id - action id - policy id.
1 - 1 - 105
SEE ALSO

pdlistpolicyescalationaction Displays all the actions that are attached to
all policies.
SYNOPSIS
DESCRIPTION
This command displays all the actions that are attached to all policies.
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdlistpolicyescalationaction
The following policy escalation actions have been found:
id - description - email
1 - Escalation to Emy - emy@company.com
SEE ALSO
117
118

pdlistuser
pdlistuser
pdlistuser Displays all the users that are associated with a particular PureDisk
storage pool.
SYNOPSIS
pdlistuser
DESCRIPTION
This command displays all the users that are associated with a particular PureDisk
storage pool.
PARAMETERS
N/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)
SEE ALSO
pdcreateuser
pddeleteuser
pdgetuser
pdlogonuser
pdsetuser

pdlogonuser
pdlogonuser
pdlogonuser Saves the credentials locally to avoid interaction during calls.
SYNOPSIS
pdlogonuser
DESCRIPTION
This command saves the credentials locally to avoid interaction during calls.
You can use the pdlogonuser command in scripting activities. Use pdlogonuser
to eliminate prompts for user name and password before each command that is
executed in a script.
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdlogonuser
Please insert the login credentials:
username: root
password:
/opt/pdcli/calls #
SEE ALSO
pdcreateuser
pddeleteuser
pdexit
pdgetuser
pdlistuser
pdsetuser
119
120

pdpasswd
pdpasswd
pdpasswd Used to set or change a user password.
SYNOPSIS
pdpasswd --name=string [--oldpwd=string] [--newpwd=string]
DESCRIPTION
This 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 it
includes 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 VALUES
Example 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.

pdpasswd
SEE ALSO
pdcreateuser
pdsetuser
121
122

pdrestore
pdrestore
pdrestore Start a restore job from the specified parameters.
SYNOPSIS
pdrestore --agentid=number [--destination=string]
[--destinationagent=number] [--dsid=number] [--maxstreams=number]
[--mbfindfile=string] [--overwrite_junction_symlink=number]
[--restore_overwrite=number] [--restorecommonroot=number]
[--restorepwd=string]
DESCRIPTION
This command starts a restore job from the specified parameters.
PARAMETERS
agentid - (Required) Agent identifier.
destination - The destination directory for the files being restored. The default
is the original location.

destinationagent - The agent to receive the restored files. By default, it is the
agent that backed up the files. Use the pdlistagent command to for a list of agent
identifiers 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 with
restores. If this parameter is not specified, PureDisk defaults to a toregistertime

of the current time, and selects all directories and files.
The file this parameter specifies contains one or more filters that help determine
what file or files are selected. The filters consist of an mbfind field and its
associated value. An example of an mbfile file is located in
Supported mbfind fields are as follows:

pdrestore

this object.
ago.
restorepwd - The data lock password that is used for the restore.
overwrite_junction_symlink - This allows the restore to overwrite symbolic
links with the same name during restore operations. Specifying 0 enables the
overwrite (default) and 1 prevents the link from being overwritten.
restore_overwrite - This causes the restore to overwrite an existing file with
the 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 0
indicates the restore should not restore the shared directory structure. Specifying
1 indicates the restore should restore the shared directory structure (default).
RETURN VALUES
/opt/pdcli/calls # ./pdrestore --agentid=2
--mbfindfile=/opt/pdcli/defaultMBFind.dat
123
124

pdrestore

____________________________________________________________
It has run for the workflow: Files and Folders Restore.
pdrunpolicy --policyid=105
1 Job(s) started.
SEE ALSO
pdbackup

pdrunpolicy
pdrunpolicy
pdrunpolicy Runs the specified policy.
SYNOPSIS
pdrunpolicy --id=number
DESCRIPTION
This command runs the specified policy.
PARAMETERS
id (Required) - The policy identifier
RETURN VALUES
/opt/pdcli/calls # ./pdrunpolicy --id=102
1 Job(s) started.
SEE ALSO
pddeletepolicy
pdgetpolicy
pdlistpolicy
pdsetpolicy
125
126

pdsetagent
pdsetagent
pdsetagent Changes and updates the details that are associated with an existing
agent.
SYNOPSIS
pdsetagent --id=number [--hostname=string] [--locationid=number]
[--departmentid=number] [--description=string]
DESCRIPTION
This command changes and updates the details that are associated with an existing
agent.
PARAMETERS
id - 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.

pdsetagent
SEE ALSO
pdactivateagent
pddeactivateagent
pddeleteagent
pdgetagent
pdlistagent
127
128

pdsetbackuppolicy
pdsetbackuppolicy
pdsetbackuppolicy Change the parameters of an existing backup policy.
SYNOPSIS
pdsetbackuppolicy --id=number [--backupacl=number]
[--bandwidth=number] [--changeaccesstime=01] [--changedetection=01]
[--compress=number] [--dsfind=string] [--enabled=01]
[--encrypt=number] [--endtime=number] [--endupload=number]
[--errorescalationperiod=number] [--includenetworkshares=01]
[--leavearchivebit=number] [--name=string] [--nrbackupstreams=number]
[--postscript=string] [--prescript=string] [--retryverify=01]
[--runpostonerr=number] [--schedule=string] [--segmentsize=number]
[--sort=string] [--starttime=number] [--usesnapshot=number]
[--verifylevel=number] [--warningescalationperiod=number]
DESCRIPTION
This command changes the parameters of an existing backup policy.
PARAMETERS
backupacl - Allows the user to choose to back up the access control list
information. If backupacl is set to "0", the ACL is not backed up. If backupacl is
set to "1", the list is backed up. The default value is 0.
in kilobytes per second (kb/sec). This option limits the bandwidth the policy uses.
files 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) - do
not compress or 1 (one) - compress. The default value is 0.


pdsetbackuppolicy
ID.


operations are stopped. The three major steps in a backup are: scanning for files,
halted.
id The ID for a backup policy.
network shares in a backup. Acceptable values are 0 (zero - do not include network
shares) and 1 (one - include network shares). The default value is 0.
129
130

pdsetbackuppolicy
archive 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 value
for that is 1.
postscript - The user-defined script that PureDisk should run at the end of a
policy.
prescript - The user-defined script that PureDisk should run at the start of a
policy.
if it fails. Acceptable values are 0 (zero), disabled, and 1 (one), enabled. The default
value is 0.
runpostonerr - When this option is set and the job fails, the script that is defined
in the postscript parameter is run at the end of the policy. The values for this
parameter are 0 (do not run the script) and 1 (run the script). The default value
is 0.

pdsetbackuppolicy
February.
kbytes.
first. Acceptable parameters are "" (or empty), do not sort, size, sort by size, and
dirname,size, sort by directory with the smallest files first. By default the backup
is not sorted.
technology (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.
values are 1 (no verification), 2 (confirm the file exists on the content router), 3
131
132

pdsetbackuppolicy
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 ALSO
pdsetbackuppolicy

pdsetcrgarbagecollectionpolicy Change the parameters of the content router
garbage collection policy.
SYNOPSIS
pdsetcrgarbagecollectionpolicy [--enabled=01]
[--errorescalationperiod=number] [--name=string] [--schedule=string]
DESCRIPTION
This command changes the parameters of the content router garbage collection
policy. Pdsetcrgarbagecollectionpolicy is a system policy, so there is only one
policy of this type.
PARAMETERS

name - The name of the garbage collection policy.
133
134


February.
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.


SEE ALSO
N/A
135
136

pdsetdatalock
pdsetdatalock
pdsetdatalock Resets the data lock password.
SYNOPSIS
pdsetdatalock --agentid=number --oldpwd=string --newpwd=string
DESCRIPTION
This command resets the data lock password.
PARAMETERS
agentid - 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 ALSO
N/A

pdsetdataminingpolicy Change the parameters of the data mining policy.
SYNOPSIS
pdsetdataminingpolicy [--enabled=0|1] [--errorescalationperiod=number]
[--full=0|1] [--name=string] [--schedule=string]
DESCRIPTION
This command changes the parameters of the data mining policy.
Pdsetdataminingpolicy is a system policy, so there is only one policy of this type.
PARAMETERS

the period of time (specified in minutes) after which an email is sent. That indicates
a job has been running for more than the specified error time frame. Additionally,
the backup job is stopped.
full - When enabled, this forces PureDisk do perform a full data mining operation.
Values for that are zero (not enabled) and 1 (enabled). The default value is 0.
name - The name of the data mining policy.
137
138


February.
is a warning that a job has been running for more than the specified warning time
frame.
RETURN VALUES
/opt/pdcli/calls # ./pdsetdataminingpolicy
Updated the data mining policy with the following properties:
_____________________________________________________________

The policy name: System policy for Data Mining.


full = 0.
SEE ALSO
pdcreatedataminingpolicy
139
140

pdsetdataremovalpolicy Change the parameters of an existing data removal
policy.
SYNOPSIS
pdsetdataremovalpolicy --id=number [--dsfind=string] [--enabled=01]
[--errorescalationperiod=number] [--kmaxnfiles=number]
[--kmaxnfilesdel=number] [--mbfindfile=string] [--name=string]
[--pdel=number] [--pnewer=number] [--registertime=string]
[--schedule=string] [--warningescalationperiod=number]
DESCRIPTION
This command changes the parameters of an existing data removal policy.
PARAMETERS
ID.

the period of time (specified in minutes) after which an email is sent. That indicates
a job has been running for more than the specified error time frame. Additionally,
the backup job is stopped.
id The ID for a data removal policy.

kmaxnfiles - The maximum number of file versions to retain.

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

this object.
ago.
name - The name of the data removal policy.

pdelThe number of days to retain the last version of a file after the file is deleted
from source.
141
142

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

registertime - When a file's metadata is saved into the metadata database, the
time it is saved is recorded. That is considered the registertime. When using

time-based data removal, you can specify what data is selected to be deleted based
on the registration time using the --registertime parameter. The format for
this parameter is seconds since epoch.
February.

is the period of time (specified in minutes) after which an email is sent. That email
warns 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 ALSO
143
144

pdsetdebugagent
pdsetdebugagent
pdsetdebugagent Change the debugging parameters for the agent.
SYNOPSIS
pdsetdebugagent --id=number --debugmode=01
DESCRIPTION
This command changes the debugging parameters for the PureDisk agent.
PARAMETERS
id - 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 job
steps 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, but when
you enable debug mode, PureDisk leaves them in place. For example, you can
enable debug mode to troubleshoot failing jobs for a particular client agent.
Typically, Symantec CFT or technical support requests that you enable this
capability in the storage pool while troubleshooting. Do not enable debug mode
for general use.
RETURN VALUES
/opt/pdcli/calls # ./pdsetdebugagent --id=6 --debugmode=1
The agent debug request has been sent.
SEE ALSO
N/A

pdsetdepartment
pdsetdepartment
pdsetdepartment Changes and updates the details that are associated with an
existing department.
SYNOPSIS
pdsetdepartment --id=number [--description=string] [--name=string]
DESCRIPTION
department.
PARAMETERS
id - 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 .
SEE ALSO
pdcreatedepartment
pddeletedepartment
pdgetdepartment
pdlistdepartment
145
146

pdsetds
pdsetds
pdsetds Changes and updates the details that are associated with an existing
data selection.
SYNOPSIS
pdsetds --id=number [--dsrules=string] [--description=string]
[--name=string] [--ostypeid=number] [--agentid=number]
[--dstype=number] [--originaltemplateid=number]
DESCRIPTION
data selection.
PARAMETERS
id - The ID of the data selection.
dsrules - A comma-separated file that is used on a client for selecting data for
backup. The structure of the file is: path|filename|include (include being 0 to

exclude, 1 to include the files selected). This parameter must 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 types
are 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, 4
DR, 6 Microsoft Exchange, 7 Microsoft SQL, 8 Shadow Copy (system backup), 11

UNC path, 9 NetBackup OST (PDDO), 14 DLO.
originaltemplateid - The data selection template ID for a data selection that
inherits from another data selection template.
RETURN VALUES
/opt/pdcli/calls # ./pdsetds --id=2

pdsetds
The changed data selection has the following properties:

________________________________________________________
The identifier is 2. The name is etc.
file pattern: *.
SEE ALSO
pdcreateds
pddeleteds
pdgetds
pdlistds
147
148

pdsetdsremovalpolicy Change the parameters of the data selection removal
policy.
SYNOPSIS
pdsetdsremovalpolicy [--enabled=01] [--errorescalationperiod=number]
[--name=string] [--schedule=string] [--warningescalationperiod=number]
DESCRIPTION
This command changes the parameters of the data selection removal policy.
PARAMETERS

name - The name of the data selection removal policy.

February.
RETURN VALUES
/opt/pdcli/calls # ./pdsetdsremovalpolicy
The updated DS removal policy has the following properties:
__________________________________________________________
The policy name: System policy for Data Selection Removal.
149
150

SEE ALSO
N/A

pdsetdstemplate
pdsetdstemplate
pdsetdstemplate Changes and updates a data selection template.
SYNOPSIS
pdsetdstemplate --id=number [--dstrules=string] [--description=string]
[--name=string] [--ostypeid=number] [--inheritancemap=string]
DESCRIPTION
This command changes and updates a data selection template.
PARAMETERS
id - The ID for a data selection template.
dstrules - The criteria that is used to determine which files the templates selects.
The criteria is specified as '<path>|<filename>|<include>' (include being 0 to

exclude/ 1 to include). A dstrules parameter of '/etc/*|*|1' would include all
files in the /etc directory. Separate multiple include and exclude rules with
commas.
description - Description of the template.
name - Name of the template.
ostypeid - Used to define the operating system of the data selection. Operating
system 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. The
parameter is specified as --inheritancemap='containerid|containertype'. Separate

multiple IDs and types with commas (--inheritancemap
'containerid|containertype,containerid|containertype'). Acceptable values for
containertype are as follows: Agent = 1, Location = 2, Department = 3, Storage
pool = 4, OS Type = 5. The container ID is found by using the pdlist command
that is associated with the desired container (pdlistagent, pdlistlocation, and
so on).
RETURN VALUES
/opt/pdcli/calls # ./pdsetdstemplate --id=5
151
152

pdsetdstemplate
The updated data selection template has the following properties:

_________________________________________________________________
file pattern: *.
directory pattern: /*.
This following rule excludes:
file pattern: *.
directory pattern: /lib/*.
SEE ALSO
pdcreatedstemplate
pddeletedstemplate
pdgetdstemplate
pdlistdstemplate

pdseteventescalation Updates an event escalation.
SYNOPSIS
pdseteventescalation --id=number --escalationactionid=number
--eventtype=number --maxseveritylevel=number --minseveritylevel=number
DESCRIPTION
This command updates an event escalation.
PARAMETERS
id - The identifier of the event escalation.
eventtype - The type of event escalation action that is created. The two types of
event escalation actions are: an agent event escalation (denoted by the number
1) and a storage pool event escalation (denoted by the number 0).
maxseveritylevel - The highest severity level the event escalation action catches.

minseveritylevel - The lowest severity level the event escalation action catches.

RETURN VALUES
/opt/pdcli/calls # ./pdseteventescalation --id=1 --escalationtype=1
Successfully updated the escalation.
SEE ALSO
153
154

pdseteventescalationaction Change the parameters of an existing escalation
action.
SYNOPSIS
pdseteventescalationaction --id=number [--address=string]
[--community=string] [--description=string] [--message=string]
[--subject=string]
DESCRIPTION
This command changes the parameters of an existing escalation action. To send
event by using SNMP, make sure that you have configured and enabled the SNMP
software. For more information, see the PureDisk Backup Operator's Guide.
PARAMETERS
address - The email address to which the event escalation action should send a
message.
community - The group of devices and management stations running SNMP.
id (Required) - Generic identifier type.
text 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 = den@h.c.
id = 1.
message =
modDate = 1225119315.
subject = subj.

SEE ALSO
pdcreateeventescalationaction
155
156

pdsetgroup
pdsetgroup
pdsetgroup Changes and updates the details that are associated with an existing
user group.
SYNOPSIS
pdsetgroup --name=string [--description=string] [--newname=string]
DESCRIPTION
user 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).
SEE ALSO
pdcreategroup
pddeletegroup
pdgetgroup
pdlistgroup

pdsetlicense
pdsetlicense
pdsetlicense Adds a license key.
SYNOPSIS
pdsetlicense --key=string
DESCRIPTION
This command adds a license key.
PARAMETERS
key - The alphanumeric PureDisk license key.
RETURN VALUES
The command has no return value unless it is entered incorrectly.
SEE ALSO
pddeletelicense
pdgetlicense
pdlistlicense
pdstatlicensing
157
158

pdsetlocation
pdsetlocation
pdsetlocation Changes and updates the details that are associated with an
existing location.
SYNOPSIS
pdsetlocation --id=number [--address=string] [--description=string]
[--name=string]
DESCRIPTION
location.
PARAMETERS
id - 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 is
installed. If a location is not specified when the agent is installed, PureDisk places
the 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.
SEE ALSO
pdcreatelocation
pddeletelocation
pdgetlocation

pdsetlocation
pdlistlocation
159
160

pdsetmaintenancepolicy Change the parameters of the maintenance policy.
SYNOPSIS
pdsetmaintenancepolicy [--daysevents=number] [--daysfiles=number]
[--daysjobs=number] [--enabled=01] [--errorescalationperiod=number]
DESCRIPTION
This command changes the parameters of the maintenance policy.
Pdsetmaintenancepolicy is a system policy, so there is only one policy of this
type.
PARAMETERS
daysevents - The number of days that should pass before an event is deleted in
maintenance.
daysfiles - The number of days that should pass before temporary files are
deleted in maintenance.
daysjobs - The number of days that should pass before a job is deleted in
maintenance.

name - The name of the maintenance policy.

February.
161
162

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 ALSO
N/A

pdsetmbgarbagecollectionpolicy Change the parameters of an existing
metabase garbage collection policy.
SYNOPSIS
pdsetmbgarbagecollectionpolicy --id=number [--dsfind=string]
[--enabled=01] [--enableextensivecleanup=number]
[--errorescalationperiod=number] [--logdeletedrecords=01]
DESCRIPTION
This command changes the parameters of an existing metabase garbage collection
policy.
PARAMETERS
ID.

enableextensivecleanup - This parameter is used to enable and disable more
extensive cleanup during the metabase garbage collection. During normal cleanup,
only dereferenced file names are removed. When this parameter is enabled, the
policy also attempts to remove expired file names. Acceptable values for this
parameter are 0 (zero), disabled, and 1 (one), enabled. The default value is 0.
163
164


id (Required) - Generic identifier type.
logdeletedrecords - When this parameter is enabled, PureDisk keeps the history
on the metabase garbage collection policies. The acceptable values for this
parameter are zero (0 - disabled) and one (1 - enabled). The default value is 0. More
information about this log file is available. See the Editing the Parameters tab on
the default metabase engine garbage collection policy section in the Symantec
NetBackup PureDisk Backup Operators Guide.
name - The name of the metabase garbage collection policy.

165
February.
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 ALSO
pdgetpolicy
166

pdsetperm
pdsetperm
pdsetperm Sets the permissions for a user.
SYNOPSIS
pdsetperm --resourcetype --resourceid --consumerid --consumertype
--permissionaction --permissiontype
DESCRIPTION
This command sets the permissions for a user.
PARAMETERS
resourcetype - 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 - The object type having its permissions modified. Acceptable values
are 1 = User, 2 = User group.

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

permissiontype - The permission being added or removed. Acceptable values are
1 = View, 2 = Add, 3 = Edit, 4 = Delete, 5 = Activate, 6 = Dstemplate management,

7 = Configuration management, 8 = Workflow management, 9 = Event
management, 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 VALUES
The command has no return value unless the command is entered incorrectly.
/opt/pdcli/calls # ./pdsetperm --consumerid=f51192be-3883-102d-8489-e94f1c13246

/opt/pdcli/calls #

pdsetperm
SEE ALSO
pdcreateuser
167
168

pdsetpolicyescalationaction Change the parameters of an existing policy
escalation action.
SYNOPSIS
pdsetpolicyescalationaction --id=number [--createevent=01]
[--description=string] [--emailalarm=string] [--emailwarning=string]
[--eventseveritylevel=number] [--message=string]
DESCRIPTION
This command changes the parameters of an existing policy escalation action.
PARAMETERS
id - The ID of the policy escalation action.
createevent - This parameter instructs PureDisk to send an event if the job has
reached its expiration date. Acceptable values are 0 (zero) - do not 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 policy
escalation occurs and the error escalation time for a policy is expired.
emailwarning - The email address that is used for sending an email when a policy
escalation occurs and the warning escalation time for a policy is expired.
eventseveritylevel - Defines the severity level for the newly created policy
escalation action. The levels are: 1 Debug, 2 Informational, 3 Authorization, 4

Warning, 5 Error, 6 Critical, and 7 Bug. Acceptable values for eventseveritylevel
are 1 (one) through 7 (seven). The default value if not specified is 1.
text 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:
_________________________________________________________________


If a policy reaches the error escalation timeout an email message is
When it reaches the warning escalation timeout an email message is
SEE ALSO
169
170

pdsetreplicationpolicy Change the parameters of an existing replication
policy.
SYNOPSIS
pdsetreplicationpolicy --id=number [--bandwidth=number]
[--crport=number] [--dsfind=string] [--enabled=01]
[--errorescalationperiod=number] [--forcecrypt=number]
[--endtime=number] [--starttime=number] [--mbfindfile=string]
[--name=string] [--remoteaddress=string] [--remotelogin=string]
[--remotepwd=string] [--schedule=string] [--typeofrep=number]
DESCRIPTION
This command changes the parameters of an existing replication policy.
PARAMETERS
id - The ID of the replication policy.
in kilobytes per second (kb/sec). This option limits the bandwidth that a policy
uses.
crport - The port number the content router uses for backup and restore
operations.
ID.


according to a 24-hour clock. For example, 2:00 A.M. is 2, and 3PM is 15. Acceptable
values are 0 (midnight) through 23 (11:00 P.M.).
indicates that a job has been running for more than the specified error time frame.
forcecrypt - This parameter forces encryption during replication.
its associated value. An example of an mbfindfile file is located in
basename: The name of the object, not including the directory name.

this object.
ago.
171
172

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.

February.
typeofrep - The type of replication to perform. Values are either 0 (zero), full, or
1 (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.
173
174

SEE ALSO

pdsetserverdbmaintenancepolicy Change the parameters of an existing server
database maintenance policy.
SYNOPSIS
pdsetserverdbmaintenancepolicy --id=number [--enabled=01]
[--errorescalationperiod=number] [--name=string] [--schedule=string]
[--vacuumspa=number] [--vacuumcr=number] [--vacuummb=number]
DESCRIPTION
This command changes the parameters of an existing server database maintenance
policy.
PARAMETERS
id - The ID of the database maintenance policy.

name - The name of the server database maintenance policy.
175
176

February.
vacuumspa - When enabled, this parameter instructs PureDisk to vacuum the
storage pool authority database. Acceptable values are 0 (zero), disabled and 1
(one), enabled. The default is disabled.
vacuumcr - When enabled, this parameter instructs PureDisk to vacuum the content
router database. Acceptable values are 0 (zero), disabled, and 1 (one), enabled. The
default is disabled.
vacuummb - When enabled, this parameter instructs PureDisk to vacuum the
metabase database. Acceptable values are 0 (zero), disabled and 1 (one), enabled.
The default is disabled.


RETURN VALUES
/opt/pdcli/calls # ./pdsetserverdbmaintenancepolicy --id=105
The adjusted server DB policy now has the following properties:
________________________________________________________________
The policy name: Default policy for Server DB Maintenance.
The following
vacuumCA =
vacuumMB =
vacuumCRDB
SEE ALSO
N/A
policy specific parameters were found:

1.
1.
= 1.
177
178

pdsetstoragepool
pdsetstoragepool
pdsetstoragepool Changes and displays the description and the name
information for a storage pool.
SYNOPSIS
pdsetstoragepool [--description=string] [--name=string]
DESCRIPTION
This command changes and displays the description and the name information
for a storage pool.
PARAMETERS
description - The description of the storage pool
name - The name of the storage pool
RETURN VALUES
/opt/pdcli/calls # ./pdsetstoragepool
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 ALSO
pdgetstoragepool

pdsetuser
179
pdsetuser
pdsetuser Changes and displays the details that are associated with an existing
user.
SYNOPSIS
pdsetuser --name=string [--departmentid=number] [--description=string]
[--email=string] [--locationid=number] [--login=string]
[--mobile=string] [--name=string] [--pwd=string] [--telephone=string]
DESCRIPTION
This command changes and displays the details that are associated with an existing
user.
PARAMETERS
departmentid - The department identifier.
description - The description of the user.
email - The email address of a user.
locationid - The location identifier.
login - The logon name of a user.
mobile - The mobile telephone number of a user.
pwd - The password for the user. Defaults to "password".
telephone - The telephone number for the user.
RETURN VALUES
/opt/pdcli/calls # ./pdsetuser --name='"John Smith"' --mobile=1112223333
180

pdsetuser
Successfully updated user:

jsmith (b6837984-0404-102e-9db8-c1d4d1c63f30).
SEE ALSO
pdcreateuser
pddeleteuser
pdgetuser
pdlistuser
pdlogonuser

pdstatlicensing
pdstatlicensing
pdstatlicensing Collects and displays extra information about the license keys.
SYNOPSIS
pdstatlicensing
DESCRIPTION
This command collects and displays extra information about the license keys.
PARAMETERS
N/A
RETURN VALUES
/opt/pdcli/calls # ./pdstatlicensing
The following information was found after doing a stat on licensing:
____________________________________________________________________
SPAIpAddress = 10.31.82.143.
activeLicenseCount = 2.
connectivityStatus = 1.
id = 1.
lastCaptureTime = 1222697006.
login = root.
name = default.
password = root.
The following information was found after doing a stat on licensing:
____________________________________________________________________
SPAIpAddress = 10.31.82.143.
activeLicenseCount = 2.
connectivityStatus = 1.
id = 1.
lastCaptureTime = 1222697006.
login = root.
name = default.
password = root.
181
182

pdstatlicensing
SEE ALSO
pddeletelicense
pdgetlicense
pdlistlicense
pdsetlicense

pdupgrade
pdupgrade
pdupgrade Used to initiate the upgrade of client software on the specified client.
SYNOPSIS
pdupgrade --agentid
DESCRIPTION
This command is used to initiate the upgrade of client software on the specified
client.
PARAMETERS
agentid - The agent identifier.
RETURN VALUES
Example 1:
/opt/pdcli/calls # ./pdupgrade --agentid=2
The agent is already upgraded, no jobs started.
Example 2:
/opt/pdcli/calls # ./pdupgrade --agentid=2
Successfully initiated the upgrade.
SEE ALSO
N/A
183
184

pdupgrade
Appendix
Third-party legal notices

This appendix includes the following topics:
Third-party legal notices for the Symantec NetBackup PureDisk product family
Third-party trademarks for the Symantec NetBackup PureDisk product family
Third-party legal notices for the Symantec NetBackup

PureDisk product family
Third-party software may be recommended, distributed, embedded, or bundled
with this Symantec product. Such third-party software is licensed separately by
its copyright holder. All third-party copyrights associated with this product are
listed in the following document, which is accessible from the PureDisk storage
pool configuration wizard's landing page:
See PureDisk Third-party Legal Notices
Third-party trademarks for the Symantec NetBackup

PureDisk product family
Active Directory, Excel, Hyper-V, Internet Explorer, Microsoft, Windows, Windows
NT, and Windows Server are either registered trademarks or trademarks of
Microsoft Corporation in the United States and other countries.
AIX, IBM, PowerPC, and Tivoli are trademarks or registered trademarks of
International Business Machines Corporation in the United States, other countries,
or both.
All SPARC trademarks are used under license and are trademarks or registered
trademarks of SPARC International, Inc., in the United States and other countries.
186
Third-party legal notices

Third-party trademarks for the Symantec NetBackup PureDisk product family
Products bearing SPARC trademarks are based upon an architecture developed

by Sun Microsystems, Inc.
AMD is a trademark of Advanced Micro Devices, Inc.
Firefox and Mozilla are registered trademarks of the Mozilla Foundation.
Intel, Itanium, Pentium, and Xeon are trademarks or registered trademarks of
Intel Corporation or its subsidiaries in the United States and other countries.
Java, Sun, and Solaris are trademarks or registered trademarks of Sun
Microsystems, Inc., in the United States and other countries.
Linux is a registered trademark of Linus Torvalds in the United States and other
countries.
Mac OS is a trademark of Apple Inc., registered in the U.S. and other countries.
Nessus is a trademark of Tenable Network Security, Inc.
NetApp is a registered trademark of Network Appliance, Inc. in the U.S. and other
countries.
Novell and SUSE are registered trademarks of Novell, Inc., in the United States
and other countries.
OpenLDAP is a registered trademark of the OpenLDAP Foundation.
Oracle is a registered trademark of Oracle and/or its affiliates.
Red Hat and Enterprise Linux are registered trademarks of Red Hat, Inc., in the
United States and other countries.
UNIX is a registered trademark of The Open Group.
VMware, vSphere, and the VMware "boxes" logo and design are trademarks or
registered trademark of VMware, Inc., in the United States and other countries.
Glossary
absolute path
The location of a given file or directory on a file system regardless of the current
working directory.
ACL (access control list) The information that identifies specific users or groups and their access privileges
for a particular file or directory.

active agent
The PureDisk software that is enabled for use within a PureDisk environment.
The PureDisk agent (the software) is installed on clients (the hardware).
active node
The nodes in a high availability cluster on which services are running.
Agent Files and Folders A collection of files, folders, or directories to be backed up. PureDisk creates this
data selection
data selection automatically when you perform a full system backup.
All-in-one storage pool
A PureDisk storage pool with all PureDisk services installed on one node.
alternate client
A client other than the source client that receives restored files. If the data is not
restored to the original client, the client that is designated to receive the data is
the alternate client.
ATOP (All Through One
See single-port communication.
Port)
attended installation
An installation that requires active interaction with a person.
authentication broker
The process that communicates with a root broker to verify user identities.
backup
A process where selected files on a computer drive are copied and stored on a
reliable form of media.
backup operator
A user or a group of users with the rights to initiate client backups.
backup streams
A connection between the PureDisk client and the PureDisk content router through
which data is sent. In case of multistreaming, the client establishes multiple
connections to the same content router and distributes the total volume of backup
data over all available connections. Multistreamed backups (vs. single streamed)
increase the aggregated throughput from client to content router, thus allowing
backups to finish sooner.
backup window
The timeframe in which backups are permitted.
CA (Certificate
A trusted third-party organization or company that issues digital certificates that

are used to create digital signatures and public-private key pairs. The role of the
CA in this process is to guarantee that the entity granting the unique certificate
Authority)
188
Glossary
is, in fact, who it claims to be. This means that the CA usually has an arrangement
with the requesting entity to confirm a claimed identity. CAs are a critical
component in data security and electronic commerce because they guarantee that
the two parties exchanging information are really who they claim to be.
central reporting
A PureDisk feature in which one or more storage pools send reporting data to
another storage pool.
CIFS (Common Internet A protocol that defines a standard for remote file access. CIFS allows users with
File System)
different platforms and computers can share files.
cluster
A set of hosts (each termed a node) that share a set of disks and are connected by
a set of redundant heartbeat networks.
common root
A shared directory structure. Common root is a concept applicable to data restore.

When the user restores the data, there is a Do not restore common root option.
The user can enable or disable the feature.
configuration files
The files that define PureDisks methods and assumptions. A custom configuration
file for each component is created automatically by the storage pool authority. It
is pushed out to the component for which this file is created. If you need to tune
any of the default PureDisk processes, you can edit the configuration files.
content router
A service that stores and retrieves file content. PureDisk breaks larger files into
segments and distributes the segments across the available content routers.
content router garbage The process of removing unneeded data objects and files from the content router.
collection
This workflow removes files and objects that cannot be removed during the normal
data removal process.
CSV (comma-separated A text file that uses commas as data delimiters.

variable) file
data lock password
An option that allows the administrator to require users to enter a password

before they perform certain operations. These operations include any operation
that exposes directory names, directory content, file names, or file content.
data mining
The process of collecting information about all the files in a PureDisk storage
pool.
data removal
The process of removing old and unneeded versions of the files that PureDisk
previously backed up.
data selection
A list of files, directories, or other data objects that you want PureDisk to back
up. They can be used to specify files and folders, databases, system information,
and other types of data. After a data selection is created, it can be backed up
automatically (through a policy) or on demand (initiated by a backup operator).
Glossary
data selection removal
The process of removing the entire data selection (including file content data)
from the content router. This process also removes the associated metadata
information from the metabase engine.
data selection template A pattern that is used for creating the list of files, directories, or other data objects
for PureDisk to back up. Templates can be developed that include or exclude
certain file types, or that back up a specific directory. PureDisk includes some
default data selection templates.
deduplication
The process of dividing a file into segments, comparing each segment with the
previously stored file segments, and then storing only the unique segments.
Deduplication significantly reduces the amount of data that is stored because
redundant data is replaced with a pointer to the unique data copy.
department
A logical collection of client systems.
disabled data selection A data selection that PureDisk ignores when it performs policy-based actions. If
a policy includes deactivated data objects, the policy does not include them when
the policy runs.
disabled policy
A policy that exists in the PureDisk environment but that is currently not activated.
No jobs are created for this policy.
disaster recovery
The process of restoring information from a backup after the original data was
lost (due to a disaster) or deleted.
DMP (dynamic
An input/output (I/O) enhancement technique that balances I/O across many

available paths from the computer to the storage device to improve performance
and availability.
multipathing)
enabled data selection
An activated list of files, directories, or other data objects that PureDisk uses for
back ups and other policy-based actions.
enabled policy
A policy that exists in the PureDisk environment that is currently activated and
run according to a schedule. PureDisk automatically creates jobs to run this policy.
escalation action
A defined procedure that takes place when an event occurs.
event
A significant occurrence in a system or application that a program detects. Events

typically trigger actions, such as sending a user notification or adding a log entry.
event escalation action A defined procedure that takes place when a specific notable occurrence takes
place.
exclude files
A listing of files or file patterns that are not included in a data selection.
exclusion rules
The means by which PureDisk determines the files or folders that should not be
part of a given data selection. See also inclusion rules.
expert installation
The process of loading the PDLinux software onto a computer with multiple hard
drives where none of the options is predefined.
method
189
190
Glossary
external authentication A credential verification authority that resides on a computer that is not part of
a PureDisk storage pool.

failover
The process of moving services from the active node in a cluster to a passive one.
file change rate
The frequency with which files on a client system are modified.
file pattern
A character sequence that includes wild cards and instructs PureDisk to select
multiple files based on the character sequence.
file system browsing
The ability to search through a graphic representation of a computer systems

file structure.
Files and Folders data
A data selection that is used to back up files, folders, and directories.
selection
fingerprint
A unique sequence of digits identifying a file or a file segment. The fingerprint of

a file or segment is computed from the file or segments content and is unique for
that file or segment.
folder pattern
An absolute path that may contain wild cards and instructs PureDisk to select
folders based on the character sequence.
FQDN (fully qualified
An unambiguous domain name that specifies the exact location of a computer

within the domain's hierarchy.
domain name)
garbage collection
The process of removing stale data or records from PureDisk that cannot be
removed during the normal data removal process.
HCL (hardware
A document that indicates the various components that are known to work with
a given software product.
compatibility list)
heartbeat
A signal sent at regular intervals to indicate that a host and its connections are
operating normally.
high availability
A system or a resource that is continuously operational.
host address
The TCP/IP address of a computer.
inactive agent
A client computer that is registered to the storage pool authority, but which is
not yet acknowledged as part of the PureDisk environment.
include files
A listing of files or file patterns that are included in a data selection.
inclusion rules
The means by which PureDisk determines the files to consider as part of a given
backup. See also exclusion rules.
inheritance
The process of receiving attributes from a parent object, such as a template.
job
An operation that has been scheduled for processing. Jobs contain source or
destination information, settings, and a schedule.
Glossary
LDAP (Lightweight
Directory Access
Protocol)
A software protocol that enables anyone to locate organizations, individuals, and

other resources such as files and devices in a network, whether on the Internet
or on a corporate intranet. LDAP is a lightweight (smaller amount of code) version
of Directory Access Protocol (DAP), which is part of X.500, a standard for directory
services in a network.
location
A logical grouping of one or more departments. A location does not need to be a

physical or a geographic location.
mapped network drive
A persistent connection within Microsoft Windows to a shared directory on a

remote server that is assigned a drive letter. The drive mapping may or may not
survive a restart, depending on how it is configured.
mapping file
A two-column file that lists both IP addresses and fully qualified domain names
(FQDNs) for each node. Mapping files are used when redefining a PureDisk
environment to use either FQDNs or IP addresses.
metabase
A distributed database that contains all the metadata about the files that are
backed up by PureDisk.
metabase engine
The service that maintains and manages file metadata information in the metabase
database. During backup, the PureDisk agent records all relevant metadata
information (the file attributes) of each file it backs up. File attributes include the
file name, its location, its size, its type, and so on. The metabase engine stores
these metadata records in its database. The metabase engine manages an inventory
of all files that are backed up.
metabase garbage
The process of removing the stale, unneeded information from the metabase that
cannot be removed during the normal data removal process.
collection
metabase server
The service that redirects metabase queries to the correct metabase engine(s).
Each metabase engine in the storage pool is responsible for managing the metadata
records from a group of agents. Queries for a file or files do not go directly to the
metabase engine but instead are directed to the metabase server. The metabase
server redirects the query to the metabase engine that manages the metadata
records of the agent that made the query or to which the query is associated. In
some cases the metabase server may have to redirect the incoming query to
multiple metabase engines.
metadata
Structural data describing the attributes of files on a disk.
Microsoft Exchange
A predefined data selection within PureDisk that backs up Microsoft Exchange

server databases.
data selection
Microsoft SQL data
selection
A predefined data selection within PureDisk that backs up Microsoft SQL server
databases.
multinode storage pool A storage pool that includes more than one PDLinux server node and can be
clustered.
191
192
Glossary
multistreaming
The process of establishing multiple connections to the content router for the
purposes of backing up data faster.
NetBackup export
engine
An optional service that allows backed up PureDisk Files and Folders data
selections to be exported to NetBackup. The NetBackup export engine does not
export other PureDisk data selection types.
network drive
A directory on a remote server that is designated as shared.
node
A computer in a storage pool that hosts PDLinux and other PureDisk services.
OpenLDAP (Open
A network protocol that is designed to work on TCP/IP stacks. It extracts

information from a hierarchical directory such as X.500. This software gives users
a single tool to find a particular piece of information. For example, a user can find
a user name, an email address, security certificate, or other contact information.
Lightweight Directory
Access Protocol)
Oracle data selection
A predefined data selection within PureDisk that backs up Oracle databases.
parallel rerouting
The process of redistributing data among the content routers in a PureDisk storage
pool. All content routers are actively involved in the redistribution at the same
time.
passive node
Any node in a highly available, clustered environment that is not running PureDisk
services.
path
The directory location of a given file or directory on a file system. Paths can be
either relative or absolute.
PDDO (PureDisk
A plug-in that uses the NetBackup OpenStorage API to enable NetBackup to write
backups to a PureDisk storage pool. All NetBackup data that is written to a
PureDisk storage pool is deduplicated.
deduplication option)
PDLinux (PureDisk
Linux)
policy
The operating system that hosts the PureDisk application. Symantec developed
PDLinux based on SUSE Linux Enterprise Server.
A method for managing backup jobs and strategies. Policies contain settings for
jobs.
policy escalation action A procedure that is defined to take place when a specific policy event (such as a
backup failure) takes place.

private network
A computer network that is accessible only by other servers, not by the general
user base.
private NIC
A network interface card that communicates to a private network.
public network
A computer network that is accessible to the general user base.
public NIC
A network interface card that communicates to a public network.
registration
The process of enrolling with the storage pool authority.
Glossary
relative path
The directory location of a given file or directory on a file system that depends
on the current working directory.
replication
The process of copying backed up data selections from one storage pool to another
storage pool.
rerouting
The process of redistributing data over all available content routers. When the
process finishes, each content router stores a volume of data proportional to its
relative capacity. Rerouting is necessary when a new content router is activated,
or an existing content router is deactivated.
resource name
The unique identifier for a service on a PureDisk node.
root broker
The authentication authority in the network. A root broker is local when it resides
on the same physical computer as the PureDisk storage pool authority. A root
broker is remote when it resides on a different PureDisk computer in the network.
A root broker is external when it does not reside on any PureDisk computer within
the storage pool.
segment
A piece of a file.
segmentation
The process of breaking a file down into smaller pieces for backup.
segmentation threshold The maximum allowable size for a file fragment.

serial rerouting
The process of redistributing data among the content routers in a PureDisk storage
pool. Only one content router redistributes data at a time.
service
A PureDisk software component. The possible services are as follows: content

router, metabase engine, metabase server, storage pool authority, and NetBackup
export engine.
service address
The TCP/IP address associated with a service group.
service group
A collection of PureDisk services.
shared disk
A physical hard drive on a computer that can be remotely accessed from another
computer. In a highly available cluster, the shared disk is normally a drive that
does not physically reside in any of the cluster nodes. Any resources that can
failover among cluster nodes must reside on a shared disk.
shared folder
A network directory, to which multiple users have read and write access, used to
exchange files with other users.
silent installation
An installation in which the user sees no indication that the installation is

occurring. The user is not prompted to enter any information and the user does
not see status messages. See also attended installation.
single port
A PureDisk feature that directs all network communication through one port.
Storage pools that implement single-port communication require fewer firewall
ports to be open between PureDisk service agents and clients.
communication
193
194
Glossary
snapshot
A consistent point-in-time view of a volume that is used as the reference point

for the backup operation. After a snapshot is created, the primary data can
continue being modified without affecting the backup operation.
SPA (storage pool
The service that manages a storage pool.
authority)
SPAR (storage pool
authority replication)
The replication of storage pool authority configuration information from an

all-in-one local storage pool to a main storage pool.
storage pool
The main data repository in PureDisk. PureDisk writes backup copies of content
and metadata to the disk storage that is associated with a storage pool. A storage
pool consists of one or more PureDisk nodes.
stream
A sequence of digital data.
SUSE
A distribution of Linux software. The name is an acronym for the German phrase
Software-und System-Entwicklung (Software and system development).
System State and

Services data selection
A data selection that is used to back up Microsoft system data on Windows

platforms.
template inheritance
The process of receiving attributes from a parent template.
TLS (transport security
An encrypted protocol that provides secure communications in the PureDisk

environment.
layer)
topology
The types of PureDisk services that a storage pool includes. All storage pool
topologies include one or more of the following services: storage pool authority,
content router, metabase engine, metabase server. A controller is installed on a
metabase engine. Optionally, a storage pool can also include a NetBackup export
engine.
unattended install
An installation that does not require human interaction.
UNC path data selection A data selection that backs up data on a CIFS network drive on a Windows client.
Also use this data selection to indicate the path for a NetApp Filer.
user
An individual with rights to access your protected network resources. Users are
defined by creating a user account that consists of a unique user name and
authentication method.
user group
A collection of users with identical permissions. These users can perform common
functions within a PureDisk environment.
vacuuming
The process of cleaning up and optimizing a database. Vacuuming removes the

records that are no longer needed and results in better database performance.
VCS (Veritas cluster
High-availability cluster software developed by Symantec for UNIX, Linux, and

Windows platforms.
server)
Glossary
VEA (Veritas Enterprise A separate middleware server used by the SAN Access Layer and other processes
Administrator)
to provide client-server communication. The VEA infrastructure enables software

components to share information about objects, manage those objects, and effect
change on those objects.
CommandCentral
A graphical user interface that displays reports and other information for users
of CommandCentral Service through a standard Web browser. The Console
provides a central point to manage cost analysis and chargeback for services,
managing workflow, displaying and managing reports, and other tasks.
Console
VSP (Volume Shapshot

Provider)
VSS (Volume Shadow
Copy Service)
VxVM (Veritas Volume

Manager)
Symantec software that backs up open files. PureDisk uses VSP on Windows 2000
clients.
A set of application programming interfaces (APIs) that creates a framework.
Within this framework, volume backups and application write can occur at the
same time. PureDisk uses Microsofts VSS technology to back up open files on
Windows 2003 and Windows XP clients.
A Symantec product installed on storage clients that enables management of
physical disks as logical devices. It enhances data storage management by
controlling space allocation, performance, data availability, device installation,
and system monitoring of private and shared systems.
wildcard character
A symbol that enables multiple matching values to be returned based on a shared

feature. Two wildcards are available: the question mark (?) and the asterisk (*).
The question mark stands for any single character, and the asterisk stands for
any character string of any length. For example, the file specification *.* returns
all files, regardless of their file names; the file specification *.sc? would return all
file names that have a three-character extension beginning with sc (such as
compusrv.scr, compusrv.scx, and so on).
workflow
A collection of steps that the software completes to accomplish a task.
XFS (Extended File
A journaling file system that you can configure on a PureDisk node.
System)
YaST (Yet another Setup The operating system installation tool for SUSE Linux.
Tool)
195
196
Glossary

PureDisk CLI Guide

Uploaded by

Copyright:

Available Formats

PureDisk CLI Guide

Uploaded by

Document Information

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

PureDisk CLI Guide

Uploaded by

Copyright:

Available Formats

Symantec NetBackup

PureDisk Command Line

Publication release 6.6.1, revision 1

Telephone and/or Web-based support that provides rapid response and

Upgrade assurance that delivers software upgrades

Global support purchased on a regional business hours or 24 hours a day, 7

Premium service offerings that include Account Management Services

Contacting Technical Support

Product release level

Available memory, disk space, and NIC information

Version and patch level

Router, gateway, and IP address information

Error messages and log files

Troubleshooting that was performed before contacting Symantec

Recent software configuration changes and network changes

Licensing and registration

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 resources

Europe, Middle-East, and Africa

North America and Latin America

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

Command Line Interface ................................................... 11

Third-party legal notices .................................................. 185

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

Command Line Interface

General MAN page for PureDisk CLI

Command Line Interface

Command Line Interface

Command Line Interface

Command Line Interface

General MAN page for PureDisk CLI

Symantec NetBackup PureDisk.

Precede special symbols in arguments with an escape character. In the bash

PUREDISK COMMANDS GROUPED BY FUNCTION

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.

Command Line Interface

pddeactivateagent - Deactivates the agent software on a client computer so

it is no longer backed up by active PureDisk policies.

pdexit - Removes any locally saved credentials.

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 license

pdupgrade - Used to initiate the upgrade of client software on the specified

pdcreatebackuppolicy - Creates a new backup policy.

pdcreatedataremovalpolicy - Creates a policy to remove data from a content

pdcreatedepartment - Creates a new department that is used to organize client

pdcreateds - Creates a new selection of files and directories on a PureDisk

client for backup.