Media Commands

Generate a report on media based on their current status.

This web service runs the fsmedinfo 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`verbose`	Optional	1	Produce the long form of the report that contains the same information as the short form, plus a list of the file segments on the medium. Default value is false.	`-l`
`starttime`	Optional	1	Used with the verbose option to indicate a start time of the files on the media to be reported. If this time and/or the end time are used with the verbose option then only the files on the media that were stored or recovered during the specified time window will be displayed. When this option or the -e is used, the output will be sorted per file system by the store/recovery time. The format for the time parameter is YYYY:MM:DD:hh:mm:ss.	`-s`
`endtime`	Optional	1	Used with the verbose option to indicate an end time of the files on the media to be reported. The format for the time parameter is YYYY:MM:DD:hh:mm:ss.	`-e`
`media`	Required	N	A media ID.	`mediaID`

Example

https://<<SERVER>>/sws/v2/media/fsmedinfo

?verbose=true

&starttime=2004:01:01:01:01:01

&endtime=2013:01:01:01:01:01

&media=E00001

&media=E00002

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsmedinfo xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsmedinfo.xsd">

<header>

<commandName>fsmedinfo</commandName>

<commandLine>/usr/adic/TSM/bin/fsmedinfo -l -s 2004:01:01:01:01:01 -e 2013:01:01:01:01:01 -F xml E00000 E00001</commandLine>

<commandDescription>Generate a report on media</commandDescription>

<localDateISO>2014-05-15T11:47:16</localDateISO>

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

<localTime>11:47:16</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:47:16Z</gmtDateISO>

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

<gmtTime>16:47:16</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<medias>

<media>

<mediaId>E00000</mediaId>

<copy>1</copy>

<mediaType>LTO</mediaType>

<storageArea>VolSub</storageArea>

<classId>sws_1400082516</classId>

<lastAccessed>15-may-2014 10:07:44</lastAccessed>

<mediaStatus>AVAIL</mediaStatus>

<writeProtect>N</writeProtect>

<markStatus>UNMARKED</markStatus>

<mediumLocation>SLOT/BIN</mediumLocation>

<formatted>Y</formatted>

<formatType>ANTF</formatType>

<numberOfSegments>10</numberOfSegments>

<externalLocation>N/A</externalLocation>

<bytesUsed>1453378</bytesUsed>

<spaceRemaining>5241831424</spaceRemaining>

<percentUsed>0.03</percentUsed>

<suspectCount>0</suspectCount>

<mountCount>5</mountCount>

<mediaClass>F0_LTO_DATA</mediaClass>

<currentState>On-line</currentState>

<assignment>Free</assignment>

<actionState>None</actionState>

<locationState>Archive</locationState>

<currentArchive>myarchive</currentArchive>

<pendingArchive>N/A</pendingArchive>

<importDate>12-may-2014 15:44:14</importDate>

<moveCount>10</moveCount>

<files />

</media>

<media>

<mediaId>E00001</mediaId>

<copy>0</copy>

<mediaType>LTO</mediaType>

<storageArea>VolSub</storageArea>

<classId>sws_1400082516</classId>

<lastAccessed>15-may-2014 10:02:43</lastAccessed>

<mediaStatus>AVAIL</mediaStatus>

<writeProtect>N</writeProtect>

<markStatus>UNMARKED</markStatus>

<mediumLocation>SLOT/BIN</mediumLocation>

<formatted>N</formatted>

<formatType>UNKNOWN</formatType>

<numberOfSegments>0</numberOfSegments>

<externalLocation>N/A</externalLocation>

<bytesUsed>0</bytesUsed>

<spaceRemaining>0</spaceRemaining>

<percentUsed>0.00</percentUsed>

<suspectCount>0</suspectCount>

<mountCount>4</mountCount>

<currentState>On-line</currentState>

<assignment>Free</assignment>

<actionState>None</actionState>

<locationState>Archive</locationState>

<currentArchive>myarchive</currentArchive>

<pendingArchive>N/A</pendingArchive>

<importDate>12-may-2014 15:44:14</importDate>

<moveCount>8</moveCount>

</media>

</medias>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388043</requestId>

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

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T11:47:16</localDateISOEnd>

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

<localTimeEnd>11:47:16</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:47:16Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:47:16</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0012</elapsedTimeInSeconds>

</footer>

</fsmedinfo>

Media / File Background job status

This web service reports the status of the background job.

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. The valid values are xml, json and text. The default value is text.	-F
requestid	Optional	1	The request id for the deletion requests If no `requestid`is provided, all outstanding requests are included.	-C

Example

https://<<SERVER>>/sws/v2/media/fsclean/background/status

?requestid=177937

&format=xml

Output

<?xml version="1.0" encoding="UTF-8"?>

<commandName>fsclean</commandName>

<commandLine>/usr/adic/TSM/exec/fsclean -C 177937 -F xml</commandLine>

<commandDescription>Remove file version information from Tertiary Manager knowledge.</commandDescription>

</header>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>interim</commandStatus>

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

</status>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

</footer>

</fsclean>

Media / File Inactive Removal

The primary function of this web service is to remove inactive versions of files.

This web service runs the fsclean 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`fsmounts`	Optional	N	One or more file systems for which to clean.	`-s`
`policy`	Optional	1	Policy class associated with data to clean.	`-c`
`endtime`	Optional	1	Endtime option. Time should be current or less than current time. If the time specified is greater than current time, current time will be used. The format for the time parameter is YYYY:MM:DD:hh:mm:ss.	`-t`
`removedonly`	Optional	1	Process inactive versions associated with removed files. Default value is false.	`-d`
`purge`	Optional	1	This option is used to indicate that a purge of the database namespace will be performed. Default value is false.	`-P`
`media`	Optional	N	A media ID.	`mediaID`

