Utilisation du groupe de commandes AdministrativeJobs de l'objet AdminTask avec les scripts de wsadmin
Le langage de script Jython permet de configurer et de gérer des travaux administratifs à l'aide de l'outil wsadmin.
deleteJob
La commande deleteJob supprime un travail existant du gestionnaire de travaux. Si le travail était en cours d'exécution lors de l'appel de la commande, le système renvoie les résultats de ce travail, même supprimé.
Objet cible
Aucun
Paramètres obligatoires
- -jobToken
- Indique l'identificateur unique du travail à supprimer. (Chaîne, obligatoire)
Valeur renvoyée
La commande ne renvoie pas de sortie.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.deleteJob('-jobToken myToken')
- Avec une liste Jython :
AdminTask.deleteJob('-jobToken', 'myToken')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.deleteJob('-interactive')
getJobTargets
La commande getJobTargets affiche la cible du travail qui vous intéresse. La cible que la commande renvoie pour un travail peut être désinscrite ou supprimée.
Objet cible
Aucun
Paramètres obligatoires
- -jobToken
- Indique l'identificateur unique du travail qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie le nom de noeud correspondant aux cibles associées au travail qui vous intéresse.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.getJobTargets('-jobToken myToken')
- Avec une liste Jython :
AdminTask.getJobTargets('-jobToken', 'myToken')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.getJobTargets('-interactive')
getJobTargetStatus
La commande getJobTargetStatus affiche l'état le plus récent de la cible associée au travail qui vous intéresse.
Objet cible
Aucun
Paramètres obligatoires
- -jobToken
- Indique l'identificateur unique du travail qui vous intéresse. (Chaîne, obligatoire)
Paramètres facultatifs
- -targetList
- Précise une liste de noeuds cible. (Chaîne[], facultatif)
Valeur renvoyée
La commande renvoie l'état de travail le plus récent pour les cibles. Les valeurs admissibles sont les suivantes : NOT_ATTEMPTED, DISTRIBUTED, ASYNC_IN_PROGRESS, SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, DELAYED et REJECTED.
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne Jython :
AdminTask.getJobTargetStatus('-jobToken myToken')
- Avec une liste Jython :
AdminTask.getJobTargetStatus('-jobToken', 'myToken')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.getJobTargetStatus('-interactive')
getJobTargetHistory
La commande getJobTargetHistory affiche l'historique de la cible du travail qui vous intéresse.
Objet cible
Aucun
Paramètres obligatoires
- -jobToken
- Indique l'identificateur unique du travail qui vous intéresse. (Chaîne, obligatoire)
- -target
- Indique le nom du noeud associé à la cible concernée. (Chaîne, obligatoire)
- -maxReturn
- Indique le nombre maximal de résultats à renvoyer. (Entier, obligatoire)
Paramètres facultatifs
- -startingTime
- Indique l'heure à partir de laquelle la commande renvoie l'historique du travail sur la cible. (Chaîne, facultatif)
- -endingTime
- Indique l'heure à laquelle la commande cesse de renvoyer l'historique du travail sur la cible. (Chaîne, facultatif)
- -ascending
- Indique si les résultats doivent être renvoyés dans un ordre croissant ou décroissant. Spécifiez true pour afficher les résultats dans l'ordre croissant ou false pour les afficher dans l'ordre décroissant. (Booléen, facultatif)
Valeur renvoyée
La commande renvoie une liste d'attributs, le premier attribut indiquant le nombre de correspondances et le second attribut, l'historique du travail sur la cible. Chaque liste contient les attributs horodatage, état, message et résultat.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.getJobTargetHistory('-jobToken 2846493472984754 -target 3820J37H3017N294 -maxReturn 20')
- Avec une liste Jython :
AdminTask.getJobTargetHistory('-jobToken', '2846493472984754', '-target', '3820J37H3017N294', '-maxReturn', '20')
Exemple d'utilisation en mode interactif
- A l'aide de Jython :
AdminTask.getJobTargetHistory('-interactive')
getJobTypes
La commande getJobTypes affiche les types de travail pris en charge sur le noeud final qui vous intéresse.
Objet cible
Aucun
Paramètres facultatifs
- -targetList
- Indique la liste des noeuds associés à la cible. (Chaîne[], facultatif)
- -group
- Indique le nom du groupe associé à la cible. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie la liste des types de travail pris en charge par chaque cible indiquée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.getJobTypes('-target myProfileKey')
- Avec une liste Jython :
AdminTask.getJobTypes('-target', 'myProfileKey')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.getJobTypes('-interactive')
getJobTypeMetadata
La commande getJobTypeMetadata affiche les métadonnées associées à un type de travail.
Objet cible
Aucun
Paramètres obligatoires
- -jobTypeList
- Indique la liste de types de travail qui vous intéresse. (Chaîne[], facultatif)
Valeur renvoyée
La commande renvoie une liste d'attributs, dont les attributs name, label, description, job-properties et job-parameters.
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne Jython :
AdminTask.getJobTypeMetadata('-jobTypeList inventory')
- Avec une liste Jython :
AdminTask.getJobTypeMetadata('-jobTypeList', 'inventory')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.getJobTypeMetadata('-interactive')
getOverallJobStatus
La commande getOverallJobStatus affiche l'état global du travail ou de la liste de travaux qui vous intéressent.
Objet cible
Aucun
Paramètres facultatifs
- -jobTokenList
- Spécifie un ou plusieurs identificateurs uniques affectés aux travaux qui vous intéressent. (Chaîne[], facultatif)
Valeur renvoyée
- STATE indique l'état en cours du travail.
- TOTAL_RESULTS indique le nombre total de travaux.
- DISTRIBUTED indique le nombre de travaux répartis.
- ASYNC_IN_PROGRESS indique le nombre de travaux asynchrones en cours.
- SUCCEEDED indique le nombre de travaux ayant abouti.
- PARTIALLY_SUCCEEDED indique le nombre de travaux ayant partiellement abouti. Un succès partiel peut se produire, par exemple, lorsqu'un noeud représente plusieurs serveurs et que seuls certains de ces serveurs terminent le travail correctement.
- FAILED indique le nombre de travaux ayant échoué.
- NOT_ATTEMPTED indique le nombre de travaux que le système n'a pas tenté d'exécuter.
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne Jython :
AdminTask.getOverallJobStatus('-jobTokenList myJobToken')
- Avec une liste Jython :
AdminTask.getOverallJobStatus('-jobTokenList', 'myJobToken')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.getOverallJobStatus('-interactive')
queryJobs
La commande queryJob interroge le gestionnaire de travaux sur chaque travail soumis.
Objet cible
Aucun
Paramètres obligatoires
- -query
- Indique l'expression à utiliser dans la requête sur les travaux. (Chaîne, obligatoire)Aidez-vous des instructions suivantes lorsque vous créez des requêtes sur les travaux :
- La requête comprend une clé, un opérateur et une valeur ou une liste de valeurs. Vous pouvez indiquer une valeur unique ou une liste de valeurs séparées par une virgule.
- Séparez plusieurs expressions par un espace et l'opérateur AND.
- Les clés sensibles à la casse prises en charge sont les suivantes :
- jobToken
- Indique le jeton du travail à interroger.
- group
- Indique le nom du groupe de noeuds à interroger.
- description
- Indique la description du travail à interroger. Si la description contient plusieurs mots, placez-la entre apostrophes ou entre guillemets. Par exemple : description = "description du travail".
- activationDateTime
- Indique la date et l'heure auxquelles le système active le travail. Par exemple : 2006-05-03T10:30:45-0000. La section -0000 de la valeur de clé activationDateTime représente le format RFC 822. La lettre de raccourci Z permet d'indiquer le temps moyen de Greenwich (GMT). Par exemple : 2006-05-03T10:30:45Z. Par défaut, le système utilise le fuseau horaire du serveur.
- expirationDateTime
- Indique la date et l'heure d'expiration du travail. Par exemple : 2006-05-03T10:30:45-0000. La section -0000 de la valeur de clé activationDateTime représente le format RFC 822. La lettre de raccourci Z permet d'indiquer le temps moyen de Greenwich (GMT). Par exemple : 2006-05-03T10:30:45Z. Par défaut, le système utilise le fuseau horaire du serveur.
- state
- Indique l'état du travail. Les valeurs valides sont ASYNC_IN_PROGRESS, SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, DELAYED, REJECTED et NOT_ATTEMPTED.
- target
- Indique le noeud cible d'un travail. Cette clé permet de renvoyer les travaux relatifs à un noeud déterminé. La commande renvoie les travaux relatifs au noeud concerné et aux groupes de noeuds auxquels il appartient. Vous ne pouvez indiquer qu'un ID cible par requête.
- Les opérateurs suivants sont pris en charge :
Tableau 1. Opérateurs queryJobs -query. Utiliser un opérateur dans une requête. Caractère Valeur = Egal à. Pour indiquer une valeur NULL, utilisez = NULL. != Différent de. Pour indiquer une valeur non NULL, utilisez = NULL. > Supérieur à < Inférieur à >= Supérieur ou égal à <= Inférieur ou égal à
- -maxReturn
- Indique le nombre maximal de résultats concordants à renvoyer. (Entier, obligatoire)
Valeur renvoyée
[ [result [{activationDateTime=2008-03-11T11:56:48-0500,
expirationDateTime=2008-05-10T11:56:48-0500, jobToken=120525460839085191,
description=testSubmitJobToValidBaseTargetList}{activationDateTime=2008-03-11T14:05:33-0500,
expirationDateTime=2008-05-10T14:05:33-0500, jobToken=120526233387582472,
description=testSubmitJobToValidBaseTargetList}]] [size 2] ]
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne Jython :
print AdminTask.queryJobs('-query activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01" -maxReturn 20')
print AdminTask.queryJobs('[-query "target = node3" -maxReturn 2]')
- Avec une liste Jython :
AdminTask.queryJobs('-query', 'activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01"', '-maxReturn', '20')
print AdminTask.queryJobs(['-query', '"target = node3"', '-maxReturn', '2'])
Exemple d'utilisation en mode interactif
- Avec une chaîne Jython :
AdminTask.queryJobs('-interactive')
resumeJob
La commande resumeJob permet de reprendre un travail précédemment démarré ou interrompu.
Objet cible
Aucun
Paramètres obligatoires
- -jobToken
- Indique l'identificateur unique du travail qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
La commande ne renvoie pas de sortie.
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne Jython :
AdminTask.resumeJob('-jobToken myToken')
- Avec une liste Jython :
AdminTask.resumeJob('-jobToken', 'myToken')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.resumeJob('-interactive')
submitJob
La commande submitJob soumet un nouveau travail administratif au gestionnaire de travaux.
Objet cible
Aucun
Paramètres obligatoires
- -jobType
- Indique le type de travail à soumettre. (Chaîne, obligatoire)
Paramètres facultatifs
- -group
- Indique le nom du groupe associé à la cible. (Chaîne, facultatif)
- -targetList
- Indique la liste des noeuds pour la cible. (Chaîne[], facultatif)
- -jobParams
- Indique les paramètres nécessaires au travail à soumettre. (Propriétés, facultatif)
- -username
- Indique le nom d'utilisateur à utiliser pour soumettre le travail lorsque que la sécurité est activée. (Chaîne, facultatif)
- -password
- Indique le mot de passe associé au nom d'utilisateur à employer pour soumettre le travail lorsque la sécurité est activée. (Chaîne, facultatif)
- -description
- Indique la description du travail. (Chaîne, facultatif)
- -activationDateTime
- Indique la date et l'heure auxquelles activer le travail, dans le format suivant : "2006-05-03T10:30:45-0000". La section "-0000" de la valeur de paramètre activationDateTime représente le format RFC 822. La lettre de raccourci "Z" permet d'indiquer le temps moyen de Greenwich (GMT). Par exemple : "2006-05-03T10:30:45Z". Par défaut, le système utilise le fuseau horaire du serveur. (Chaîne, facultatif)
- -expirationDateTime
- Indique la date d'expiration du travail. (Chaîne, facultatif)
- -executionWindow
- Indique l'intervalle de récurrence du travail. (Chaîne, facultatif)
- -executionWindowUnit
- Indique l'unité de mesure de l'intervalle de récurrence pour la valeur définie par le paramètre executionWindow. Spécifiez DAILY pour une exécution quotidienne du travail, WEEKLY pour une exécution hebdomadaire, MONTHLY pour une exécution mensuelle ou YEARLY pour une exécution annuelle. D'autre part, vous pouvez préciser CONNECTION pour exécuter le travail chaque fois que le noeud se connecte au gestionnaire de travaux pour collecter les travaux. Lorsque vous spécifiez CONNECTION, ne définissez pas le paramètre executionWindow. (Chaîne, facultatif)
- Indique l'adresse électronique à laquelle le système envoie les notifications de travaux. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie le jeton du travail qui vient d'être soumis.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.submitJob('[-jobType createApplicationServer -target profileKey -jobParams "[serverName myServer]" ]')
- Avec une liste Jython :
AdminTask.submitJob(['-jobType', 'createApplicationServer', '-target', 'profileKey', '-jobParams', '"[serverName myServer]"'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.submitJob('-interactive')
suspendJob
La commande suspendJob interrompt un travail précédemment soumis.
Objet cible
Aucun
Paramètres obligatoires
- -jobToken
- Indique l'identificateur unique du travail à interrompre. (Chaîne, obligatoire)
Valeur renvoyée
La commande ne renvoie pas de sortie.
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne Jython :
AdminTask.suspendJob('-jobToken myToken')
- Avec une liste Jython :
AdminTask.suspendJob('-jobToken', 'myToken')
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.suspendJob('-interactive')