Retrieve operation
The retrieve operation obtains copies of the archived files from the IBM Tivoli Storage Manager server. You can retrieve specific files or entire directories.
The following table describes the elements for the retrieve operation request:
Adapter request elements for the retrieve operation
The following figure shows a sample adapter request for the retrieve operation:
Sample adapter request for the retrieve operation
<tsm-request>
<operation-name>retrieve</operation-name>
<command-request>
<timeout-secs>120</timeout-secs>
<command-options>
<description>"Test Description"</description>
<dateformat>DD-MM-YYYY</dateformat>
<timeformat>HH,MM,SS</timeformat>
<fromdate>30-09-2008</fromdate>
<fromtime>12,00,00</fromtime>
<todate>01-10-2008</todate>
<totime>16,00,00</totime>
<filesonly />
<preservepath>complete</preservepath>
<replace>yes</replace>
<skipntpermissions>yes</skipntpermissions>
</command-options>
</command-request>
</tsm-request>
<operation-name>retrieve</operation-name>
<command-request>
<timeout-secs>120</timeout-secs>
<command-options>
<description>"Test Description"</description>
<dateformat>DD-MM-YYYY</dateformat>
<timeformat>HH,MM,SS</timeformat>
<fromdate>30-09-2008</fromdate>
<fromtime>12,00,00</fromtime>
<todate>01-10-2008</todate>
<totime>16,00,00</totime>
<filesonly />
<preservepath>complete</preservepath>
<replace>yes</replace>
<skipntpermissions>yes</skipntpermissions>
</command-options>
</command-request>
</tsm-request>
The following figure shows the adapter response for the sample request:
Sample adapter response for the retrieve operation
<tsm-response>
<metadata>
<status>success</status>
<count>1</count>
</metadata>
<commands-output>
<command-output>
<metadata>
<command>dsmc retrieve -description="Test Description" -dateformat=2 - timeformat=2 -fromdate=30-09-2008 -fromtime=12,00,00 -todate=01-10-2008 -totime=16,00,00 -filesonly -preservepath=complete -replace=yes - skipntpermissions=yes C:\tmuninst.ini C:\temp\</command>
<line-count>20</line-count>
<execution-milliseconds>5032</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: 01-10-2008 12,15,08</line>
<line index="5">(c) Copyright by IBM Corporation and other(s) 1990, 2007. All Rights Reserved.</line>
<line index="6">Retrieve function invoked.</line>
<line index="7">Node Name: D-13096</line>
<line index="8">Session established with server SERVER1: Linux/i386</line>
<line index="9"> Server Version 5, Release 5, Level 0.0</line>
<line index="10"> Server date/time: 01-10-2008 12,13,11 Last access: 01-10-2008 12,12,41</line>
<line index="11">Retrieving 21 \\d-13096\c$\tmuninst.ini -- > \\d-13096\c$\temp\tmuninst.ini [Done] </line>
<line index="12">Retrieving 21 \\d-13096\c$\tmuninst.ini -- > \\d-13096\c$\temp\tmuninst.ini [Done] </line>
<line index="13">Retrieve processing finished.</line>
<line index="14">Total number of objects retrieved: 2</line>
<line index="15">Total number of objects failed: 0</line>
<line index="16">Total number of bytes transferred: 90 B</line>
<line index="17">Data transfer time: 0.00 sec</line>
<line index="18">Network data transfer rate: 0.00 KB/sec</line>
<line index="19">Aggregate data transfer rate: 0.02 KB/sec</line>
<line index="20">Elapsed processing time: 00,00,03</line>
</output>
</command-output>
</commands-output>
</tsm-response>
<metadata>
<status>success</status>
<count>1</count>
</metadata>
<commands-output>
<command-output>
<metadata>
<command>dsmc retrieve -description="Test Description" -dateformat=2 - timeformat=2 -fromdate=30-09-2008 -fromtime=12,00,00 -todate=01-10-2008 -totime=16,00,00 -filesonly -preservepath=complete -replace=yes - skipntpermissions=yes C:\tmuninst.ini C:\temp\</command>
<line-count>20</line-count>
<execution-milliseconds>5032</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: 01-10-2008 12,15,08</line>
<line index="5">(c) Copyright by IBM Corporation and other(s) 1990, 2007. All Rights Reserved.</line>
<line index="6">Retrieve function invoked.</line>
<line index="7">Node Name: D-13096</line>
<line index="8">Session established with server SERVER1: Linux/i386</line>
<line index="9"> Server Version 5, Release 5, Level 0.0</line>
<line index="10"> Server date/time: 01-10-2008 12,13,11 Last access: 01-10-2008 12,12,41</line>
<line index="11">Retrieving 21 \\d-13096\c$\tmuninst.ini -- > \\d-13096\c$\temp\tmuninst.ini [Done] </line>
<line index="12">Retrieving 21 \\d-13096\c$\tmuninst.ini -- > \\d-13096\c$\temp\tmuninst.ini [Done] </line>
<line index="13">Retrieve processing finished.</line>
<line index="14">Total number of objects retrieved: 2</line>
<line index="15">Total number of objects failed: 0</line>
<line index="16">Total number of bytes transferred: 90 B</line>
<line index="17">Data transfer time: 0.00 sec</line>
<line index="18">Network data transfer rate: 0.00 KB/sec</line>
<line index="19">Aggregate data transfer rate: 0.02 KB/sec</line>
<line index="20">Elapsed processing time: 00,00,03</line>
</output>
</command-output>
</commands-output>
</tsm-response>
Tip: For faster searching, add an asterisk to the end of your partial query. Example: cert*