Example

https://<<SERVER>>/sws/v2/media/fsclean

?media=E00001

&endtime=2013:01:01:01:01:01

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsclean xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsclean.xsd">

<header>

<commandName>fsclean</commandName>

<commandLine>/usr/adic/TSM/exec/fsclean -m E00001 -t 2013:01:01:01:01:01 -F xml</commandLine>

<commandDescription>Remove file version information from Tertiary Manager knowledge.</commandDescription>

<localDateISO>2014-05-15T09:55:32</localDateISO>

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

<localTime>09:55:32</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T14:55:32Z</gmtDateISO>

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

<gmtTime>14:55:32</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0589</statusCode>

<statusNumber>589</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387924</requestId>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

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

</status>

<status>

<statusCode>FS0723</statusCode>

<statusNumber>723</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387924</requestId>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>completed</commandStatus>

<statusText>Nothing found to clean for request.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T09:55:32</localDateISOEnd>

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

<localTimeEnd>09:55:32</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T14:55:32Z</gmtDateISOEnd>

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

<gmtTimeEnd>14:55:32</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0003</elapsedTimeInSeconds>

</footer>

</fsclean>

Media / File Inactive Remove by Media

Clean all Tertiary Manager knowledge of files on media that has been marked as logically blank.

This web service runs the fsclean 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`rminfomedia`	Required	1	Media for which file version removal is required.	`media ID`
`rminforetrieve`	Optional	1	The filename file contains a list of files which need to be retrieved so that their missing copies can be regenerated.	`-p`
`purge`	Optional	1	This option is used to indicate that a purge of the database namespace will be performed. Default value is false.	`-P`

Example

https://<<SERVER>>/sws/v2/media/fsclean/rminfo

?rminfomedia=E00001

&purge=false

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsclean xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsclean.xsd">

<header>

<commandName>fsclean</commandName>

<commandLine>/usr/adic/TSM/exec/fsclean -r E00001 -F xml</commandLine>

<commandDescription>Remove file version information from Tertiary Manager knowledge.</commandDescription>

<localDateISO>2014-05-15T12:43:55</localDateISO>

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

<localTime>12:43:55</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T17:43:55Z</gmtDateISO>

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

<gmtTime>17:43:55</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0589</statusCode>

<statusNumber>589</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388137</requestId>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>interim</commandStatus>

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

</status>

<status>

<statusCode>FS0723</statusCode>

<statusNumber>723</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388137</requestId>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>completed</commandStatus>

<statusText>Nothing found to clean for request.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T12:43:55</localDateISOEnd>

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

<localTimeEnd>12:43:55</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T17:43:55Z</gmtDateISOEnd>

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

<gmtTimeEnd>17:43:55</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0002</elapsedTimeInSeconds>

</footer>

</fsclean>

Media / File Inactive Removal List

This will give a listing of all media which has been marked as logically blank.

This web service runs the fsclean 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

format

Optional

1

The output format requested. Valid values are xml, json and text. The default is text.

-F

Example

https://<<SERVER>>/sws/v2/media/fsclean/rminfo/list

?format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsclean xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsclean.xsd">

<header>

<commandName>fsclean</commandName>

<commandLine>/usr/adic/TSM/exec/fsclean -r -l -F xml</commandLine>

<commandDescription>Remove file version information from Tertiary Manager knowledge.</commandDescription>

<localDateISO>2014-05-15T09:57:17</localDateISO>

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

<localTime>09:57:17</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T14:57:17Z</gmtDateISO>

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

<gmtTime>14:57:17</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0589</statusCode>

<statusNumber>589</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387927</requestId>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>interim</commandStatus>

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

</status>

<status>

<statusCode>FS0723</statusCode>

<statusNumber>723</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387927</requestId>

<commandName>/usr/adic/TSM/exec/fsclean</commandName>

<commandStatus>completed</commandStatus>

<statusText>Nothing found to clean for request.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T09:57:17</localDateISOEnd>

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

<localTimeEnd>09:57:17</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T14:57:17Z</gmtDateISOEnd>

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

<gmtTimeEnd>14:57:17</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0002</elapsedTimeInSeconds>

</footer>

</fsclean>

Media / Move Media

Move media from one archive to another.

This web service runs the vsmove 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`media`	Required	N	The media(s) that need(s) to be moved.	`media ID`
`archive`	Required	1	Specifies the name of the archive to which the specified media are to be moved.	`-a`
`operator`	Optional	1	Indicates this command is to be processed only if both the source and destination archives are operator-attended. Default value is false.	`-i`
`wait`	Optional	1	Indicates the Media Manager software waits until the command processing completes before returning status to the client. Default value is false.	`-w`
`verbose`	Optional	1	Indicates that verbose output is desired. Default value is false.	`-v`
`hostname`	Optional	1	The host name of the Media Manager server. The default host name is the host name of the computer where the CLI command is issued.	`-H`
`priority`	Optional	1	The execution priority of the entered command. Assignable priority values are restricted to a range from 1 (highest) to 32 (lowest) inclusive. The default priority value is 15.	`-P`
`retries`	Optional	1	The number of retries the CLI software attempts if a timeout is returned by the API software. The default retries value is 3.	`-R`
`timeout`	Optional	1	The amount of time (in seconds) the API software waits for status from the Media Manager software before returning a timeout to the CLI software. Total wait time for a command is (retries plus 1) multiplied by time-out value. The default time-out value is 120 seconds.	`-T`
`rpcnumber`	Optional	1	The RPC program number for the Media Manager software. The default value for the Media Manager software program number is 300016.	`-V`

Example

https://<<SERVER>>/sws/v2/media/vsmove

?media=E00008

&archive=myarchive

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<vsmove xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vsmove.xsd">

<header>

<commandName>vsmove</commandName>

