IBM Spectrum Protectfor WindowsVersion 8.1.0

Administrator's Reference

IBM

IBM Spectrum Protectfor WindowsVersion 8.1.0

Administrator's Reference

IBM

Note:Before you use this information and the product it supports, read the information in “Notices” on page 1745.

This edition applies to version 8, release 1, modification 0 of IBM Spectrum Protect (product numbers 5725-W98,5725-W99, 5725-X15, 5725-Z10), and to all subsequent releases and modifications until otherwise indicated in neweditions.

© Copyright IBM Corporation 1993, 2016.US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contractwith IBM Corp.

Contents

About this publication . . . . . . . . xiiiWho should read this guide . . . . . . . . xiiiPublications . . . . . . . . . . . . . . xiiiConventions used in this publication . . . . . xiiiWhat's new in Version 8.1 . . . . . . . . . xiv

Chapter 1. Managing the server from thecommand line . . . . . . . . . . . . 1Issuing commands from the administrative client . . 1

Starting and stopping the administrative client . . 2Monitoring server activities from theadministrative client . . . . . . . . . . . 2Monitoring removable-media mounts from theadministrative client . . . . . . . . . . . 3Processing individual commands from theadministrative client . . . . . . . . . . . 3Processing a series of commands from theadministrative client . . . . . . . . . . . 4Formatting output from commands. . . . . . 4Saving command output to a specified location. . 4Administrative client options . . . . . . . . 5

Issuing commands from the Operations Center . . . 8Issuing commands from the server console . . . . 8Entering administrative commands . . . . . . . 8

Reading syntax diagrams . . . . . . . . . 9Using continuation characters to enter longcommands. . . . . . . . . . . . . . 13Naming IBM Spectrum Protect objects . . . . 13Using wildcard characters to specify objectnames . . . . . . . . . . . . . . . 14Specifying descriptions in keyword parameters 15

Controlling command processing . . . . . . . 16Server command processing . . . . . . . . 16Stopping background processes. . . . . . . 17

Performing tasks concurrently on multiple servers 17Routing commands to a single server. . . . . 18Routing commands to multiple servers . . . . 18Routing commands to a server group. . . . . 18Routing commands to server groups . . . . . 19Routing commands to two servers and a servergroup . . . . . . . . . . . . . . . 19Routing commands inside scripts . . . . . . 19

Privilege classes for commands . . . . . . . . 20Commands requiring system privilege . . . . 20Commands requiring policy privilege . . . . 23Commands requiring storage privilege . . . . 24Commands requiring operator privilege . . . . 25Commands any administrator can issue . . . . 26

Chapter 2. Administrative commands 29ACCEPT DATE (Accepts the current system date) 30ACTIVATE POLICYSET (Activate a new policy set) 31ASSIGN DEFMGMTCLASS (Assign a defaultmanagement class) . . . . . . . . . . . . 33AUDIT commands . . . . . . . . . . . . 35

AUDIT CONTAINER commands . . . . . . 36AUDIT LDAPDIRECTORY (Audit an LDAPdirectory server) . . . . . . . . . . . . 48AUDIT LIBRARY (Audit volume inventories inan automated library) . . . . . . . . . . 50AUDIT LIBVOLUME (Verify databaseinformation for a tape volume) . . . . . . . 52AUDIT LICENSES (Audit server storage usage) 54AUDIT VOLUME (Verify database informationfor a storage pool volume) . . . . . . . . 55

BACKUP commands . . . . . . . . . . . 61BACKUP DB (Back up the database) . . . . . 62BACKUP DEVCONFIG (Create backup copies ofdevice configuration information) . . . . . . 68BACKUP NODE (Back up a NAS node) . . . . 70BACKUP STGPOOL (Back up primary storagepool data to a copy storage pool) . . . . . . 75BACKUP VOLHISTORY (Save sequential volumehistory information) . . . . . . . . . . 79

BEGIN EVENTLOGGING (Begin logging events) . . 81CANCEL commands . . . . . . . . . . . 83

CANCEL EXPIRATION (Cancel an expirationprocess) . . . . . . . . . . . . . . 84CANCEL EXPORT (Delete a suspended exportoperation) . . . . . . . . . . . . . . 85CANCEL PROCESS (Cancel an administrativeprocess) . . . . . . . . . . . . . . 86CANCEL REPLICATION (Cancel nodereplication processes) . . . . . . . . . . 89CANCEL REQUEST (Cancel one or more mountrequests) . . . . . . . . . . . . . . 90CANCEL RESTORE (Cancel a restartable restoresession). . . . . . . . . . . . . . . 91CANCEL SESSION (Cancel one or more clientsessions) . . . . . . . . . . . . . . 92

CHECKIN LIBVOLUME (Check a storage volumeinto a library). . . . . . . . . . . . . . 93CHECKOUT LIBVOLUME (Check a storagevolume out of a library) . . . . . . . . . . 100CLEAN DRIVE (Clean a drive) . . . . . . . 106COMMIT (Control committing of commands in amacro). . . . . . . . . . . . . . . . 107CONVERT STGPOOL (Convert a storage pool to acontainer storage pool) . . . . . . . . . . 108COPY commands . . . . . . . . . . . . 110

COPY ACTIVEDATA (Copy active backup datafrom a primary storage pool to an active-datapool) . . . . . . . . . . . . . . . 111COPY CLOPTSET (Copy a client option set) . . 115COPY DOMAIN (Copy a policy domain) . . . 116COPY MGMTCLASS (Copy a managementclass) . . . . . . . . . . . . . . . 118COPY POLICYSET (Copy a policy set) . . . . 120COPY PROFILE (Copy a profile) . . . . . . 122COPY SCHEDULE (Copy a client or anadministrative command schedule) . . . . . 124

© Copyright IBM Corp. 1993, 2016 iii

COPY SCRIPT (Copy an IBM Spectrum Protectscript) . . . . . . . . . . . . . . . 128COPY SERVERGROUP (Copy a server group) 129

DEACTIVATE DATA (Deactivate data for a clientnode) . . . . . . . . . . . . . . . . 130DECOMMISSION commands . . . . . . . . 133

DECOMMISSION NODE (Decommission anapplication or system) . . . . . . . . . 134DECOMMISSION VM (Decommission a virtualmachine) . . . . . . . . . . . . . . 137

DEFINE commands . . . . . . . . . . . 139DEFINE ALERTTRIGGER (Define an alerttrigger) . . . . . . . . . . . . . . 141DEFINE ASSOCIATION (Associate client nodeswith a schedule) . . . . . . . . . . . 144DEFINE BACKUPSET (Define a backup set) . . 146DEFINE CLIENTACTION (Define a one-timeclient action) . . . . . . . . . . . . 150DEFINE CLIENTOPT (Define an option to anoption set) . . . . . . . . . . . . . 156DEFINE CLOPTSET (Define a client option setname) . . . . . . . . . . . . . . . 158DEFINE COLLOCGROUP (Define a collocationgroup). . . . . . . . . . . . . . . 159DEFINE COLLOCMEMBER (Define collocationgroup member). . . . . . . . . . . . 161DEFINE COPYGROUP (Define a copy group) 165DEFINE DATAMOVER (Define a data mover) 175DEFINE DEVCLASS (Define a device class) . . 178DEFINE DOMAIN (Define a new policydomain) . . . . . . . . . . . . . . 240DEFINE DRIVE (Define a drive to a library) . . 242DEFINE EVENTSERVER (Define a server as theevent server) . . . . . . . . . . . . 247DEFINE GRPMEMBER (Add a server to aserver group) . . . . . . . . . . . . 248DEFINE LIBRARY (Define a library). . . . . 249DEFINE MACHINE (Define machineinformation for disaster recovery) . . . . . 270DEFINE MACHNODEASSOCIATION(Associate a node with a machine) . . . . . 272DEFINE MGMTCLASS (Define a managementclass) . . . . . . . . . . . . . . . 274DEFINE NODEGROUP (Define a node group) 277DEFINE NODEGROUPMEMBER (Define nodegroup member). . . . . . . . . . . . 278DEFINE PATH (Define a path) . . . . . . 279DEFINE POLICYSET (Define a policy set) . . . 289DEFINE PROFASSOCIATION (Define a profileassociation) . . . . . . . . . . . . . 291DEFINE PROFILE (Define a profile) . . . . . 297DEFINE RECMEDMACHASSOCIATION(Associate recovery media with a machine) . . 299DEFINE RECOVERYMEDIA (Define recoverymedia) . . . . . . . . . . . . . . 301DEFINE SCHEDULE (Define a client or anadministrative command schedule) . . . . . 303DEFINE SCRATCHPADENTRY (Define ascratch pad entry) . . . . . . . . . . . 328DEFINE SCRIPT (Define an IBM SpectrumProtect script) . . . . . . . . . . . . 330

DEFINE SERVER (Define a server forserver-to-server communications). . . . . . 333DEFINE SERVERGROUP (Define a servergroup). . . . . . . . . . . . . . . 340DEFINE SPACETRIGGER (Define the spacetrigger) . . . . . . . . . . . . . . 341DEFINE STATUSTHRESHOLD (Define a statusmonitoring threshold) . . . . . . . . . 344DEFINE STGPOOL (Define a storage pool) . . 348DEFINE STGPOOLDIRECTORY (Define astorage pool directory) . . . . . . . . . 408DEFINE SUBSCRIPTION (Define a profilesubscription) . . . . . . . . . . . . 410DEFINE VIRTUALFSMAPPING (Define avirtual file space mapping) . . . . . . . . 412DEFINE VOLUME (Define a volume in astorage pool) . . . . . . . . . . . . 414

DELETE commands . . . . . . . . . . . 420DELETE ALERTTRIGGER (Remove a messagefrom an alert trigger) . . . . . . . . . . 422DELETE ASSOCIATION (Delete the nodeassociation to a schedule) . . . . . . . . 423DELETE BACKUPSET (Delete a backup set) . . 425DELETE CLIENTOPT (Delete an option in anoption set) . . . . . . . . . . . . . 430DELETE CLOPTSET (Delete a client option set) 431DELETE COLLOCGROUP (Delete a collocationgroup). . . . . . . . . . . . . . . 432DELETE COLLOCMEMBER (Delete collocationgroup member). . . . . . . . . . . . 433DELETE COPYGROUP (Delete a backup orarchive copy group) . . . . . . . . . . 436DELETE DATAMOVER (Delete a data mover) 438DELETE DEDUPSTATS (Delete datadeduplication statistics) . . . . . . . . . 439DELETE DEVCLASS (Delete a device class) . . 443DELETE DOMAIN (Delete a policy domain) 444DELETE DRIVE (Delete a drive from a library) 445DELETE EVENT (Delete event records). . . . 446DELETE EVENTSERVER (Delete the definitionof the event server) . . . . . . . . . . 448DELETE FILESPACE (Delete client node datafrom the server) . . . . . . . . . . . 449DELETE GRPMEMBER (Delete a server from aserver group) . . . . . . . . . . . . 453DELETE KEYRING (Delete passwordinformation in the key database) . . . . . . 454DELETE LIBRARY (Delete a library). . . . . 455DELETE MACHINE (Delete machineinformation) . . . . . . . . . . . . . 456DELETE MACHNODEASSOCIATION (Deleteassociation between a machine and a node) . . 457DELETE MGMTCLASS (Delete a managementclass) . . . . . . . . . . . . . . . 458DELETE NODEGROUP (Delete a node group) 459DELETE NODEGROUPMEMBER (Delete nodegroup member). . . . . . . . . . . . 460DELETE PATH (Delete a path) . . . . . . 461DELETE POLICYSET (Delete a policy set) . . . 463DELETE PROFASSOCIATION (Delete a profileassociation) . . . . . . . . . . . . . 464

