Status services enable users to get drive and volume statuses. For example, use a status service to get all volume information, get volume status, or get drive online or offline statuses. These services can obtain the service result almost instantaneously by querying the database, so the status services are implemented as a synchronous call. The completion of the operation returns the result of the operation.
The following two Web Services are the general status Web Services for retrieving the job status and job result of each asynchronous management service execution.
getJobResult(int jobId)
getJobStatus(int jobId)
The getjobstatus and getJobResult Web Services are an example of pairing up asynchronous (management) services with synchronous (status) services to obtain the results of an execution.
This synchronous call retrieves the job result for the given job ID entered.
jobId
The job ID returned by management and file WebService call to indicate the running web service job.
ValidationFailedException andResultNotFoundException
If the jobID is 0 or an invalid value, the exception thrown is: Invalid jobID.
ResultNotFoundException
If the job result cannot be found, the exception thrown is: No job result is found.
Example: The JobResult cannot be found with the jobId1234.
<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" >
xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<env:Header>
<ns1:Security>
<ns1:UsernameToken>
<ns1:Username>username</ns1:Username>
<ns1:Password>password</ns1:Password>
</ns1:UsernameToken>
</ns1:Security>
</env:Header>
<env:Body>
< ns1:getJobResult>
<arg0>1212</arg0>
</ns2:getJobResult>
</env:Body>
</env:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns2:getJobResultResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<return>
<callerIp>127.0.0.1</callerIp>
<jobCompletedOn>1399190120</jobCompletedOn>
<jobId>607</jobId>
<jobStatus>Success</jobStatus>
<jobUser>Admin</jobUser>
<serviceCalled>enterVolume</serviceCalled>
</return>
</ns2:getJobResultResponse>
</S:Body>
</S:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<S:Fault xmlns:ns4="http://schemas.xmlsoap.org/soap/envelope/"
<S:Code>
<S:Value>S:Receiver</S:Value>
<S:Code>
<S:Reason>
<S:Text>The JobResult cannot be found with the jobId 607</S:Text>
<S:Reason>
<S:Detail>
<ns2:ResultNotFoundException xmlns:ns2="http://wsb.ejb.ws.mds.ltfsle.oracle/">
<message>The JobResult cannot be found with the jobId 607</message>
</ns2:ResultNotFoundException>
<S:Detail>
<S:Fault>
</S:Body>
</S:Envelope>
This synchronous call retrieves the job status of the given job ID. The return codes are:
0 (Web service call associated with job ID is complete.)
1 (Web service call associated with job ID is still in progress.)
-1 (No such web service call with job ID is found in the system.)
ValidationFailedException
If the jobID is 0 or an invalid value, the exception thrown is: Invalid jobID.
<?xml version = '1.0' encoding = 'UTF-8'?
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-sece
xt-1.0.xsd" xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<env:Header>
<ns1:Security>
<ns1:UsernameToken>
<ns1:Username>username</ns1:Username>
<ns1:Password>password</ns1:Password>
</ns1:UsernameToken>
</ns1:Security>
</env:Header>
<env:Body>
<ns2:getJobStatus>
<arg0>1212</arg0>
</ns2:getJobStatus>
</env:Body>
</env:Envelope>
These service signatures retrieve volume and drive statuses.
getAllDriveInfo()
getAllVolumeInfo()
getVolumeInfoByStatus (String status)
getVolumeInfoByVolser (String[] volsers)
A synchronous call that retrieves all the library tape drive information.
Valid drive responses are shown in the SOAP Response example. Refer to the Glossary for definitions.
None. If there are some errors in getting all drive info, the return value is an empty drive array.
<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1=
"http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<env:Header>
<ns1:Security>
<ns1:UsernameToken>
<ns1:Username>username</ns1:Username>
<ns1:Password>password</ns1:Password>
</ns1:UsernameToken>
</ns1:Security>
</env:Header>
<env:Body>
<ns1:getAllDriveInfo/>
</env:Body>
</env:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns2:getAllDriveInfoResponse xmlns:ns2="http://ws.ltfsle.oracle/">
<return>
<acslsPath>0 ,0 ,12 ,5</acslsPath>
<availableStatus>Available</availableStatus>
<driveCompress>Compression Enabled</driveCompress>
<driveEncry>Encryption NO</driveEncry>
<driveFwRev>RF53</driveFwRev>
<driveGenDev>/dev/sg10</driveGenDev>
<driveLtfsCap>LTFS Capable</driveLtfsCap>
<drivePoolName>Default Drive Pool</drivePoolName>
<driveProdId>T10000C</driveProdId>
<driveSn>576001000421</driveSn>
<driveStatus>Assigned</driveStatus>
<driveStdDev>/dev/st3</driveStdDev>
<driveType>T1C</driveType>
<driveVendor>STK</driveVendor>
<onlineStatus>Online</onlineStatus>
</return>
</ns2:getAllDriveInfoResponse>
</S:Body>
</S:Envelope>
This request function is a synchronous call that retrieves all the volume information in LTFS-LE.
Valid responses are shown in the SOAP Response example. Refer to the Glossary for definitions.
None. If there are errors in getting all volume information, the return value is an empty volume array.
<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope"
xmlns:ns1="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd"
xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<env:Header>
<ns1:Security>
<ns1:UsernameToken>
<ns1:Username>username</ns1:Username>
<ns1:Password>password</ns1:Password>
</ns1:UsernameToken>
</ns1:Security>
</env:Header>
<env:Body>
<ns2:getAllVolumeInfo/>
</env:Body>
</env:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns2:getAllVolumeInfoResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<return>
<acslsPath>0, ,0 ,12 ,24 ,4</acslsPath>
<assignedStatus>Assigned</assignedStatus>
<availableStatus>Available</availableStatus>
<capacityAvailable>1453410222080</capacityAvailable>
<capacityUsed>24117248</capacityUsed>
<currentLocation>home</currentLocation>
<inuseStatus>In use</inuseStatus>
<ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
<onlineStatus>Online</onlineStatus>
<volser>F50191</volser>
<volumeCreatedOn>1403014692</volumeCreatedOn>
<volumePoolName>Default Volume Pool</volumePoolName>
<volumeType>LTO-1.5T</volumeType>
</return>
<return>
<acslsPath>0, ,0 ,12 ,23 ,5</acslsPath>
<assignedStatus>Assigned</assignedStatus>
<availableStatus>Available</availableStatus>
<capacityAvailable>1453410222080</capacityAvailable>
<capacityUsed>24117248</capacityUsed>
<currentLocation>home</currentLocation>
<inuseStatus>In use</inuseStatus>
<ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
<onlineStatus>Online</onlineStatus>
<volser>F50192</volser>
<volumeCreatedOn>1403014692</volumeCreatedOn>
<volumePoolName>Default Volume Pool</volumePoolName>
<volumeType>LTO-1.5T</volumeType>
</return>
<return>
</ns2:getAllVolumeInfoResponse>
</S:Body>
</S:Envelope>
A synchronous call that retrieves volume information by volume status.
getVolumeInfoByStatus(String status)
LTFS-LE Web Service chain to call:
getVolumeInfoByStatus(status)
Valid volume statuses are: Online, Offline, Assigned, Unassigned, In Use, Idle, Available, or Unavailable.
It does not support the entering of multiple statuses, nor does it support the pending status.
Valid responses are shown in the SOAP Response example. Refer to the Glossary for definitions.
StatusNotFoundException and VolumeNotFoundException
If a volume is not found by the given status, the message is No volume found with the [status] status.
<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1
="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns2
="http://sb.ejb.ws.mds..ltfsle.oracle/">
<env:Header>
<ns1:Security>
<ns1:UsernameToken>
<ns1:Username>username</ns1:Username>
<ns1:Password>password</ns1:Password>
</ns1:UsernameToken>
</ns1:Security>
</env:Header>
<env:Body>
<ns2:getVolumeInfoByStatus>
<arg0>online</arg0>
</ns2:getVolumeInfoByStatus>
</env:Body>
</env:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns2:getVolumeInfoByStatusResponse xmlns:ns2="http://ws.ltfsle.oracle/">
<return>
<acslsPath>3 ,0 ,12 ,38 ,1</acslsPath>
<assignedStatus>Assigned</assignedStatus>
<availableStatus>Available</availableStatus>
<capacityAvailable>1453410222080</capacityAvailable>
<capacityUsed>24117248</capacityUsed>
<currentLocation>home</currentLocation>
<inuseStatus>In use</inuseStatus>
<ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
<onlineStatus>Online</onlineStatus>
<volser>O50191</volser>
<volumeCreatedOn>1402933089</volumeCreatedOn>
<volumePoolName>Default Volume Pool</volumePoolName>
<volumeType>LTO-1.5T</volumeType>
</return>
<return>
<acslsPath>3 ,0 ,12 ,41 ,2</acslsPath>
<assignedStatus>Assigned</assignedStatus>
<availableStatus>Available</availableStatus>
<capacityAvailable>1453410222080</capacityAvailable>
<capacityUsed>24117248</capacityUsed>
<currentLocation>home</currentLocation>
<inuseStatus>In use</inuseStatus>
<ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
<onlineStatus>Online</onlineStatus>
<volser>O50191</volser>
<volumeCreatedOn>1402933089</volumeCreatedOn>
<volumePoolName>Default Volume Pool</volumePoolName>
<volumeType>LTO-1.5T</volumeType>
</return>
</ns2:getVolumeInfoByStatusResponse>
</S:Body>
</S:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns3
="http://www.w3.org/2003/05/soap-envelope">
<ns3:Code>
<ns3:Value>ns3:Receiver</ns3:Value>
</ns3:Code>
<ns3:Reason>
<ns3:Text>Status:[status] is an invalid status.</ns3:Text>
</ns3:Reason>
<ns3:Detail>
<ns2:StatusNotFoundException xmlns:ns2="http://ws.ltfsle.oracle/">
<message>Status:[status] is an invalid status.</message>
</ns2:StatusNotFoundException>
</ns3:Detail>
</ns3:Fault>
</S:Body>
</S:Envelope>
A synchronous call that retrieves the volume information of one or more volumes by volume serial number.
getVolumeInfoByVolser (String[] volsers)
LTFS-LE Web Service to call:
getVolumeInfoByVolser([volser1, volser2, ...])
If any one of volume serial numbers is not found, a VolumeNotFoundException exception is thrown.
<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://www.w3.org/2003/05/soap-envelope" xmlns:ns1
="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd" xmlns:ns2
="http://1.0.xsd" xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
<env:Header>
<ns1:Security>
<ns1:UsernameToken>
<ns1:Username>username</ns1:Username>
<ns1:Password>password</ns1:Password>
</ns1:UsernameToken>
</ns1:Security>
</env:Header>
<env:Body>
<ns2:getVolumeInfoByVolser>
<arg0>F52270</arg0>
<arg0>EL0010</arg0>
<arg0>F50331</arg0>
</ns2:getVolumeInfoByVolser>
</env:Body>
</env:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns2:getVolumeInfoByVolserResponse xmlns:ns2="http://ws.ltfsle.oracle/">
<return>
<acslsPath>3 ,0 ,12 ,38 ,1</acslsPath>
<assignedStatus>Assigned</assignedStatus>
<availableStatus>Available</availableStatus>
<capacityAvailable>1453410222080</capacityAvailable>
<capacityUsed>24117248</capacityUsed>
<currentLocation>home</currentLocation>
<inuseStatus>In use</inuseStatus>
<ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
<onlineStatus>Online</onlineStatus>
<volser>O50191</volser>
<volumeCreatedOn>1403015625</volumeCreatedOn>
<volumePoolName>Default Volume Pool</volumePoolName>
<volumeType>LTO-1.5T</volumeType>
</return>
<return>
<acslsPath>3 ,0 ,12 ,38 ,2</acslsPath>
<assignedStatus>Assigned</assignedStatus>
<availableStatus>Available</availableStatus>
<capacityAvailable>1453410222080</capacityAvailable>
<capacityUsed>24117248</capacityUsed>
<currentLocation>home</currentLocation>
<inuseStatus>In use</inuseStatus>
<ltfsUUID>e255c63b-54c9-4fc7-a60b-e63d58ed0005</ltfsUUID>
<onlineStatus>Online</onlineStatus>
<volser>O50191</volser>
<volumeCreatedOn>1403015625</volumeCreatedOn>
<volumePoolName>Default Volume Pool</volumePoolName>
<volumeType>LTO-1.5T</volumeType>
</ns2:getVolumeInfoByVolserResponse>
</S:Body>
</S:Envelope>
<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
<S:Body>
<ns3:Fault xmlns:ns2="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns3="http://www.w3.org/2003/05/soap-envelope">
</ns3:Code>
<ns3:Value>ns3:Receiver</ns3:Value>
</ns3:Code>
<ns3:Reason>
<ns3:Text> The volume(s) [vol1],[vol2],..,[vols] is(are) not found in the LTFS-LE library</ns3:Text>
</ns3:Reason>
<ns3:Detail>
<ns2:VolumeNotFoundException xmlns:ns2="http://ws.ltfsle.oracle/">
<message> The volume(s) [vol1],[vol2],..,[vols] is(are) not found in the LTFS-LE library</message>
</ns2:VolumeNotFoundException>
</ns3:Detail>
</ns3:Fault>
</S:Body>
</S:Envelope>