<commandLine>/usr/adic/MSM/clibin/vsmove -a myarchive E00008 -F xml</commandLine>

<commandDescription>Move media from one archive to another.</commandDescription>

<localDateISO>2014-05-15T11:50:27</localDateISO>

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

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:50:27Z</gmtDateISO>

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

<gmtTime>16:50:27</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<vsmoveOutput>

<vsmoveSuccess>

<vsmoveSuccessCompleted>0</vsmoveSuccessCompleted>

<vsmoveSuccessTotal>1</vsmoveSuccessTotal>

</vsmoveSuccess>

<errorMessage>

<errorMessageCode>VOL024</errorMessageCode>

<errorMessageText>error in the list</errorMessageText>

</errorMessage>

<mediaErrors>

<mediaError>

<mediaErrorMedium>E00008</mediaErrorMedium>

<mediaErrorText>medium already exists in target archive</mediaErrorText>

</mediaError>

</mediaErrors>

</vsmoveOutput>

<footer>

<returnCode>24</returnCode>

<localDateISOEnd>2014-05-15T11:50:27</localDateISOEnd>

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

<localTimeEnd>11:50:27</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:50:27Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:50:27</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0051</elapsedTimeInSeconds>

</footer>

</vsmove>

Media / Import Cleaning Media

This web service imports a list of cleaning media.

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. The valid values are json and text. The default value is text.	`-F`
mediaid	Required	N	The list of media IDs.	None

Example

https://<<SERVER>>/sws/v2/media/fsmedin/cleaningmedia

?mediaid=000025

&format=json

Output

{
    "header": {
        "commandName": "fsmedin",
        "commandLine": "/usr/adic/TSM/exec/fsmedin -k -F json 000025",
        "commandDescription": "Logically enters media into the Tertiary Manager system from the Media Manager system.",
        "localDateISO": "2015-11-02T12:47:31",
        "localDate": "2015-11-02",
        "localTime": "12:47:31",
        "localDayOfWeek": 1,
        "gmtDateISO": "2015-11-02T19:47:31Z",
        "gmtDate": "2015-11-02",
        "gmtTime": "19:47:31",
        "gmtDayOfWeek": 1
    },
    "statuses": [
        {
            "statusCode": "FS0627",
            "statusNumber": 627,
            "dayOfMonth": 2,
            "requestId": 177981,
            "commandName": "/usr/adic/TSM/exec/fsmedin",
            "commandStatus": "interim",
            "statusText": "Entering cleaning media..."
        },
        {
            "statusCode": "FS0574",
            "statusNumber": 574,
            "dayOfMonth": 2,
            "requestId": 177981,
            "commandName": "fsmedin",
            "commandStatus": "interim",
            "statusText": "Entering of medium 000025 failed. Reason: Query could not find a match for given criteria."
        },
        {
            "statusCode": "FS0390",
            "statusNumber": 390,
            "dayOfMonth": 2,
            "requestId": 177981,
            "commandName": "fsmedin",
            "commandStatus": "failed",
            "statusText": "0 out of 1 requests were successful."
        }
    ],
    "footer": {
        "returnCode": 1,
        "localDateISOEnd": "2015-11-02T12:47:31",
        "localDateEnd": "2015-11-02",
        "localTimeEnd": "12:47:31",
        "localDayOfWeekEnd": 1,
        "gmtDateISOEnd": "2015-11-02T19:47:31Z",
        "gmtDateEnd": "2015-11-02",
        "gmtTimeEnd": "19:47:31",
        "gmtDayOfWeekEnd": 1,
        "elapsedTimeInSeconds": "0.0043"
    }
}

Media / Import Media

This web service imports a list of media.

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. The valid values are json and text. The default value is text.	`-F`
mediaid	Required	N	The list of media IDs.	None
mediaformat	Optional	1	The media format that is requested for the media. The valid values are ANTF and LTFS.	-T
policyclass	Optional	1	The policy class this media will be associated.	-c
withholdformatting	Optional	1	This option is used to withhold formatting media immediately.	-w

Example

https://<<SERVER>>/sws/v2/media/fsmedin

?mediaid=000017

&format=json

Output

{
    "header": {
        "commandName": "fsmedin",
        "commandLine": "/usr/adic/TSM/exec/fsmedin -b -F json 000017",
        "commandDescription": "Logically enters media into the Tertiary Manager system from the Media Manager system.",
        "localDateISO": "2015-11-02T12:45:58",
        "localDate": "2015-11-02",
        "localTime": "12:45:58",
        "localDayOfWeek": 1,
        "gmtDateISO": "2015-11-02T19:45:58Z",
        "gmtDate": "2015-11-02",
        "gmtTime": "19:45:58",
        "gmtDayOfWeek": 1
    },
    "statuses": [
        {
            "statusCode": "FS0627",
            "statusNumber": 627,
            "dayOfMonth": 2,
            "requestId": 177962,
            "commandName": "/usr/adic/TSM/exec/fsmedin",
            "commandStatus": "interim",
            "statusText": "Entering media..."
        },
        {
            "statusCode": "FS0575",
            "statusNumber": 575,
            "dayOfMonth": 2,
            "requestId": 177962,
            "commandName": "fsmedin",
            "commandStatus": "interim",
            "statusText": "Entering of medium 000017 successful."
        }
    ],
    "footer": {
        "returnCode": 0,
        "localDateISOEnd": "2015-11-02T12:45:58",
        "localDateEnd": "2015-11-02",
        "localTimeEnd": "12:45:58",
        "localDayOfWeekEnd": 1,
        "gmtDateISOEnd": "2015-11-02T19:45:58Z",
        "gmtDateEnd": "2015-11-02",
        "gmtTimeEnd": "19:45:58",
        "gmtDayOfWeekEnd": 1,
        "elapsedTimeInSeconds": "0.0080"
    }
}
,
{
    "statusCode": "FS0627",
    "statusNumber": 627,
    "dayOfMonth": 2,
    "requestId": 177962,
    "commandName": "fsmedin",
    "commandStatus": "interim",
    "statusText": "Formatting media..."
},
{
    "statusCode": "FS0575",
    "statusNumber": 575,
    "dayOfMonth": 2,
    "requestId": 177962,
    "commandName": "fsmedin",
    "commandStatus": "interim",
    "statusText": "Formatting of medium 000017 successful."
},
{
    "statusCode": "FS0390",
    "statusNumber": 390,
    "dayOfMonth": 2,
    "requestId": 177962,
    "commandName": "fsmedin",
    "commandStatus": "completed",
    "statusText": "1 out of 1 requests were successful."
}
],
"footer": {
    "returnCode": 0,
    "localDateISOEnd": "2015-11-02T12:45:59",
    "localDateEnd": "2015-11-02",
    "localTimeEnd": "12:45:59",
    "localDayOfWeekEnd": 1,
    "gmtDateISOEnd": "2015-11-02T19:45:59Z",
    "gmtDateEnd": "2015-11-02",
    "gmtTimeEnd": "19:45:59",
    "gmtDayOfWeekEnd": 1,
    "elapsedTimeInSeconds": "0.0379"
}
}