iv IBM Spectrum Protect for Windows: Administrator's Reference

DELETE PROFILE (Delete a profile) . . . . . 467DELETE RECMEDMACHASSOCIATION(Delete recovery media and machineassociation) . . . . . . . . . . . . . 469DELETE RECOVERYMEDIA (Delete recoverymedia) . . . . . . . . . . . . . . 470DELETE SCHEDULE (Delete a client or anadministrative command schedule) . . . . . 471DELETE SCRATCHPADENTRY (Delete ascratch pad entry) . . . . . . . . . . . 474DELETE SCRIPT (Delete command lines from ascript or delete the entire script) . . . . . . 475DELETE SERVER (Delete a server definition) 476DELETE SERVERGROUP (Delete a servergroup). . . . . . . . . . . . . . . 477DELETE SPACETRIGGER (Delete the storagepool space triggers) . . . . . . . . . . 478DELETE STATUSTHRESHOLD (Delete a statusmonitoring threshold) . . . . . . . . . 479DELETE STGPOOL (Delete a storage pool) . . 481DELETE STGPOOLDIRECTORY (Deleting astorage pool directory) . . . . . . . . . 482DELETE SUBSCRIBER (Delete subscriptionsfrom a configuration manager database) . . . 484DELETE SUBSCRIPTION (Delete a profilesubscription) . . . . . . . . . . . . 485DELETE VIRTUALFSMAPPING (Delete avirtual file space mapping) . . . . . . . . 486DELETE VOLHISTORY (Delete sequentialvolume history information) . . . . . . . 487DELETE VOLUME (Delete a storage poolvolume) . . . . . . . . . . . . . . 492

DISABLE commands . . . . . . . . . . . 495DISABLE EVENTS (Disable events for eventlogging) . . . . . . . . . . . . . . 496DISABLE REPLICATION (Prevent outboundreplication processing on a server) . . . . . 499DISABLE SESSIONS (Prevent new sessions fromaccessing IBM Spectrum Protect) . . . . . . 500

DISMOUNT command . . . . . . . . . . 502DISMOUNT VOLUME (Dismount a volume byvolume name) . . . . . . . . . . . . 503

DISPLAY OBJNAME (Display a full object name) 504ENABLE commands . . . . . . . . . . . 505

ENABLE EVENTS (Enable server or clientevents for logging) . . . . . . . . . . 506ENABLE REPLICATION (Allow outboundreplication processing on a server) . . . . . 509ENABLE SESSIONS (Resume user activity onthe server) . . . . . . . . . . . . . 510

END EVENTLOGGING (Stop logging events) . . 512EXPIRE INVENTORY (Manually start inventoryexpiration processing) . . . . . . . . . . 514EXPORT commands . . . . . . . . . . . 519

EXPORT ADMIN (Export administratorinformation) . . . . . . . . . . . . . 520EXPORT NODE (Export client nodeinformation) . . . . . . . . . . . . . 527EXPORT POLICY (Export policy information) 549EXPORT SERVER (Export server information) 556

EXTEND DBSPACE (Increase space for thedatabase) . . . . . . . . . . . . . . . 575GENERATE commands . . . . . . . . . . 578

GENERATE BACKUPSET (Generate a backupset of Backup-Archive Client data) . . . . . 579GENERATE BACKUPSETTOC (Generate a tableof contents for a backup set) . . . . . . . 588GENERATE DEDUPSTATS (Generate datadeduplication statistics) . . . . . . . . . 590

GRANT commands . . . . . . . . . . . 594GRANT AUTHORITY (Add administratorauthority) . . . . . . . . . . . . . 595GRANT PROXYNODE (Grant proxy authorityto a client node) . . . . . . . . . . . 599

HALT (Shut down the server) . . . . . . . . 600HELP (Get help on commands and error messages) 602IDENTIFY DUPLICATES (Identify duplicate datain a storage pool) . . . . . . . . . . . . 604IMPORT commands . . . . . . . . . . . 608

IMPORT ADMIN (Import administratorinformation) . . . . . . . . . . . . . 609IMPORT NODE (Import client nodeinformation) . . . . . . . . . . . . . 613IMPORT POLICY (Import policy information) 620IMPORT SERVER (Import server information) 623

INSERT MACHINE (Insert machine characteristicsinformation or recovery instructions) . . . . . 629ISSUE MESSAGE (Issue a message from a serverscript) . . . . . . . . . . . . . . . . 630LABEL LIBVOLUME (Label a library volume) . . 632LOAD DEFALERTTRIGGERS (Load the default setof alert triggers) . . . . . . . . . . . . 639LOCK commands . . . . . . . . . . . . 641

LOCK ADMIN (Lock out an administrator) . . 642LOCK NODE (Lock out a client node) . . . . 644LOCK PROFILE (Lock a profile) . . . . . . 646

MACRO (Invoke a macro) . . . . . . . . . 648MIGRATE STGPOOL (Migrate storage pool to nextstorage pool) . . . . . . . . . . . . . 650MOVE commands . . . . . . . . . . . . 653

MOVE CONTAINER (Move a container) . . . 653MOVE DATA (Move files on a storage poolvolume) . . . . . . . . . . . . . . 655MOVE DRMEDIA (Move disaster recoverymedia offsite and back onsite) . . . . . . . 659MOVE GRPMEMBER (Move a server groupmember) . . . . . . . . . . . . . . 676MOVE MEDIA (Move sequential-access storagepool media) . . . . . . . . . . . . . 677MOVE NODEDATA (Move data by node in asequential access storage pool) . . . . . . 685

NOTIFY SUBSCRIBERS (Notify managed serversto update profiles). . . . . . . . . . . . 695PERFORM LIBACTION (Define or delete all drivesand paths for a library) . . . . . . . . . . 696PING SERVER (Test the connection betweenservers) . . . . . . . . . . . . . . . 700PREPARE (Create a recovery plan file) . . . . . 701PROTECT STGPOOL (Protect data that belongs toa storage pool) . . . . . . . . . . . . . 706QUERY commands . . . . . . . . . . . 712

Contents v

QUERY ACTLOG (Query the activity log) . . . 715QUERY ADMIN (Display administratorinformation) . . . . . . . . . . . . . 721QUERY ALERTTRIGGER (Query the list ofdefined alert triggers) . . . . . . . . . 726QUERY ALERTSTATUS (Query the status of analert) . . . . . . . . . . . . . . . 728QUERY ASSOCIATION (Query client nodeassociations with a schedule) . . . . . . . 733QUERY AUDITOCCUPANCY (Query clientnode storage utilization). . . . . . . . . 735QUERY BACKUPSET (Query a backup set) . . 738QUERY BACKUPSETCONTENTS (Querycontents of a backup set) . . . . . . . . 743QUERY CLEANUP (Query the cleanup that isrequired in a source storage pool) . . . . . 745QUERY CLOPTSET (Query a client option set) 748QUERY COLLOCGROUP (Query a collocationgroup). . . . . . . . . . . . . . . 750QUERY CONTAINER (Query a container). . . 752QUERY CONTENT (Query the contents of astorage pool volume) . . . . . . . . . . 757QUERY CONVERSION (Query conversionstatus of a storage pool) . . . . . . . . . 764QUERY COPYGROUP (Query copy groups) . . 766QUERY DAMAGED (Query damaged data in adirectory-container or cloud-container storagepool) . . . . . . . . . . . . . . . 770QUERY DATAMOVER (Display data moverdefinitions) . . . . . . . . . . . . . 775QUERY DB (Display database information) . . 778QUERY DBSPACE (Display database storagespace) . . . . . . . . . . . . . . . 781QUERY DEDUPSTATS (Query datadeduplication statistics) . . . . . . . . . 783QUERY DEVCLASS (Display information onone or more device classes). . . . . . . . 791QUERY DIRSPACE (Query storage utilization ofFILE directories) . . . . . . . . . . . 795QUERY DOMAIN (Query a policy domain) . . 797QUERY DRIVE (Query information about adrive) . . . . . . . . . . . . . . . 800QUERY DRMEDIA (Query disaster recoverymedia) . . . . . . . . . . . . . . 804QUERY DRMSTATUS (Query disaster recoverymanager system parameters) . . . . . . . 814QUERY ENABLED (Query enabled events) . . 817QUERY EVENT (Query scheduled andcompleted events) . . . . . . . . . . . 819QUERY EVENTRULES (Query rules for serveror client events) . . . . . . . . . . . 832QUERY EVENTSERVER (Query the eventserver). . . . . . . . . . . . . . . 835QUERY EXPORT (Query for active orsuspended export operations) . . . . . . . 836QUERY EXTENTUPDATES (Query updateddata extents). . . . . . . . . . . . . 843QUERY FILESPACE (Query one or more filespaces) . . . . . . . . . . . . . . 845QUERY LIBRARY (Query a library) . . . . . 853QUERY LIBVOLUME (Query a library volume) 856

QUERY LICENSE (Display license information) 859QUERY LOG (Display information about therecovery log) . . . . . . . . . . . . 863QUERY MACHINE (Query machineinformation) . . . . . . . . . . . . . 865QUERY MEDIA (Query sequential-accessstorage pool media) . . . . . . . . . . 868QUERY MGMTCLASS (Query a managementclass) . . . . . . . . . . . . . . . 874QUERY MONITORSETTINGS (Query theconfiguration settings for monitoring alerts andserver status) . . . . . . . . . . . . 877QUERY MONITORSTATUS (Query themonitoring status) . . . . . . . . . . . 880QUERY MOUNT (Display information onmounted sequential access volumes). . . . . 884QUERY NASBACKUP (Query NAS backupimages) . . . . . . . . . . . . . . 886QUERY NODE (Query nodes) . . . . . . . 891QUERY NODEDATA (Query client data involumes) . . . . . . . . . . . . . . 903QUERY NODEGROUP (Query a node group) 906QUERY OCCUPANCY (Query client file spacesin storage pools) . . . . . . . . . . . 908QUERY OPTION (Query server options) . . . 912QUERY PATH (Display a path definition) . . . 914QUERY POLICYSET (Query a policy set) . . . 918QUERY PROCESS (Query one or more serverprocesses) . . . . . . . . . . . . . 921QUERY PROFILE (Query a profile) . . . . . 926QUERY PROXYNODE (Query proxy authorityfor a client node) . . . . . . . . . . . 929QUERY PVUESTIMATE (Display processorvalue unit estimate) . . . . . . . . . . 930QUERY RECOVERYMEDIA (Query recoverymedia) . . . . . . . . . . . . . . 934QUERY REPLICATION (Query node replicationprocesses) . . . . . . . . . . . . . 937QUERY REPLNODE (Display information aboutreplication status for a client node) . . . . . 950QUERY REPLRULE (Query replication rules) 954QUERY REPLSERVER (Query a replicationserver). . . . . . . . . . . . . . . 956QUERY REQUEST (Query one or more pendingmount requests) . . . . . . . . . . . 958QUERY RESTORE (Query restartable restoresessions) . . . . . . . . . . . . . . 959QUERY RPFCONTENT (Query recovery planfile contents stored on a target server) . . . . 962QUERY RPFILE (Query recovery plan fileinformation stored on a target server) . . . . 964QUERY SAN (Query the devices on the SAN) 967QUERY SCHEDULE (Query schedules). . . . 970QUERY SCRATCHPADENTRY (Query a scratchpad entry) . . . . . . . . . . . . . 978QUERY SCRIPT (Query IBM Spectrum Protectscripts) . . . . . . . . . . . . . . 980QUERY SERVER (Query a server) . . . . . 983QUERY SERVERGROUP (Query a server group) 988QUERY SESSION (Query client sessions) . . . 990

