4 Services de gestion

Les services de gestion sont les services qui gèrent les ressources de stockage. Par exemple, vous utilisez un service de gestion pour insérer un volume, éjecter un volume, ou encore pour mettre un volume en ligne ou hors ligne.

Présentation

Ces services doivent communiquer avec le composant mécanique de la solution, et le temps de réponse dépend du type d'opération et des latences mécaniques. Les services de gestion sont implémentés sous la forme d'un appel asynchrone. Un service de gestion est asynchrone car son retour se produit avant que le travail ait été exécuté.

  • L'exécution de l'opération renvoie un ID de travail ou de programme que le service d'appel doit appeler pour obtenir les résultats lorsque ceux-ci sont disponibles.

  • Lorsque le retour du service asynchrone se produit, un ID de travail est fourni dans la réponse. Les codes retour sont :

    • 0 (l'appel de service Web associé à cet ID de travail est terminé)

    • 1 (l'appel de service Web associé à cet ID de travail est toujours en cours)

    • -1 (aucun appel de service Web associé à cet ID de travail n'a été trouvé au sein du système)

  • Le programmeur chargé de l'implémentation du client de services Web doit périodiquement appeler le service Web getJobStatus en lui transmettant l'ID de travail pour obtenir le statut de celui-ci.

  • Une fois que le service Web getJobStatus a renvoyé la valeur "0", appelez le service Web getJobResult pour obtenir le résultat du service.

Le délai d'exécution de chaque service Web asynchrone peut être variable. Le moteur de traitement expire en cas de défaillance sur le plan mécanique. Ce guide fournit des recommandations sur le temps d'attente maximal recommandé que le client de services Web tiers doit observer avant d'expirer.

Pour plus d'informations sur les services Web getJobStatus et getJobResult, reportez-vous au "Services de statut"

assignVolume

Pour gérer les volumes à l'aide de LTFS-LE, vous devez assigner les volumes à l'application LTFS-LE.

Lorsque vous assignez un volume à LTFS-LE, il est automatiquement mis en ligne et ajouté au pool de volumes par défaut. Lorsque vous assignez un volume non formaté, le volume est automatiquement formaté pour une utilisation avec LTFS-LE.

Format

        assignVolume(String[] volsers)

Conditions préalables :

Avant d'assigner un volume, vérifiez qu'un lecteur compatible est disponible et que le volume est hors ligne, non assigné, pas dans un pool et disponible. Les volumes doivent exister dans la bibliothèque.

Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Assurez-vous que le volume se trouve dans l'un des statuts requis et effectuez les éventuelles actions correctives nécessaires avant de continuer.

Service Web LTFS-LE à appeler :

assignVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est à présent assigné au logiciel LTFS-LE. Si le volume n'est pas au format LTFS, il est automatiquement formaté au format LTFS.

Paramètres

  • Les valeurs volser désignent les numéros de série des volumes à assigner. Les paramètres d'entrée se présentent sous la forme d'un tableau de chaînes et permettent d'assigner plusieurs volumes.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'est pas hors ligne, non assigné et supprimé du pool, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Assigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume SL0010’s inuseStatus is In use.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:assignVolume>
         <arg0>F50233</arg0>
         <arg0>F50234</arg0>
      </ns1:assignVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope   xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Body>
      <ns2:assignVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1220</return>
      </ns2:assignVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 SL0010’s assignedStatus is Assigned</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s assignedStatus is Assigned</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

ejectVolume

Cette fonction API éjecte un ou plusieurs volumes LTFS-LE de la bibliothèque.

Du fait de la taille de message, LTFS-LE prend en charge l'éjection d'un maximum de 30 volumes à l'aide de la fente (CAP). Les éjections sont réalisées quatre par quatre jusqu'à ce que tous les volumes aient été entièrement éjectés. Il n'a aucun délai d'expiration. Il s'agit d'un appel asynchrone.

Format

ejectVolume(String[] volsers,String acs,String lsm,String cap)

Condition préalable :

Vérifiez les conditions suivantes : les volumes sont finalisés et hors ligne avant l'éjection ; un CAP est disponible ; et l'ACS est identique à la bibliothèque configurée. Pour ce faire, procédez comme suit :

  1. Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  2. Si le volume est en ligne et qu'il n'est pas en cours d'utilisation, finalisez-le :

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    
  3. Si le volume est en ligne, mettez-le hors ligne avant d'exécuter l'appel d'éjection de l'API :

    offlineVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    

Chaîne de service Web LTFS-LE à appeler :

ejectVolume([volser1,volser2,...],acs,lsm,cap) 
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est éjecté de la bibliothèque. L'utilisateur doit se rendre à la bibliothèque et extraire le volume après avoir ouvert la porte du CAP.

Paramètres

  • Les valeurs volser désignent les numéros de série des volumes à éjecter.

  • acs désigne l'identificateur ACS de la bibliothèque.

  • lsm désigne l'identificateur LSM de la bibliothèque.

  • cap désigne l'ID du CAP (fente) utilisé pour éjecter le volume.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Un paramètre nul est renvoyé si l'un des éléments du tableau de valeurs volser est vide, ou si une partie de l'identificateur CAP (acs, lsm, cap_id) est manquante ou en cours d'utilisation.

  • Si le volume n'est pas hors ligne, non assigné et supprimé du pool, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Assigned.

  • The volume SL0010’s availableStatus is Available.

  • The volume SL0010’s inuseStatus is In use.

  • ACS 0 is inconsistent with the library acs 7.

Délai d'expiration recommandé

Cette valeur dépend du temps nécessaire pour retirer le volume du CAP (fente).

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:ejectVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
         <arg1>3</arg1>
         <arg2>0</arg2>
         <arg3>1</arg3>
      </ns1:ejectVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401  -wss-wssecurity-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:ejectVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1213</return>
      </ns2:ejectVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 SL0010’s onlineStatus is Online</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s onlineStatus is Online</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

enterVolume

Il s'agit d'un appel asynchrone qui insère un ou plusieurs volumes dans la bibliothèque à l'aide du CAP (fente).

Format

enterVolume(String acs,String lsm,String cap)

Condition préalable :

Il n'y a aucune condition préalable spécifique pour l'insertion d'un volume dans le CAP. Néanmoins, l'administrateur ou le service doit collecter l'identificateur du CAP (acs, lsm et cap_id), et s'assurer qu'un CAP est disponible et n'est pas au milieu d'une opération (en attente, éjection, insertion ou audit) avant d'exécuter cette commande.

Chaîne de service Web LTFS-LE à appeler :

enterVolume(acs,lsm,cap)
getJobStatus(jobId) <poll each 10s until status is complete>
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est inséré dans la bibliothèque.

Paramètres

  • acs désigne l'identificateur ACS de la bibliothèque.

  • lsm désigne l'identificateur LSM de la bibliothèque.

  • cap désigne l'ID du CAP (fente) utilisé pour insérer le volume.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException.

Si l'un des paramètres est vide, une exception nulle est générée. Voici quelques exemples d'exceptions générées :

  • ACS 4 is inconsistent with the library acs 7.

  • Invalid ACS number.

Délai d'expiration recommandé

Cette valeur dépend du temps nécessaire à l'administrateur pour insérer le volume dans le CAP (fente).

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1
="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:enterVolume>
         <arg0>3</arg0>
         <arg1>0</arg1>
         <arg2>1</arg2>
      </ns1:enterVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/
oasis-200401-wss-wssecurity-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:enterVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1212</return>
      </ns2:enterVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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> Invalid ACS number </ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>Invalid ACS number</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

finalizeVolume

Utilisez la commande finalizeVolume pour valider les modifications apportées au volume. En général, cette opération s'effectue avant la mise hors ligne du volume pour qu'il soit éjecté de la bibliothèque. La finalisation d'un volume provoque l'application des métadonnées non écrites et des suppressions de fichiers non appliquées. Cette opération permet de s'assurer que les opérations réalisées sur l'espace de noms global sont reflétées sur le volume physique. L'échec de la finalisation d'un volume avant sa mise hors ligne est susceptible de retarder la mise hors ligne de ce volume.

Format

finalizeVolume(String volser)

Conditions préalables :

Vérifiez qu'un lecteur compatible est disponible et que le volume est en ligne, dans un pool, inactif et disponible avant de finaliser le volume. Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Assurez que le volume se trouve dans tous les états requis et effectuez les éventuelles actions correctives nécessaires avant de continuer.

Service Web LTFS-LE à appeler :

finalizeVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, toutes les opérations en attente d'application au volume ont été appliquées à celui-ci.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Paramètres

  • volser désigne le numéro de série du volume à finaliser.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'est pas hors ligne, non assigné et supprimé du pool, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Offline.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume SL0010’s inuseStatus is In use.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1
="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:finalizeVolume>
         <arg0>F50233</arg0>
      </ns1:finalizeVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
    <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
        <wsu:Timestamp   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:finalizeVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1219</return>
      </ns2:finalizeVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 SL0010’s onlineStatus is Offline</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s onlineStatus is Offline</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

formatVolume

Un appel asynchrone qui formate le volume au format LTFS. Le service Web LTFS-LE ne demande pas de confirmation et n'effectue aucune validation du volume. Vous devez donc faire attention au volume qui va être formaté et vous assurer que c'est le bon.

Lorsqu'un volume est formaté, toutes les données situées dessus sont supprimées.

Format

formatVolume(String volser)

Condition préalable :

Vérifiez que le volume est hors ligne et assigné, dans un pool, et disponible avant de le formater. Vérifiez qu'un lecteur compatible est disponible.

Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Assurez-vous que le volume est dans l'état requis décrit dans la condition préalable.

  • Effectuez les éventuelles actions correctives nécessaires avant de continuer.

Chaîne de service Web LTFS-LE à appeler :

formatVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est à présent formaté au format LTFS-LE.

Paramètres

  • volser désigne le numéro de série du volume à éjecter.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

La liste suivante répertorie des exemples d'exceptions générées :

  • The volume EL0010 is not found in LTFS library.

  • The volume EL0010's onlineStatus is Online

  • The volume EL0010's assignedStatus is Unassigned.

  • The volume EL0010's availableStatus is Unavailable

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"    xmlns:ns1
="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:formatVolume>
         <arg0>F50234</arg0>
      </ns1:formatVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:formatVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1215</return>
      </ns2:formatVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

formatVolumeWithDrive

Cet appel asynchrone formate le volume au format LTFS ; il est utilisé lorsqu'un volume doit être formaté dans un lecteur spécifique. Le volume et le lecteur doivent être compatibles.

Format

formatVolumeWithDrive (String volser, String drivesn)

Condition préalable :

Vérifiez que le volume est hors ligne et assigné, dans un pool, et disponible avant de le formater. Le volume et le lecteur doivent exister dans la bibliothèque et être compatibles. Le lecteur doit être à l'état inactif ou disponible.

Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • Assurez-vous que le volume est dans l'état requis décrit dans la condition préalable.

  • Effectuez les éventuelles actions correctives nécessaires avant de continuer.

Chaîne de service Web LTFS-LE à appeler :

formatVolumeWithDrive(volser,drivesn)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est à présent formaté au format LTFS-LE.

Paramètres

  • volser désigne le numéro de série du volume.

  • drivesn désigne le numéro de série du lecteur qui formate le volume.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

La liste suivante répertorie des exemples d'exceptions générées :

  • The volume EL0010 is not found in LTFS library.

  • The volume EL0010's assignedStatus is Unassigned.

  • The volume EL0010’s onlineStatus is Online.

  • The volume EL0010’s availableStatus is Unavailable

  • The drive 123456 is not found in LTFS library.

  • The drive 123456's availableStatus is In use

  • The drive 123456's onlineStatus is Offline

  • The drive 123456's assignedStatus is Unassigned

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="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:formatVolumeWithDrive>
         <arg0>F50234</arg0>
         <arg1>576001000421</arg1>
      </ns1:formatVolumeWithDrive>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:formatVolumeWithDriveResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1215</return>
      </ns2:formatVolumeWithDriveResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 F50377's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The Volume F50377's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

getVolumePath

Cet appel asynchrone détermine le chemin du volume dans l'espace de noms global.

Format

getVolumePath(volser)

Paramètres

  • volser désigne le numéro de série de volume pour le chemin de volume à trouver.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Le volume doit exister dans la bibliothèque, et il doit être assigné et disponible.

La liste suivante répertorie des exemples d'exceptions générées :

  • The volume EL0020's assignedStatus is Unassigned.

  • The volume EL0010 is not found in LTFS library.

  • The volume EL0010’s availableStatus is Unavailable.

Délai d'expiration recommandé

3 600 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:getVolumePath>
         <arg0>F50233</arg0>
      </ns1:getVolumePath>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope  xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2: getVolumePath xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1225</return>
      </ns2: getVolumePath >
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010’s availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010’s availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

offlineVolume

Cet appel asynchrone place un volume dans un état hors ligne et permet l'éjection, l'archivage sécurisé, le formatage, l'assignation et l'annulation de l'affectation d'un ou plusieurs volumes.

Format

offlineVolume(String[] volser)

Conditions préalables :

Avant de le mettre hors ligne, vérifiez que le volume existe dans la bibliothèque, et qu'il est assigné, disponible et finalisé. Vérifiez qu'un lecteur compatible est disponible.

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Finalisez le volume s'il se trouve dans un état en ligne et assigné.

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete >
    getJobResult(jobId)
    

Chaîne de service Web LTFS-LE à appeler :

offlineVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est à présent hors ligne.

Paramètres

  • Les valeurs volser désignent les numéros de série des volumes à mettre hors ligne. Les paramètres d'entrée se présentent sous la forme d'un tableau de chaînes et permettent de mettre hors ligne plusieurs volumes.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est en ligne, assigné, disponible et finalisé avant d'être mis hors ligne, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Offline.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:offlineVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
      </ns1:offlineVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope    xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:offlineVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1218</return>
      </ns2:offlineVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

onlineVolume

Cet appel asynchrone place un volume dans un état en ligne permettant la lecture, l'écriture ou la finalisation du volume.

Format

onlineVolume(String[] volsers)

Conditions préalables :

Avant de le mettre en ligne, vérifiez que le volume existe dans la bibliothèque, et qu'il est hors ligne, assigné, dans un pool et disponible. Vérifiez qu'un lecteur compatible est disponible.

getVolumeInfoByVolser([volser1, volser2, ...])

Service Web LTFS-LE à appeler :

onlineVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est à présent en ligne.

Paramètres

  • Les valeurs volser désignent les numéros de série des volumes à mettre en ligne. Les paramètres d'entrée se présentent sous la forme d'un tableau de chaînes et permettent de mettre en ligne plusieurs volumes.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est en ligne, non assigné, pas dans un pool et non disponible avant d'être mis en ligne, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ns1="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:onlineVolume>
         <arg0>F40244</arg0>
         <arg0>F43022</arg0>
      </ns1:onlineVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:onlineVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1217</return>
      </ns2:onlineVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 SL0010’s availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume SL0010’s availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

prepareVolume

Cet appel asynchrone déplace le dossier du volume depuis le dossier /LTFSLE/LOST+FOUND+VOLUMES/ vers le dossier /LTFSLE/.

Format

prepareVolume(volser)

Conditions préalables :

Avant de préparer le volume, vérifiez que le dossier du volume se trouve à l'emplacement/LTFSLE/LOST+FOUND+VOLUMES, que le volume existe dans la bibliothèque, et qu'il est hors ligne, assigné et disponible. Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Obtenez l'emplacement du volume.

    getVolumePath(volser)
    
  • Assurez-vous que le volume se trouve dans tous les états requis et effectuez les éventuelles actions correctives nécessaires avant de continuer.

Service Web LTFS-LE à appeler :

prepareVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le dossier du volume est à présent accessible depuis le dossier /LTFSLE.

Paramètres

  • volser désigne le numéro de série du volume à préparer de manière à ce qu'il soit accessible depuis l'emplacement /LTFSLE/.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est en ligne, non assigné et non disponible avant d'être préparé, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

Délai d'expiration recommandé

3 600 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:prepareVolume>
         <arg0>F50233</arg0>
      </ns1:prepareVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope   xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:prepareVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1221</return>
      </ns2:prepareVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010's availableStatus is Unavailable</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's availableStatus is Unavailable</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unassignVolume

Cette commande annule l'assignation d'un volume à LTFS-LE.

Format

unassignVolume(String[] volsers)

Conditions préalables :

Le volume doit exister dans la bibliothèque, et il doit être hors ligne, assigné, dans un pool et disponible avant que son assignation soit annulée. Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Assurez-vous que le volume se trouve dans tous les états requis et effectuez les éventuelles actions correctives nécessaires avant de continuer.

Service Web LTFS-LE à appeler :

unassignVolume([volser1, volser2, ...])
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, l'affectation du volume à LTFS-LE est annulée.

Paramètres

  • Les valeurs volser désignent les numéros de série des volumes dont l'assignation doit être annulée. Les paramètres d'entrée se présentent sous la forme d'un tableau de chaînes et permettent d'annuler l'assignation de plusieurs volumes.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est en ligne, non assigné, pas dans un pool et non disponible avant que son assignation soit annulée, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"   xmlns:ns1
="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:unassignVolume>
         <arg0>F50233</arg0>
         <arg0>F50234</arg0>
      </ns1:unassignVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
     <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp   xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unassignVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1221</return>
      </ns2:unassignVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unformatVolume

L'appel asynchrone unformatVolume supprime le formatage d'un volume LTFS. Lorsque vous annulez le formatage d'un volume LTFS, les en-têtes de format LTFS (partitions de métadonnées et de données) sont supprimés du volume et il devient un volume standard non-LTFS.

Le service Web LTFS-LE ne demande pas de confirmation et n'effectue aucune validation du volume. Cependant, lorsque le formatage d'un volume est annulé, toutes les données situées dessus sont supprimées. Vous devez donc faire attention au volume dont le formatage va être annulé et vous assurer que c'est le bon.

Condition préalable :

Vérifiez que le volume est hors ligne et non assigné avant d'annuler son formatage. Vérifiez qu'un lecteur compatible est disponible.

Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1, volser2, ...])
    
  • Assurez-vous que le volume est dans l'état requis par la condition préalable.

  • Effectuez les éventuelles actions correctives nécessaires avant de continuer.

Chaîne de service Web LTFS-LE à appeler :

unformatVolume(volser)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume n'est plus formaté et le format LTFS-LE a été supprimé du volume.

Format

unformatVolume(String volser)

Paramètres

  • volser désigne le numéro de série du volume dont le formatage doit être annulé.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est en ligne, non assigné et non disponible avant que son formatage soit annulé, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope   xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="http://sb.ejb.ws.mds.ltfsle.oracle/">
   <env:Header>
      <ns1:Security>
         <ns1:UsernameToken>
            <ns1:Username>username</ns1:Username>
            <ns1:Password>password</ns1:Password>
      </ns1:Security>
   </env:Header>
   <env:Body>
      <ns1:unformatVolume>
         <arg0>F50344</arg0>
      </ns1:unformatVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp     xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unformatVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1216</return>
      </ns2:unformatVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

unformatVolumeWithDrive

Cet appel asynchrone supprime le formatage d'un volume LTFS. Lorsque vous annulez le formatage d'un volume LTFS, les en-têtes de format LTFS (partitions de métadonnées et de données) sont supprimés du volume et il devient un volume standard non-LTFS.

Format

unformatVolumeWithDrive (String volser, String drivesn)

Condition préalable :

Le volume et le lecteur doivent exister dans la bibliothèque. Le volume et le lecteur doivent être compatibles. Le volume ne doit pas être assigné, et il doit être hors ligne et disponible. Le lecteur doit être à l'état inactif, en ligne ou disponible.

Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • Assurez-vous que le volume est dans l'état requis décrit dans la condition préalable.

  • Effectuez les éventuelles actions correctives nécessaires avant de continuer.

Chaîne de service Web LTFS-LE à appeler :

unformatVolumeWithDrive(volser,drivesn)
getJobStatus(jobId) < poll each 10s until status is complete > 
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est à présent formaté au format LTFS-LE.

Paramètres

  • volser désigne le numéro de série du volume dont le formatage doit être annulé.

  • drivesn désigne le numéro de série du lecteur (une chaîne de caractères et de chiffres).

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

Exception ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est hors ligne, non assigné, en cours d'utilisation et non disponible, ou si le lecteur n'est pas compatible avec le volume ou se trouve dans la bibliothèque, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

  • The volume's type LTO-5 is not compatible with drive's type T1C.

  • The drive HP23112 is not found in LTFS library.

  • The drive 123456's availableStatus is In use.

  • The drive 123456's onlineStatus is Offline.

  • The drive 123456's assignedStatus is Unassigned.

Délai d'expiration recommandé

7 200 secondes

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="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:unformatVolumeWithDrive>
         <arg0>F50344</arg0>
         <arg1>576001000421</arg1>
      </ns1:unformatVolumeWithDrive>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp       xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:unformatVolumeWithDriveResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1216</return>
      </ns2:unformatVolumeWithDriveResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 type LTO-5 is not compatible with drive's type T1C</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume's type LTO-5 is not compatible with drive's type T1C</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>

vaultVolume

Cette fonction API archive de façon sécurisée un ou plusieurs volumes LTFS-LE présents dans le pool de volumes LTFS-LE par défaut. Vous ne pouvez archiver de façon sécurisée qu'un seul volume à la fois.

Cet appel asynchrone archive de façon sécurisée jusqu'à 30 volumes à l'aide du CAP (fente). La fente peut accueillir quatre volumes. Si l'utilisateur archive de façon sécurisée 30 volumes, ceux-ci sont envoyés quatre par quatre à la fente jusqu'à ce que toutes les éjections aient été effectuées.

Format

vaultVolume(String[] volsers,String acs,String lsm,String cap)

Condition préalable :

Avant d'effectuer un archivage sécurisé, vérifiez qu'un CAP est disponible et que le volume concerné est finalisé et hors ligne. Le nombre total de volumes doit être inférieur ou égal à 30. Les volumes doivent être dans la même bibliothèque configurée. Pour ce faire, procédez comme suit :

  • Obtenez le statut du volume :

    getVolumeInfoByVolser([volser1,volser2,...])
    
  • Si le volume se trouve dans un état en ligne et assigné, finalisez-le :

    finalizeVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    
  • Si le volume est en ligne, mettez-le hors ligne avant d'exécuter l'appel vaultVolume de l'API :

    offlineVolume(volser)
    getJobStatus(jobId) < poll each 10s until status is complete > getJobResult(jobId)
    

Chaîne de service Web LTFS-LE à appeler :

vaultVolume([volser1,volser2,...],acs,lsm,cap)
getJobStatus(jobId) < poll each 10s until status is complete >
getJobResult(jobId)

Condition postérieure :

Une fois que les services Web ont été exécutés, les résultats sont générés sous la forme d'un document XML. Vous devez les convertir en codes retour appropriés. En cas de réussite des appels de l'API, le volume est inséré dans la bibliothèque. L'utilisateur doit se rendre à la bibliothèque et extraire le volume après avoir ouvert la porte du CAP.

Paramètres

  • Les valeurs volser désignent les numéros de série des volumes à archiver.

  • acs désigne l'identificateur ACS de la bibliothèque.

  • lsm désigne l'identificateur LSM de la bibliothèque.

  • cap désigne l'ID du CAP (fente) utilisé pour éjecter le volume.

  • jobId désigne l'ID de travail utilisé pour extraire le statut et le résultat du travail.

Réponse

Les réponses valides sont présentées dans l'exemple de réponse SOAP. Reportez-vous au glossaire pour les définitions correspondantes.

Rôles

Admin ou Service

Exception générée

ValidationFailedException

Des exceptions peuvent être générées :

  • Si les numéros de série volser n'ont pas été saisis, l'exception suivante est générée : "The parameter volsers is null".

  • Si le volume n'existe pas dans la bibliothèque et qu'il est en ligne, non assigné, pas dans un pool et non disponible avant son archivage sécurisé, les statuts disponibles génèrent des exceptions d'échec de validation au format suivant : "volume [volume sn] status is []".

En voici quelques exemples :

  • The volume EL0010 is not found in LTFS library.

  • The volume SL0010’s onlineStatus is Online.

  • The volume SL0010’s assignedStatus is Unassigned.

  • The volume SL0010’s availableStatus is Unavailable.

  • The volume EL0010's inuseStatus is In use.

Délai d'expiration recommandé

Cette valeur dépend du temps nécessaire à l'administrateur pour retirer le volume du CAP (fente).

Intervalle d'interrogation du travail recommandé

10 secondes

Demande SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<env:Envelope    xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"  xmlns:ns1
="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:vaultVolume>
         <arg0>F50234</arg0>
         <arg0>F50233</arg0>
         <arg1>3</arg1>
         <arg2>0</arg2>
         <arg3>1</arg3>
      </ns1:vaultVolume>
   </env:Body>
</env:Envelope>

Réponse SOAP

<?xml version = '1.0' encoding = 'UTF-8'?>
<S:Envelope xmlns:S="http://www.w3.org/2003/05/soap-envelope">
   <S:Header>
      <wsse:Security xmlns:wsse="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-
-secext-1.0.xsd" S:mustUnderstand="true">
         <wsu:Timestamp  xmlns:wsu="http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-
wssecurity-utility-1.0.xsd">
            <wsu:Created>2014-06-17T14:36:36Z</wsu:Created>
            <wsu:Expires>2014-06-17T14:37:36Z</wsu:Expires>
         </wsu:Timestamp>
      </wsse:Security>
   </S:Header>
   <S:Body>
      <ns2:vaultVolumeResponse xmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
         <return>1214</return>
      </ns2:vaultVolumeResponse>
   </S:Body>
</S:Envelope>

Erreur SOAP

<?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 EL0010's inuseStatus is In use</ns3:Text>
         </ns3:Reason>
         <ns3:Detail>
            <ns2:ValidationFailedExceptionxmlns:ns2="http://sb.ejb.ws.mds.ltfsle.oracle/">
               <message>The volume EL0010's inuseStatus is In use</message>
            </ns2:ValidationFailedException>
         </ns3:Detail>
      </ns3:Fault>
   </S:Body>
</S:Envelope>