Media / Export Media

This web service exports a list of media.

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. The valid values are json and text. The default value is text.	`-F`
mediaid	Required	N	The list of media IDs.	None

Example

https://<<SERVER>>/sws/v2/media/fsmedout

?mediaid=000017

&format=json

Output

{
    "header": {
        "commandName": "fsmedout",
        "commandLine": "/usr/adic/TSM/exec/fsmedout -F json 000017",
        "commandDescription": "Logically removes media from the Tertiary Manager system.",
        "localDateISO": "2015-11-02T12:48:23",
        "localDate": "2015-11-02",
        "localTime": "12:48:23",
        "localDayOfWeek": 1,
        "gmtDateISO": "2015-11-02T19:48:23Z",
        "gmtDate": "2015-11-02",
        "gmtTime": "19:48:23",
        "gmtDayOfWeek": 1
    },
    "statuses": [
        {
            "statusCode": "FS0575",
            "statusNumber": 575,
            "dayOfMonth": 2,
            "requestId": 177985,
            "commandName": "fsmedout",
            "commandStatus": "interim",
            "statusText": "Ejecting of medium 000017 successful."
        },
        {
            "statusCode": "FS0390",
            "statusNumber": 390,
            "dayOfMonth": 2,
            "requestId": 177985,
            "commandName": "fsmedout",
            "commandStatus": "completed",
            "statusText": "1 out of 1 requests were successful."
        }
    ],
    "footer": {
        "returnCode": 0,
        "localDateISOEnd": "2015-11-02T12:48:23",
        "localDateEnd": "2015-11-02",
        "localTimeEnd": "12:48:23",
        "localDayOfWeekEnd": 1,
        "gmtDateISOEnd": "2015-11-02T19:48:23Z",
        "gmtDateEnd": "2015-11-02",
        "gmtTimeEnd": "19:48:23",
        "gmtDayOfWeekEnd": 1,
        "elapsedTimeInSeconds": "0.0226"
    }
}

Media / Copy Media

Initiates copy-replace for a media.

This web service runs the fsmedcopy command.

Parameters

Parameter	Req / Opt	Num	Description	CLI Option
`includeinactive`	Optional	1	Indicates all files, active and inactive versions will be copied from the source medium. Default value is false.	`-a`
`blank`	Optional	1	Specify blank media for media destination. Default value is false.	`-b`
`destination`	Optional	1	Copy data file(s) to destination media.	`-d`
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`checksum`	Optional	1	Generate and maintain a checksum for each copied file. Valid values are y and n.	`-G y or n`
limit	Optional	1	Use this option to throttle and limit the number of concurrent streams used for the request. Note: This option is useful with object storage media. The default value is 10.	`-L`
`recreate`	Optional	1	Use this option when issues exist with a medium such that files can not be read from it. Files on the medium can be recreated from alternate media which have different copies of the files. The argument specifies which copy to use. If 0 is specified, then the command uses any copy to recreate copies of files for the bad medium. Valid values are 0 through 8.	`-R`
`mediatype`	Optional	1	Defines the type of medium to be used.	`-t`
`runtime`	Optional	1	Maximum allowable time in hours for the command to finish.	`-u`
`drivepool`	Optional	1	Media Manager drive pool group from which the destination drive will be selected when copying the specified media.	`-v`
`media`	Required	N	Media IDs of the media(s).	`media ID`
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

Example

https://<<SERVER>>/sws/v2/media/fsmedcopy/replace

?media=E00001

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsmedcopy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsmedcopy.xsd">

<header>

<commandName>fsmedcopy</commandName>

<commandLine>/usr/adic/TSM/exec/fsmedcopy E00001 -r -G n -F xml</commandLine>

<commandDescription>Replace and/or defragment media.</commandDescription>

<localDateISO>2014-05-15T10:02:36</localDateISO>

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

<localTime>10:02:36</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T15:02:36Z</gmtDateISO>

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

<gmtTime>15:02:36</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0575</statusCode>

<statusNumber>575</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387943</requestId>

<commandName>fsmedcopy</commandName>

<commandStatus>interim</commandStatus>

<statusText>Copying files from medium E00001 successful.</statusText>

</status>

<status>

<statusCode>FS0390</statusCode>

<statusNumber>390</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387943</requestId>

<commandName>fsmedcopy</commandName>

<commandStatus>completed</commandStatus>

<statusText>1 out of 1 requests were successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T10:02:42</localDateISOEnd>

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