vi IBM Spectrum Protect for Windows: Administrator's Reference

QUERY SHREDSTATUS (Query shreddingstatus ) . . . . . . . . . . . . . . 995QUERY SPACETRIGGER (Query the spacetriggers) . . . . . . . . . . . . . . 997QUERY SSLKEYRINGPW (Query SSL keydatabase file password) . . . . . . . . . 999QUERY STATUS (Query system parameters) 1000QUERY STATUSTHRESHOLD (Query statusmonitoring thresholds) . . . . . . . . . 1010QUERY STGPOOL (Query storage pools). . . 1013QUERY STGPOOLDIRECTORY (Query astorage pool directory) . . . . . . . . . 1035QUERY SUBSCRIBER (Display subscriberinformation) . . . . . . . . . . . . 1038QUERY SUBSCRIPTION (Display subscriptioninformation) . . . . . . . . . . . . 1040QUERY SYSTEM (Query the systemconfiguration and capacity) . . . . . . . 1042QUERY TAPEALERTMSG (Display status ofSET TAPEALERTMSG command) . . . . . 1044QUERY TOC (Display table of contents for abackup image) . . . . . . . . . . . 1045QUERY VIRTUALFSMAPPING (Query avirtual file space mapping) . . . . . . . 1048QUERY VOLHISTORY (Display sequentialvolume history information) . . . . . . . 1050QUERY VOLUME (Query storage poolvolumes) . . . . . . . . . . . . . 1058

QUIT (End the interactive mode of theadministrative client) . . . . . . . . . . 1065RECLAIM STGPOOL (Reclaim volumes in asequential-access storage pool) . . . . . . . 1066RECONCILE VOLUMES (Reconcile differences inthe virtual volume definitions) . . . . . . . 1069REGISTER commands . . . . . . . . . . 1072

REGISTER ADMIN (Register an administratorID) . . . . . . . . . . . . . . . 1073REGISTER LICENSE (Register a new license) 1077REGISTER NODE (Register a node) . . . . 1079

REMOVE commands . . . . . . . . . . 1097REMOVE ADMIN (Delete an administrativeuser ID) . . . . . . . . . . . . . . 1098REMOVE DAMAGED (Remove damaged datafrom a source storage pool) . . . . . . . 1099REMOVE NODE (Delete a node or anassociated machine node) . . . . . . . . 1101REMOVE REPLNODE (Remove a client nodefrom replication) . . . . . . . . . . . 1103REMOVE REPLSERVER (Remove a replicationserver) . . . . . . . . . . . . . . 1105

RENAME commands . . . . . . . . . . 1107RENAME ADMIN (Rename an administrator) 1108RENAME FILESPACE (Rename a client filespace on the server) . . . . . . . . . . 1110RENAME NODE (Rename a node) . . . . . 1114RENAME SCRIPT (Rename an IBM SpectrumProtect script) . . . . . . . . . . . . 1116RENAME SERVERGROUP (Rename a servergroup) . . . . . . . . . . . . . . 1117RENAME STGPOOL (Change the name of astorage pool) . . . . . . . . . . . . 1118

REPAIR STGPOOL (Repair a directory-containerstorage pool) . . . . . . . . . . . . . 1119REPLICATE NODE (Replicate data in file spacesthat belong to a client node) . . . . . . . . 1122REPLY (Allow a request to continue processing) 1132RESET PASSEXP (Reset password expiration) . . 1133RESTART EXPORT (Restart a suspended exportoperation) . . . . . . . . . . . . . . 1135RESTORE commands . . . . . . . . . . 1137

RESTORE NODE (Restore a NAS node) . . . 1138RESTORE STGPOOL (Restore storage pool datafrom a copy pool or an active-data pool) . . . 1143RESTORE VOLUME (Restore primary volumedata from a copy pool or an active-data pool) . 1147

REVOKE commands . . . . . . . . . . 1151REVOKE AUTHORITY (Remove administratorauthority) . . . . . . . . . . . . . 1152REVOKE PROXYNODE (Revoke proxyauthority for a client node) . . . . . . . 1156

ROLLBACK (Rollback uncommitted changes in amacro) . . . . . . . . . . . . . . . 1157RUN (Run an IBM Spectrum Protect script) . . . 1158SELECT (Perform an SQL query of the IBMSpectrum Protect database) . . . . . . . . 1161SET commands . . . . . . . . . . . . 1171

SET ACCOUNTING (Set accounting records onor off) . . . . . . . . . . . . . . 1174SET ACTLOGRETENTION (Set the retentionperiod or the size of the activity log) . . . . 1175SET ALERTACTIVEDURATION (Set theduration of an active alert) . . . . . . . 1177SET ALERTCLOSEDDURATION (Set theduration of a closed alert) . . . . . . . . 1178SET ALERTEMAIL (Set the alert monitor toemail alerts to administrators) . . . . . . 1179SET ALERTEMAILFROMADDR (Set the emailaddress of the sender) . . . . . . . . . 1180SET ALERTEMAILSMTPHOST (Set the SMTPmail server host name) . . . . . . . . . 1181SET ALERTEMAILSMTPPORT (Set the SMTPmail server host port) . . . . . . . . . 1182SET ALERTSUMMARYTOADMINS (Set the listof administrators to receive alert summaries byemail ) . . . . . . . . . . . . . . 1183SET ALERTINACTIVEDURATION (Set theduration of an inactive alert) . . . . . . . 1184SET ALERTMONITOR (Set the alert monitor toon or off) . . . . . . . . . . . . . 1185SET ALERTUPDATEINTERVAL (Set how oftenthe alert monitor updates and prunes alerts) . 1186SET ARCHIVERETENTIONPROTECTION(Activate data retention protection) . . . . . 1187SET ARREPLRULEDEFAULT (Set the serverreplication rule for archive data). . . . . . 1189SET AUTHENTICATION (Set passwordauthentication) . . . . . . . . . . . 1191SET BKREPLRULEDEFAULT (Set the serverreplication rule for backup data). . . . . . 1192SET CLIENTACTDURATION (Set the durationperiod for the client action) . . . . . . . 1195

Contents vii

SET CONFIGMANAGER (Specify aconfiguration manager). . . . . . . . . 1196SET CONFIGREFRESH (Set managed serverconfiguration refresh) . . . . . . . . . 1197SET CONTEXTMESSAGING (Set messagecontext reporting on or off) . . . . . . . 1198SET CPUINFOREFRESH (Refresh interval forthe client workstation information scan) . . . 1199SET CROSSDEFINE (Specifies whether tocross-define servers) . . . . . . . . . . 1200SET DBRECOVERY (Set the device class forautomatic backups) . . . . . . . . . . 1201SET DEDUPVERIFICATIONLEVEL (Set thepercentage of extents to verify) . . . . . . 1204SET DEFAULTAUTHENTICATION (Set thedefault authentication method for REGISTERNODE and REGISTER ADMIN commands) . . . . 1206SET DISSIMILARPOLICIES (Enable thepolicies on the target replication server tomanage replicated data) . . . . . . . . 1208SET DRMACTIVEDATASTGPOOL (Specify theactive-data pools to be managed by DRM) . . 1210SET DRMCHECKLABEL (Specify labelchecking) . . . . . . . . . . . . . 1211SET DRMCMDFILENAME (Specify the nameof a file to contain commands) . . . . . . 1212SET DRMCOPYCONTAINERSTGPOOL(Specify the container-copy storage pools to beprocessed by DRM commands) . . . . . . 1213SET DRMCOPYSTGPOOL (Specify the copystorage pools to be managed by DRM) . . . 1214SET DRMCOURIERNAME (Specify the couriername) . . . . . . . . . . . . . . 1215SET DRMDBBACKUPEXPIREDAYS (SpecifyDB backup series expiration) . . . . . . . 1216SET DRMFILEPROCESS (Specify fileprocessing) . . . . . . . . . . . . . 1218SET DRMINSTRPREFIX (Specify the prefix forrecovery instructions file names) . . . . . 1219SET DRMNOTMOUNTABLENAME (Specifythe not mountable location name) . . . . . 1221SET DRMPLANPREFIX (Specify a prefix forrecovery plan file names) . . . . . . . . 1222SET DRMPLANVPOSTFIX (Specifyreplacement volume names) . . . . . . . 1224SET DRMPRIMSTGPOOL (Specify the primarystorage pools to be managed by DRM) . . . 1225SET DRMRPFEXPIREDAYS (Set criteria forrecovery plan file expiration) . . . . . . . 1226SET DRMVAULTNAME (Specify the vaultname) . . . . . . . . . . . . . . 1228SET EVENTRETENTION (Set the retentionperiod for event records) . . . . . . . . 1229SET FAILOVERHLADDRESS (Set a failoverhigh level address) . . . . . . . . . . 1230SET INVALIDPWLIMIT (Set the number ofinvalid logon attempts). . . . . . . . . 1231SET LDAPPASSWORD (Set the LDAPpassword for the server) . . . . . . . . 1233SET LDAPUSER (Specify an ID for an LDAPdirectory server) . . . . . . . . . . . 1234

