File
Generate a report about files known to the Tertiary Storage Manager.
This web service runs the fsfileinfo
command.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
---|---|---|---|---|
|
Optional |
1 |
If checksum was turned on for the file when stored and this option is specified, the checksum value generated for the file will be displayed. Default value is false. |
|
|
Optional |
1 |
If compression is enabled for the file when stored, the compression type, size, and ratio for the file is displayed. Default value is false. |
|
|
Optional |
1 |
The directory to process. The recursive parameter determines how the directory will be processed. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
If encryption is enabled for the file when stored, the encryption type for the file is displayed. Default value is false. |
|
|
Optional |
1 |
List of files for which information is required. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
|
Optional |
1 |
If the file has one or more copies stored to Object Storage, then the object ids will be displayed. Offset information will also be displayed for each object id. Default value is false. |
|
|
Optional |
1 |
If the file has a copy or more stored to Object Storage, then the object URLs are displayed. Object Storage configuration information is also displayed. Default value is false. |
|
recursive
|
Optional | 1 | This parameter is only valid when the directory parameter is specified. A value of false will only process the contents of the directory while a value of true will perform a recursive operation on the directory. The default value is true. |
|
Example
https://<<
SERVER>>/sws/v2/file/fsfileinfo
?file=/stornext/snfs1/xxx/testfile.0
&format=xml
Output
<?xml version="1.0" encoding="UTF-8" ?>
<fsfileinfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsfileinfo.xsd">
<header>
<commandName>fsfileinfo</commandName>
<commandLine>/usr/adic/TSM/bin/fsfileinfo -F xml /stornext/snfs1/xxx/testfile.0</commandLine>
<commandDescription>Generate a report about files known to the Tertiary Manager</commandDescription>
<localDateISO>2014-05-15T11:12:56</localDateISO>
<localDate>2014-05-15</localDate>
<localTime>11:12:56</localTime>
<localDayOfWeek>4</localDayOfWeek>
<gmtDateISO>2014-05-15T16:12:56Z</gmtDateISO>
<gmtDate>2014-05-15</gmtDate>
<gmtTime>16:12:56</gmtTime>
<gmtDayOfWeek>4</gmtDayOfWeek>
</header>
<fileInfos>
<fileInfo>
<fileName>/stornext/snfs1/xxx/testfile.0</fileName>
<storedPathFileName>N/A</storedPathFileName>
<storedPathSameAsFileName>false</storedPathSameAsFileName>
<lastModificationDateString>15-may-2014 11:11:09</lastModificationDateString>
<lastModificationDate>2014-05-15</lastModificationDate>
<lastModificationDayOfWeek>4</lastModificationDayOfWeek>
<lastModificationTime>11:11:09</lastModificationTime>
<owner>root</owner>
<location>DISK</location>
<group>root</group>
<existingCopies>0</existingCopies>
<access>664</access>
<targetCopies>1</targetCopies>
<targetStubSize>0</targetStubSize>
<targetStubScale>1024</targetStubScale>
<existingStubSize>n/a</existingStubSize>
<fileSize>100000</fileSize>
<store>MINTIME</store>
<affinity>n/a</affinity>
<reloc>MINTIME</reloc>
<class>xxx</class>
<trunc>MINTIME</trunc>
<cleanDBInfo>NO</cleanDBInfo>
<medias>
<media>
<message>None</message>
</media>
</medias>
<checksums>
<checksum>
<summary>N</summary>
</checksum>
</checksums>
<objects>
<object>
<summary>N</summary>
</object>
</objects>
</fileInfo>
</fileInfos>
<statuses>
<status>
<statusCode>FS0000</statusCode>
<statusNumber>0</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388006</requestId>
<commandName>/usr/adic/TSM/bin/fsfileinfo</commandName>
<commandStatus>completed</commandStatus>
<statusText>Command Successful.</statusText>
</status>
</statuses>
<footer>
<returnCode>0</returnCode>
<localDateISOEnd>2014-05-15T11:12:56</localDateISOEnd>
<localDateEnd>2014-05-15</localDateEnd>
<localTimeEnd>11:12:56</localTimeEnd>
<localDayOfWeekEnd>4</localDayOfWeekEnd>
<gmtDateISOEnd>2014-05-15T16:12:56Z</gmtDateISOEnd>
<gmtDateEnd>2014-05-15</gmtDateEnd>
<gmtTimeEnd>16:12:56</gmtTimeEnd>
<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
<elapsedTimeInSeconds>0.0022</elapsedTimeInSeconds>
</footer>
</fsfileinfo>
Allows you to expire numbered copies from all versions of the specified file(s). You must first configure the copy numbers for expiration. When you create or modify a file, you must create all copies for the current version before any copies can be expired. You can manually expire copies before the expiration interval has elapsed. You cannot expire copies for Write Once Read Multiple (WORM) media types.
This web service runs the /usr/adic/TSM/exec/fsexpcopy
command.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
---|---|---|---|---|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
|
Optional |
1 |
The copy number to expire. Note: Required unless the scheduled parameter is set. |
|
|
Optional |
N |
One or more file(s) to expire. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
The directory from which to do start the recursive file expiration. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
Boolean that selects scheduled processing for automatic expiration of copies based on time since last access of a file. When specified, the copy, file and dir parameters cannot be set. Note: At most one instance of the command is allowed to be running, and the command can take a long time to complete. |
|
JSON Example
https://<<SERVER>>/sws/v2/policy/fsexpcopy
?copy=2
&file=/stornext/snfs/file1
&/stornext/snfs/file2
&format=JSON
JSON Output
{ "header": { "commandName": "fsexpcopy", "commandLine": "/usr/adic/TSM/exec/fsexpcopy -c 2 /stornext/snfs/file1 /stornext/snfs/file2 -F JSON", "commandDescription": "Expire file copies from media", "localDateISO": "2018-06-05T16:05:46", "localDate": "2018-06-05", "localTime": "16:05:46", "localDayOfWeek": 2, "gmtDateISO": "2018-06-05T20:05:46Z", "gmtDate": "2018-06-05", "gmtTime": "20:05:46", "gmtDayOfWeek": 2 }, "statuses": [ { "statusCode": "FS0850", "statusNumber": 850, "dayOfMonth": 5, "requestId": 78396, "commandName": "/usr/adic/TSM/exec/fsexpcopy", "commandStatus": "interim", "statusText": "Copy(s) successfully expired for /stornext/snfs/file1." }, { "statusCode": "FS0850", "statusNumber": 850, "dayOfMonth": 5, "requestId": 78396, "commandName": "/usr/adic/TSM/exec/fsexpcopy", "commandStatus": "interim", "statusText": "Copy(s) successfully expired for /stornext/snfs/file2." }, { "statusCode": "FS0390", "statusNumber": 390, "dayOfMonth": 5, "requestId": 78396, "commandName": "/usr/adic/TSM/exec/fsexpcopy", "commandStatus": "completed", "statusText": "2 out of 2 file copy expires were successful." }, { "statusCode": "FS0000", "statusNumber": 0, "dayOfMonth": 5, "requestId": 78396, "commandName": "/usr/adic/TSM/exec/fsexpcopy", "commandStatus": "completed", "statusText": "Command Successful." } ], "footer": { "returnCode": 0, "localDateISOEnd": "2018-06-05T16:05:46", "localDateEnd": "2018-06-05", "localTimeEnd": "16:05:46", "localDayOfWeekEnd": 2, "gmtDateISOEnd": "2018-06-05T20:05:46Z", "gmtDateEnd": "2018-06-05", "gmtTimeEnd": "20:05:46", "gmtDayOfWeekEnd": 2, "elapsedTimeInSeconds": "0.0037" } }
XML Example
https://<<SERVER>>/sws/v2/policy/fsexpcopy
?copy=2
&file=/stornext/snfs/file1
&/stornext/snfs/file2
&format=XML
XML Output
<?xml version="1.0" encoding="UTF-8"?> <fsexpcopy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsexpcopy.xsd"> <header> <commandName>fsexpcopy</commandName> <commandLine>/usr/adic/TSM/exec/fsexpcopy -c 2 /stornext/snfs/file1 /stornext/snfs/file2 -F XML</commandLine> <commandDescription>Expire file copies from media</commandDescription> <localDateISO>2018-06-05T16:05:26</localDateISO> <localDate>2018-06-05</localDate> <localTime>16:05:26</localTime> <localDayOfWeek>2</localDayOfWeek> <gmtDateISO>2018-06-05T20:05:26Z</gmtDateISO> <gmtDate>2018-06-05</gmtDate> <gmtTime>20:05:26</gmtTime> <gmtDayOfWeek>2</gmtDayOfWeek> </header> <statuses> <status> <statusCode>FS0850</statusCode> <statusNumber>850</statusNumber> <dayOfMonth>5</dayOfMonth> <requestId>78393</requestId> <commandName>/usr/adic/TSM/exec/fsexpcopy</commandName> <commandStatus>interim</commandStatus> <statusText>Copy(s) successfully expired for /stornext/snfs/file1.</statusText> </status> <status> <statusCode>FS0850</statusCode> <statusNumber>850</statusNumber> <dayOfMonth>5</dayOfMonth> <requestId>78393</requestId> <commandName>/usr/adic/TSM/exec/fsexpcopy</commandName> <commandStatus>interim</commandStatus> <statusText>Copy(s) successfully expired for /stornext/snfs/file2.</statusText> </status> <status> <statusCode>FS0390</statusCode> <statusNumber>390</statusNumber> <dayOfMonth>5</dayOfMonth> <requestId>78393</requestId> <commandName>/usr/adic/TSM/exec/fsexpcopy</commandName> <commandStatus>completed</commandStatus> <statusText>2 out of 2 file copy expires were successful.</statusText> </status> <status> <statusCode>FS0000</statusCode> <statusNumber>0</statusNumber> <dayOfMonth>5</dayOfMonth> <requestId>78393</requestId> <commandName>/usr/adic/TSM/exec/fsexpcopy</commandName> <commandStatus>completed</commandStatus> <statusText>Command Successful.</statusText> </status> </statuses> <footer> <returnCode>0</returnCode> <localDateISOEnd>2018-06-05T16:05:26</localDateISOEnd> <localDateEnd>2018-06-05</localDateEnd> <localTimeEnd>16:05:26</localTimeEnd> <localDayOfWeekEnd>2</localDayOfWeekEnd> <gmtDateISOEnd>2018-06-05T20:05:26Z</gmtDateISOEnd> <gmtDateEnd>2018-06-05</gmtDateEnd> <gmtTimeEnd>20:05:26</gmtTimeEnd> <gmtDayOfWeekEnd>2</gmtDayOfWeekEnd> <elapsedTimeInSeconds>0.0024</elapsedTimeInSeconds> </footer> </fsexpcopy>
Generate a report about a file’s tape copy location.
This web service runs the fsfiletapeloc
command.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
---|---|---|---|---|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
|
Required |
1 |
The file for which location is being queried. The path name of the file is required. |
|
|
Optional |
1 |
The copy ID to generate the report for. If not specified, the information for the primary copy will be reported. |
|
Example
https://<<
SERVER>>/sws/v2/file/fsfiletapeloc
?file=/stornext/snfs1/xxx/testfile.0
&format=xml
Output
<?xml version="1.0" encoding="UTF-8"?> <fsfiletapeloc xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsfiletapeloc.xsd"> <header> <commandName>fsfiletapeloc</commandName> <commandLine>/usr/adic/TSM/bin/fsfiletapeloc -F XML /stornext/snfs1/xxx/testfile.0</commandLine> <commandDescription>Generate a report about a file's tape copy location</commandDescription> <localDateISO>2017-10-05T13:27:22</localDateISO> <localDate>2017-10-05</localDate> <localTime>13:27:22</localTime> <localDayOfWeek>4</localDayOfWeek> <gmtDateISO>2017-10-05T18:27:22Z</gmtDateISO> <gmtDate>2017-10-05</gmtDate> <gmtTime>18:27:22</gmtTime> <gmtDayOfWeek>4</gmtDayOfWeek> </header> <files> <file> <fileName>/stornext/snfs1/xxx/testfile.0</fileName> <segments> <segment> <index>1</index> <mediaId>ACD683</mediaId> <libraryId>Library1</libraryId> <format>ANTF</format> <startBlock>56580</startBlock> <offset>128</offset> <segmentSize>99900000000</segmentSize> <blockSize>524288</blockSize> </segment> <segment> <index>2</index> <mediaId>ACD682</mediaId> <libraryId>Library1</libraryId> <format>ANTF</format> <startBlock>190550</startBlock> <offset>128</offset> <segmentSize>99900000000</segmentSize> <blockSize>524288</blockSize> </segment> </segments> </file> </files> <statuses> <status> <statusCode>FS0000</statusCode> <statusNumber>0</statusNumber> <dayOfMonth>5</dayOfMonth> <requestId>1224480</requestId> <commandName>/usr/adic/TSM/bin/fsfiletapeloc</commandName> <commandStatus>completed</commandStatus> <statusText>Command Successful.</statusText> </status> </statuses> <footer> <returnCode>0</returnCode> <localDateISOEnd>2017-10-05T13:27:22</localDateISOEnd> <localDateEnd>2017-10-05</localDateEnd> <localTimeEnd>13:27:22</localTimeEnd> <localDayOfWeekEnd>4</localDayOfWeekEnd> <gmtDateISOEnd>2017-10-05T18:27:22Z</gmtDateISOEnd> <gmtDateEnd>2017-10-05</gmtDateEnd> <gmtTimeEnd>18:27:22</gmtTimeEnd> <gmtDayOfWeekEnd>4</gmtDayOfWeekEnd> <elapsedTimeInSeconds>0.0006</elapsedTimeInSeconds> </footer> </fsfiletapeloc>
Retrieve truncated files from media and place on disk.
This web service runs the fsretrieve
command.
Important Consideration About The Recursive Retrieve Command
There are two phases when you invoke a recursive retrieve command:
- Phase 1: Mapping of the directory and the files to determine which files are retrieved.
- Phase 2: The actual retrieves from tape, sdisk, and object storage.
During Phase 1 you can only execute one recursive retrieve command at a time. If you execute multiple recursive retrieve commands concurrently, the processes fail and you are notified that an existing recursive retrieve command is in progress.
For example, if a recursive retrieve is currently running Phase 1 and an additional recursive retrieve is invoked, the second request fails
However, if that same recursive retrieve is currently running Phase 2, and an additional recursive retrieve is invoked, the second request is processed without any errors.
For additional information, see How to Find the async Job ID in the Output.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
|
Optional |
1 |
This parameter retrieves file(s) to a specific file system affinity. |
|
|
Optional |
1 |
This parameter allocates disk blocks to files in alphabetic order in an attempt to provide sequential block allocation to all files in the specified directory. Note: This parameter is only valid when the directory parameter is used and the recursive parameter is false. The default value is false. |
|
|
Optional |
1 |
Used to retrieve a specific copy of filename if one exists. |
|
|
Optional |
1 |
The directory to process. The recursive parameter determines how the directory will be processed. Note: At least one file or directory path is required. |
|
|
Optional |
N |
List of files that need to be retrieved. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
Force change in alternate retrieval location behavior. Valid values are true and false. |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
recursive
|
Optional | 1 | This parameter is only valid when the directory parameter is specified. A value of false will only process the contents of the directory while a value of true will perform a recursive operation on the directory. The default value is true. |
|
retrievaltype |
Optional | 1 |
This parameter specifies the type of retrieval from glacier storage. The following types of retrieval are supported:
If this option is not specified, then the retrieval type defaults to the configured value. Note: This option is ignored if it is not supported by the media. |
-g
|
|
Optional |
1 |
Specifies top priority and will cause all files for the retrieve request to be placed at the top of the retrieve queue. Default value is false. |
|
|
Optional |
1 |
Updates the access time for the requested files. |
|
Example
https://<<
SERVER>>/sws/v2/file/fsretrieve
?file=/stornext/snfs1/xxx/testfile.0
&format=xml
Output
<?xml version="1.0" encoding="UTF-8" ?>
<fsretrieve xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsretrieve.xsd">
<header>
<commandName>fsretrieve</commandName>
<commandLine>/usr/adic/TSM/bin/fsretrieve -a -p -F xml /stornext/snfs1/xxx/testfile.0</commandLine>
<commandDescription>Retrieve files from media and place on disk</commandDescription>
<localDateISO>2014-05-15T11:21:35</localDateISO>
<localDate>2014-05-15</localDate>
<localTime>11:21:35</localTime>
<localDayOfWeek>4</localDayOfWeek>
<gmtDateISO>2014-05-15T16:21:35Z</gmtDateISO>
<gmtDate>2014-05-15</gmtDate>
<gmtTime>16:21:35</gmtTime>
<gmtDayOfWeek>4</gmtDayOfWeek>
</header>
<statuses>
<status>
<statusCode>FS0589</statusCode>
<statusNumber>589</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388015</requestId>
<commandName>/usr/adic/TSM/bin/fsretrieve</commandName>
<commandStatus>interim</commandStatus>
<statusText>Tertiary Manager software request received.</statusText>
</status>
<status>
<statusCode>FS0347</statusCode>
<statusNumber>347</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388015</requestId>
<commandName>fsretrieve</commandName>
<commandStatus>interim</commandStatus>
<statusText>File /stornext/snfs1/xxx/testfile.0 has been retrieved.</statusText>
</status>
<status>
<statusCode>FS0390</statusCode>
<statusNumber>390</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388015</requestId>
<commandName>fsretrieve</commandName>
<commandStatus>completed</commandStatus>
<statusText>1 out of 1 retrieves were successful.</statusText>
</status>
</statuses>
<footer>
<returnCode>0</returnCode>
<localDateISOEnd>2014-05-15T11:21:39</localDateISOEnd>
<localDateEnd>2014-05-15</localDateEnd>
<localTimeEnd>11:21:39</localTimeEnd>
<localDayOfWeekEnd>4</localDayOfWeekEnd>
<gmtDateISOEnd>2014-05-15T16:21:39Z</gmtDateISOEnd>
<gmtDateEnd>2014-05-15</gmtDateEnd>
<gmtTimeEnd>16:21:39</gmtTimeEnd>
<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
<elapsedTimeInSeconds>4.0212</elapsedTimeInSeconds>
</footer>
</fsretrieve>
Retrieve files from media and place them into a new disk file.
This web service runs the fsretrieve
command.
Important Consideration About The Recursive Retrieve Command
There are two phases when you invoke a recursive retrieve command:
- Phase 1: Mapping of the directory and the files to determine which files are retrieved.
- Phase 2: The actual retrieves from tape, sdisk, and object storage.
During Phase 1 you can only execute one recursive retrieve command at a time. If you execute multiple recursive retrieve commands concurrently, the processes fail and you are notified that an existing recursive retrieve command is in progress.
For example, if a recursive retrieve is currently running Phase 1 and an additional recursive retrieve is invoked, the second request fails
However, if that same recursive retrieve is currently running Phase 2, and an additional recursive retrieve is invoked, the second request is processed without any errors.
For additional information, see How to Find the async Job ID in the Output.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
|
Required |
1 |
File that needs to be retrieved. |
|
|
Required |
1 |
The new path and file name into which to retrieve the file. |
|
|
Optional |
1 |
Used to retrieve a specific copy of filename if one exists. |
|
|
Optional |
1 |
Updates the access time for the requested files. |
|
|
Optional |
1 |
Specifies top priority and will cause all files for the retrieve request to be placed at the top of the retrieve queue. Default value is false. |
|
Example
https://<<SERVER>>/sws/v2/file/fsretrieve/new
?file=/stornext/snfs1/xxx/testfile.0
&newfile=/stornext/snfs1/xxx/testfile.1
&format=xml
Output
<?xml version="1.0" encoding="UTF-8" ?>
<fsretrieve xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsretrieve.xsd">
<header>
<commandName>fsretrieve</commandName>
<commandLine>/usr/adic/TSM/bin/fsretrieve /stornext/snfs1/xxx/testfile.0 -n /stornext/snfs1/xxx/testfile.1 -F xml</commandLine>
<commandDescription>Retrieve files from media and place on disk</commandDescription>
<localDateISO>2014-05-15T11:26:44</localDateISO>
<localDate>2014-05-15</localDate>
<localTime>11:26:44</localTime>
<localDayOfWeek>4</localDayOfWeek>
<gmtDateISO>2014-05-15T16:26:44Z</gmtDateISO>
<gmtDate>2014-05-15</gmtDate>
<gmtTime>16:26:44</gmtTime>
<gmtDayOfWeek>4</gmtDayOfWeek>
</header>
<statuses>
<status>
<statusCode>FS0589</statusCode>
<statusNumber>589</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388021</requestId>
<commandName>/usr/adic/TSM/bin/fsretrieve</commandName>
<commandStatus>interim</commandStatus>
<statusText>Tertiary Manager software request received.</statusText>
</status>
<status>
<statusCode>FS0347</statusCode>
<statusNumber>347</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388021</requestId>
<commandName>fsretrieve</commandName>
<commandStatus>interim</commandStatus>
<statusText>File /stornext/snfs1/xxx/testfile.0 has been retrieved.</statusText>
</status>
<status>
<statusCode>FS0390</statusCode>
<statusNumber>390</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388021</requestId>
<commandName>fsretrieve</commandName>
<commandStatus>completed</commandStatus>
<statusText>1 out of 1 retrieves were successful.</statusText>
</status>
</statuses>
<footer>
<returnCode>0</returnCode>
<localDateISOEnd>2014-05-15T11:26:46</localDateISOEnd> <localDateEnd>2014-05-15</localDateEnd>
<localTimeEnd>11:26:46</localTimeEnd>
<localDayOfWeekEnd>4</localDayOfWeekEnd>
<gmtDateISOEnd>2014-05-15T16:26:46Z</gmtDateISOEnd>
<gmtDateEnd>2014-05-15</gmtDateEnd>
<gmtTimeEnd>16:26:46</gmtTimeEnd>
<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
<elapsedTimeInSeconds>2.0689</elapsedTimeInSeconds>
</footer>
</fsretrieve>
This web service relocates a managed file from one disk affinity to another.
Parameters
Parameter | Req / Opt | Num | Description | CLI Option |
---|---|---|---|---|
affinity |
Required | 1 | The destination affinity for the files. | -a
|
allocation |
Optional | 1 |
This allocates disk blocks to files in alphabetic order in an attempt to provide sequential block allocation to all files in the specified directory. This parameter is only valid when the directory parameter is used and the recursive parameter is false. The default value is false. |
-A
|
directory |
Optional | 1 |
The directory to process. The recursive parameter determines how the directory is processed. Note: At least one file or directory path is required. |
-R or -D |
file |
Optional | N |
The files that need to be relocated. Note: At least one file or directory path is required. |
None |
format |
Optional | 1 | The output format requested. The valid values are json and text. The default value is text. | -F
|
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
recursive |
Optional | 1 |
This parameter is only valid when the directory parameter is specified. A value of false only process the contents of the directory, while a value of true performs a recursive operation on the directory. The default is true. |
-R or -D |
Example
https://<<SERVER>>/sws/v2/file/fsrelocate
?file=/stornext/snfs1/pol1/file1.txt
&affinity=tier2
&format=json
Output
{
"header": {
"commandName": "fsrelocate",
"commandLine": "fsrelocate /stornext/snfs1/pol1/file1.txt -a tier2 -F JSON",
"commandDescription": "Relocate a managed file from one disk affinity to another or change the affinity association of a truncated file",
"localDateISO": "2015-11-03T07:19:34",
"localDate": "2015-11-03",
"localTime": "07:19:34",
"localDayOfWeek": 2,
"gmtDateISO": "2015-11-03T13:19:34Z",
"gmtDate": "2015-11-03",
"gmtTime": "13:19:34",
"gmtDayOfWeek": 2
},
"statuses": [
{
"statusCode": "FS0589",
"statusNumber": 589,
"dayOfMonth": 3,
"requestId": 255713,
"commandName": "fsrelocate",
"commandStatus": "interim",
"statusText": "Tertiary Manager software request received. /stornext/snfs1/pol1/file1.txt"
},
{
"statusCode": "FS0684",
"statusNumber": 684,
"dayOfMonth": 3,
"requestId": 255713,
"commandName": "fsrelocate",
"commandStatus": "interim",
"statusText": "File successfully relocated."
},
{
"statusCode": "FS0390",
"statusNumber": 390,
"dayOfMonth": 3,
"requestId": 255713,
"commandName": "fsrelocate",
"commandStatus": "completed",
"statusText": "1 out of 1 relocates were successful."
}
],
"footer": {
"returnCode": 0,
"localDateISOEnd": "2015-11-03T07:19:34",
"localDateEnd": "2015-11-03",
"localTimeEnd": "07:19:34",
"localDayOfWeekEnd": 2,
"gmtDateISOEnd": "2015-11-03T13:19:34Z",
"gmtDateEnd": "2015-11-03",
"gmtTimeEnd": "13:19:34",
"gmtDayOfWeekEnd": 2,
"elapsedTimeInSeconds": "0.0040"
}
}
Retrieve files from media and place them on disk.
This web service runs the fsretrieve
command.
Important Consideration About The Recursive Retrieve Command
There are two phases when you invoke a recursive retrieve command:
- Phase 1: Mapping of the directory and the files to determine which files are retrieved.
- Phase 2: The actual retrieves from tape, sdisk, and object storage.
During Phase 1 you can only execute one recursive retrieve command at a time. If you execute multiple recursive retrieve commands concurrently, the processes fail and you are notified that an existing recursive retrieve command is in progress.
For example, if a recursive retrieve is currently running Phase 1 and an additional recursive retrieve is invoked, the second request fails
However, if that same recursive retrieve is currently running Phase 2, and an additional recursive retrieve is invoked, the second request is processed without any errors.
For additional information, see How to Find the async Job ID in the Output.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
|
Required |
1 |
File that needs to be retrieved. |
|
|
Required |
1 |
The new path and file name into which to retrieve the file. The location specified for the new file must be a local file system. Retrieval to an NFSmounted file system is not permitted. |
|
|
Required |
1 |
The starting byte for the file to be retrieved. The |
|
|
Required |
1 |
The last byte for the file to be retrieved. |
|
|
Optional |
1 |
Updates the access time for the requested files. |
|
|
Optional |
1 |
Specifies top priority and will cause the file for the retrieve request to be placed at the top of the retrieve queue. Default value is false. |
|
Example
https://<<
SERVER>>/sws/v2/file/fsretrieve/partial
?file=/stornext/snfs1/xxx/testfile.0
&newfile=/stornext/snfs1/xxx/testfile.1
&startbyte=100
&endbyte=1000
&format=xml
Output
<?xml version="1.0" encoding="UTF-8" ?>
<fsretrieve xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsretrieve.xsd">
<header>
<commandName>fsretrieve</commandName>
<commandLine>/usr/adic/TSM/bin/fsretrieve /stornext/snfs1/xxx/testfile.0 -n /stornext/snfs1/xxx/testfile.1 -b 100 1000 -F xml</commandLine>
<commandDescription>Retrieve files from media and place on disk</commandDescription>
<localDateISO>2014-05-15T11:35:23</localDateISO>
<localDate>2014-05-15</localDate>
<localTime>11:35:23</localTime>
<localDayOfWeek>4</localDayOfWeek>
<gmtDateISO>2014-05-15T16:35:23Z</gmtDateISO>
<gmtDate>2014-05-15</gmtDate>
<gmtTime>16:35:23</gmtTime>
<gmtDayOfWeek>4</gmtDayOfWeek>
</header>
<statuses>
<status>
<statusCode>FS0589</statusCode>
<statusNumber>589</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388031</requestId>
<commandName>/usr/adic/TSM/bin/fsretrieve</commandName>
<commandStatus>interim</commandStatus>
<statusText>Tertiary Manager software request received.</statusText>
</status>
<status>
<statusCode>FS0347</statusCode>
<statusNumber>347</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388031</requestId>
<commandName>fsretrieve</commandName>
<commandStatus>interim</commandStatus>
<statusText>File /stornext/snfs1/xxx/testfile.0 has been retrieved.</statusText>
</status>
<status>
<statusCode>FS0390</statusCode>
<statusNumber>390</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388031</requestId>
<commandName>fsretrieve</commandName>
<commandStatus>completed</commandStatus>
<statusText>1 out of 1 retrieves were successful.</statusText>
</status>
</statuses>
<footer>
<returnCode>0</returnCode>
<localDateISOEnd>2014-05-15T11:35:24</localDateISOEnd>
<localDateEnd>2014-05-15</localDateEnd>
<localTimeEnd>11:35:24</localTimeEnd>
<localDayOfWeekEnd>4</localDayOfWeekEnd>
<gmtDateISOEnd>2014-05-15T16:35:24Z</gmtDateISOEnd>
<gmtDateEnd>2014-05-15</gmtDateEnd>
<gmtTimeEnd>16:35:24</gmtTimeEnd>
<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
<elapsedTimeInSeconds>0.0727</elapsedTimeInSeconds>
</footer>
</fsretrieve>
Expedite the storage of a file that currently resides on disk to media.
This web service runs the fsstore
command.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
---|---|---|---|---|
|
Optional |
1 |
Number of copies of the file(s) to be stored. |
|
|
Optional |
1 |
The directory to process. The recursive parameter determines how the directory will be processed. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
Media Manager drive pool group used to store the file specified. |
|
|
Optional |
N |
File that needs to be stored. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
|
Optional |
1 |
Defines the type of medium to be used for storage. |
|
|
Optional |
1 |
Minimum File Size in bytes to be stored. |
|
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
recursive
|
Optional | 1 | This parameter is only valid when the directory parameter is specified. A value of false will only process the contents of the directory while a value of true will perform a recursive operation on the directory. The default value is true. |
|
|
Optional |
1 |
Maximum allowable time in hours for the command to finish. |
|
|
Optional |
1 |
The truncation mode. Valid value are immediate and policy. |
|
Example
https://<<SERVER>>/sws/v2/file/fsstore
?file=/stornext/snfx1/smp2data/filex1
&file=/stornext/snfx1/smp2data/filex2
&copies=1
&format=xml
Output
<?xml version="1.0" encoding="UTF-8"?> <fsstore xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsstore.xsd"> <header> <commandName>fsstore</commandName> <commandLine>/usr/adic/TSM/bin/fsstore -c 1 -F xml /stornext/snfx1/smp2data/filex1 /stornext/snfx1/smp2data/filex2</commandLine> <commandDescription>Request the storage of a file that currently resides on disk to media</commandDescription> <localDateISO>2015-12-03T11:43:19</localDateISO> <localDate>2015-12-03</localDate> <localTime>11:43:19</localTime> <localDayOfWeek>4</localDayOfWeek> <gmtDateISO>2015-12-03T18:43:19Z</gmtDateISO> <gmtDate>2015-12-03</gmtDate> <gmtTime>18:43:19</gmtTime> <gmtDayOfWeek>4</gmtDayOfWeek> </header> <statuses> <status> <statusCode>FS0589</statusCode> <statusNumber>589</statusNumber> <dayOfMonth>3</dayOfMonth> <requestId>180889</requestId> <commandName>/usr/adic/TSM/bin/fsstore</commandName> <commandStatus>interim</commandStatus> <statusText>Tertiary Manager software request received.</statusText> </status> <status> <statusCode>FS0799</statusCode> <statusNumber>799</statusNumber> <dayOfMonth>3</dayOfMonth> <requestId>180889</requestId> <commandName>/usr/adic/TSM/bin/fsstore</commandName> <commandStatus>interim</commandStatus> <statusText>2 file store request(s) have been sent to Tertiary Manager.</statusText> </status> <status> <statusCode>FS0346</statusCode> <statusNumber>346</statusNumber> <dayOfMonth>3</dayOfMonth> <requestId>180889</requestId> <commandName>fsstore</commandName> <commandStatus>interim</commandStatus> <statusText>File /stornext/snfx1/smp2data/filex1 copy 1 has been stored.</statusText> </status> <status> <statusCode>FS0346</statusCode> <statusNumber>346</statusNumber> <dayOfMonth>3</dayOfMonth> <requestId>180889</requestId> <commandName>fsstore</commandName> <commandStatus>interim</commandStatus> <statusText>File /stornext/snfx1/smp2data/filex2 copy 1 has been stored.</statusText> </status> <status> <statusCode>FS0390</statusCode> <statusNumber>390</statusNumber> <dayOfMonth>3</dayOfMonth> <requestId>180889</requestId> <commandName>fsstore</commandName> <commandStatus>completed</commandStatus> <statusText>2 out of 2 statuses were successful.</statusText> </status> <status> <statusCode>FS0000</statusCode> <statusNumber>0</statusNumber> <dayOfMonth>3</dayOfMonth> <requestId>180889</requestId> <commandName>fsstore</commandName> <commandStatus>completed</commandStatus> <statusText>Command Successful.</statusText> </status> </statuses> <footer> <returnCode>0</returnCode> <localDateISOEnd>2015-12-03T11:43:21</localDateISOEnd> <localDateEnd>2015-12-03</localDateEnd> <localTimeEnd>11:43:21</localTimeEnd> <localDayOfWeekEnd>4</localDayOfWeekEnd> <gmtDateISOEnd>2015-12-03T18:43:21Z</gmtDateISOEnd> <gmtDateEnd>2015-12-03</gmtDateEnd> <gmtTimeEnd>18:43:21</gmtTimeEnd> <gmtDayOfWeekEnd>4</gmtDayOfWeekEnd> <elapsedTimeInSeconds>1.0867</elapsedTimeInSeconds> </footer> </fsstore>
Remove the copy of a file from disk after the file was stored to a medium.
This web service runs the fsrmdiskcopy
command.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
---|---|---|---|---|
|
Optional |
1 |
The directory to process. The recursive parameter determines how the directory will be processed. Note: At least one file or directory path is required. |
|
|
Optional |
N |
One or more files to remove from disk. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
recursive
|
Optional | 1 | This parameter is only valid when the directory parameter is specified. A value of false will only process the contents of the directory while a value of true will perform a recursive operation on the directory. The default value is true. |
|
Example
https://<<
SERVER>>/sws/v2/file/fsrmdiskcopy
?file=/stornext/snfs1/xxx/testfile.0
&format=xml
Output
<?xml version="1.0" encoding="UTF-8" ?>
<fsrmdiskcopy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsrmdiskcopy.xsd">
<header>
<commandName>fsrmdiskcopy</commandName>
<commandLine>/usr/adic/TSM/bin/fsrmdiskcopy -F xml /stornext/snfs1/xxx/testfile.0</commandLine>
<commandDescription>Remove file data blocks from disk after the file was stored to a medium</commandDescription>
<localDateISO>2014-05-15T11:43:34</localDateISO>
<localDate>2014-05-15</localDate>
<localTime>11:43:34</localTime>
<localDayOfWeek>4</localDayOfWeek>
<gmtDateISO>2014-05-15T16:43:34Z</gmtDateISO>
<gmtDate>2014-05-15</gmtDate>
<gmtTime>16:43:34</gmtTime>
<gmtDayOfWeek>4</gmtDayOfWeek>
</header>
<statuses>
<status>
<statusCode>FS0266</statusCode>
<statusNumber>266</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388038</requestId>
<commandName>/usr/adic/TSM/bin/fsrmdiskcopy</commandName> <commandStatus>interim</commandStatus>
<statusText>Data disk blocks for file /stornext/snfs1/xxx/testfile.0 were successfully removed.</statusText>
</status>
<status>
<statusCode>FS0390</statusCode>
<statusNumber>390</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388038</requestId>
<commandName>/usr/adic/TSM/bin/fsrmdiskcopy</commandName> <commandStatus>completed</commandStatus>
<statusText>1 out of 1 disk copy removes were successful.</statusText>
</status>
</statuses>
<footer>
<returnCode>0</returnCode>
<localDateISOEnd>2014-05-15T11:43:34</localDateISOEnd>
<localDateEnd>2014-05-15</localDateEnd>
<localTimeEnd>11:43:34</localTimeEnd>
<localDayOfWeekEnd>4</localDayOfWeekEnd>
<gmtDateISOEnd>2014-05-15T16:43:34Z</gmtDateISOEnd>
<gmtDateEnd>2014-05-15</gmtDateEnd>
<gmtTimeEnd>16:43:34</gmtTimeEnd>
<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
<elapsedTimeInSeconds>0.0007</elapsedTimeInSeconds>
</footer>
</fsrmdiskcopy>
Modify the class attributes of a file.
This web service runs the fschfiat
command.
Parameters
Parameter |
Req / Opt |
Num |
Description |
CLI Option |
|
Optional |
1 |
This options indicates if the database entries are to be cleaned when the file is removed from the file system. Valid values are true and false.The true argument indicates that the database entries will be cleaned and the file will NOT be recoverable by the |
|
|
Optional |
1 |
The directory to process. The recursive parameter determines how the directory will be processed. Note: At least one file or directory path is required. |
|
|
Optional |
N |
One or more file(s) having the attributes changed. Note: At least one file or directory path is required. |
|
|
Optional |
1 |
The output format requested. Valid values are xml, json and text. The default is text. |
|
jobtype |
Optional | 1 |
This parameter is used for async mode only and enables the user to run it as a fast or slow job. Valid values are fast and slow. The default value is fast. Note: The fast and slow queues provide a method for segregating jobs that run quickly from jobs that take a long time to complete. Each queue is configured by default to run up to four jobs simultaneously in order within their respective queues. |
None |
mode |
Optional | 1 | This option specifies if the job will be run synchronously or asynchronously. The valid values are sync and async. The default value is sync. | None |
|
Optional |
1 |
Number of copies of the file(s) to be stored. |
|
|
Optional |
1 |
This specifies the class that will be associated with the file. |
|
recursive
|
Optional | 1 | This parameter is only valid when the directory parameter is specified. A value of false will only process the contents of the directory while a value of true will perform a recursive operation on the directory. The default value is true. |
|
|
Optional |
1 |
This option indicates how relocation policies operate on the file. Valid values are exclude and policy. The exclude argument excludes the file from relocation when a relocation policy occurs. The policy argument relocates the file by relocation policy. |
|
|
Optional |
1 |
This option indicates how storage policies operate on the file. Valid values are exclude and policy. The exclude argument excludes the file from storage when a store policy occurs. The policy argument stores the file by storage policy. |
|
|
Optional |
1 |
The truncation stub size (in kilobytes). This value is used to determine the number of bytes to leave on disk when files are truncated. |
|
|
Optional |
1 |
This option indicates how truncation policies operate on the file. Valid values are exclude, policy, immediate and clear. The exclude argument excludes the file from truncation when a store and/or cleanup policy application occurs. The immediate argument truncates the file immediately when stored to a medium. The policy argument truncates the file by cleanup policy. The clear argument temporarily clears the indication that this file met truncate exclusion criteria defined in the |
|
Example
https://<<
SERVER>>/sws/v2/file/fschfiat
?store=exclude
&trunc=immediate
&file=/stornext/snfs1/xxx/testfile.0
&format=xml
Output
<?xml version="1.0" encoding="UTF-8" ?>
<fschfiat xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fschfiat.xsd">
<header>
<commandName>fschfiat</commandName>
<commandLine>/usr/adic/TSM/bin/fschfiat -s e -t i -D n -F xml /stornext/snfs1/xxx/testfile.0</commandLine>
<commandDescription>Change file attributes for a set of file names</commandDescription>
<localDateISO>2014-05-15T11:45:04</localDateISO>
<localDate>2014-05-15</localDate>
<localTime>11:45:04</localTime>
<localDayOfWeek>4</localDayOfWeek>
<gmtDateISO>2014-05-15T16:45:04Z</gmtDateISO>
<gmtDate>2014-05-15</gmtDate>
<gmtTime>16:45:04</gmtTime>
<gmtDayOfWeek>4</gmtDayOfWeek>
</header>
<statuses>
<status>
<statusCode>FS0109</statusCode>
<statusNumber>109</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388039</requestId>
<commandName>/usr/adic/TSM/bin/fschfiat</commandName>
<commandStatus>interim</commandStatus>
<statusText>Command successful for /stornext/snfs1/xxx/testfile.0.</statusText>
</status>
<status>
<statusCode>FS0390</statusCode>
<statusNumber>390</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388039</requestId>
<commandName>/usr/adic/TSM/bin/fschfiat</commandName>
<commandStatus>completed</commandStatus>
<statusText>1 out of 1 file attribute changes were successful.</statusText>
</status>
<status>
<statusCode>FS0000</statusCode>
<statusNumber>0</statusNumber>
<dayOfMonth>15</dayOfMonth>
<requestId>388039</requestId>
<commandName>/usr/adic/TSM/bin/fschfiat</commandName>
<commandStatus>completed</commandStatus>
<statusText>Command Successful.</statusText>
</status>
</statuses>
<footer>
<returnCode>0</returnCode>
<localDateISOEnd>2014-05-15T11:45:04</localDateISOEnd>
<localDateEnd>2014-05-15</localDateEnd>
<localTimeEnd>11:45:04</localTimeEnd>
<localDayOfWeekEnd>4</localDayOfWeekEnd>
<gmtDateISOEnd>2014-05-15T16:45:04Z</gmtDateISOEnd>
<gmtDateEnd>2014-05-15</gmtDateEnd>
<gmtTimeEnd>16:45:04</gmtTimeEnd>
<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
<elapsedTimeInSeconds>0.0046</elapsedTimeInSeconds>
</footer>
</fschfiat>
Below is an example command that initiates the async request to the StorNext MDC over HTTP or HTTPS:
Below is an example of the output:
{ "job" : "23", "message" : "Job has been successfully submitted." }
Below is an example command that queries for the status for the job number:
Below is an example of the output:
{ "jobList": [ { "jobInfo": { "job": "17", "state": "COMPLETED", "exitcode": 0, "datecompleted": "2018-10-30 19:13:05" }, "response": { "header": { "commandName": "fsretrieve", "commandLine": "/usr/adic/TSM/bin/fsretrieve -F JSON /stornext/snfs1/foobar", "commandDescription": "Retrieve files from media and place on disk", "localDateISO": "2018-10-30T19:12:51", "localDate": "2018-10-30", "localTime": "19:12:51", "localDayOfWeek": 2, "gmtDateISO": "2018-10-30T23:12:51Z", "gmtDate": "2018-10-30", "gmtTime": "23:12:51", "gmtDayOfWeek": 2 }, "statuses": [ { "statusCode": "FS0589", "statusNumber": 589, "dayOfMonth": 30, "requestId": 248266, "commandName": "/usr/adic/TSM/bin/fsretrieve", "commandStatus": "interim", "statusText": "Tertiary Manager software request received." }, { "statusCode": "FS0347", "statusNumber": 347, "dayOfMonth": 30, "requestId": 248266, "commandName": "/usr/adic/TSM/bin/fsretrieve", "commandStatus": "interim", "statusText": "File /stornext/snfs1/foobar has been retrieved." }, { "statusCode": "FS0390", "statusNumber": 390, "dayOfMonth": 30, "requestId": 248266, "commandName": "/usr/adic/TSM/bin/fsretrieve", "commandStatus": "completed", "statusText": "1 out of 1 retrieves were successful." } ], "footer": { "returnCode": 0, "localDateISOEnd": "2018-10-30T19:13:05", "localDateEnd": "2018-10-30", "localTimeEnd": "19:13:05", "localDayOfWeekEnd": 2, "gmtDateISOEnd": "2018-10-30T23:13:05Z", "gmtDateEnd": "2018-10-30", "gmtTimeEnd": "23:13:05", "gmtDayOfWeekEnd": 2, "elapsedTimeInSeconds": "13.0942" } } } ] }