<localTimeEnd>10:02:42</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T15:02:42Z</gmtDateISOEnd>

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

<gmtTimeEnd>15:02:42</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>5.0470</elapsedTimeInSeconds>

</footer>

</fsmedcopy>

</footer>

</fsclean>

Media / Fragmentation Report

Report on media fragmentation.

This web service runs the fsmedcopy 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`media`	Required	N	The media IDs for which we need the fragmentation report.	`media ID`
`fill`	Optional	1	Fill level threshold between 0 and 100 percent. The percentage of the medium that has been written, including active and inactive file versions. A default of 0 percent is used if not specified.	`-f`
`fragmentation`	Optional	1	The percent (0 – 100) of wasted space out of the filled space on a medium. A default of 0 (zero) percent is used if not specified.	`-w`

Example

https://<<SERVER>>/sws/v2/media/fsmedcopy/fragreport

?media=E00001

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsmedcopy xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsmedcopy.xsd">

<header>

<commandName>fsmedcopy</commandName>

<commandLine>/usr/adic/TSM/exec/fsmedcopy E00001 -F xml</commandLine>

<commandDescription>Replace and/or defragment media.</commandDescription>

<localDateISO>2014-05-15T11:52:30</localDateISO>

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

<localTime>11:52:30</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:52:30Z</gmtDateISO>

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

<gmtTime>16:52:30</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<media>

<medium>

<mediaId>E00001</mediaId>

<fillLevel>0.00</fillLevel>

<wastedSpace>0.00</wastedSpace>

<segmentCount>0</segmentCount>

<available>Y</available>

<vaulted>N</vaulted>

</medium>

</media>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388046</requestId>

<commandName>/usr/adic/TSM/exec/fsmedcopy</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T11:52:30</localDateISOEnd>

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

<localTimeEnd>11:52:30</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:52:30Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:52:30</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0005</elapsedTimeInSeconds>

</footer>

</fsmedcopy>

Media / Eject Media

Eject media out of an archive to be entered into another archive.

This web service runs the vsarchiveeject 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`media`	Required	N	Media IDs that need to be ejected.	`mediaID`
`port`	Optional	1	Specifies the import/export port the media is ejected to (if applicable).	`-s`
`verbose`	Optional	1	Indicates that verbose output is desired. Default value is false.	`-v`
`hostname`	Optional	1	The host name of the Media Manager server.	`-H`
`priority`	Optional	1	The execution priority of the entered command. Assignable priority values are restricted to a range from 1 (highest) to 32 (lowest) inclusive. The default priority value is 15.	`-P`
`retries`	Optional	1	The number of retries that are attempted if a timeout is returned by the API software. The default retries value is 3.	`-R`
`timeout`	Optional	1	The amount of time (in seconds) the API software waits for status from the Media Manager software before returning a timeout. Total wait time for a command is (retries plus 1) multiplied by time-out value. The default time-out value is 120 seconds.	`-T`
`rpcnumber`	Optional	1	The RPC program number for the Media Manager software. The default value for the Media Manager software program number is 300016.	`-V`

Example

https://<<SERVER>>/sws/v2/media/vsarchiveeject

?media=E00008

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<vsarchiveeject xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vsarchiveeject.xsd">

<header>

<commandName>vsarchiveeject</commandName>

<commandLine>/usr/adic/MSM/clibin/vsarchiveeject E00008 -F xml</commandLine>

<commandDescription>Ejects media out of an archive to be entered into another archive.</commandDescription>

<localDateISO>2014-05-15T11:53:41</localDateISO>

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

<localTime>11:53:41</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:53:41Z</gmtDateISO>

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

<gmtTime>16:53:41</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<vsarchiveejectOutput>

<vsarchiveejectReport>

<successfullyEjected>0</successfullyEjected>

<totalRequested>1</totalRequested>

</vsarchiveejectReport>

<errorMessage>

<errorMessageCode>VOL024</errorMessageCode>

<errorMessageText>error in the list</errorMessageText>

</errorMessage>

<mediaErrors>

<mediaError>

<mediaErrorMedium>E00008</mediaErrorMedium>

<mediaErrorText>port not available</mediaErrorText>

</mediaError>

</mediaErrors>

</vsarchiveejectOutput>

<footer>

<returnCode>24</returnCode>

<localDateISOEnd>2014-05-15T11:53:41</localDateISOEnd>

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

<localTimeEnd>11:53:41</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:53:41Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:53:41</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0080</elapsedTimeInSeconds>

</footer>

</vsarchiveeject>

Media / Enter Media

Enter media that has been ejected out of an archive into another archive.

This web service runs the vsarchiveenter 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`media`	Required	N	Media IDs that need to be moved.	`mediaID`
`port`	Optional	1	Specifies the import/export port the media is entered from (if applicable).	`-s`
`archive`	Required	1	Specifies the name of the archive to which the specified media are to be moved.	`-a`
`verbose`	Optional	1	Indicates that verbose output is desired.	`-v`
`hostname`	Optional	1	The host name of the Media Manager server.	`-H`
`priority`	Optional	1	The execution priority of the entered command. Assignable priority values are restricted to a range from 1 (highest) to 32 (lowest) inclusive. The default priority value is 15.	`-P`
`retries`	Optional	1	The number of retries that are attempted if a timeout is returned by the API software. The default retries value is 3.	`-R`
`timeout`	Optional	1	The amount of time (in seconds) the API software waits for status from the Media Manager software before returning a timeout. Total wait time for a command is (retries plus 1) multiplied by time-out value. The default time-out value is 120 seconds.	`-T`
`rpcnumber`	Optional	1	The RPC program number for the Media Manager software. The default value for the Media Manager software program number is 300016.	`-V`

Example

https://<<SERVER>>/sws/v2/media/vsarchiveenter