SET LICENSEAUDITPERIOD (Set license auditperiod) . . . . . . . . . . . . . . 1235SET MAXCMDRETRIES (Set the maximumnumber of command retries) . . . . . . . 1236SET MAXSCHEDSESSIONS (Set maximumscheduled sessions) . . . . . . . . . . 1237SET MINPWLENGTH (Set minimum passwordlength) . . . . . . . . . . . . . . 1239SET MONITOREDSERVERGROUP (Set thegroup of monitored servers) . . . . . . . 1240SET MONITORINGADMIN (Set the name ofthe monitoring administrator) . . . . . . 1241SET NODEATRISKINTERVAL (Specifies at-riskmode for an individual node) . . . . . . 1242SET PASSEXP (Set password expiration date) 1244SET PRODUCTOFFERING (Set the productoffering that is licensed to your enterprise) . . 1246SET QUERYSCHEDPERIOD (Set query periodfor polling client nodes) . . . . . . . . 1248SET RANDOMIZE (Set randomization ofscheduled start times) . . . . . . . . . 1249SET REGISTRATION (Set open or closedregistration) . . . . . . . . . . . . 1251SET REPLRECOVERDAMAGED (Specifywhether damaged files are recovered from areplication server) . . . . . . . . . . 1253SET REPLRETENTION (Set the retentionperiod for replication records) . . . . . . 1256SET REPLSERVER (Set the target replicationserver) . . . . . . . . . . . . . . 1258SET RETRYPERIOD (Set time between retryattempts) . . . . . . . . . . . . . 1260SET SCHEDMODES (Select a centralscheduling mode) . . . . . . . . . . 1261SET SCRATCHPADRETENTION (Set scratchpad retention time) . . . . . . . . . . 1263SET SERVERHLADDRESS (Set the high-leveladdress of a server) . . . . . . . . . . 1264SET SERVERLLADDRESS (Set the low-leveladdress of a server) . . . . . . . . . . 1265SET SERVERNAME (Specify the server name) 1266SET SERVERPASSWORD (Set password forserver) . . . . . . . . . . . . . . 1267SET SPREPLRULEDEFAULT (Set the serverreplication rule for space-managed data) . . . 1268SET SSLKEYRINGPW (Set the SSL key ringpassword) . . . . . . . . . . . . . 1270SET STATUSATRISKINTERVAL (Specifieswhether to enable client at-risk activity intervalevaluation) . . . . . . . . . . . . . 1271SET STATUSMONITOR (Specifies whether toenable status monitoring) . . . . . . . . 1273SET STATUSREFRESHINTERVAL (Set refreshinterval for status monitoring) . . . . . . 1275SET STATUSSKIPASFAILURE (Specifieswhether to use client at-risk skipped files asfailure evaluation) . . . . . . . . . . 1277SET SUBFILE (Set subfile backup for clientnodes) . . . . . . . . . . . . . . 1279SET SUMMARYRETENTION (Set number ofdays to keep data in activity summary table) . 1280

viii IBM Spectrum Protect for Windows: Administrator's Reference

SET TAPEALERTMSG (Set tape alert messageson or off) . . . . . . . . . . . . . 1281SET TOCLOADRETENTION (Set loadretention period for table of contents) . . . . 1282SET VMATRISKINTERVAL (Specifies theat-risk mode for an individual VM filespace) . 1283

SETOPT (Set a server option for dynamic update) 1285SHRED DATA (Shred data) . . . . . . . . 1287SUSPEND EXPORT (Suspend a currently runningexport operation) . . . . . . . . . . . . 1289UNLOCK commands . . . . . . . . . . 1290

UNLOCK ADMIN (Unlock an administrator) 1291UNLOCK NODE (Unlock a client node) . . . 1293UNLOCK PROFILE (Unlock a profile). . . . 1295

UPDATE commands . . . . . . . . . . 1296UPDATE ALERTTRIGGER (Update a definedalert trigger) . . . . . . . . . . . . 1297UPDATE ALERTSTATUS (Update the status ofan alert) . . . . . . . . . . . . . . 1300UPDATE ADMIN (Update an administrator) 1302UPDATE BACKUPSET (Update a retentionvalue assigned to a backup set) . . . . . . 1306UPDATE CLIENTOPT (Update a client optionsequence number) . . . . . . . . . . 1311UPDATE CLOPTSET (Update a client optionset description) . . . . . . . . . . . 1312UPDATE COLLOCGROUP (Update acollocation group) . . . . . . . . . . 1313UPDATE COPYGROUP (Update a copy group) 1314UPDATE DATAMOVER (Update a datamover) . . . . . . . . . . . . . . 1322UPDATE DEVCLASS (Update the attributes ofa device class) . . . . . . . . . . . . 1324UPDATE DOMAIN (Update a policy domain) 1380UPDATE DRIVE (Update a drive) . . . . . 1382UPDATE FILESPACE (Update file-spacenode-replication rules) . . . . . . . . . 1386UPDATE LIBRARY (Update a library) . . . . 1391UPDATE LIBVOLUME (Change the status of astorage volume) . . . . . . . . . . . 1408UPDATE MACHINE (Update machineinformation) . . . . . . . . . . . . 1410UPDATE MGMTCLASS (Update amanagement class) . . . . . . . . . . 1412UPDATE NODE (Update node attributes) . . 1415UPDATE NODEGROUP (Update a nodegroup) . . . . . . . . . . . . . . 1433UPDATE PATH (Change a path) . . . . . 1434UPDATE POLICYSET (Update a policy setdescription) . . . . . . . . . . . . 1442UPDATE PROFILE (Update a profiledescription) . . . . . . . . . . . . 1444UPDATE RECOVERYMEDIA (Update recoverymedia) . . . . . . . . . . . . . . 1445UPDATE REPLRULE (Update replication rules) 1447UPDATE SCHEDULE (Update a schedule) 1449UPDATE SCRATCHPADENTRY (Update ascratch pad entry) . . . . . . . . . . 1474UPDATE SCRIPT (Update an IBM SpectrumProtect script) . . . . . . . . . . . . 1475

UPDATE SERVER (Update a server defined forserver-to-server communications) . . . . . 1478UPDATE SERVERGROUP (Update a servergroup description) . . . . . . . . . . 1482UPDATE SPACETRIGGER (Update the spacetriggers) . . . . . . . . . . . . . . 1483UPDATE STATUSTHRESHOLD (Update astatus monitoring threshold) . . . . . . . 1485UPDATE STGPOOL (Update a storage pool) 1489UPDATE STGPOOLDIRECTORY (Update astorage pool directory) . . . . . . . . . 1540UPDATE VIRTUALFSMAPPING (Update avirtual file space mapping) . . . . . . . 1543UPDATE VOLHISTORY (Update sequentialvolume history information) . . . . . . . 1545UPDATE VOLUME (Change a storage poolvolume) . . . . . . . . . . . . . . 1547

VALIDATE commands . . . . . . . . . . 1551VALIDATE LANFREE (Validate LAN-Freepaths) . . . . . . . . . . . . . . 1552VALIDATE POLICYSET (Verify a policy set) 1554VALIDATE REPLICATION (Validatereplication for a client node) . . . . . . . 1556VALIDATE REPLPOLICY (Verify the policieson the target replication server) . . . . . . 1561

VARY (Bring a random access volume online oroffline) . . . . . . . . . . . . . . . 1564

Chapter 3. Server options . . . . . 1567Modifying server options . . . . . . . . . 1567Types of server options. . . . . . . . . . 1568

Server communication options . . . . . . 1568Server storage options . . . . . . . . . 1570Client-server options . . . . . . . . . 1571Date, number, time, and language options . . 1571Database options . . . . . . . . . . . 1571Data transfer options . . . . . . . . . 1572Message options . . . . . . . . . . . 1572Event logging options . . . . . . . . . 1573Security options and licensing options. . . . 1573Miscellaneous options . . . . . . . . . 1574

3494SHARED . . . . . . . . . . . . . 1575ACSACCESSID . . . . . . . . . . . . 1576ACSLOCKDRIVE . . . . . . . . . . . 1577ACSQUICKINIT . . . . . . . . . . . . 1578ACSTIMEOUTX . . . . . . . . . . . . 1579ACTIVELOGDIRECTORY . . . . . . . . . 1580ACTIVELOGSIZE . . . . . . . . . . . 1581ADMINCOMMTIMEOUT . . . . . . . . . 1582ADMINIDLETIMEOUT . . . . . . . . . 1583ADMINONCLIENTPORT . . . . . . . . . 1584ADSMGROUPNAME . . . . . . . . . . 1585ALIASHALT . . . . . . . . . . . . . 1586ALLOWDESAUTH . . . . . . . . . . . 1587ALLOWREORGINDEX. . . . . . . . . . 1588ALLOWREORGTABLE . . . . . . . . . . 1589ARCHFAILOVERLOGDIRECTORY. . . . . . 1590ARCHLOGCOMPRESS. . . . . . . . . . 1591ARCHLOGDIRECTORY . . . . . . . . . 1592ARCHLOGUSEDTHRESHOLD . . . . . . . 1593ASSISTVCRRECOVERY . . . . . . . . . 1594

Contents ix

AUDITSTORAGE . . . . . . . . . . . 1595BACKUPINITIATIONROOT . . . . . . . . 1596CHECKTAPEPOS . . . . . . . . . . . 1597CLIENTDEDUPTXNLIMIT . . . . . . . . 1599COMMMETHOD . . . . . . . . . . . 1601COMMTIMEOUT . . . . . . . . . . . 1603DATEFORMAT . . . . . . . . . . . . 1604DBDIAGLOGSIZE . . . . . . . . . . . 1605DBDIAGPATHFSTHRESHOLD . . . . . . . 1607DBMEMPERCENT . . . . . . . . . . . 1608DBMTCPPORT . . . . . . . . . . . . 1609DEDUPREQUIRESBACKUP . . . . . . . . 1610DEDUPTIER2FILESIZE. . . . . . . . . . 1611DEDUPTIER3FILESIZE. . . . . . . . . . 1612DEVCONFIG . . . . . . . . . . . . . 1613DISABLEREORGTABLE . . . . . . . . . 1614DISABLESCHEDS . . . . . . . . . . . 1615DISPLAYLFINFO. . . . . . . . . . . . 1616DNSLOOKUP . . . . . . . . . . . . . 1617DRIVEACQUIRERETRY . . . . . . . . . 1618ENABLENASDEDUP . . . . . . . . . . 1619EVENTSERVER . . . . . . . . . . . . 1620EXPINTERVAL . . . . . . . . . . . . 1621EXPQUIET . . . . . . . . . . . . . . 1622FFDCLOGLEVEL . . . . . . . . . . . 1623FFDCLOGNAME . . . . . . . . . . . 1624FFDCMAXLOGSIZE . . . . . . . . . . 1625FFDCNUMLOGS. . . . . . . . . . . . 1626FILEEXIT . . . . . . . . . . . . . . 1627FILETEXTEXIT . . . . . . . . . . . . 1628FSUSEDTHRESHOLD . . . . . . . . . . 1629IDLETIMEOUT . . . . . . . . . . . . 1630KEEPALIVE . . . . . . . . . . . . . 1631KEEPALIVETIME . . . . . . . . . . . 1632KEEPALIVEINTERVAL. . . . . . . . . . 1633LANGUAGE . . . . . . . . . . . . . 1634LDAPCACHEDURATION. . . . . . . . . 1635LDAPURL . . . . . . . . . . . . . . 1636MAXSESSIONS . . . . . . . . . . . . 1637MESSAGEFORMAT . . . . . . . . . . . 1638MIRRORLOGDIRECTORY . . . . . . . . 1639MOVEBATCHSIZE . . . . . . . . . . . 1640MOVESIZETHRESH . . . . . . . . . . 1641MSGINTERVAL . . . . . . . . . . . . 1642NAMEDPIPENAME . . . . . . . . . . 1643NDMPCONNECTIONTIMEOUT . . . . . . 1644NDMPCONTROLPORT . . . . . . . . . 1645NDMPENABLEKEEPALIVE . . . . . . . . 1646NDMPKEEPIDLEMINUTES . . . . . . . . 1647NDMPPORTRANGE . . . . . . . . . . 1648NDMPPREFDATAINTERFACE . . . . . . . 1649NOPREEMPT . . . . . . . . . . . . . 1650NORETRIEVEDATE. . . . . . . . . . . 1651NPAUDITFAILURE . . . . . . . . . . . 1652NPAUDITSUCCESS . . . . . . . . . . . 1653NPBUFFERSIZE . . . . . . . . . . . . 1654NUMBERFORMAT . . . . . . . . . . . 1655NUMOPENVOLSALLOWED. . . . . . . . 1656PUSHSTATUS . . . . . . . . . . . . . 1658QUERYAUTH . . . . . . . . . . . . . 1659RECLAIMDELAY . . . . . . . . . . . 1660

