Archive

Archive / Query

Return information about an archive.

This web service runs the vsarchiveqry 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.	None
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`archive`	Optional	1	Identifies the archive to be queried. If not specified, all archives are queried.	`-a (if absent)`
`showclassgroups`	Optional	1	Indicates that detailed information on all MediaClass groups associated with the specified archive(s) are to be reported. Default value is false.	`-c`
`showdrives`	Optional	1	Indicates that all drives associated with the specified archive(s) are to be reported. Default value is false.	`-d`
`showmedia`	Optional	1	Indicates that all media associated with the specified archive(s) are to be reported. Default value is false.	`-m`
`showports`	Optional	1	Indicates that all import/export ports associated with the specified archive(s) are to be reported. Default value is false.	`-s`
`showtypes`	Optional	1	Indicates that detailed information on all media types associated with the specified archive(s) are to be reported. Default value is false.	`-t`
`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 web service will attempt 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/archive/vsarchiveqry
?archive=myarchive
&format=xml

Output

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

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

<header>

<commandName>vsarchiveqry</commandName>

<commandLine>/usr/adic/MSM/clibin/vsarchiveqry myarchive -F xml</commandLine>

<commandDescription>Queries for information about an archive.</commandDescription>

<localDateISO>2014-05-15T10:44:08</localDateISO>

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

<localTime>10:44:08</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T15:44:08Z</gmtDateISO>

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

<gmtTime>15:44:08</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<archives>

<archive>

<archiveName>myarchive</archiveName>

<archiveType>SCSI</archiveType>

<archiveState>On-line</archiveState>

<archiveMode>Attended</archiveMode>

<fillMode>None</fillMode>

<configState>Not Being Configured</configState>

</archive>

</archives>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T10:44:08</localDateISOEnd>

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

<localTimeEnd>10:44:08</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T15:44:08Z</gmtDateISOEnd>

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

<gmtTimeEnd>15:44:08</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0178</elapsedTimeInSeconds>

</footer>

</vsarchiveqry>

Archive / Query Port

Query an archive port.

This web service runs the mmportinfo command.

Note: This web service returns text output.

Parameters

Parameter	Req / Opt	Num	Description	CLI Option
`archive`	Required	1	Identifies the archive to obtain port information about. Valid archive names may contain up to 16 alphanumeric characters, including spaces. Leading and trailing spaces are not permitted.	`archive name`

Example

https://<<SERVER>>/sws/v2/archive/mmportinfo ?archive=i40

Output

Exit Code: 0

Output: 512:LTOW,LTO:0,0,15,512

Archive / Change State

Change the state of an archive.

This web service runs the vsarchivevary 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.	None
`format`	Optional	1	The output format requested. Valid values are xml, json and text. The default is text.	`-F`
`archive`	Required	1	Identifies the archive to be queried.	`archive name`
`state`	Required	1	Identifies the state into which the archive is placed. Valid archive states are: on-line, off-line, and diagnostic. The archive states, on-line, off-line, and diagnostic are abbreviated as on, of, and d respectively.	`-s`
`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 web service will attempt 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/archive/vsarchivevary ?archive=myarchive &state=on &format=xml

Output

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

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

<header>

<commandName>vsarchivevary</commandName>

<commandLine>/usr/adic/MSM/clibin/vsarchivevary myarchive -s on -F xml</commandLine>

<commandDescription>Varies the state of an archive.</commandDescription>

<localDateISO>2014-05-15T10:45:46</localDateISO>

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

<localTime>10:45:46</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T15:45:46Z</gmtDateISO>

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

<gmtTime>15:45:46</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<vsarchivevaryOutput>

<vsarchivevarySuccess>

<vsarchivevaryArchive>myarchive</vsarchivevaryArchive>

<vsarchivevaryState>on-line</vsarchivevaryState>

</vsarchivevarySuccess>

</vsarchivevaryOutput>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T10:45:46</localDateISOEnd>

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

<localTimeEnd>10:45:46</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T15:45:46Z</gmtDateISOEnd>

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

<gmtTimeEnd>15:45:46</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0183</elapsedTimeInSeconds>

</footer>

</vsarchivevary>