?media=E00008

&archive=myarchive

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<vsarchiveenter xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="vsarchiveenter.xsd">

<header>

<commandName>vsarchiveenter</commandName>

<commandLine>/usr/adic/MSM/clibin/vsarchiveenter E00008 -a myarchive -F xml</commandLine>

<commandDescription>Enters media that has been ejected out of an archive into another archive.</commandDescription>

<localDateISO>2014-05-15T11:54:54</localDateISO>

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

<localTime>11:54:54</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:54:54Z</gmtDateISO>

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

<gmtTime>16:54:54</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<vsarchiveenterOutput>

<vsarchiveenterReport>

<successfullyEntered>0</successfullyEntered>

<totalRequested>1</totalRequested>

</vsarchiveenterReport>

<errorMessage>

<errorMessageCode>VOL024</errorMessageCode>

<errorMessageText>error in the list</errorMessageText>

</errorMessage>

<mediaErrors>

<mediaError>

<mediaErrorMedium>E00008</mediaErrorMedium>

<mediaErrorText>invalid action or location state for operation</mediaErrorText>

</mediaError>

</mediaErrors>

</vsarchiveenterOutput>

<footer>

<returnCode>24</returnCode>

<localDateISOEnd>2014-05-15T11:54:54</localDateISOEnd>

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

<localTimeEnd>11:54:54</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:54:54Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:54:54</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0091</elapsedTimeInSeconds>

</footer>

</vsarchiveenter>

Media / Purge Media

This web service purges a list of media.

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. The valid values are json and text. The default value is text.	`-F`
mediaid	Required	N	The list of media IDs.	None

Example

https://<<SERVER>>/sws/v2/media/fsmedout/purge

?mediaid=000017

&format=json

Output

{
    "header": {
        "commandName": "fsmedout",
        "commandLine": "/usr/adic/TSM/exec/fsmedout -k -F json 000017",
        "commandDescription": "Logically removes media from the Tertiary Manager system.",
        "localDateISO": "2015-11-02T12:45:24",
        "localDate": "2015-11-02",
        "localTime": "12:45:24",
        "localDayOfWeek": 1,
        "gmtDateISO": "2015-11-02T19:45:24Z",
        "gmtDate": "2015-11-02",
        "gmtTime": "19:45:24",
        "gmtDayOfWeek": 1
    },
    "statuses": [
        {
            "statusCode": "FS0575",
            "statusNumber": 575,
            "dayOfMonth": 2,
            "requestId": 177957,
            "commandName": "fsmedout",
            "commandStatus": "interim",
            "statusText": "Ejecting of medium 000017 successful."
        },
        {
            "statusCode": "FS0390",
            "statusNumber": 390,
            "dayOfMonth": 2,
            "requestId": 177957,
            "commandName": "fsmedout",
            "commandStatus": "completed",
            "statusText": "1 out of 1 requests were successful."
        }
    ],
    "footer": {
        "returnCode": 0,
        "localDateISOEnd": "2015-11-02T12:45:25",
        "localDateEnd": "2015-11-02",
        "localTimeEnd": "12:45:25",
        "localDayOfWeekEnd": 1,
        "gmtDateISOEnd": "2015-11-02T19:45:25Z",
        "gmtDateEnd": "2015-11-02",
        "gmtTimeEnd": "19:45:25",
        "gmtDayOfWeekEnd": 1,
        "elapsedTimeInSeconds": "0.0554"
    }
}

Media / Attribute Query

Queries for the attributes of one or more specified media.

This web service runs the vsmedqry command.

Note: This web service returns text output.

Parameters

Parameter	Req / Opt	Num	Description	CLI Option
`media`	Required	N	Specifies a media to be queried.	`mediaID`
`hostname`	Optional	1	The host name of the Media Manager server.	`-H`
`priority`	Optional	1	The execution priority of the entered command. Assignable priority values are restricted to a range from 1 (highest) to 32 (lowest) inclusive. The default priority value is 15.	`-P`
`retries`	Optional	1	The number of retries that are attempted if a timeout is returned by the API software. The default retries value is 3.	`-R`
`timeout`	Optional	1	The amount of time (in seconds) the API software waits for status from the Media Manager software before returning a timeout. Total wait time for a command is (retries plus 1) multiplied by time-out value. The default time-out value is 120 seconds.	`-T`
`rpcnumber`	Optional	1	The RPC program number for the Media Manager software. The default value for the Media Manager software program number is 300016.	`-V`

Example

https://<<SERVER>>/sws/v2/media/vsmedqry

?media=000001

Output

------------------------------------------------------

Media Query Report 03-Jan-2014 11:58:23 1

------------------------------------------------------

Media ID: 000001

----------------------------------------------------------------------------

Media Type: LTO

Media Class: F0_LTO_DATA

Assignment: Free

Location State: Archive

Current Archive: mylib

Pending Archive:

Action State: Checkout

Import Date: 15-Aug-2013 08:08:21

Last Access: 11-Dec-2013 11:08:40

Mount Count: 99

Move Count: 198

Manufacturer:

Batch:

Current State: On-line

Media / Change Media State

Change the class or state of a media.

This web service runs the fschmedstate 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`media`	Required	N	One or more 16-character media identifiers.	`mediaID`
`state`	Optional	1	Media state. Valid values for states are as follows: unsusp: Reset error count associated with media to 0. protect: Mark media as write-protected. Files can be read, but no data can be written to the media. unprotect: Mark the media as unprotected for data storage on media. avail: Media are available for storage and retrieval. unavail: Media are unavailable to Tertiary Manager software. unmark: Unmark media that are marked Error, or Check out. Either the `state` or `policy` is required.	`-s`
`policy`	Optional	1	Change the policy class name of blank media. Either the `state` or `policy` is required.	`-c`
`blank`	Optional	1	Change policy class for a blank medium to system blank pool. Default value is false.	`-b`

