Directory

Modify the class attributes of a directory.

This web service runs the fschdiat command.

Note: You must specify at least one of the optional parameters.

Parameters

Parameter	Req / Opt	Num	Description	CLI Option
`directory`	Required	N	Directory or directories to process.	`directory name`
`recursive`	Optional	1	Only one directory can be specified when the parameter is used. A value of false will process directory and its contents while a value of true will perform a recursive operation on the directory. If this parameter is not used, then the directories specified by the directory parameter are processed.	`-R` or `-D`
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`stubsize`	Optional	1	This indicates the stub size (in kilobytes) and is used to determine the number of bytes to leave on disk when files are truncated. It will be the minimum number of bytes left on disk (the value is rounded up to a multiple of the file system block size). If policy is specified as the value, then the policy class definitions will be used to determine the stub size.	`-S`
`reloc`	Optional	1	This option indicates how relocation policies operate. Valid values are exclude and policy. The exclude option excludes files from storage when a store policy occurs. The policy option stores files by storage policy.	`-r`
`store`	Optional	1	This option indicates how storage policies operate. Valid values are exclude and policy. The exclude option excludes files from storage when a store policy occurs. The policy option stores files by storage policy.	`-s`
`trunc`	Optional	1	This option indicates how truncation policies operate. Valid values are exclude and policy. The exclude option excludes files from storage when a store policy occurs. The policy option stores files by storage policy.	`-t`
`clean`	Optional	1	This option indicates if the database entries are to be cleaned when the file is removed from the file system. The yes option indicates that the database entries will be cleaned and the file will NOT be recoverable. The no option indicates that the database entries will NOT be cleaned and the file will be recoverable.	`-C`
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
`policy`	Optional	1	This specifies the class that will be associated with the directory.	`-c`

Example

https://<<SERVER>>/sws/v2/directory/fschdiat

?policy=smp4

&directory=/stornext/snfx1/smp2data/foodir0

&format=xml

Output

<?xml version="1.0" encoding="UTF-8"?>
<fschdiat xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="fschdiat.xsd">
    <header>
        <commandName>fschdiat</commandName>
        <commandLine>/usr/adic/TSM/bin/fschdiat -c smp4 -F xml
/stornext/snfx1/smp2data/foodir0</commandLine>
        <commandDescription>Modify the class attributes of a
directory</commandDescription>
        <localDateISO>2015-12-03T11:49:12</localDateISO>
        <localDate>2015-12-03</localDate>
        <localTime>11:49:12</localTime>
        <localDayOfWeek>4</localDayOfWeek>
        <gmtDateISO>2015-12-03T18:49:12Z</gmtDateISO>
        <gmtDate>2015-12-03</gmtDate>
        <gmtTime>18:49:12</gmtTime>
        <gmtDayOfWeek>4</gmtDayOfWeek>
    </header>
    <statuses>
        <status>
            <statusCode>FS0109</statusCode>
            <statusNumber>109</statusNumber>
            <dayOfMonth>3</dayOfMonth>
            <requestId>180911</requestId>
            <commandName>/usr/adic/TSM/bin/fschdiat</commandName>
            <commandStatus>interim</commandStatus>
            <statusText>Command successful for
/stornext/snfx1/smp2data/foodir0.</statusText>
        </status>
        <status>
            <statusCode>FS0390</statusCode>
            <statusNumber>390</statusNumber>
            <dayOfMonth>3</dayOfMonth>
            <requestId>180911</requestId>
            <commandName>/usr/adic/TSM/bin/fschdiat</commandName>
            <commandStatus>completed</commandStatus>
            <statusText>1 out of 1 directory attribute changes were
successful.</statusText>
        </status>
        <status>
            <statusCode>FS0000</statusCode>
            <statusNumber>0</statusNumber>
            <dayOfMonth>3</dayOfMonth>
            <requestId>180911</requestId>
            <commandName>/usr/adic/TSM/bin/fschdiat</commandName>
            <commandStatus>completed</commandStatus>
            <statusText>Command Successful.</statusText>
        </status>
    </statuses>
    <footer>
        <returnCode>0</returnCode>
        <localDateISOEnd>2015-12-03T11:49:12</localDateISOEnd>
        <localDateEnd>2015-12-03</localDateEnd>
        <localTimeEnd>11:49:12</localTimeEnd>
        <localDayOfWeekEnd>4</localDayOfWeekEnd>
        <gmtDateISOEnd>2015-12-03T18:49:12Z</gmtDateISOEnd>
        <gmtDateEnd>2015-12-03</gmtDateEnd>
        <gmtTimeEnd>18:49:12</gmtTimeEnd>
        <gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>
        <elapsedTimeInSeconds>0.0003</elapsedTimeInSeconds>
    </footer>
</fschdiat>

Directory / Retrieve Files

Retrieve or recover 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.

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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`directory`	Required	1	The directory from which to start the recursive retrieves.	`-R`
`updateaccesstime`	Optional	1	Updates the access time for the requested files. Default value is false.	`-a`
`toppriority`	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.	`-p`

Example

https://<<SERVER>>/sws/v2/directory/fsretrieve

?directory=/stornext/snfs1/xxx

&updateaccesstime=false

&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 -R /stornext/snfs1/xxx -F xml</commandLine>

<commandDescription>Retrieve files from media and place on disk</commandDescription>

<localDateISO>2014-05-15T11:04:42</localDateISO>

<localDate>2014-05-15</localDate>

<localTime>11:04:42</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:04:42Z</gmtDateISO>

<gmtDate>2014-05-15</gmtDate>

<gmtTime>16:04:42</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0657</statusCode>

<statusNumber>657</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387987</requestId>

<commandName>/usr/adic/TSM/bin/fsretrieve</commandName>

<commandStatus>interim</commandStatus>

<statusText>Creating map of /stornext/snfs1/xxx ...</statusText>

</status>

<status>

<statusCode>FS0658</statusCode>

<statusNumber>658</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387987</requestId>

<commandName>/usr/adic/TSM/bin/fsretrieve</commandName>

<commandStatus>interim</commandStatus>

<statusText>Mapping completed.</statusText>

</status>

<status>

<statusCode>FS0589</statusCode>

<statusNumber>589</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387987</requestId>

<commandName>/usr/adic/TSM/bin/fsretrieve</commandName>

<commandStatus>interim</commandStatus>

<statusText>Tertiary Manager software request received.</statusText>

</status>

<status>

<statusCode>FS0655</statusCode>

<statusNumber>655</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387987</requestId>

<commandName>fsretrieve</commandName>

<commandStatus>interim</commandStatus>

<statusText>Currently processed 0 out of 100 files.</statusText>

</status>

<status>

<statusCode>FS0390</statusCode>

<statusNumber>390</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387987</requestId>

<commandName>fsretrieve</commandName>

<commandStatus>completed</commandStatus>

<statusText>100 out of 100 retrieves were successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T11:04:51</localDateISOEnd>

<localDateEnd>2014-05-15</localDateEnd>

<localTimeEnd>11:04:51</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:04:51Z</gmtDateISOEnd>

<gmtDateEnd>2014-05-15</gmtDateEnd>

<gmtTimeEnd>16:04:51</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>9.0595</elapsedTimeInSeconds>

</footer>

</fsretrieve>