Groupe de commandes dpManagerCommands de l'objet AdminTask
Le langage de script Jython permet de configurer le gestionnaire d'appliances DataPower à l'aide de l'outil wsadmin. Le gestionnaire d'appliances IBM WebSphere DataPower fournit un ensemble de fonctions permettant de gérer des appliances DataPower. Les commandes et paramètres du groupe dpManagerCommands peuvent être utilisés pour interroger, configurer et administrer le gestionnaire d'appliances DataPower.
Les appliances IBM® WebSphere® DataPower SOA sont des périphériques réseau spécifiquement conçus et faciles à déployer pour simplifier, sécuriser et accélérer vos déploiements XML et services web. Lors de la première utilisation du gestionnaire d'appliances DataPower, il n'existe aucune appliance, aucun ensemble géré, ni aucune version de microprogramme. Vous devez créer des appliances, ajouter des versions de microprogramme et créer des ensembles gérés.
Avant de commencer, vérifiez que chaque appliance que vous voulez ajouter a un microprogramme 3.6.0.4 ou supérieur. Vérifiez également que le noeud final AMP (Appliance Management Protocol) est activé pour chaque appliance. Si le noeud final AMP d'interface de gestion XML était désactivé pendant l'installation, utilisez l'interface Web DataPower pour l'activer.
dpExport
La commande dpExport exporte la configuration et les versions du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -file
- Indique le fichier du système local vers lequel le gestionnaire d'appliances DataPower exporte la configuration et les versions. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de la tâche créée par le système.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpExport('-file c:/temp/DPManager.export_doc')
AdminTask.dpExport('-file /temp/DPManager.export')
- Avec une liste Jython :
AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])
AdminTask.dpExport(['-file', '/temp/DPManager.export'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpExport('-interactive')
dpGetManager
La commande dpGetManager affiche les propriétés du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Valeur renvoyée
La commande renvoie un objet Propriétés qui contient les paramètres en cours du gestionnaire d'appliances DataPower.
Syntaxe d'un exemple de mode différé
- A l'aide de la chaîne et de la liste Jython :
AdminTask.dpGetManager()
dpGetManagerStatus
La commande dpGetManagerStatus affiche l'état du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Valeur renvoyée
La commande renvoie une description de l'état du gestionnaire d'appliances DataPower.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne et de la liste Jython :
AdminTask.dpGetManagerStatus()
dpImport
La commande dpImport importe la configuration et les versions du gestionnaire d'appliances DataPower. Elle remplace la configuration et les versions existantes par la configuration et les versions importées.
Objet cible
Aucun
Paramètres obligatoires
- -file
- Indique le fichier système du gestionnaire d'appliances DataPower qui contient la configuration et les versions à importer. (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.dpImport('-file c:/temp/DPManager.import')
AdminTask.dpImport('-file /temp/DPManager.import')
- Avec une liste Jython :
AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])
AdminTask.dpImport(['-file', '/temp/DPManager.export'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpImport('-interactive')
dpSetManager
La commande dpSetManager modifie la configuration du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres facultatifs
- -maxVersionsToStore
- Indique le nouveau nombre maximal de versions à conserver. (Entier, facultatif).
- -versionsDirectory
- Indique le répertoire système du gestionnaire d'appliances DataPower où le gestionnaire crée les versions. La commande déplace les versions existantes du répertoire en cours vers le nouveau répertoire. (Chaîne, facultatif)
Valeur renvoyée
Si vous indiquez une valeur pour le paramètre versionsDirectory, la commande renvoie l'ID de la tâche qu'elle génère.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpSetManager('-maxVersionsToStore 20 -versionsDirectory newDir')
- Avec une liste Jython :
AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetManager('-interactive')
dpStopManager
La commande dpStopManager arrête le gestionnaire d'appliances DataPower. Le gestionnaire redémarrera automatiquement la prochaine fois qu'il sera utilisé.
Objet cible
Aucun
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 et de la liste Jython :
AdminTask.dpStopManager()
dpAddAppliance
La commande dpAddAppliance ajoute une appliance au gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -hostname
- Indique le nom d'hôte ou l'adresse IP de l'appliance. (Chaîne, obligatoire)
- -hlmPort
- Indique le numéro de port utilisé par le gestionnaire d'appliances DataPower pour communiquer avec l'appliance. La valeur par défaut est 5550. (Entier, obligatoire)
- -name
- Indique le nom unique de l'appliance dans le gestionnaire d'appliances DataPower. Les caractères \\/,#$@:;\"*?<>|=+&%' ne sont pas admis pour le paramètre name. (Chaîne, obligatoire)
- -userId
- Indique l'ID utilisateur utilisé par le gestionnaire d'appliances DataPower pour accéder à l'appliance. (Chaîne, obligatoire)
- -password
- Indique le mot de passe codé sur 64 bits utilisé par le gestionnaire d'appliances DataPower pour accéder à l'appliance. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de la tâche créée par le système. Lorsque la tâche se termine, la valeur de l'attribut "result" de la tâche contient l'ID de la nouvelle appliance.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpAddAppliance('[-hostname myappliance.ibm.com –name myappliance -userId admin -password mypassword]')
- Avec une liste Jython :
AdminTask.dpAddAppliance(['-hostname', 'myappliance.ibm.com', '–name', 'myappliance', '-userId', ' admin', '-password', 'mypassword'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpAddAppliance('-interactive')
dpGetAllApplianceIds
La commande dpGetAllApplianceIds affiche l'ID de toute appliance prise en charge par le gestionnaire d'appliances DataPower.
Objet cible
Aucun
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient l'ID de chaque appliance de votre configuration. Pour les appliances, l'ID correspond au numéro de série de l'appliance DataPower.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne et de la liste Jython :
AdminTask.dpGetAllApplianceIds()
dpGetAllMSApplianceIds
La commande dpGetAllMSApplianceIds affiche l'ID de toutes les appliances appartenant à un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient l'ID des appliances appartenant à l'ensemble géré qui vous intéresse.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')
- Avec une liste Jython :
AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllMSApplianceIds('-interactive')
dpGetAppliance
La commande dpGetAppliance affiche une appliance spécifique du gestionnaire d'appliancesDataPower.
Objet cible
Aucun
Paramètres obligatoires
- -applianceId
- Indique l'ID de l'appliance appartenant au gestionnaire d'appliances DataPower que vous souhaitez afficher. (Chaîne, obligatoire)
Valeur renvoyée
[ [userId admin] [applianceType XI50] [serialNumber [00605 20356]]
[firmwareManagementStatus ManagementStatus.synced] [actualFirmwareLevel 3.6.1.0] [rollupOperationalStatus
OperationalStatus.unknown] [hostname dp3.dyn.webahead.ibm.com] [settingsManagementStatus ManagementStatus.synced]
[rollupManagementStatus ManagementStatus.synced] [applianceId [00605 20356]] [guiPort 8080] [modelType 9002] [isManaged true]
[managedSetId jgMS1] [featureLicenses [MQ, TAM, DataGlue, JAXP-API, PKCS7-SMIME, WebSphere-JMS]] [hlmPort 5550] [isMaster true]
[name dp3] ]
Attribut | Description |
---|---|
applianceId | Affiche l'ID de l'appliance qui vous intéresse. |
managedSetId | Affiche l'ID de l'ensemble géré dont l'appliance est membre. Si l'appliance n'est pas gérée, la commande ne renvoie pas cet attribut. |
actualFirmwareLevel | Affiche le niveau du microprogramme de l'appliance. |
featureLicenses | Affiche une liste des autorisations utilisateur relatives à cette appliance, telles que MQ, TAM, etc. |
guiPort | Affiche le port associé à l'appliance pour l'interface Web DataPower. |
hlmPort | Affiche le numéro de port permettant la communication entre le gestionnaire d'appliances DataPower et l'appliance. |
hostname | Affiche le nom d'hôte ou l'adresse IP de l'appliance. |
isManaged | Affiche la valeur true si le gestionnaire d'appliances DataPower gère l'appliance. |
isMaster | Affiche la valeur true si l'appliance est l'appliance maître de l'ensemble géré. Cette propriété n'est pas affichée si l'appliance n'est pas gérée par le gestionnaire d'appliances DataPower. |
modelType | Affiche le type de modèle de l'appliance. |
applianceType | Affiche le type d'appliance. |
settingsManagementStatus | Affiche l'état de gestion des paramètres de l'appliance. Cet attribut est également appelé "état de synchronisation" de l'interface Web DataPower. |
firmwareManagementStatus | Affiche l'état de gestion du microprogramme de l'appliance. Cet attribut est également appelé "état de synchronisation" de l'interface Web DataPower. |
domainManagementStatus | Affiche l'état de gestion d'un domaine spécifique de l'appliance. Cet attribut est également appelé "état de synchronisation" de l'interface Web DataPower. |
domainOperationalStatus | Affiche l'état opérationnel d'un domaine spécifique de l'appliance. |
rollupManagementStatus | Affiche l'état de gestion combiné du microprogramme, des paramètres et des domaines de l'appliance. Cet attribut est également appelé "état de synchronisation" de l'interface Web DataPower. |
rollupOperationalStatus | Affiche l'état opérationnel combiné du microprogramme, des paramètres et des domaines de l'appliance. |
serialNumber | Affiche le numéro de série de l'appliance qui vous intéresse. |
name | Affiche le nom de l'appliance dans le gestionnaire d'appliances DataPower. |
userId | Affiche l'ID utilisateur utilisé par le gestionnaire d'appliances DataPower pour accéder à l'appliance. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAppliance('-applianceId "00605 20356"')
- Avec une liste Jython :
AdminTask.dpGetAppliance(['-applianceId', '00605 20356'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAppliance('-interactive')
dpManageAppliance
La commande dpManageAppliance ajoute une appliance à un ensemble géré et active la gestion de cette appliance.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré dont l'appliance est membre. (Chaîne, obligatoire)
- -applianceId
- Indique l'ID de l'appliance appartenant au gestionnaire d'appliances DataPower qui doit être ajoutée à l'ensemble géré. (Chaîne, obligatoire)
Paramètres facultatifs
- -asMaster
- Indique si l'appliance doit être définie comme l'appliance maître de l'ensemble géré. La première appliance ajoutée à l'ensemble géré est définie comme appliance maître, même si ce paramètre n'est pas spécifié. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée. Lorsque la tâche se termine, la valeur de l'attribut "result" correspond à l'ID de l'appliance.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')
- Avec une liste Jython :
AdminTask.dpManageAppliance(['-managedSetId', 'testMS1', '-applianceId', '00605 20351'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpManageAppliance('-interactive')
dpRemoveAppliance
La commande dpRemoveAppliance supprime une appliance du gestionnaire d'appliances DataPower. Elle supprime également l'appliance d'un ensemble géré, dans la mesure où l'appliance en est membre. Vous ne pouvez pas supprimer une appliance maître d'un ensemble géré. Vous devez auparavant sélectionner une autre appliance et la définir comme appliance maître, avant de supprimer une appliance maître.
Objet cible
Aucun
Paramètres obligatoires
- -applianceId
- Indique l'ID de l'appliance appartenant au gestionnaire d'appliances DataPower qui doit être supprimée de l'ensemble géré. Pour les appliances, l'ID correspond au numéro de série de l'appliance DataPower. (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.dpRemoveAppliance('[-applianceId "00605 20356"]')
- Avec une liste Jython :
AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpRemoveAppliance('-interactive')
dpSetAppliance
La commande dpSetAppliance modifie la configuration du gestionnaire d'appliances DataPower au niveau d'une appliance.
Objet cible
Aucun
Paramètres obligatoires
- -applianceId
- Indique l'ID de l'appliance appartenant au gestionnaire d'appliances DataPower que vous souhaitez modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -hostname
- Indique le nom d'hôte ou l'adresse IP de l'appliance. (Chaîne, facultatif)
- -hlmPort
- Indique le numéro de port utilisé par le gestionnaire d'appliances DataPower pour communiquer avec l'appliance. La valeur par défaut est 5550. (Entier, facultatif).
- -name
- Indique le nom unique de l'appliance dans le gestionnaire d'appliances DataPower. Les caractères \\/,#$@:;\"*?<>|=+&%' ne sont pas admis pour le paramètre name. (Chaîne, facultatif)
- -userId
- Indique l'ID utilisateur utilisé par le gestionnaire d'appliances DataPower pour accéder à l'appliance. (Chaîne, facultatif)
- -password
- Indique le mot de passe codé sur 64 bits utilisé par le gestionnaire d'appliances DataPower pour accéder à l'appliance. (Chaîne, facultatif)
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.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')
- Avec une liste Jython :
AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', '-password', 'myPassword'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetAppliance('-interactive')
dpUnmanageAppliance
La commande dpUnmanageAppliance supprime l'appliance qui vous intéresse de l'ensemble géré auquel elle appartient. L'appliance n'est alors plus gérée, mais reste définie dans le gestionnaire.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré dont l'appliance est membre. (Chaîne, obligatoire)
- -applianceId
- Indique l'ID de l'appliance appartenant au gestionnaire d'appliances DataPower qui doit être supprimée de l'ensemble géré. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 20351"]')
- Avec une liste Jython :
AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpUnmanageAppliance('-interactive')
dpAddManagedSet
La commande dpAddManagedSet ajoute un ensemble géré au gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -name
- Indique le nom unique de l'appliance dans le gestionnaire d'appliances DataPower. Les caractères \\/,#$@:;\"*?<>|=+&%' ne sont pas admis pour le paramètre name. (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.dpAddManagedSet('-name testMS')
- Avec une liste Jython :
AdminTask.dpAddManagedSet(['-name testMS'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpAddManagedSet('-interactive')
dpGetAllManagedSetIds
La commande dpGetAllManagedSetIds affiche les ID de tous les ensembles gérés du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient l'ID de chaque noeud géré.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne et de la liste Jython :
AdminTask.dpGetAllManagedSetIds()
dpGetManagedSet
La commande dpGetManagedSet affiche des informations sur un ensemble géré spécifique du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
managedSetId | Affiche l'ID de l'ensemble géré. |
masterApplianceId | Affiche l'ID de l'appliance maître de l'ensemble géré. |
desiredFirmwareVersionId | Affiche l'ID de la version du microprogramme à utiliser pour l'ensemble géré. |
name | Affiche le nom associé à l'ensemble géré. |
rollupOperationalStatus | Affiche l'état opérationnel de l'ensemble géré. |
rollupManagementStatus | Affiche l'état de gestion de l'ensemble géré. |
settingsId | Affiche l'ID des paramètres de l'ensemble géré. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetManagedSet('-managedSetId testMS1')
- Avec une liste Jython :
AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetManagedSet('-interactive')
dpRemoveManagedSet
La commande dpRemoveManagedSet supprime un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré à 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.dpRemoveManagedSet('-managedSetId testMS')
- Avec une liste Jython :
AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpRemoveManagedSet('-interactive')
dpSetManagedSet
La commande dpSetManagedSet modifie un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré à modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -masterApplianceId
- Indique l'ID de l'appliance à définir comme appliance maître de l'ensemble géré. Cette appliance doit être membre de l'ensemble géré. Ce paramètre ainsi que le paramètre desiredFirmwareVersionId s'excluent mutuellement. (Chaîne, facultatif)
- -desiredFirmwareVersionId
- Indique l'ID de la version du microprogramme à synchroniser avec chaque appliance de l'ensemble géré. Ce paramètre ainsi que le paramètre masterApplianceId s'excluent mutuellement. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 20356"')
- Avec une liste Jython :
AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetManagedSet('-interactive')
dpSynchManagedSet
La commande dpSynchManagedSet permet de synchroniser manuellement un ensemble géré du gestionnaire d'appliances DataPower. Le gestionnaire tente automatiquement de synchroniser les périphériques membres.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré à synchroniser. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
- Avec une liste Jython :
AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSynchManagedSet('-interactive')
dpAddFirmwareVersion
La commande dpAddFirmwareVersion ajoute une version de microprogramme au gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -file
- Spécifie le fichier faisant partie du système de fichiers du gestionnaire d'appliances DataPower qui contient l'image de microprogramme à stocker dans la version du microprogramme. (Chaîne, obligatoire)
Paramètres facultatifs
- -userComment
- Indique le commentaire à stocker dans la version du microprogramme. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée. Lorsque la tâche se termine, la valeur de l'attribut "result" affiche l'ID de la nouvelle version du microprogramme.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpAddFirmwareVersion('[-file "C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
AdminTask.dpAddFirmwareVersion('[-file "/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
- Avec une liste Jython :
AdminTask.dpAddFirmwareVersion(['-file', '"C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
AdminTask.dpAddFirmwareVersion(['-file', '"/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpAddFirmwareVersion('-interactive')
dpGetAllFirmwareIds
La commande dpGetAllFirmwareIds affiche les ID de tous les microprogrammes du gestionnaire d'appliances DataPower dans la configuration.
Objet cible
Aucun
Valeur renvoyée
La commande renvoie un tableau de type chaîne pour chaque ID de microprogramme défini dans la configuration du gestionnaire d'appliances DataPower.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne et de la liste Jython :
AdminTask.dpGetAllFirmwareIds()
dpGetAllFirmwareVersionIds
La commande dpGetAllFirmwareVersionIds affiche les ID de chaque version de microprogramme du gestionnaire d'appliances DataPower. Une version de microprogramme représente une image de microprogramme que vous pouvez déployer sur une appliance DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -firmwareId
- Indique l'ID du microprogramme à rechercher. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient toutes les versions de microprogramme de votre configuration.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllFirmwareVersionIds('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
- Avec une liste Jython :
AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllFirmwareVersionIds('-interactive')
dpGetAllMSIdsUsingFirmwareVersion
La commande dpGetAllMSIdsUsingFirmwareVersion affiche les ID des ensembles gérés qui utilisent une version de microprogramme.
Objet cible
Aucun
Paramètres obligatoires
- -firmwareVersionId
- Indique l'ID de la version de microprogramme qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient l'ID des ensembles gérés qui utilisent la version de microprogramme qui vous intéresse.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- Avec une liste Jython :
AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')
dpGetBestFirmware
La commande dpGetBestFirmware affiche le microprogramme du gestionnaire d'appliances DataPower qui correspond le mieux aux paramètres. Le microprogramme du gestionnaire d'appliances DataPower contient une ou plusieurs versions de microprogramme qui correspondent à différentes versions du microprogramme. Cette commande n'identifie pas la version de microprogramme optimale de DataPower. Elle identifie la version de microprogramme qui correspond à l'appliance.
Objet cible
Aucun
Paramètres obligatoires
- -applianceType
- Indique le type d'appliance DataPower pour lequel le microprogramme doit être affiché. (Chaîne, obligatoire)
- -modelType
- Indique le type de modèle de l'appliance DataPower pour lequel le microprogramme doit être affiché. (Chaîne, obligatoire)
- -applianceFeatures
- Indique les fonctions de l'appliance DataPower pour lesquelles le microprogramme doit être affiché. (Chaîne, obligatoire)
Paramètres facultatifs
- -level
- Indique le niveau de la version de microprogramme qui doit être contenue dans le microprogramme renvoyé. (Chaîne, facultatif)
Valeur renvoyée
Attribut | Description |
---|---|
firmwareId | Affiche l'ID du microprogramme. |
applianceType | Affiche le type d'appliance pour lequel le microprogramme est utilisé. |
modelType | Affiche le type de modèle du microprogramme. |
strictFeatures | Affiche les fonctions exactes pour lesquelles le microprogramme est utilisé. |
nonStrictFeatures | Affiche les fonctions globales pour lesquelles le microprogramme est utilisé. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" -applianceFeatures "JAXP-API" -level "3.6.0.4"')
- Avec une liste Jython :
AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetBestFirmware('-interactive')
dpGetFirmware
La commande dpGetFirmware affiche les attributs d'un microprogramme spécifique de gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -firmwareId
- Indique l'ID du microprogramme qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
firmwareId | Affiche l'ID du microprogramme. |
applianceType | Affiche le type d'appliance pour lequel le microprogramme est utilisé. |
modelType | Affiche le type de modèle du microprogramme. |
strictFeatures | Affiche les fonctions exactes pour lesquelles le microprogramme est utilisé. |
nonStrictFeatures | Affiche les fonctions globales pour lesquelles le microprogramme est utilisé. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
- Avec une liste Jython :
AdminTask.dpGetFirmware(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetFirmware('-interactive')
dpGetFirmwareVersion
La commande dpGetFirmwareVersion affiche une version de microprogramme spécifique du gestionnaire d'appliances DataPower. Une version de microprogramme représente une image de microprogramme que vous pouvez déployer sur une appliance DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -firmwareVersionId
- Indique l'ID de la version de microprogramme qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
firmwareVersionId | Affiche l'ID de la version du microprogramme. |
firmareId | Affiche l'ID du microprogramme qui contient la version du microprogramme. |
niveau | Affiche le niveau du microprogramme. |
manufactureDate | Affiche la date à laquelle le microprogramme a été produit. |
timestamp | Affiche la date à laquelle l'image de microprogramme a été chargée dans le gestionnaire d'appliancesDataPower. |
userComment | Affiche le commentaire stocké avec la version du microprogramme. |
isInUse | Indique si un ensemble géré utilise la version de microprogramme. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- Avec une liste Jython :
AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetFirmwareVersion('-interactive')
dpRemoveFirmwareVersion
La commande dpRemoveFirmwareVersion supprime une version de microprogramme du gestionnaire d'appliances DataPower. Le microprogramme associé à la version du microprogramme perdure. Vérifiez qu'aucun ensemble géré n'utilise la version de microprogramme à supprimer, avant d'exécuter cette commande.
Objet cible
Aucun
Paramètres obligatoires
- -firmwareVersionId
- Indique l'ID de la version de microprogramme à 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.dpRemoveFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
- Avec une liste Jython :
AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpRemoveFirmwareVersion('-interactive')
dpSetFirmwareVersion
La commande dpSetFirmwareVersion modifie une version de microprogramme du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -firmwareVersionId
- Indique l'ID de la version de microprogramme à modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -userComment
- Indique le commentaire à stocker dans la version du microprogramme. (Chaîne, facultatif)
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.dpSetFirmwareVersion('-firmwareVersionId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')
- Avec une liste Jython :
AdminTask.dpSetFirmwareVersion(['-firmwareVersionId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15', '-userComment', 'new user comment'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetFirmwareVersion('-interactive')
dpCopyMSDomainVersion
La commande dpCopyMSDomainVersion copie une version de domaine géré du gestionnaire d'appliances DataPower vers un nouvel ensemble géré.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré qui vous intéresse. (Chaîne, obligatoire)
- -msDomainVersionId
- Indique l'ID de la version de domaine géré à copier. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet -msDomainVersionId "myManagedSet:default:1"]')
- Avec une liste Jython :
AdminTask.dpCopyMSDomainVersion(['-managedSetId', 'myManagedSet', '-msDomainVersionId', 'myManagedSet:default:1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpCopyMSDomainVersion('-interactive')
dpGetAllDomainNames
La commande dpGetAllDomainNames affiche les noms de chacun des domaines d'une appliance DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -applianceId
- Indique l'ID de l'appliance appartenant au gestionnaire d'appliances DataPower que vous souhaitez afficher. (Chaîne, obligatoire)
Paramètres facultatifs
- -managed
- Indique s'il faut renvoyer les domaines gérés. La commande renvoie le nom de chaque domaine de l'appliance si vous ne spécifiez pas les paramètres gérés ou non gérés, ou si vous ne spécifiez pas les deux paramètres. (Chaîne, facultatif)
- -unmanaged
- Indique si la commande renvoie les domaines non gérés. La commande renvoie le nom de chaque domaine de l'appliance si vous ne spécifiez pas les paramètres gérés ou non gérés, ou si vous ne spécifiez pas les deux paramètres. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie un tableau de type chaîne contenant les noms des domaines de l'appliance.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')
- Avec une liste Jython :
AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', '-unmanaged'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllDomainNames('-interactive')
dpGetAllMSDomainIds
La commande dpGetAllMSDomainIds affiche l'ID de tous les domaines appartenant à un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient l'ID des domaines appartenant à l'ensemble géré.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
- Avec une liste Jython :
AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllMSDomainIds('-interactive')
dpGetAllMSDomainVersionIds
La commande dpGetAllMSDomainVersionIds affiche l'ID de chaque version de domaine pour un domaine appartenant à un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainId
- Indique l'ID du domaine géré à afficher. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de chaque version de domaine qui existe dans le domaine de l'ensemble géré.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')
- Avec une liste Jython :
AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllMSDomainVersionIds('-interactive')
dpGetMSDomain
La commande dpGetMSDomain affiche un domaine appartenant à un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainId
- Indique l'ID du domaine géré à afficher. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
msDomainId | Affiche l'ID du domaine. |
managedSetId | Affiche l'ID de l'ensemble géré auquel le domaine appartient. |
name | Affiche le nom du domaine. |
desiredDomainVersionId | Affiche l'ID de la version de domaine que l'ensemble géré utilise pour le domaine considéré. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
- Avec une liste Jython :
AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetMSDomain('-interactive')
dpGetMSDomainVersion
La commande dpGetMSDomainVersion affiche la version d'un domaine géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainVersionId
- Indique l'ID de la version de domaine géré qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
msDomainVersionId | Affiche l'ID de la version du domaine géré. |
msDomainId | Affiche l'ID du domaine géré. |
versionNumber | Affiche le numéro de version. |
timestamp | Affiche la date à laquelle le système a créé la copie. |
userComment | Affiche le commentaire stocké avec la version de domaine de l'ensemble géré. |
isInUse | Indique si l'ensemble géré utilise la version de domaine pour le domaine. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- Avec une liste Jython :
AdminTask.dpGetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetMSDomainVersion('-interactive')
dpManageDomain
La commande dpManageDomain ajoute un domaine à un ensemble géré, et démarre la gestion de ce domaine.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré à administrer. (Chaîne, obligatoire)
- -domain
- Indique le nom du domaine lié à l'appliance maître à gérer. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée. Lorsque la tâche se termine, la valeur de l'attribut "result" contient l'ID du nouveau domaine.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]')
- Avec une liste Jython :
AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpManageDomain('-interactive')
dpRemoveMSDomainVersion
La commande dpRemoveMSDomainVersion supprime une version de domaine géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainVersionId
- Indique l'ID de la version de domaine géré à 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.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
- Avec une liste Jython :
AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpRemoveMSDomainVersion('-interactive')
dpSetMSDomain
La commande dpSetMSDomain modifie un domaine géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainId
- Indique l'ID du domaine géré à modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -desiredDomainVersionId
- Indique l'ID de la version de domaine à synchroniser avec chaque appliance de l'ensemble géré. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpSetMSDomain('[-msDomainId ms1:domain1 -desiredDomainVersionId ms1:domain1:1]')
- Avec une liste Jython :
AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1', '-desiredDomainVersionId', 'ms1:domain1:1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetMSDomain('-interactive')
dpSetMSDomainVersion
La commande dpSetMSDomainVersion modifie la version d'un domaine géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainVersionId
- Indique l'ID de la version de domaine géré à modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -userComment
- Indique le commentaire à stocker dans la version de domaine. (Chaîne, facultatif)
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.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web Service proxy for banking application"]')
- Avec une liste Jython :
AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2', '-userComment', 'New web service proxy for banking application'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetMSDomainVersion('-interactive')
dpUnmanageDomain
La commande dpUnmanageDomain supprime un domaine d'un ensemble géré, et arrête la gestion de ce domaine.
Objet cible
Aucun
Paramètres obligatoires
- -msDomainId
- Indique l'ID du domaine géré à supprimer de l'ensemble géré. (Chaîne, obligatoire)
Paramètres facultatifs
- -clean
- Supprime le domaine de chaque appliance de l'ensemble géré. (Chaîne, facultatif)
Valeur renvoyée
Si vous indiquez le paramètre clean, la commande renvoie l'ID de la tâche créée par le système.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')
- Avec une liste Jython :
AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpUnmanageDomain('-interactive')
dpCopyMSSettingsVersion
La commande dpCopyMSSettingsVersion copie une version des paramètres gérés du gestionnaire d'appliances DataPower vers un nouvel ensemble géré.
Objet cible
Aucun
Paramètres obligatoires
- -managedSetId
- Indique l'ID de l'ensemble géré qui vous intéresse. (Chaîne, obligatoire)
- -msSettingsVersionId
- Indique l'ID de la version des paramètres gérés à copier. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
- Avec une liste Jython :
AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 'myManagedSet1:1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpCopyMSSettingsVersion('-interactive')
dpGetAllMSSettingsVersionIds
La commande dpGetAllMSSettingsVersionIds affiche l'ID de chaque version de paramètres dans un ensemble géré du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msSettingsId
- Indique l'ID des paramètres gérés qui vous intéressent. (Chaîne, obligatoire)
Valeur renvoyée
La commande renvoie un tableau de type chaîne qui contient l'ID des versions des paramètres de l'ensemble géré qui vous intéresse.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
- Avec une liste Jython :
AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetAllMSSettingsVersionIds('-interactive')
dpGetMSSettings
La commande dpGetMSSettings affiche l'ID de l'ensemble géré auquel appartiennent les paramètres.
Objet cible
Aucun
Paramètres obligatoires
- -msSettingsId
- Indique l'ID des paramètres gérés qui vous intéressent. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
msSettingsId | Affiche l'ID des paramètres. |
managedSetId | Affiche l'ID de l'ensemble géré auquel les paramètres sont affectés. |
desiredSettingsVersionId | Affiche l'ID de la version des paramètres utilisée par l'ensemble géré. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
- Avec une liste Jython :
AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetMSSettings('-interactive')
dpGetMSSettingsVersion
La commande dpGetMSSettingsVersion affiche la version des paramètres gérés du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msSettingsVersionId
- Indique l'ID de la version des paramètres gérés qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
msSetSettingsVersionId | Affiche l'ID de la version des paramètres de l'ensemble géré. |
msSettingsId | Affiche l'ID des paramètres de l'ensemble géré qui vous intéressent. |
timestamp | Affiche la date à laquelle le système a créé la copie. |
versionNumber | Affiche le numéro de version. |
userComment | Affiche le commentaire associé à la version des paramètres de l'ensemble géré. |
isInUse | Affiche l'ID de la version des paramètres utilisée par l'ensemble géré. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
- Avec une liste Jython :
AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetMSSettingsVersion('-interactive')
dpRemoveMSSettingsVersion
La commande dpRemoveMSSettingsVersion supprime une version des paramètres gérés du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msSettingsVersionId
- Indique l'ID de la version des paramètres gérés à 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.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')
- Avec une liste Jython :
AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpRemoveMSSettingsVersion('-interactive')
dpSetMSSettings
La commande dpSetMSSettings modifie les paramètres gérés du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msSettingsId
- Indique l'ID des paramètres gérés à modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -desiredSettingsVersionId
- Indique l'ID de la version des paramètres à synchroniser avec chaque appliance de l'ensemble géré. (Chaîne, facultatif)
Valeur renvoyée
La commande renvoie l'ID de la tâche qu'elle a créée.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')
- Avec une liste Jython :
AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetMSSettings('-interactive')
dpSetMSSettingsVersion
La commande dpSetMSSettingsVersion modifie la version des paramètres gérés du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -msSettingsVersionId
- Indique l'ID de la version des paramètres gérés à modifier. (Chaîne, obligatoire)
Paramètres facultatifs
- -userComment
- Indique le commentaire à stocker dans la version des paramètres. (Chaîne, facultatif)
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.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new timeserver added"]')
- Avec une liste Jython :
AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has new timeserver added'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpSetMSSettingsVersion('-interactive')
dpGetAllTaskIds
La commande dpGetAllTaskIds affiche les ID de toutes les tâches du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Valeur renvoyée
La commande renvoie la liste des ID de tâches asynchrones qui existent actuellement dans le gestionnaire d'appliances DataPower.
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne et de la liste Jython :
AdminTask.dpGetAllTaskIds()
dpGetTask
La commande dpGetTask affiche des informations sur une tâche spécifique du gestionnaire d'appliances DataPower.
Objet cible
Aucun
Paramètres obligatoires
- -taskId
- Indique l'ID de la tâche qui vous intéresse. (Chaîne, obligatoire)
Valeur renvoyée
Attribut | Description |
---|---|
taskId | Affiche l'ID unique de la tâche. |
taskDescription | Affiche une description de la tâche. |
creationDate | Affiche la date et l'heure auxquelles le système a créé la tâche. |
createdByUser | Affiche l'utilisateur qui a créé la tâche. |
currentStep | Affiche le numéro de l'étape en cours pour la tâche considérée. |
currentStepDescription | Affiche une description de l'étape en cours. |
currentStepTimestamp | Affiche l'heure et la date auxquelles l'étape en cours a été le plus récemment mise à jour pour la tâche. Le système met à jour l'attribut currentTimeStamp lorsqu'il construit un objet, met à jour une étape, marque une tâche comme étant terminée ou recense une exception. |
error | Affiche le message d'erreur généré par l'exception qui a entraîné la fin d'une tâche, si applicable. |
totalSteps | Affiche le nombre total estimé des étapes pour la tâche considérée. N'utilisez pas cet argument pour déterminer si la tâche est terminée. Utilisez l'attribut isComplete pour déterminer si la tâche est terminée. |
hasError | Affiche la valeur true si la tâche ne s'est pas déroulée correctement. |
hasUpdate | Affiche la valeur true si la tâche a été mise à jour. |
isComplete | Affiche la valeur true si la tâche est terminée. |
taskStatus | Affiche un entier qui représente l'état de la tâche. Si le résultat est 0, cela signifie que la tâche est dans une file d'attente et que le système n'a pas démarré la tâche. Si le résultat est 1, cela signifie que la tâche est en cours d'exécution. Si le résultat est 2, cela signifie que la tâche s'est terminée avec succès. Si le résultat est 3, cela signifie que la tâche a rencontré une exception. |
result | Affiche le résultat renvoyé par la tâche. Reportez-vous à la commande en question pour déterminer si la commande renvoie une sortie. |
Exemple d'utilisation en mode de traitement par lots
- A l'aide de la chaîne Jython :
AdminTask.dpGetTask('-taskId 1')
- Avec une liste Jython :
AdminTask.dpGetTask(['-taskId', '1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpGetTask('-interactive')
dpPurgeTask
La commande dpPurgeTask purge une tâche spécifique du gestionnaire d'appliances DataPower. Le système supprime automatiquement les tâches au bout de 24 heures.
Objet cible
Aucun
Paramètres obligatoires
- -taskId
- Indique l'ID de la tâche appartenant au gestionnaire d'appliances DataPower que vous souhaitez purger. (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.dpPurgeTask('-taskId 1')
- Avec une liste Jython :
AdminTask.dpPurgeTask(['-taskId', '1'])
Exemple d'utilisation en mode interactif
- En langage Jython :
AdminTask.dpPurgeTask('-interactive')