Example

https://<<SERVER>>/sws/v2/media/fschmedstate

?media=E00001

&state=avail

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fschmedstate xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fschmedstate.xsd">

<header>

<commandName>fschmedstate</commandName>

<commandLine>/usr/adic/TSM/exec/fschmedstate E00001 -s avail -F xml</commandLine>

<commandDescription>Change the class or state of a medium.</commandDescription>

<localDateISO>2014-05-15T11:56:21</localDateISO>

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

<localTime>11:56:21</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:56:21Z</gmtDateISO>

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

<gmtTime>16:56:21</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0249</statusCode>

<statusNumber>249</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388051</requestId>

<commandName>/usr/adic/TSM/exec/fschmedstate</commandName>

<commandStatus>interim</commandStatus>

<statusText>Media E00001 is already in state avail.</statusText>

</status>

<status>

<statusCode>FS0390</statusCode>

<statusNumber>390</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>388051</requestId>

<commandName>/usr/adic/TSM/exec/fschmedstate</commandName>

<commandStatus>failed</commandStatus>

<statusText>0 out of 1 media state change requests were successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>1</returnCode>

<localDateISOEnd>2014-05-15T11:56:21</localDateISOEnd>

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

<localTimeEnd>11:56:21</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:56:21Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:56:21</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0001</elapsedTimeInSeconds>

</footer>

</fschmedstate>

Media / Checkout Media

Check media out of the Media Manager system.

This web service runs the vscheckout command.

Note: This web service returns text output.

Parameters

Parameter	Req / Opt	Num	Description	CLI Option
`media`	Required	N	Specifies a list of one or more media to be queried.	`mediaID`
`comment`	Optional	1	Provide a comment to be associated with each checked-out media.	`-t`
`verbose`	Optional	1	Indicates that verbose output is needed. Default value is false.	`-v`
`hostname`	Optional	1	The host name of the Media Manager server.	`-H`
`priority`	Optional	1	The execution priority of the entered command. Assignable priority values are restricted to a range from 1 (highest) to 32 (lowest) inclusive. The default priority value is 15.	`-P`
`retries`	Optional	1	The number of retries that are attempted if a timeout is returned by the API software. The default retries value is 3.	`-R`
`timeout`	Optional	1	The amount of time (in seconds) the API software waits for status from the Media Manager software before returning a timeout. Total wait time for a command is (retries plus 1) multiplied by time-out value. The default time-out value is 120 seconds.	`-T`
`rpcnumber`	Optional	1	The RPC program number for the Media Manager software. The default value for the Media Manager software program number is 300016.	`-V`

Example

https://<<SERVER>>/sws/v2/media/vscheckout

?media=E00001

Output

Check out 1 of 1 media was successful

Media / List Media for Removal

List all media that are marked for removal.

This web service runs the fsmedlist 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`policy`	Optional	N	Policy class(es) for which the report is to be generated.	`-c`
`blank`	Optional	1	Used to report on the blank media in the general scratch pool. Default value is false.	`-g`
`checkout`	Optional	1	List all media marked for check out. Default value is false.	`-lk`

Example

https://<<SERVER>>/sws/v2/media/fsmedlist/removal

?policy=myaxrpol1

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsmedlist xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="fsmedlist.xsd">

<header>

<commandName>fsmedlist</commandName>

<commandLine>

/usr/adic/TSM/bin/fsmedlist -c myaxrpol1 -l -m -F xml

</commandLine>

<commandDescription>

Generate a list of media that have a specific status

</commandDescription>

<localDateISO>2014-07-01T16:01:10</localDateISO>

<localDate>2014-07-01</localDate>

<localTime>16:01:10</localTime>

<localDayOfWeek>2</localDayOfWeek>

<gmtDateISO>2014-07-01T22:01:10Z</gmtDateISO>

<gmtDate>2014-07-01</gmtDate>

<gmtTime>22:01:10</gmtTime>

<gmtDayOfWeek>2</gmtDayOfWeek>

</header>

<classes>

<class>

<classId>myaxrpol1</classId>

<marked>

<total>0</total>

</marked>

<totalMediaInClass>0</totalMediaInClass>

</class>

</classes>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>1</dayOfMonth>

<requestId>323000</requestId>

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

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-07-01T16:01:10</localDateISOEnd>

<localDateEnd>2014-07-01</localDateEnd>

<localTimeEnd>16:01:10</localTimeEnd>

<localDayOfWeekEnd>2</localDayOfWeekEnd>

<gmtDateISOEnd>2014-07-01T22:01:10Z</gmtDateISOEnd>

<gmtDateEnd>2014-07-01</gmtDateEnd>

<gmtTimeEnd>22:01:10</gmtTimeEnd>

<gmtDayOfWeekEnd>2</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0002</elapsedTimeInSeconds>

</footer>

</fsmedlist>

Media / List Media by State

Lists media by state.

This web service runs the fsmedlist 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`policy`	Optional	N	Policy class(es) for which the report is to be generated.	`-c`
`blank`	Optional	1	Used to report on the blank media in the general scratch pool. Default value is false.	`-g`
`unformatted`	Optional	1	List unformatted blank media. Default value is false.	`-lb`
`formatted`	Optional	1	List formatted blank media. Default value is false.	`-lf`
`protect`	Optional	1	List all write protected media. Default value is false.	`-lp`
`error`	Optional	1	List media with mark error. Default value is false.	`-lq`
`available`	Optional	1	List all available media. Default value is false.	`-la`
`inaccessible`	Optional	1	List all media unavailable to Tertiary Manager software. Default value is false.	`-ln`
`unavailable`	Optional	1	List all media marked as unavailable, but still located within the Tertiary Manager system. Default value is false.	`-lu`
`suspect`	Optional	1	List all suspect media. Default value is false.	`-ls`