RECLAIMPERIOD . . . . . . . . . . . 1661REORGBEGINTIME. . . . . . . . . . . 1662REORGDURATION . . . . . . . . . . . 1663REPORTRETRIEVE . . . . . . . . . . . 1664REPLBATCHSIZE . . . . . . . . . . . 1665REPLSIZETHRESH . . . . . . . . . . . 1666REQSYSAUTHOUTFILE . . . . . . . . . 1667RESOURCETIMEOUT . . . . . . . . . . 1668RESTOREINTERVAL . . . . . . . . . . 1669RETENTIONEXTENSION . . . . . . . . . 1670SANDISCOVERY. . . . . . . . . . . . 1671SANDISCOVERYTIMEOUT . . . . . . . . 1672SANREFRESHTIME . . . . . . . . . . . 1673SEARCHMPQUEUE. . . . . . . . . . . 1674SECUREPIPES. . . . . . . . . . . . . 1675SERVERDEDUPTXNLIMIT . . . . . . . . 1676SHMPORT . . . . . . . . . . . . . . 1678SHREDDING . . . . . . . . . . . . . 1679SNMPHEARTBEATINTERVAL . . . . . . . 1680SNMPMESSAGECATEGORY. . . . . . . . 1681SNMPSUBAGENT . . . . . . . . . . . 1682SNMPSUBAGENTHOST . . . . . . . . . 1683SNMPSUBAGENTPORT . . . . . . . . . 1684SSLDISABLELEGACYTLS . . . . . . . . . 1685SSLFIPSMODE . . . . . . . . . . . . 1686SSLHIDELEGACYTLS . . . . . . . . . . 1687SSLINITTIMEOUT . . . . . . . . . . . 1688SSLTCPADMINPORT . . . . . . . . . . 1689SSLTCPPORT . . . . . . . . . . . . . 1690SSLTLS12 . . . . . . . . . . . . . . 1691TCPADMINPORT . . . . . . . . . . . 1692TCPNODELAY . . . . . . . . . . . . 1693TCPPORT . . . . . . . . . . . . . . 1694TCPWINDOWSIZE . . . . . . . . . . . 1695TECBEGINEVENTLOGGING . . . . . . . 1696TECHOST . . . . . . . . . . . . . . 1697TECPORT . . . . . . . . . . . . . . 1698TECUTF8EVENT . . . . . . . . . . . . 1699THROUGHPUTDATATHRESHOLD . . . . . 1700THROUGHPUTTIMETHRESHOLD . . . . . 1701TIMEFORMAT . . . . . . . . . . . . 1702TXNGROUPMAX . . . . . . . . . . . 1703UNIQUETDPTECEVENTS . . . . . . . . 1704UNIQUETECEVENTS . . . . . . . . . . 1705USEREXIT . . . . . . . . . . . . . . 1706VERBCHECK . . . . . . . . . . . . . 1707VOLUMEHISTORY . . . . . . . . . . . 1708

Chapter 4. Server utilities. . . . . . 1709DSMMAXSG (Increase the block size for writingdata) . . . . . . . . . . . . . . . . 1710DSMSERV (Start the server) . . . . . . . . 1711DSMSERV DISPLAY DBSPACE (Displayinformation about database storage space) . . . 1713DSMSERV DISPLAY LOG (Display recovery loginformation) . . . . . . . . . . . . . 1714DSMSERV EXTEND DBSPACE (Increase space forthe database) . . . . . . . . . . . . . 1716DSMSERV FORMAT (Format the database andlog) . . . . . . . . . . . . . . . . 1718

x IBM Spectrum Protect for Windows: Administrator's Reference

DSMSERV INSERTDB (Move a server databaseinto an empty database) . . . . . . . . . 1721DSMSERV LOADFORMAT (Format a database) 1724DSMSERV REMOVEDB (Remove a database) 1726DSMSERV RESTORE DB (Restore the database) 1728

DSMSERV RESTORE DB (Restore a database toits most current state) . . . . . . . . . 1729DSMSERV RESTORE DB (Restore a database toa point-in-time) . . . . . . . . . . . 1733

DSMSERV UPDATE (Create registry entries for aserver instance) . . . . . . . . . . . . 1738

Appendix A. Return codes for use inIBM Spectrum Protect scripts . . . . 1739

Appendix B. Accessibility featuresfor the IBM Spectrum Protectproduct family . . . . . . . . . . 1743

Notices . . . . . . . . . . . . . 1745

Glossary . . . . . . . . . . . . . 1749

Index . . . . . . . . . . . . . . 1751

Contents xi

xii IBM Spectrum Protect for Windows: Administrator's Reference

About this publication

IBM Spectrum Protect™ is a client/server program that provides storagemanagement solutions to customers in a multi-vendor computer environment. IBMSpectrum Protect provides an automated, centrally scheduled, policy-managedbackup, archive, and space-management facility for file servers and workstations.

This publication provides you with the commands and options that you can use tomanage the IBM Spectrum Protect server.

Who should read this guideThis reference is intended for anyone who is registered as an administrator. Asingle administrator can manage IBM Spectrum Protect, or several people canshare administrative responsibilities.

You should be familiar with the operating system on which the server resides andthe communication protocols required for the client/server environment. You alsoneed to understand the storage management practices of your organization, suchas how you are currently backing up workstation files and how you are usingstorage devices.

PublicationsThe IBM Spectrum Protect product family includes IBM Spectrum ProtectSnapshot, IBM Spectrum Protect for Space Management, IBM Spectrum Protect forDatabases, and several other storage management products from IBM®.

To view IBM product documentation, see IBM Knowledge Center.

Conventions used in this publicationv Command to be entered on the Windows command line:

> dsmadmc

v Command to be entered on the command line of an administrative client:query devclass

In the usage and descriptions for administrative commands, the term characterscorresponds to the number of bytes available to store an item. For languages inwhich it takes a single byte to represent a displayable character, the character tobyte ratio is 1 to 1. However, for DBCS and other multi-byte languages, thereference to characters refers only to the number of bytes available for the item andmay represent fewer actual characters.

© Copyright IBM Corp. 1993, 2016 xiii

http://www.ibm.com/support/knowledgecenter

What's new in Version 8.1IBM Spectrum Protect Version 8.1 introduces new features and updates.

For a list of new features and updates, see What's new.

xiv IBM Spectrum Protect for Windows: Administrator's Reference

http://www.ibm.com/support/knowledgecenter/SSEQVQ_8.1.0/srv.common/r_wn_tsmserver.html

Chapter 1. Managing the server from the command line

IBM Spectrum Protect provides several different command-line interfaces formanaging IBM Spectrum Protect servers.

About this task

The following command-line interfaces are available:

Administrative command-line clientThe administrative command-line client is a program that runs on a fileserver, workstation, or mainframe. It is installed as part of the IBMSpectrum Protect server installation process. The administrative client canbe accessed remotely.

From the administrative client, you can issue any server commands.

Server consoleThe server console is a command-line window on the system where theserver is installed. Therefore, to use the server console, you must be at thephysical location of the server system.

Compared to the administrative client, the capabilities of the server consoleare limited. From the server console, you cannot issue certain commands,and you cannot route commands to other servers. Also, you cannot specifythat certain commands process before other commands can be issued.However, this limitation can be useful if, for example, you want to run twocommands in quick succession.

Operations Center command lineFrom the Operations Center, you can access the IBM Spectrum Protectcommand line. You might want to use this command line to issue servercommands to complete certain IBM Spectrum Protect tasks that are notsupported in the Operations Center.

Server scripts provide for automation of common administrative tasks. A macro isa file that contains one or more IBM Spectrum Protect administrative commands.When you issue the MACRO command, the server processes all commands in themacro file in order, including commands that are contained in any nested macros.

Issuing commands from the administrative clientThe administrative command-line client is a program that runs on a file server,workstation, or mainframe.

About this task

Ensure that your administrative client and your server are running in compatiblelanguages. See “LANGUAGE” on page 1634 for language and locale options. Ifyour client and server are using different languages, the messages that IBMSpectrum Protect generates might not be understandable.

Tip: Text strings that are sent from the client to the server do not depend on theserver language setting. The text is displayed properly if the administrative clientruns in the same locale when sending the string and when receiving the string.

© Copyright IBM Corp. 1993, 2016 1

For example, assume that you update a node contact field with a value thatcontains national characters (update node myNode contact=NLcontact_info), andlater query the node (query node myNode format=detailed). If the client is runningin the same locale when you update as when you query, the NLcontact_infodisplays properly. If you update the node contact field when the client is runningin one locale, and query the node when the client is running in a different locale,the NLcontact_info might not display properly.

Starting and stopping the administrative clientUse the DSMADMC command to start an administrative client session.

About this task

The IBM Spectrum Protect server must be running before an administrative clientcan connect.

Procedurev To start an administrative client session in command-line mode, enter this

command on your workstation:dsmadmc -id=admin -password=admin -dataonly=yes

By entering the DSMADMC command with the -ID and -PASSWORD options asshown, you are not prompted for a user ID and password.

v To stop an administrative command-line client session, enter the followingcommand:quit

v To interrupt a DSMADMC command before the IBM Spectrum Protect server finishesprocessing it, use the UNIX kill -9 command from an available command line.Do not press Ctrl+C because, while it ends the session, it can lead to unexpectedresults.

Monitoring server activities from the administrative clientTo monitor IBM Spectrum Protect activities, such as server migration and clientlogons, run the administrative client in console mode. You cannot enter anyadministrative commands in console mode.

Procedurev To start an administrative client session in console mode, enter the following

command:dsmadmc -consolemode

You are prompted for a password if authentication is turned on for the server. Ifyou do not want to be prompted for your user ID and password, enter theDSMADMC command with the -ID and -PASSWORD options.

