Query-systeminfo operation


The query-systeminfo operation gathers information on one or more of the following items and send this information to a file or the console:

  • For Microsoft Windows:
    • DSMOPTFILE - The contents of the dsm.opt file
    • ENV - Environment variables
    • ERRORLOG - The IBM Tivoli Storage Manager error log file
    • FILE - Attributes for the file name that you specify
    • FILESNOTTOBACKUP - Enumeration of the following Windows Registry key:
      • HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\BackupRestore\FilesNotToBackup

        This key specifies those files that should not be backed up by backup products. The query inclexcl command indicates that these files are excluded.
    • INCLEXCL - Compiles a list of include-exclude in the order in which they are processed during backup and archive operations.
    • KEYSNOTTORESTORE - Enumeration of the following Windows Registry key:
      • HKEY_LOCAL_MACHINE\SYSTEM\ControlSet001\BackupRestore\KeysNotToRestore

        This key specifies those Windows Registry keys that backup products should not restore.
    • MSINFO - Windows system information (output from MSINFO32.EXE).
    • OPTIONS - Compiled options
    • OSINFO - Name and version of the client operating system
    • POLICY - Policy set dump
    • REGISTRY - Windows Registry entries related to IBM Tivoli Storage Manager
    • SCHEDLOG - The contents of the IBM Tivoli Storage Manager schedule log (usually dsmsched.log)
    • SFP - The list of files protected by Windows System File Protection, and for each file, indicates whether that file exists. These files are backed up as part of the SYSFILES system object.
    • SFP= <filename> - Indicates whether the specified file (file name) is protected by Windows System File Protection. For example: SFP=C:\WINNT\SYSTEM32\MSVCRT.DLL
    • SYSTEMOBJECT - Windows system object information
    • CLUSTER - Windows cluster information
    • ENCRYPT - Available encryption methods
  • For UNIX:
    • DB2UDB -DATABase=dbconfigname - Verifies that the Configuration Wizard successfully transferred the IBM DB2 Universal Database (UDB), IBM Tivoli Storage Manager, and storage subsystem settings to the master backup node. Replace dbconfigname with the DB2 UDB configuration name provided in the Configuration Wizard. Note that this item is only valid for IBM AIX when both the DB2 Integration Module and Hardware Devices Snapshot Integration Module are installed.
    • DSMOPTFILE - The contents of the dsm.opt file
    • DSMSYSFILE - The contents of the dsm.sys file
    • ENV - Environment variables
    • ERRORLOG - IBM Tivoli Storage Manager error log file
    • FILE - Attributes for the file name that you specify
    • INCLEXCL - Compiles a list of include-exclude in the order in which they are processed during backup and archive operations.
    • OPTIONS - Compiled options
    • OSINFO - Name and version of the client operating system (includes ULIMIT information for UNIX)
    • POLICY - Policy set dump
    • SCHEDLOG - The contents of the IBM Tivoli Storage Manager schedule log (usually dsmsched.log)
    • CLUSTER - IBM AIX cluster information
    • ENCRYPT - Available encryption methods

      The following table describes the elements for the adapter request:
      The [confluence_table-plus] macro is a standalone macro and it cannot be used inline.

The following figure shows a sample adapter request for the query-systeminfo operation:

Sample adapter request for the query-systeminfo operation

<tsm-request>
 <operation-name>query-systeminfo</operation-name>
 <command-request>
   <command-options>
     <console />
   </command-options>
   <command-arguments>
     <item-list>options policy</item-list>
   </command-arguments>
 </command-request>
</tsm-request>


The following figure shows the adapter response for the sample request:

Sample adapter response for the query-systeminfo operation

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

 

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