Example

https://<<SERVER>>/sws/v2/media/fsmedlist/state

?policy=myaxrpol1

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsmedlist xsi:noNamespaceSchemaLocation="fsmedlist.xsd">

<header>

<commandName>

fsmedlist

</commandName>

<commandLine>

/usr/adic/TSM/bin/fsmedlist -c myaxrpol1 -l -F xml

</commandLine>

<commandDescription>

Generate a list of media that have a specific status

</commandDescription>

<localDateISO>

2014-07-01T16:05:08

</localDateISO>

<localDate>

2014-07-01

</localDate>

<localTime>

16:05:08

</localTime>

<localDayOfWeek>

2

</localDayOfWeek>

<gmtDateISO>

2014-07-01T22:05:08Z

</gmtDateISO>

2014-07-01

</gmtDate>

22:05:08

</gmtTime>

2

</gmtDayOfWeek>

</header>

<class>

myaxrpol1

</classId>

<total>

0

</total>

</inDrive>

<inBin>

<total>

0

</total>

</inBin>

<exiting>

<total>

0

</total>

</exiting>

<outOfStorNext>

<total>

0

</total>

</outOfStorNext>

<markedForCheckOut>

<total>

0

</total>

</markedForCheckOut>

<markError>

<total>

0

</total>

</markError>

<marked>

<total>

0

</total>

</marked>

<total>

0

</total>

</formattedBlank>

<unformattedBlank>

<total>

0

</total>

</unformattedBlank>

<writeProtected>

<total>

0

</total>

</writeProtected>

<suspect>

<total>

0

</total>

</suspect>

<available>

<total>

0

</total>

</available>

<unavailable>

<total>

0

</total>

<formattedBlank>

</unavailable>

<unavailableToTertiaryManager>

<total>

0

</total>

</unavailableToTertiaryManager>

<totalMediaInClass>

0

</totalMediaInClass>

</class>

</classes>

<statuses>

<status>

<statusCode>

FS0000

</statusCode>

<statusNumber>

0

</statusNumber>

<dayOfMonth>

1

</dayOfMonth>

<requestId>

323010

</requestId>

<commandName>

/usr/adic/TSM/bin/fsmedlist

</commandName>

completed

</commandStatus>

Command Successful.

</statusText>

</status>

</statuses>

0

</returnCode>

2014-07-01T16:05:08

</localDateISOEnd>

2014-07-01

</localDateEnd>

16:05:08

</localTimeEnd>

2

</localDayOfWeekEnd>

2014-07-01T22:05:08Z

</gmtDateISOEnd>

2014-07-01

</gmtDateEnd>

22:05:08

</gmtTimeEnd>

2

</gmtDayOfWeekEnd>

0.0001

</elapsedTimeInSeconds>

</footer>

</fsmedlist>

Media / List Media by Location

Lists media by location.

This web service runs the fsmedlist 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
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`policy`	Optional	N	Policy class(es) for which the report is to be generated.	`-c`
`blank`	Optional	1	Used to report on the blank media in the general scratch pool. Default value is false.	`-g`
`drive`	Optional	1	List all media located in a drive. Default value is false.	`-ld`
`home`	Optional	1	List all media located in their home slot/bin. Default value is false.	`-lh`
`exit`	Optional	1	List all media exiting a storage area. Default value is false.	`-lz`
`checkout`	Optional	1	List all media that are checked out of the storage areas. Default value is false.	`-lo`

Example

https://<<SERVER>>/sws/v2/media/fsmedlist/location

?policy=myaxrpol1

&drive=true

&format=xml

Output

<?xml version="1.0" encoding="UTF-8" ?>

<fsmedlist xsi:noNamespaceSchemaLocation="fsmedlist.xsd">

<header>

<commandName>

fsmedlist

</commandName>

<commandLine>

/usr/adic/TSM/bin/fsmedlist -c myaxrpol1 -l -d -F xml

</commandLine>

<commandDescription>

Generate a list of media that have a specific status

</commandDescription>

<localDateISO>

2014-07-01T16:08:05

</localDateISO>

<localDate>

2014-07-01

</localDate>

<localTime>

16:08:05

</localTime>

<localDayOfWeek>

2

</localDayOfWeek>

<gmtDateISO>

2014-07-01T22:08:05Z

</gmtDateISO>

<gmtDate>

2014-07-01

</gmtDate>

<gmtTime>

22:08:05

</gmtTime>

<gmtDayOfWeek>

2

</gmtDayOfWeek>

</header>

<classes>

<class>

<classId>

myaxrpol1

</classId>

<inDrive>

<total>

0

</total>

</inDrive>

<totalMediaInClass>

0

</totalMediaInClass>

</class>

</classes>

<statuses>

<status>

<statusCode>

FS0000

</statusCode>

<statusNumber>

0

</statusNumber>

<dayOfMonth>

1

</dayOfMonth>

<requestId>

323016

</requestId>

<commandName>

/usr/adic/TSM/bin/fsmedlist

</commandName>

<commandStatus>

completed

</commandStatus>

<statusText>

Command Successful.

</statusText>

</status>

</statuses>

<footer>

<returnCode>

0

</returnCode>

<localDateISOEnd>

2014-07-01T16:08:05

</localDateISOEnd>

2014-07-01

</localDateEnd>

16:08:05

</localTimeEnd>

2

</localDayOfWeekEnd>

2014-07-01T22:08:05Z

</gmtDateISOEnd>

2014-07-01

</gmtDateEnd>

22:08:05

</gmtTimeEnd>

2

</gmtDayOfWeekEnd>

0.0001

</elapsedTimeInSeconds>

</footer>

</fsmedlist>