v To end an administrative client session in console mode, use a keyboard breaksequence.

Operating system Break sequence

UNIX and Linux clients Ctrl+C

Windows clients Ctrl+C or Ctrl+Break

2 IBM Spectrum Protect for Windows: Administrator's Reference

Monitoring removable-media mounts from the administrativeclient

To monitor the mounting and dismounting of removable media, run theadministrative client in mount mode. When the client is running in mount mode,you cannot enter any administrative commands.

Procedurev To start an administrative client session in mount mode, enter the following

command:dsmadmc -mountmode

You are prompted for a password if authentication is turned on for the server. Ifyou do not want to be prompted for your user ID and password, enter theDSMADMC command with the -ID and -PASSWORD options.

v To end an administrative client session in mount mode, use a keyboard breaksequence.

Operating system Break sequence

UNIX and Linux clients Ctrl+C

Windows clients Ctrl+C or Ctrl+Break

Processing individual commands from the administrativeclient

Use batch mode to enter a single administrative command. Your administrativeclient session automatically ends when the command is processed.

Procedure

To start an administrative client session in batch mode, use the followingcommand: dsmadmc server_commandIf you do not want to be prompted for your user ID and password, you can enterthe DSMADMC command with the -ID and -PASSWORD options.In batch mode, you must enter the complete command on one line. If a commanddoes not fit on one line, enter the command by using a macro or a script. If youspecify a parameter with a string of text using batch mode, enclose the text insingle quotation marks (' ') in the macro. Do not use double quotation marks forcommands in batch mode, because your operating system might not parse thequotation marks correctly.You can bypass this batch mode double quotation mark restriction for Windowsclients by using the back slash (\) escape character. For example, on the OBJECTSparameter of the DEFINE CLIENTACTION command, you could enter the stringwith the \ character preceding the double quotation marks in the command.dsmadmc -id=admin -password=admin define clientaction test_node domain=test_domaction=restore objects=’\"C:\program files\test\*\"’

Chapter 1. Managing the server from the command line 3

Processing a series of commands from the administrativeclient

Use the interactive mode to process a series of administrative commands.

About this task

To start an administrative client session in interactive mode, a server session mustbe available. To ensure the availability of server sessions for both administrativeand client node sessions, the interactive mode of the administrative client isdisconnected if one or more of the following conditions is true:v The server was stopped using the HALT command.v Commands were not issued from the administrative client session for the length

of time specified with the IDLETIMEOUT server option.v The administrative client session was canceled with the CANCEL SESSION

command.

Procedure

To start an administrative session in interactive mode, use the following command:dsmadmcYou can use continuation characters when using interactive mode. For moreinformation, see “Using continuation characters to enter long commands” on page13.You can automatically restart your administrative client session by enteringanother command each time the tsm: servername > prompt appears.Do not enter a server command with the DSMADMC command. Doing so will start theadministrative client in batch, not interactive, mode. For example, do not enter:dsmadmc server_command

Formatting output from commandsIBM Spectrum Protect formats the output processed from commands according toyour screen or window width.

Procedurev If the width of your screen or window is not wide enough to display the output

horizontally, IBM Spectrum Protect arranges and displays the informationvertically.

v You can format the output of QUERY commands using the DISPLAYMODE andOUTFILE administrative client options.

Saving command output to a specified locationThe most common use for redirecting output is to save the output from querycommands to a specified file or program. You can then browse the contents of thefile or in some cases, print the contents.

About this task

On some operating systems, you can redirect output of a command by usingspecial characters such as >, >>, and |. Redirection characters direct the output ofa command to a file or program that you specify instead of to your screen. You cansave the output from a command by entering redirection characters at the end ofthe command. To redirect output, leave a blank between the redirection characterand the file or program name. See the following examples.

4 IBM Spectrum Protect for Windows: Administrator's Reference

When redirecting output, follow the naming conventions of the operating systemwhere you are running the administrative client.

Procedure

The examples in the following table show how to redirect command output.

Task Procedure

Redirect the output of a QUERYDOMAIN command to a new file inbatch or interactive mode

Use a single greater-than sign (>) to redirect the output to a new file or writeover an existing file:

dsmadmc -id=xxx -pa=xxx query domain acctg > dominfo.acc

Append the output of a QUERYDOMAIN command to the end of anexisting file in batch or interactivemode

Use two consecutive greater-than signs (>>) to append the output to the end ofan existing file:

dsmadmc -id=xxx -pa=xxx query domain acctg >> dominfo.acc

Redirect all output from anadministrative client session inconsole mode to a program calledfilter.exe

Use the vertical bar (|) to direct all output for a session to a program:

dsmadmc -console -id=admin -password=xxx | filter.exe

The program can be set up to monitor the output for individual messages asthey occur and take appropriate action, such as sending mail to another user.

In console mode, redirect alloutput to a file

Specify the -OUTFILE option with a destination file name. For example, thefollowing command redirects all output to the save.out file:

dsmadmc -id=sullivan -password=secret -consolemode -outfile=save.out

Administrative client optionsIn all administrative client modes, you can use options to modify administrativeclient session responses.

Syntax

►► DSMADMC ▼

admin_client_option server_command►◄

Example of using administrative client options

You can enter the DSMADMC command with your user ID and password by using the-ID and -PASSWORD options so that you are not prompted for that information. Tohave IBM Spectrum Protect redirect all output to a file, specify the -OUTFILE optionwith a destination file name. For example, to issue the QUERY NODE command inbatch mode with the output redirected to the SAVE.OUT file, enter:dsmadmc -id=sullivan -password=secret -outfile=save.out query node

Options

Administrative client options can be specified with the DSMADMC command and arevalid from an administrative client session only. You can type an option inuppercase letters, lowercase letters, or any combination. Uppercase letters denotethe shortest acceptable abbreviation. If an option appears entirely in uppercaseletters, you cannot abbreviate it.

Chapter 1. Managing the server from the command line 5

-ALWAYSPromptSpecifies that a command prompt is displayed if the input is from thekeyboard or if it is redirected (for example, from a file). If this option is notspecified and the input is redirected, the command prompt is not written.

If the input is redirected, only the command output is displayed. If this optionis specified, the command prompt and the command output are displayed.

-CHECKAliashaltAllows the administrative client to recognize an alias for the HALT command asset in the ALIASHALT server option. See “ALIASHALT” on page 1586 fordetails.

-COMMAdelimitedSpecifies that any tabular output from a server query is to be formatted ascomma-separated strings rather than in readable format. This option isintended to be used primarily when you redirect the output of an SQL query(SELECT command). The comma-separated value format is a standard dataformat, which can be processed by many common programs, includingspreadsheets, databases, and report generators.

-CONsolemodeSpecifies that IBM Spectrum Protect runs in console mode. Most server consoleoutput is echoed to your screen. The exception are items such as responses toquery commands that are issued from the console, trace output, or any systemmessages that displayed on the console.

-DATAONLY=NO or YESSpecifies whether product version information and output headers displaywith the output. The default is NO.

NO Specifies that the product version information and output column headersdisplay.

YESSuppresses the product version information and output column headers.

-DISPLaymode=LISt or TABleYou can force the QUERY output to tabular or list format regardless of thecommand-line window column width.

If you are using the -DISPLAYMODE option and you want the output to go to afile, do not specify the -OUTFILE option. Use redirection to write to the file.

-ID=useridSpecifies the administrator's user ID.

-ItemcommitSpecifies that IBM Spectrum Protect commits commands inside a script or amacro as each command is processed.

-MOUNTmodeSpecifies that IBM Spectrum Protect runs in mount mode. All serverremovable-media mount messages are echoed to your screen.

-NEWLINEAFTERPromptSpecifies that a newline character is written after the command prompt andcommands that are entered from the keyboard are displayed underneath theprompt. If this option is not specified, commands entered from the keyboardare displayed to the right side of the prompt.

6 IBM Spectrum Protect for Windows: Administrator's Reference

-NOConfirmSpecifies that you do not want IBM Spectrum Protect to request confirmationbefore processing commands that affect the availability of the server or datathat is managed by the server.

-OUTfileSpecifies that output from a server query is displayed in one row. If the outputin a row exceeds the column width that is defined by the server, the output isdisplayed on multiple lines in that row. This option is available in batch modeonly.

-OUTfile=filenameSpecifies that output from a server query is redirected to a specified file. Inbatch mode, output is redirected to a file you specify and the format of theoutput matches the format of the output on your screen.

In interactive, console, or mount mode sessions, output displays on yourscreen.

-PAssword=passwordSpecifies the administrator's password.

-QuietSpecifies that IBM Spectrum Protect does not display standard outputmessages to your screen. However, when you use this option, certain errormessages still appear.

-TABdelimitedSpecifies that any tabular output from a server query is to be formatted astab-separated strings rather than in readable format. This option is intended tobe used primarily when you redirect the output of an SQL query (SELECTcommand). The tab-separated value format is a standard data format, whichcan be processed by many common programs, including spreadsheets,databases, and report generators.

-TCPPortSpecifies a TCP/IP port address for an IBM Spectrum Protect server. TheTCPPORT option is only supported by administrative clients that are running onWindows operating systems and is valid on the Windows administrative clientcommand line.

-TCPServeraddressSpecifies a TCP/IP server address for an IBM Spectrum Protect server. TheTCPSERVERADDRESS option is only supported by administrative clients that arerunning on Windows operating systems and is valid on the Windowsadministrative client command line.

In addition to the options that are listed here, you can also specify any option thatis in the client options file. Each option must be preceded with a hyphen anddelimited with a space.

Chapter 1. Managing the server from the command line 7

Issuing commands from the Operations CenterFrom the Operations Center command-line interface, you can issue commands tomanage IBM Spectrum Protect servers that are configured as hub or spoke servers.

Procedure

To open the command-line interface, hover over the globe icon

in theOperations Center menu bar, and click Command Builder.

Issuing commands from the server consoleIBM Spectrum Protect provides a user ID named SERVER_CONSOLE that allowsyou to issue commands and administer the server from the server console afterIBM Spectrum Protect is installed. At installation, SERVER_CONSOLE isautomatically registered as an administrator and is given system authority.

About this task

If you have system privilege, you can revoke or grant new privileges to theSERVER_CONSOLE user ID. You cannot take any of the following actions:v Register or update the SERVER_CONSOLE user IDv Lock or unlock the SERVER_CONSOLE user IDv Rename the SERVER_CONSOLE user IDv Remove SERVER_CONSOLE user IDv Route commands from the SERVER_CONSOLE user ID

Not all IBM Spectrum Protect commands are supported by the server console. Youcannot specify the WAIT parameter from the server console.

Entering administrative commandsCommands consist of command names and usually parameters and variables.Syntax diagrams depict the rules to follow when entering commands.

About this task

To display command-line help for server commands that have unique names, youcan type help commandName, where commandName is the name of the servercommand for which you want information. For example, to display help for theREGISTER NODE command, type help register node. Command syntax andparameter descriptions are displayed in the output.

