Drive

Drive / State

Report the state of all Quantum storage subsystem drive components and storage subsystems and/or Tertiary Manager software.

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

drive

Optional

1

Component alias drive identifier. Submitting the fsstate request without this option generates a report showing all storage subsystems and drive components currently configured in the Quantum storage subsystem and the state of Tertiary Manager software.

component alias

Example

https://<<SERVER>>/sws/v2/drive/fsstate
?drive=vtl_dr1
&format=xml

Output

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

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

<header>

<commandName>fsstate</commandName>

<commandLine>/usr/adic/TSM/bin/fsstate vtl_dr1 -F xml</commandLine>

<commandDescription>Report the state of all Stornext drive components and storage susbsystems and/or Tertirary Manager software</commandDescription>

<localDateISO>2014-05-15T11:08:06</localDateISO>

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

<localTime>11:08:06</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:08:06Z</gmtDateISO>

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

<gmtTime>16:08:06</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<components>

<component>

<note>configured</note>

<alias>vtl_dr1</alias>

<driveId>1</driveId>

<driveState>ON</driveState>

<driveStatus>FREE</driveStatus>

<mediaId>NONE</mediaId>

</component>

</components>

<statuses>

<status>

<statusCode>FS0000</statusCode>

<statusNumber>0</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387993</requestId>

<commandName>fsstate</commandName>

<commandStatus>completed</commandStatus>

<statusText>Command Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T11:08:06</localDateISOEnd>

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

<localTimeEnd>11:08:06</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:08:06Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:08:06</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0084</elapsedTimeInSeconds>

</footer>

</fsstate>

Drive / Change State

Change the state of a storage component in the Quantum storage subsystem.

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

drive

Required

1

Component alias drive identifier.

component alias

state

Required

1

The desired state of the drive components or subsystems. The valid values for drive components are MAINT, ON, or OFF. Valid values for subsystems are ON or OFF.

-s

Example

https://<<SERVER>>/sws/v2/drive/fschstate
?drive=vtl_dr1
&state=ON
&format=xml

Output

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

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

<header>

<commandName>fschstate</commandName>

<commandLine>/usr/adic/TSM/exec/fschstate vtl_dr1 -s on -F xml</commandLine>

<commandDescription>Change the state of a storage component.</commandDescription>

<localDateISO>2014-05-15T11:09:06</localDateISO>

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

<localTime>11:09:06</localTime>

<localDayOfWeek>4</localDayOfWeek>

<gmtDateISO>2014-05-15T16:09:06Z</gmtDateISO>

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

<gmtTime>16:09:06</gmtTime>

<gmtDayOfWeek>4</gmtDayOfWeek>

</header>

<statuses>

<status>

<statusCode>FS0258</statusCode>

<statusNumber>258</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387995</requestId>

<commandName>fschstate</commandName>

<commandStatus>interim</commandStatus>

<statusText>Command attempted on vtl_dr1. New state = on. Status = Successful.</statusText>

</status>

<status>

<statusCode>FS0270</statusCode>

<statusNumber>270</statusNumber>

<dayOfMonth>15</dayOfMonth>

<requestId>387995</requestId>

<commandName>fschstate</commandName>

<commandStatus>completed</commandStatus>

<statusText>Overall status = Successful.</statusText>

</status>

</statuses>

<footer>

<returnCode>0</returnCode>

<localDateISOEnd>2014-05-15T11:09:06</localDateISOEnd>

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

<localTimeEnd>11:09:06</localTimeEnd>

<localDayOfWeekEnd>4</localDayOfWeekEnd>

<gmtDateISOEnd>2014-05-15T16:09:06Z</gmtDateISOEnd>

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

<gmtTimeEnd>16:09:06</gmtTimeEnd>

<gmtDayOfWeekEnd>4</gmtDayOfWeekEnd>

<elapsedTimeInSeconds>0.0175</elapsedTimeInSeconds>

</footer>

</fschstate>