Execute-macro operation


The execute-macro operation executes a series of commands that you specify in a macro file. By including the macro command within a macro file, you can nest as many as ten levels of commands. You must specify different commands on separate lines.

The following table describes the elements for the adapter request:

 Adapter request elements for the execute-macro operation

The following figure shows a sample adapter request for the execute-macro operation:

Sample adapter request for the execute-macro operation

<tsm-response>
 <metadata>
   <status>success</status>
   <count>1</count>
 </metadata>
 <commands-output>
   <command-output>
     <metadata>
       <command>dsmc macro C:\macro.txt</command>
       <line-count>198</line-count>
       <execution-milliseconds>2594</execution-milliseconds>
       <exit-code>0</exit-code>
       <status>success</status>
     </metadata>
     <output>
       <line index="1">IBM Tivoli Storage Manager</line>
       <line index="2">Command Line Backup/Archive Client Interface</line>
       <line index="3">  Client Version 5, Release 5, Level 0.0  </line>
       <line index="4">  Client date/time: 10/07/2008 15:55:57</line>
       <line index="5">(c) Copyright by IBM Corporation and other(s) 1990, 2007.         All Rights Reserved.</line>
       <line index="6">Node Name: D-13096</line>
       <line index="7">Session established with server SERVER1:         Linux/i386</line>
       <line index="8">  Server Version 5, Release 5, Level 0.0</line>
       <line index="9">  Server date/time: 10/07/2008 15:53:28  Last access:         10/07/2008 15:47:31</line>
       <line index="10">query options</line>
       <line index="11">              ACTIVATEKEY: YES</line>
       <line index="12">          AFSBACKUPMNTPNT: YES</line>
       <line index="13">          ALLOWWILDCARDCH: NO</line>
       <line index="14">        ARCHSYMLINKASFILE: YES</line>
       <line index="15">               ASNODENAME:</line>
       <line index="16">             AUTOFSRENAME: PROMPT</line>
       <line index="17">             AUDITLOGGING: OFF</line>
       <line index="18">             AUDITLOGNAME: C:\Program         Files\Tivoli\Tsm\baclient\log\dsmaudit.log</line>
       <line index="19">                AUTOMOUNT:</line>
       <line index="20">           BACKUPREGISTRY: YES</line>
       <line index="21">       CANDIDATESINTERVAL: 1</line>
       <line index="22">       CASESENSITIVEAWARE: NO</line>
       <line index="23">          CHANGINGRETRIES: 4</line>
       <line index="24">          CHECKFORORPHANS: NO</line>
       <line index="25">          CHECKTHRESHOLDS: 5</line>
       <line index="26">               CLIENTVIEW: STANDARD</line>
       <line index="27">         CLUSTERDISKSONLY: YES</line>
       <line index="28">              CLUSTERNODE: NO</line>
       <line index="29">               COMMMETHOD: TCP/IP</line>
       <line index="30">      COLLOCATEBYFILESPEC: NO</line>
       <line index="31">      COMMRESTARTDURATION: 60</line>
       <line index="32">      COMMRESTARTINTERVAL: 15</line>
       <line index="33">           COMPRESSALWAYS: YES</line>
       <line index="34">              COMPRESSION: NO</line>
       <line index="35">               DATEFORMAT: 1</line>
       <line index="36">            DEFAULTSERVER:</line>
       <line index="37">          DFSBACKUPMNTPNT: YES</line>
       <line index="38">                    DIRMC: DEFAULT</line>
       <line index="39">               DISABLENQR: NO</line>
       <line index="40">             DISKBUFFSIZE: 32</line>
       <line index="41">        DISKCACHELOCATION:</line>
       <line index="42">                   DOMAIN: Default ALL-LOCAL</line>
       <line index="43">                           \\d-13096\c$</line>
       <line index="44">                           SYSTEMOBJECT</line>
       <line index="45">             DOMAIN.IMAGE:</line>
       <line index="46">               DOMAIN.NAS:</line>
       <line index="47">                  DOMNODE:</line>
       <line index="48">           DSMTRACELISTEN: NO</line>
       <line index="49">                   EDITOR: YES</line>
       <line index="50">               EFSDECRYPT: NO</line>
       <line index="51">   ENABLE8DOT3NAMESUPPORT: NO</line>
       <line index="52">ENABLEARCHIVERETENTIONPROTECTION: NO</line>
       <line index="53">            ENABLELANFREE: NO</line>
       <line index="54">   ENABLECLIENTENCRYPTKEY: NO</line>
       <line index="55">           ENCRYPTIONTYPE: AES128</line>
       <line index="56">               ENCRYPTKEY: SAVE</line>
       <line index="57">              ERRORLOGMAX: 0</line>
       <line index="58">             ERRORLOGNAME: C:\Program         Files\Tivoli\Tsm\baclient\log\dsmerror.log</line>
       <line index="59">        ERRORLOGRETENTION: N</line>
       <line index="60">                ERRORPROG:</line>
       <line index="61">             EVENTLOGGING: NO</line>
       <line index="62">          FASTQUERYBACKUP: NO</line>
       <line index="63">           FOLLOWSYMBOLIC: NO</line>
       <line index="64">        FRSPRIMARYRESTORE: NO</line>
       <line index="65">                   GROUPS:</line>
       <line index="66">   GUITREEVIEWAFTERBACKUP: NO</line>
       <line index="67">             ICATPASSWORD:</line>
       <line index="68">             IMAGEGAPSIZE: 32</line>
       <line index="69">            INCRTHRESHOLD: 0</line>
       <line index="70">              JOURNALPIPE: \\.\pipe\jnlSessionMgr</line>
       <line index="71">           KERNELMESSAGES: YES</line>
       <line index="72">                 LANGUAGE: C:\Program         Files\Tivoli\Tsm\baclient\dscenu.txt</line>
       <line index="73">        LANFREECOMMMETHOD: Named Pipe</line>
       <line index="74">           LANFREESHMPORT: 1</line>
       <line index="75">           LANFREETCPPORT: 1500</line>
       <line index="76">  LANFREETCPSERVERADDRESS: 127.0.0.1</line>
       <line index="77">         LARGECOMMBUFFERS: NO</line>
       <line index="78">                 MAILPROG:</line>
       <line index="79">           MAKESPARSEFILE: YES</line>
       <line index="80">          MANAGEDSERVICES: WEBCLIENT</line>
       <line index="81">             MAXCANDPROCS: 5</line>
       <line index="82">            MAXCMDRETRIES: 2</line>
       <line index="83">             MAXMIGRATORS: 1</line>
       <line index="84">         MAXRECALLDAEMONS: 20</line>
       <line index="85">         MAXRECONCILEPROC: 3</line>
       <line index="86">         MAXTHRESHOLDPROC: 3</line>
       <line index="87">    MEMORYEFFICIENTBACKUP: NO</line>
       <line index="88">        MIGRATEENCRYPTKEY: NO</line>
       <line index="89">        MIGFILEEXPIRATION: 7</line>
       <line index="90">            MIGRATESERVER:</line>
       <line index="91">           MINMIGFILESIZE: 0</line>
       <line index="92">         MINRECALLDAEMONS: 3</line>
       <line index="93">            NAMEDPIPENAME: \\.\pipe\Server1</line>
       <line index="94">              NASNODENAME:</line>
       <line index="95">               NFSTIMEOUT: 0</line>
       <line index="96">                 NODENAME: D-13096</line>
       <line index="97">            NOSNAPRESTORE: NO</line>
       <line index="98">             NUMBERFORMAT: 0</line>
       <line index="99">          NWEXITNLMPROMPT: 0</line>
       <line index="100">      NWIGNORECOMPRESSBIT: NO</line>
       <line index="101">                 NWPWFILE: YES</line>
       <line index="102">                  OPTFILE: C:\Program         Files\Tivoli\Tsm\baclient\dsm.opt</line>
       <line index="103">             OPTIONFORMAT: STANDARD</line>
       <line index="104">            OVERLAPRECALL: NO</line>
       <line index="105">           PASSWORDACCESS: GENERATE</line>
       <line index="106">              PASSWORDDIR:</line>
       <line index="107">         POSTNSCHEDULECMD:</line>
       <line index="108">          POSTSCHEDULECMD:</line>
       <line index="109">          POSTSNAPSHOTCMD:</line>
       <line index="110">          PRENSCHEDULECMD:</line>
       <line index="111">           PRESCHEDULECMD:</line>
       <line index="112">   PRESERVELASTACCESSDATE: NO</line>
       <line index="113">           PRESNAPSHOTCMD:</line>
       <line index="114">     PROCESSORUTILIZATION: 0</line>
       <line index="115">         QUERYSCHEDPERIOD: 12</line>
       <line index="116">            QUIET/VERBOSE: VERBOSE</line>
       <line index="117">        RECONCILEINTERVAL: 24</line>
       <line index="118">                  REPLACE: PROMPT</line>
       <line index="119">    RESETARCHIVEATTRIBUTE: NO</line>
       <line index="120">      RESOURCEUTILIZATION: 2</line>
       <line index="121">   RESTORECHECKSTUBACCESS: YES</line>
       <line index="122">          RESTOREMIGSTATE: YES</line>
       <line index="123">              RETRYPERIOD: 20</line>
       <line index="124">             RUNASSERVICE: NO</line>
       <line index="125">         SCHEDCMDDISABLED: NO</line>
       <line index="126">              SCHEDLOGMAX: 0</line>
       <line index="127">             SCHEDLOGNAME: C:\Program         Files\Tivoli\Tsm\baclient\log\dsmsched.log</line>
       <line index="128">        SCHEDLOGRETENTION: N</line>
       <line index="129">                SCHEDMODE: POLLING</line>
       <line index="130">    SCHEDRESTRETRDISABLED: NO</line>
       <line index="131">              SCROLLLINES: 20</line>
       <line index="132">             SCROLLPROMPT: NO</line>
       <line index="133">               SERVERNAME: DSMSERV</line>
       <line index="134">        SESSIONINITIATION: CLIENT</line>
       <line index="135">                  SHMPORT: 1</line>
       <line index="136">             SHMQUEUENAME: \QUEUES\ADSM\DSMSERV</line>
       <line index="137">                  SKIPACL: NO</line>
       <line index="138">       SKIPACLUPDATECHECK: NO</line>
       <line index="139">        SKIPNTPERMISSIONS: NO</line>
       <line index="140">        SKIPNTSECURITYCRC: NO</line>
       <line index="141">    SNAPSHOTCACHELOCATION:</line>
       <line index="142">        SNAPSHOTCACHESIZE: 1</line>
       <line index="143">    SNAPSHOTFSIDLERETRIES: 99</line>
       <line index="144">       SNAPSHOTFSIDLEWAIT: 2S,50MS; MINSET: 1</line>
       <line index="145">       SNAPSHOTPROVIDERFS: NONE</line>
       <line index="146">    SNAPSHOTPROVIDERIMAGE: NONE</line>
       <line index="147">  SRVPREPOSTSCHEDDISABLED: NO</line>
       <line index="148">   SRVPREPOSTSNAPDISABLED: NO</line>
       <line index="149">                      SSL: NO</line>
       <line index="150">                   SUBDIR: NO</line>
       <line index="151">            SUBFILEBACKUP: NO</line>
       <line index="152">         SUBFILECACHEPATH:</line>
       <line index="153">         SUBFILECACHESIZE: 10</line>
       <line index="154">               TAPEPROMPT: NO</line>
       <line index="155">             TCPADMINPORT: 1500</line>
       <line index="156">              TCPBUFFSIZE: 32768</line>
       <line index="157">         TCPCLIENTADDRESS:</line>
       <line index="158">            TCPCLIENTPORT: 1501</line>
       <line index="159">               TCPNODELAY: YES</line>
       <line index="160">                  TCPPORT: 1500</line>
       <line index="161">             TCPRECVDELAY: 0</line>
       <line index="162">             TCPSENDDELAY: 0</line>
       <line index="163">         TCPSERVERADDRESS: 172.11.11.111</line>
       <line index="164">            TCPWINDOWSIZE: 64512</line>
       <line index="165">                TESTFLAGS: Not yet implemented</line>
       <line index="166">               TIMEFORMAT: 0</line>
       <line index="167">                TRACEFILE:</line>
       <line index="168">               TRACEFLAGS:</line>
       <line index="169">                 TRACEMAX: 0</line>
       <line index="170">             TRACESEGSIZE: 0</line>
       <line index="171">             TXNBYTELIMIT: 26214400</line>
       <line index="172">             USEDIRECTORY: NO</line>
       <line index="173">                    USERS:</line>
       <line index="174">              USEUNCNAMES: NO</line>
       <line index="175">        VIRTUALMOUNTPOINT:</line>
       <line index="176">          VIRTUALNODENAME: D-13096</line>
       <line index="177">                VMBACKDIR:</line>
       <line index="178">             VMBACKUPTYPE: Unknown</line>
       <line index="179">                  VMCHOST:</line>
       <line index="180">                    VMCPW:</line>
       <line index="181">                  VMCUSER:</line>
       <line index="182">                   VMLIST:</line>
       <line index="183">         VSSALTSTAGINGDIR:</line>
       <line index="184">               WASEXPHOME:</line>
       <line index="185">                  WASHOME:</line>
       <line index="186">                WASNDHOME:</line>
       <line index="187">               WASOFFLINE: NO</line>
       <line index="188">ANS1900I Return code is 0.</line>
       <line index="189">query mgmtclassDomain Name: STANDARD</line>
       <line index="190">Activated Policy Set Name : STANDARD</line>
       <line index="191">Activation date/time      : 09/19/2008 08:58:01</line>
       <line index="192">Default Mgmt Class Name   : STANDARD</line>
       <line index="193">Grace Period Backup Retn. : 30 day(s)</line>
       <line index="194">Grace Period Archive Retn.: 365 day(s)</line>
       <line index="195">MgmtClass Name                  : STANDARD</line>
       <line index="196">Description                     : Installed default         management class.</line>
       <line index="197">ANS1900I Return code is 0.</line>
       <line index="198">ANS1895I Highest macro return code was 0.</line>
     </output>
   </command-output>
 </commands-output>
</tsm-response>

 

Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*