You can also type help followed by the topic number for the command. Topicnumbers are listed in the table of contents for command-line help, for example:3.0 Administrative commands

3.46 REGISTER3.46.1 REGISTER ADMIN (Register an administrator)3.46.2 REGISTER LICENSE (Register a new license)3.46.3 REGISTER NODE (Register a node)

To display help about the REGISTER NODE command, type:help 3.46.3

8 IBM Spectrum Protect for Windows: Administrator's Reference

Use topic numbers to display command-line help for subcommands. DEFINEDEVCLASS is an example of a command that has subcommands. For example, youcan specify the DEFINE DEVCLASS command for 3590 device classes and for 3592device classes:3.0 Administrative commands

...3.13.10 DEFINE DEVCLASS (Define a device class)

3.13.10.1 DEFINE DEVCLASS (Define a 3590 device class)3.13.10.2 DEFINE DEVCLASS (Define a 3592 device class)...

To display help for the DEFINE DEVCLASS command for 3590 device classes, type:help 3.13.10.1

Reading syntax diagramsTo read a syntax diagram for entering a command, follow the path of the line.Read from left to right and from top to bottom.v The ►►─── symbol indicates the beginning of a syntax diagram.v The ───► symbol at the end of a line indicates that the syntax diagram continues

onto the next line.v The ►─── symbol at the beginning of a line indicates that a syntax diagram

continues from the previous line.v The ───►◄ symbol indicates the end of a syntax diagram.

Command names

The command name can consist of a single action word, such as HALT, or it canconsist of an action word and an object for the action, such as DEFINE DOMAIN.You can enter the command in any column of the input line.

Enter the entire command name or the abbreviation that is specified in the syntaxdiagram for the command. Uppercase letters denote the shortest acceptableabbreviation. If a command appears entirely in uppercase letters, you cannotabbreviate it. You can enter the command in uppercase letters, lowercase letters, orany combination. In this example, you can enter CMDNA, CMDNAM, orCMDNAME in any combination of uppercase and lowercase letters.

►► CMDNAme ►◄

Note: Command names in descriptive text are always capitalized.

Required parameters

When a parameter is on the same line as the command name, the parameter isrequired. When two or more parameter values are in a stack and one of them is onthe line, you must specify one value.

In this example, you must enter PARMNAME=A, PARMNAME=B, orPARMNAME=C. Do not include any blanks immediately before or after the equalsign (=).

Chapter 1. Managing the server from the command line 9

►► PARMName = ABC

►◄

Optional parameters

When a parameter is below the line, the parameter is optional. In this example,you can enter PARMNAME=A or nothing at all. Do not include any blanksimmediately before or after the equal sign (=).

►►PARMName = A

►◄

When two or more parameter values are in a stack below the line, all of them areoptional. In this example, you can enter PARMNAME=A, PARMNAME=B,PARMNAME=C, or nothing at all. Do not include any blanks immediately beforeor after the equal sign (=).

►►PARMNAme = A

BC

►◄

Defaults

Defaults are above the line. The system uses the default unless you override it. Youcan override the default by entering an option from the stack below the line.

In this example, PARMNAME=A is the default. You can also enterPARMNAME=A, PARMNAME=B, or PARMNAME=C. Do not include any blanksbefore or after the equal sign (=).

►►PARMNAme = A

PARMName = ABC

►◄

Variables

Highlighted lowercase items (like this) denote variables. In these examples,var_name represents variables::

►► CMDNAme var_name ►◄

►►PARMname = var_name

►◄

10 IBM Spectrum Protect for Windows: Administrator's Reference

Special characters

You must code these symbols exactly as they appear in the syntax diagram.

* Asterisk

: Colon

, Comma

= Equal sign

- Hyphen

( ) Parentheses

. Period

Repeating values

An arrow returning to the left means that the item can be repeated. A characterwithin the arrow means that you must separate repeated items with that character.

►► ▼

,

file_name ►◄

Repeatable choices

A stack of values followed by an arrow returning to the left means that you canselect more than one value or, when permitted, repeat a single item. In thisexample, you can choose more than one value, with each name delimited with acomma. Do not include any blanks before or after the equal sign (=).

►► ▼

,

PARMNAme = value1value2value3

►◄

Footnotes

Footnotes are enclosed in parentheses.

►► ▼

,(1)

file_name ►◄

Notes:

1 You can specify up to five file names.

Entering parameters

The order in which you enter parameters can be important. The following exampleshows a portion of the command for defining a copy storage pool:

Chapter 1. Managing the server from the command line 11

►► DEFine STGpool pool_name device_class_name POoltype = COpy ►

►DESCription = description

REClaim = 100

REClaim = percent►◄

The first two parameters in this command (pool_name and device_class_name arerequired parameters. pool_name and device_class_name are also positional. That is,they must be entered in the order shown, immediately after the command name.The POOLTYPE parameter is a required keyword parameter. DESCRIPTION andRECLAIM, are optional keyword parameters. Keyword parameters are identified byan equal sign that specifies a specific value or a variable. Keyword parametersmust follow any positional parameters in a command.

The following command entries, in which the keyword parameters are ordereddifferently, are both acceptable:define stgpool mycopypool mydeviceclass pooltype=copy description=engineering

reclaim=50define stgpool mycopypool mydeviceclass description=engineering pooltype=copy

reclaim=50

The following example, in which one of the positional parameters follows akeyword parameter, is not acceptable:define stgpool mycopypool pooltype=copy mydeviceclass description=engineering

reclaim=50

Syntax fragments

Some diagrams, because of their length, must display parts of the syntax withfragments. The fragment name appears between vertical bars in the diagram.

The expanded fragment appears in the diagram after all other parameters or at thebottom of the diagram. A heading with the fragment name identifies the expandedfragment. Commands appearing directly on the line are required.

In this example, the fragment is named “Fragment”.

►► Fragment ►◄

Fragment:

A

BC

12 IBM Spectrum Protect for Windows: Administrator's Reference

Using continuation characters to enter long commandsContinuation characters are useful when you want to process a command that islonger than your screen or window width. You can use continuation characters inthe interactive mode of the administrative client.

About this task

Without continuation characters, you can enter up to 256 characters. Withcontinuation characters, you can enter up to 1500 characters.

Note: In the MACRO command, the maximums apply after any substitution variableshave been applied.

With continuation characters, you can do the following:v Enter a dash at the end of the line you want to continue.

For example:register admin pease mypasswd -contact="david, ext1234"

v Continue a list of values by entering a dash or a back slash, with no precedingblank spaces, after the last comma of the list that you enter on the first line.Then, enter the remaining items in the list on the next line with no precedingblank spaces. For example:stgpools=stg1,stg2,stg3,-stg4,stg5,stg6

v Continue a string of values that are enclosed in quotation marks by entering thefirst part of the string that is enclosed in quotation marks, followed by a dash ora back slash at the end of the line. Then, enter the remainder of the string on thenext line, enclosed in the same type of quotation marks.For example:contact="david pease, bldg. 100, room 2b, san jose,"-"ext. 1234, alternate contact-norm pass,ext 2345"

IBM Spectrum Protect concatenates the two strings with no intervening blanks.You must use only this method to continue a quoted string of values acrossmore than one line.

Naming IBM Spectrum Protect objectsIBM Spectrum Protect restricts the number and type of characters that you can useto name objects.

About this task

The following characters are available for defining object names.

Character Description

A–Z Any letter, A through Z

0–9 Any number, 0 through 9

_ Underscore

. Period

- Hyphen

+ Plus

& Ampersand

Chapter 1. Managing the server from the command line 13

The following table shows the maximum length of characters permitted for namingobjects.

Type of Name Maximum Length

Administrators, client option sets, client nodes,passwords, server groups, server, names, virtual filespace names

64

Restartable export identifiers 64

High-level and low-level TCP/IP (IPv4 or IPv6)addresses

64

Device classes, drives, libraries, management classes,policy domains, profiles, schedules scripts, backupsets, storage pools

30

The following characters are available for defining password names:a b c d e f g h i j k l m n o p q r s t u v w x y zA B C D E F G H I J K L M N O P Q R S T U V W X Y Z0 1 2 3 4 5 6 7 8 9 . ! @ # $ % ^ & * _ - + = ` ( )| { } [ ] : ; < > , ? / ~

Passwords considered “LOCAL” are those passwords that authenticate with theIBM Spectrum Protect server and are not case-sensitive. Passwords considered“LDAP” are those passwords that authenticate with an LDAP directory server andare case-sensitive.

When you use DEFINE commands to define database, recovery log, and storagepool volumes, the naming convention for the volume name is dependent on thetype of sequential access media or random access media that you are using. Referto the specific VOLUME command for details.

Using wildcard characters to specify object namesIn some commands, such as the query commands, you can use wildcard charactersto create a pattern-matching expression that specifies more than one object. Usingwildcard characters makes it easier to tailor a command to your needs.

About this task

The wildcard characters you use depend on the operating system from which youissue commands. For example, you can use wildcard characters such as an asterisk(*) to match any (0 or more) characters, or you can use a question mark (?) or apercent sign (%) to match exactly one character.

Table 1 provides references to wildcard characters for some operating systems. Usewildcard characters appropriate for your system.

Table 1. Wildcard characters by operating system

Operating system Match any Match exactly one

AIX®, Linux, Windows * ?

TSO * %

14 IBM Spectrum Protect for Windows: Administrator's Reference

For example, if you want to query all the management classes whose names beginwith DEV in all the policy sets in DOMAIN1, and your system uses an asterisk asthe match-any character, you can enter:query mgmtclass domain1 * dev*

If your system uses a question mark as the match-exactly-one character, and youwant to query the management classes in POLICYSET1 in DOMAIN1, you canenter:query mgmtclass domain1 policyset1 mc?

IBM Spectrum Protect displays information about management classes with namesMC.

Table 2 shows additional examples of using wildcard characters to match anycharacters.

Table 2. Match-any character

Pattern Matches Does not match

ab* ab, abb, abxxx a, b, aa, bb

ab*rs abrs, abtrs, abrsrs ars, aabrs, abrss

ab*ef*rs abefrs, abefghrs abefr, abers

Table 3 shows additional examples of using wildcard characters to match exactlyone character. The question mark (?) can be replaced by a percent sign (%) if yourplatform uses that character instead of (?).

Table 3. Match-exactly-one character

Pattern Matches Does not match

ab? abc ab, abab, abzzzz

ab?rs abfrs abrs, abllrs

ab?ef?rs abdefjrs abefrs, abdefrs, abefjrs

ab??rs abcdrs, abzzrs abrs, abjrs, abkkkrs

Specifying descriptions in keyword parametersIf a description (a string of text) for a parameter begins with a single or doublequotation mark, or contains any embedded blanks or equal signs, you mustsurround the value with either single (') or double (") quotation marks.

About this task

The opening and closing quotation marks must be the same type of quotationmarks. For example, if the opening quotation is a single quotation mark, theclosing quotation mark must also be a single quotation mark.

For example, to register a new client node named Louie, with a password of secret,and with his title included as contact information, enter:register node louie secret contact="manager of dept. 61f"

The following table presents ways of entering a description for the CONTACTparameter. The value can contain quotation marks, embedded blanks, or equalsigns.

Chapter 1. Managing the server from the command line 15

For this description Enter this

manager contact=manager

manager's contact="manager's" or contact='manager"s'

"manager" contact='"manager"' or contact="""manager"""

manager's report contact="manager's report" or contact='manager''sreport'

manager's "report" contact='manager''s "report"'

manager=dept. 61f contact='manager=dept. 61f'

manager reports to dept. 61f contact='manager reports to dept. 61f' orcontact="manager reports to dept. 61f"

Controlling command processingYou can run some IBM Spectrum Protect commands sequentially or concurrentlywith other commands. You can also route commands from one server to otherservers for processing.

About this task

Server command processingIBM Spectrum Protect processes administrator commands either in the foregroundor in the background. Commands that process in the foreground must completebefore you can issue another command. When commands are processing in thebackground, you can issue additional commands at any time.

Most IBM Spectrum Protect commands process in the foreground. For somecommands that normally process in the background (for example, BACKUP DB),you can specify the WAIT parameter (WAIT=YES) with the command so that thecommand processes in the foreground. You might want to process a command inthe foreground rather than in the background for any of the following reasons:v To quickly determine whether a command completed successfully. When you

issue a command that processes in the foreground, IBM Spectrum Protect sendsa confirmation message indicating that the command completed successfully. Ifyou process the command in the background, you need to open operationalreporting or query the activity log to determine whether the commandcompleted successfully.

v To monitor server activities (for example, messages) on the administrative clientas a command is being processed. This might be preferable to searching a longactivity log after the command has completed.

v To be able to start another process immediately after a command has completed.For example, you might specify WAIT=YES for a command that takes a shorttime to process so that, when the processing completes, you can immediatelystart processing another command.

v To serialize commands in an administrative script when it is important that onecommand completes before another begins.

Check the individual command description to determine whether a command hasa WAIT parameter.

You can cancel commands that are processed in the foreground from the serverconsole or from another administrative client session.

16 IBM Spectrum Protect for Windows: Administrator's Reference

Each background process is assigned a process number. Use the QUERY PROCESScommand to obtain the status and process number of a background process.

Note:

v If you are defining a schedule with a command that specifies WAIT=NO (thedefault), and you issue QUERY EVENT to determine the status of yourscheduled operation, failed operations will report an event status ofCOMPLETED with a return of OK. In order for the QUERY EVENT output toreflect the failed status, the WAIT parameter must be set to YES. This will runthe scheduled operation in the foreground and inform you of the status when itcompletes.

v You cannot process commands in the foreground from the server console.

Stopping background processesUse the CANCEL PROCESS command to cancel commands that generatebackground processes.

About this task

Use the QUERY PROCESS command to obtain the status and process number of abackground process. If a background process is active when you cancel it, theserver stops the process. Any changes that are uncommitted are rolled back.However, changes that are committed are not rolled back.

When you issue a QUERY command from the administrative client, multiplescreens of output might be generated. If this occurs and additional output is notneeded, you can cancel the display of output to the client workstation. Doing sodoes not end the processing of the command.

Performing tasks concurrently on multiple serversCommand routing allows you to route commands to one or more servers forprocessing and then collect the output from these servers.

About this task

To route commands to other servers, you must have the same administrator IDand password as well as the required administrative authority on each server towhich the command is being routed. You cannot route commands to other serversfrom the server console.

After the command has completed processing on all servers, the output displays,in its entirety, for each server. For example, the output from SERVER_A displays inits entirety, followed by the output from SERVER_B. The output includes summarymessages for each individual server and identifies which server processed theoutput. Return codes indicate whether commands processed on the serverssuccessfully. These return codes include one of three severities: 0, ERROR, orWARNING.

Each server that is identified as the target of a routed command must first bedefined using the DEFINE SERVER command. The command is automaticallyrouted to all servers specified as members of a server group or to individualservers specified with the command.

Chapter 1. Managing the server from the command line 17

The following examples describe how to route the QUERY STGPOOL command toone server, multiple servers, a server group, multiple server groups, or acombination of servers and server groups. Each server or server group in a listmust be separated with a comma, without spaces.

Routing commands to a single serverProcedure

To route the QUERY STGPOOL command to a server named ASTRO, enter:astro: query stgpool

The colon after the server name indicates the end of the routing information. Thisis also called the server prefix. Another way to indicate the end of routinginformation is to use parentheses around the server name, for example:(astro) query stgpool

Routing commands to multiple serversAbout this task

Procedure

To route the QUERY STGPOOL command to multiple servers named HD_QTR,MIDAS, SATURN, enter:hd_qtr,midas,saturn: query stgpool

If the first server has not been defined to IBM Spectrum Protect, the command isrouted to the next defined server in the list of servers.You can also enter the command this way:(hd_qtr,midas,saturn) query stgpool

Routing commands to a server groupAbout this task

In this example, the server group ADMIN has servers named SECURITY,PAYROLL, PERSONNEL defined as group members. The command is routed toeach of these servers.

Procedure

To route the QUERY STGPOOL command to the server group named ADMIN,enter:admin: query stgpool

You can also enter the command this way:(admin) query stgpool

18 IBM Spectrum Protect for Windows: Administrator's Reference

Routing commands to server groupsAbout this task

In this example, the server group ADMIN2 has servers SERVER_A, SERVER_B,and SERVER_C defined as group members, and server group ADMIN3 has serversASTRO, GUMBY, and CRUSTY defined as group members. The command isrouted to servers SERVER_A, SERVER_B, SERVER_C, ASTRO, GUMBY, andCRUSTY.

Procedure

To route the QUERY STGPOOL command to two server groups that are namedADMIN2 and ADMIN3, enter:admin2,admin3: query stgpool

You can also enter the command this way:(admin2,admin3) query stgpool

Routing commands to two servers and a server groupAbout this task

In this example, the server group DEV_GROUP has servers SALES, MARKETING,and STAFF defined as group members. The command is routed to servers SALES,MARKETING, STAFF, MERCURY, and JUPITER.

Procedure

To route the QUERY STGPOOL command to a server group named DEV_GROUPand to the servers named MERCURY and JUPITER, enter:dev_group,mercury,jupiter: query stgpool

You can also enter the command this way:(dev_group,mercury,jupiter) query stgpool

Routing commands inside scriptsAbout this task

When routing commands inside scripts, you must enclose the server or servergroup in parentheses and omit the colon. Otherwise, the command will not berouted when the RUN command is issued, and will only be run on the serverwhere the RUN command is issued.

For example, to route the QUERY STGPOOL command inside a script:

Procedure1. Define a script called QU_STG to route it to the DEV_GROUP server group.

define script qu_stg "(dev_group) query stgpool"

2. Run the QU_STG script:run qu_stg

Chapter 1. Managing the server from the command line 19

Results

In this example, the server group DEV_GROUP has servers SALES, MARKETING,and STAFF defined as group members. The QUERY STGPOOL command is routedto these servers.

Privilege classes for commandsThe authority granted to an administrator through the privilege class determineswhich administrative commands that the administrator can issue.

There are four administrator privilege classes in IBM Spectrum Protect:v Systemv Policyv Storagev Operator

After an administrator has been registered using the REGISTER ADMIN command,the administrator can issue a limited set of commands, including all querycommands. When you install IBM Spectrum Protect, the server console is definedas a system administrator named SERVER_CONSOLE and is granted systemprivilege.

The following sections describe each type of administrator privilege and thecommands that can be issued by an administrator who has been granted thecorresponding authority.

Commands requiring system privilegeAn administrator with system privilege has the highest level of authority for theserver. With system privilege, an administrator can issue any administrativecommand and has authority to manage all policy domains and all storage pools.

Table 4 on page 21 lists the commands that administrators with system privilegecan issue. In some cases administrators with lower levels of authority, for example,unrestricted storage privilege, can also issue these commands. In addition, theREQSYSAUTHOUTFILE server option can be used to specify that certaincommands require system privilege if they cause the server to write to an externalfile. For more information about this server option, review“REQSYSAUTHOUTFILE” on page 1667.

20 IBM Spectrum Protect for Windows: Administrator's Reference

Table 4. System privilege commands

Command name Command name

AUDIT LDAPDIRECTORY

AUDIT LICENSES

ACCEPT DATE

BEGIN EVENTLOGGING

CANCEL EXPIRATION

CANCEL PROCESS

CANCEL REPLICATION

CANCEL REQUEST

CANCEL RESTORE

CLEAN DRIVE

COPY ACTIVEDATA

COPY DOMAIN

COPY POLICYSET

COPY PROFILE

COPY SCHEDULE (Review note.)

COPY SCRIPT

COPY SERVERGROUP

DEFINE BACKUPSET

DEFINE CLIENTACTION

DEFINE CLIENTOPT

DEFINE CLOPTSET

DEFINE COLLOCGROUP

DEFINE COLLOCMEMBER

DEFINE DEVCLASS

DEFINE DOMAIN

DEFINE DRIVE

DEFINE EVENTSERVER

DEFINE GRPMEMBER

DEFINE LIBRARY

DEFINE MACHINE

DEFINE MACHNODEASSOCIATION

DEFINE NODEGROUP

DEFINE NODEGROUPMEMBER

DEFINE PATH

DEFINE PROFASSOCIATION

DEFINE PROFILE

DEFINE RECMEDMACHASSOCIATION

DEFINE RECOVERYMEDIA

DEFINE SCHEDULE (Review note.)

DEFINE SCRIPT

DEFINE SERVER

DEFINE SERVERGROUP

DEFINE SPACETRIGGER

DEFINE STGPOOL

DEFINE SUBSCRIPTION

DEFINE VIRTUALFSMAPPING

DEFINE VOLUME

DELETE BACKUPSET

DELETE CLIENTOPT

DELETE CLOPTSET

DEFINE COLLOCGROUP

DEFINE COLLOCMEMBER

DELETE DOMAIN

DELETE DRIVE

DELETE EVENTSERVER

DELETE GRPMEMBER

DELETE LIBRARY

DELETE MACHINE

DELETE MACHNODEASSOCIATION

DELETE NODEGROUP

DELETE NODEGROUPMEMBER

DELETE PROFASSOCIATION

DELETE PROFILE

DELETE RECMEDMACHASSOCIATION

DELETE RECOVERYMEDIA

DELETE SCHEDULE (Review note.)

DELETE SCRIPT

DELETE SERVER

DELETE SERVERGROUP

DELETE SPACETRIGGER

DELETE STGPOOL

DELETE SUBSCRIBER

DELETE SUBSCRIPTION

DELETE VIRTUALFSMAPPING

DISABLE EVENTS

ENABLE EVENTS

END EVENTLOGGING

EXPIRE INVENTORY

EXPORT ADMIN

EXPORT NODE

EXPORT POLICY

EXPORT SERVER

GENERATE BAC