Befehlsgruppe "dpManagerCommands" für das Objekt "AdminTask"

Sie können die Scripting-Sprache Jython verwenden, um den DataPower-Gerätemanager mit dem Tool "wsadmin" zu konfigurieren. Der IBM WebSphere DataPower-Gerätemanager stellt eine Reihe von Funktionen für die Verwaltung von DataPower-Geräten bereit. Verwenden Sie die Befehle und Parameter in der Gruppe "dpManagerCommands", um den DataPower-Gerätemanager abzufragen, zu konfigurieren und zu verwalten.

Die SOA-Geräte (SOA Appliances) von IBM® WebSphere® DataPower sind zweckgerichtete, einfach zu implementierende Netzgeräte zur Vereinfachung, Sicherung und Beschleunigung Ihrer XML- und Web-Service-Implementierungen. Wenn Sie den DataPower-Gerätemanager zum ersten Mal verwenden, sind keine Geräte, verwalteten Gruppen oder Firmware-Versionen vorhanden. Sie müssen Geräte erstellen, Firmware-Versionen hinzufügen und verwaltete Gruppe erstellen.

Vergewissern Sie sich, dass die Geräte, die Sie verwalten möchten, die Firmware-Version 3.6.0.4 oder eine höhere Version verwenden. Überprüfen Sie außerdem, ob der AMP-Endpunkt (Appliance Management Protocol) für jedes Gerät aktiviert ist. Wenn der AMP-Endpunkt der XML-Managementschnittstelle während der Installation inaktiviert wurde, aktivieren Sie ihn über die DataPower-WebGUI.

Anmerkung: Die DataPower-WebGUI unterscheidet sich vom DataPower-Gerätemanager in der Administrationskonsole.
Verwenden Sie die folgenden Befehle, um den DataPower-Gerätemanager zu verwalten:
Verwenden Sie die folgenden Befehle, um verwaltete Gruppen zu verwalten:
Verwenden Sie die folgenden Befehle, um Einstellungen und Einstellungsversionen zu verwalten:
Verwenden Sie die folgenden Befehle, um Tasks zu verwalten:

dpExport

Der Befehl "dpExport" exportiert die Konfiguration und Versionen des DataPower-Gerätemanagers.

Zielobjekt

Ohne.

Erforderliche Parameter

-file
Gibt die Datei im lokalen Dateisystem an, in die der DataPower-Gerätemanager die Konfiguration und Versionen exportiert. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID der vom System erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    [Windows]
    AdminTask.dpExport('-file c:/temp/DPManager.export_doc') 
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpExport('-file 
     /temp/DPManager.export')
  • Mit Jython (List):
    [Windows]
    AdminTask.dpExport(['-file', 'C:/temp/DPManager.export'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpExport(['-file', 
     '/temp/DPManager.export'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpExport('-interactive')

dpGetManager

Der Befehl "dpGetManager" zeigt die Eigenschaften des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die aktuellen Einstellungen des DataPower-Gerätemanagers enthält.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpGetManager()

dpGetManagerStatus

Der Befehl "dpGetManagerStatus" zeigt den Status des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt eine Beschreibung des DataPower-Gerätemanagerstatus zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpGetManagerStatus()

dpImport

Der Befehl "dpImport" importiert die Konfigurationen und Versionen des DataPower-Gerätemanagers. Der Befehl ersetzt die vorhandene Konfiguration und die vorhandenen Versionen durch die importierte Konfiguration und die importierten Versionen.

Zielobjekt

Ohne.

Erforderliche Parameter

-file
Gibt die Systemdatei des DataPower-Gerätemanagers an, die die Konfiguration und die Versionen für den Import enthält. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    [Windows]
    AdminTask.dpImport('-file c:/temp/DPManager.import')
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpImport('-file 
     /temp/DPManager.import')
  • Mit Jython (List):
    [Windows]
    AdminTask.dpImport(['-file', 'C:/temp/DPManager.export'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpImport(['-file', 
     '/temp/DPManager.export'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpImport('-interactive')

dpSetManager

Der Befehl "dpSetManager" ändert die Konfiguration des DataPower-Gerätemanagers.

Zielobjekt

Ohne.

Optionale Parameter

-maxVersionsToStore
Gibt die neue maximale Anzahl aufzubewahrender Versionen an. (Integer, optional)
-versionsDirectory
Gibt das Systemverzeichnis des DataPower-Gerätemanagers an, in dem der Manager die Versionen erstellt. Der Befehl verschiebt die vorhandenen Versionen aus dem Verzeichnis mit den aktuellen Versionen in das Verzeichnis mit den neuen Versionen. (String, optional)

Rückgabewerte

Wenn Sie einen Wert für den Parameter "versionsDirectory" angeben, gibt der Befehl die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetManager('-maxVersionsToStore 20 -versionsDirectory newDir')
  • Mit Jython (List):
    AdminTask.dpSetManager(['-maxVersionsToStore', '20', '-versionsDirectory', 'newDir'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetManager('-interactive')

dpStopManager

Der Befehl "dpStopManager" stoppt den DataPower-Gerätemanager. Der Manager wird automatisch erneut gestartet, wenn der DataPower-Gerätemanager das nächste Mal verwendet wird.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpStopManager()

dpAddAppliance

Der Befehl "dpAddAppliance" fügt dem DataPower-Gerätemanager ein Gerät hinzu.

Zielobjekt

Ohne.

Erforderliche Parameter

-hostname
Gibt den Hostnamen oder die IP-Adresse des Geräts an. (String, erforderlich)
-hlmPort
Gibt die Portnummer an, die der DataPower-Gerätemanager für die Kommunikation mit dem Gerät verwendet. Der Standardwert ist 5550. (Integer, erforderlich)
-name
Gibt den eindeutigen Namen des Geräts im DataPower-Gerätemanager an. Die folgenden Zeichen dürfen im Namensparameter nicht verwendet werden: \\/,#$@:;\"*?<>|=+&%' (String, erforderlich)
-userId
Gibt die Benutzer-ID an, die der DataPower-Gerätemanager verwendet, um auf das Gerät zuzugreifen. (String, erforderlich)
-password
Gibt das base-64-codierte Kennwort an, das der DataPower-Gerätemanager verwendet, um auf das Gerät zuzugreifen. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID der vom System erstellten Task zurück. Wenn die Task beendet wird, enthält der Wert des Ergebnisattributs in der Task die ID des neuen Geräts.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpAddAppliance('[-hostname myappliance.ibm.com – name myappliance -userId 
     admin -password mypassword]')
  • Mit Jython (List):
    AdminTask.dpAddAppliance(['-hostname', 'myappliance.ibm.com', '–name', 'myappliance', '-userId', '
      admin', '-password', 'mypassword'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpAddAppliance('-interactive')

dpGetAllApplianceIds

Der Befehl "dpGetAllApplianceIds" zeigt die ID jedes DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die jede Geräte-ID in Ihrer Konfiguration enthält. Für Geräte ist die ID die Seriennummer des DataPower-Geräts.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpGetAllApplianceIds()

dpGetAllMSApplianceIds

Der Befehl "dpGetAllMSApplianceIds" zeigt die IDs aller Geräte in einer verwalteten Gruppe des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der gewünschten verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die die IDs der Geräte in der gewünschten verwalteten Gruppe enthält.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllMSApplianceIds('[-managedSetId myManagedSet]')
  • Mit Jython (List):
    AdminTask.dpGetAllMSApplianceIds(['-managedSetId', 'myManagedSet'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllMSApplianceIds('-interactive')

dpGetAppliance

Der Befehl "dpGetAppliance" zeigt ein bestimmtes Gerät im DataPower-Gerätemanager an.

Zielobjekt

Ohne.

Erforderliche Parameter

-applianceId
Gibt die ID des Geräts im DataPower-Gerätemanager an, das angezeigt werden soll. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute des gewünschten Geräts enthält, wie in der folgenden Beispielausgabe gezeigt:
[ [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] ]
Tabelle 1. Befehlsattribute. Die folgende Tabelle enthält Beschreibungen der Attribute, die der Befehl zurückgibt:
Attribut Beschreibung
applianceId Zeigt die ID des gewünschten Geräts an.
managedSetId Zeigt die ID der verwaltete Gruppe an, zu der dieses Gerät gehört. Wenn das Gerät nicht verwaltet ist, gibt der Befehl dieses Attribut nicht zurück.
actualFirmwareLevel Zeigt die Version der Firmware des Geräts an.
featureLicenses Zeigt eine Liste mit Featureberechtigungen für das Gerät an, z. B. MQ, TAM usw.
guiPort Zeigt den Geräteport für die DataPower-WebGUI-Schnittstelle an.
hlmPort Zeigt die Portnummer für die Kommunikation zwischen dem DataPower-Gerätemanager und dem Gerät an.
hostname Zeigt den Hostnamen oder die IP-Adresse des Geräts an.
isManaged Zeigt den Wert true an, wenn der DataPower-Gerätemanager das Gerät verwaltet.
isMaster Zeigt den Wert true an, wenn das Gerät das Mastergerät in der verwalteten Gruppe ist. Diese Eigenschaft wird nicht angezeigt, wenn das Gerät nicht vom DataPower-Gerätemanager verwaltet wird.
modelType Zeigt den Modelltyp des Geräts an.
applianceType Zeigt den Gerätetyp an.
settingsManagementStatus Zeigt den Verwaltungsstatus der Einstellungen auf dem Gerät an. Dieses Attribut wird in der DataPower-WebGUI auch als Synchronisationsstatus bezeichnet.
firmwareManagementStatus Zeigt den Verwaltungsstatus der Firmware auf dem Gerät an. Dieses Attribut wird in der DataPower-WebGUI auch als Synchronisationsstatus bezeichnet.
domainManagementStatus Zeigt den Verwaltungsstatus einer bestimmten Domäne auf dem Gerät an. Dieses Attribut wird in der DataPower-WebGUI auch als Synchronisationsstatus bezeichnet.
domainOperationalStatus Zeigt den Betriebsstatus einer bestimmten Domäne auf dem Gerät an.
rollupManagementStatus Zeigt den zusammengefassten Verwaltungsstatus der Firmware, Einstellungen und Domänen auf dem Gerät an. Dieses Attribut wird in der DataPower-WebGUI auch als Synchronisationsstatus bezeichnet.
rollupOperationalStatus Zeigt den zusammengefassten Betriebsstatus der Firmware, Einstellungen und Domänen auf dem Gerät an.
serialNumber Zeigt die Seriennummer des gewünschten Geräts an.
name Zeigt den Namen des Geräts im DataPower-Gerätemanager an.
userId Zeigt die Benutzer-ID an, die der DataPower-Gerätemanager für den Zugriff auf das Gerät verwendet.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAppliance('-applianceId "00605 20356"')
  • Mit Jython (List):
    AdminTask.dpGetAppliance(['-applianceId', '00605 20356']) 

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAppliance('-interactive')

dpManageAppliance

Der Befehl "dpManageAppliance" fügt das Gerät einer verwalteten Gruppe hinzu und startet die Verwaltung des Geräts.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der verwalteten Gruppe an, zu der das Gerät gehört. (String, erforderlich)
-applianceId
Gibt die ID des Geräts im DataPower-Gerätemanager an, das der verwalteten Gruppe hinzugefügt werden soll. (String, erforderlich)

Optionale Parameter

-asMaster
Gibt an, ob das Gerät als Mastergerät der verwalteten Gruppe definiert werden soll. Wenn dieser Parameter nicht angegeben wird, wird das erste Gerät, das der verwalteten Gruppe hinzugefügt wird, als Mastergerät festgelegt. (String, optional)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück. Nach Abschluss der Task entspricht der Wert des Ergebnisattributs der ID des Geräts.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpManageAppliance('-managedSetId testMS1 -applianceId "00605 20351"')
  • Mit Jython (List):
    AdminTask.dpManageAppliance(['-managedSetId', 'testMS1', '-applianceId', '00605 20351'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpManageAppliance('-interactive')

dpRemoveAppliance

Der Befehl "dpRemoveAppliance" entfernt ein Gerät aus dem DataPower-Gerätemanager. Der Befehl entfernt das Gerät auch aus einer verwalteten Gruppe, wenn es zu einer solchen gehört. Ein Gerät, das das Mastergerät einer verwalteten Gruppe ist, kann nicht entfernt werden. Sie müssen ein anderes Gerät als Mastergerät auswählen, bevor Sie ein Mastergerät entfernen.

Zielobjekt

Ohne.

Erforderliche Parameter

-applianceId
Gibt die ID des Geräts im DataPower-Gerätemanager an, das aus der verwalteten Gruppe entfernt werden soll. Für Geräte ist die ID die Seriennummer des DataPower-Geräts. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpRemoveAppliance('[-applianceId "00605 20356"]')
  • Mit Jython (List):
    AdminTask.dpRemoveAppliance(['-applianceId', '00605 20356'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpRemoveAppliance('-interactive')

dpSetAppliance

Der Befehl "dpSetAppliance" ändert die DataPower-Gerätemanagerkonfiguration für ein Gerät.

Zielobjekt

Ohne.

Erforderliche Parameter

-applianceId
Gibt die ID des Geräts im DataPower-Gerätemanager an, das geändert werden soll. (String, erforderlich)

Optionale Parameter

-hostname
Gibt den Hostnamen oder die IP-Adresse des Geräts an. (String, optional)
-hlmPort
Gibt die Portnummer an, die der DataPower-Gerätemanager für die Kommunikation mit dem Gerät verwendet. Der Standardwert ist 5550. (Integer, optional)
-name
Gibt den eindeutigen Namen des Geräts im DataPower-Gerätemanager an. Die folgenden Zeichen dürfen im Namensparameter nicht verwendet werden: \\/,#$@:;\"*?<>|=+&%' (String, optional)
-userId
Gibt die Benutzer-ID an, die der DataPower-Gerätemanager verwendet, um auf das Gerät zuzugreifen. (String, optional)
-password
Gibt das base-64-codierte Kennwort an, das der DataPower-Gerätemanager verwendet, um auf das Gerät zuzugreifen. (String, optional)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetAppliance('[-applianceId "00605 20356" -hostname myappliance2.ibm.com 
     -name myappliance2 -hlmPort 4500 -userId admin2 -password myPassword]')
  • Mit Jython (List):
    AdminTask.dpSetAppliance(['-applianceId', '00605 20356', '-hostname', 
     'myappliance2.ibm.com', '-name', 'myappliance2', '-hlmPort', '4500', '-userId', 'admin2', 
     '-password', 'myPassword']) 

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetAppliance('-interactive')

dpUnmanageAppliance

Der Befehl "dpUnmanageAppliance" entfernt das gewünschte Gerät aus seiner verwalteten Gruppe. Das Gerät ist danach nicht mehr verwaltet, bleibt aber im Manager definiert.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der verwalteten Gruppe an, zu der das Gerät gehört. (String, erforderlich)
-applianceId
Gibt die ID des Geräts im DataPower-Gerätemanager an, das aus der verwalteten Gruppe entfernt werden soll. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die vom Befehl erstellte Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpUnmanageAppliance('[-managedSetId testMS1 -applianceId "00605 
     20351"]')
  • Mit Jython (List):
    AdminTask.dpUnmanageAppliance(['-managedSetId', 'testMS1', '-applianceId "00605 20351"'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpUnmanageAppliance('-interactive')

dpAddManagedSet

Der Befehl "dpAddManagedSet" fügt dem DataPower-Gerätemanager eine verwaltete Gruppe hinzu.

Zielobjekt

Ohne.

Erforderliche Parameter

-name
Gibt den eindeutigen Namen des Geräts im DataPower-Gerätemanager an. Die folgenden Zeichen dürfen im Namensparameter nicht verwendet werden: \\/,#$@:;\"*?<>|=+&%' (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpAddManagedSet('-name testMS')
  • Mit Jython (List):
    AdminTask.dpAddManagedSet(['-name testMS'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpAddManagedSet('-interactive')

dpGetAllManagedSetIds

Der Befehl "dpGetAllManagedSetIds" zeigt die IDs aller verwalteten Gruppen im DataPower-Gerätemanager an.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die die IDs aller verwalteten Gruppen enthält.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpGetAllManagedSetIds()

dpGetManagedSet

Der Befehl "dpGetManagedSet" zeigt Informationen für eine bestimmte verwaltete Gruppe im DataPower-Gerätemanager an.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der gewünschten verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute für die verwaltete Gruppe enthält.
Tabelle 2. Befehlsattribute. Die folgende Tabelle enthält weitere Informationen zu den Attributen, die der Befehl zurückgibt:
Attribut Beschreibung
managedSetId Zeigt die ID der verwalteten Gruppe an.
masterApplianceId Zeigt die ID des Mastergeräts in der verwalteten Gruppe an.
desiredFirmwareVersionId Zeigt die ID der Firmware-Version an, die für die verwaltete Gruppe verwendet wird.
name Zeigt den Namen an, der der verwalteten Gruppe zugeordnet ist.
rollupOperationalStatus Zeigt den Betriebsstatus der verwalteten Gruppe an.
rollupManagementStatus Zeigt den Verwaltungsstatus der verwalteten Gruppe an.
settingsId Zeigt die ID der Einstellungen für die verwaltete Gruppe an.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetManagedSet('-managedSetId testMS1')
  • Mit Jython (List):
    AdminTask.dpGetManagedSet(['-managedSetId', 'testMS1']) 

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetManagedSet('-interactive')

dpRemoveManagedSet

Der Befehl "dpRemoveManagedSet" entfernt eine verwaltete Gruppe aus dem DataPower-Gerätemanager.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der zu entfernenden verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpRemoveManagedSet('-managedSetId  testMS')
  • Mit Jython (List):
    AdminTask.dpRemoveManagedSet(['-managedSetId', 'testMS'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpRemoveManagedSet('-interactive')

dpSetManagedSet

Der Befehl "dpSetManagedSet" ändert eine verwaltete Gruppe im DataPower-Gerätemanager.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der zu ändernden verwalteten Gruppe an. (String, erforderlich)

Optionale Parameter

-masterApplianceId
Gibt die ID des Geräts an, das als Mastergerät für die verwaltete Gruppe definiert werden soll. Dieses Gerät muss Member der verwalteten Gruppe sein. Dieser Parameter und der Parameter "desiredFirmwareVersionId" schließen sich gegenseitig aus. (String, optional)
-desiredFirmwareVersionId
Gibt die ID der Firmware-Version an, die auf jedem Gerät in der verwalteten Gruppe synchronisiert werden soll. Dieser Parameter und der Parameter "masterApplianceId" schließen sich gegenseitig aus. (String, optional)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetManagedSet('-managedSetId myManagedSet -masterApplianceId "00605 
     20356"')
  • Mit Jython (List):
    AdminTask.dpSetManagedSet(['-managedSetId', 'myManagedSet', '-masterApplianceId', '"00605 20356"'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetManagedSet('-interactive')

dpSynchManagedSet

Der Befehl "dpSynchManagedSet" synchronisiert die verwaltete Gruppe im DataPower-Gerätemanager manuell. Der Manager versucht, die Membereinheiten automatisch zu synchronisieren.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der zu synchronisierenden verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSynchManagedSet('-managedSetId myManagedSet')
  • Mit Jython (List):
    AdminTask.dpSynchManagedSet(['-managedSetId', 'myManagedSet'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSynchManagedSet('-interactive')

dpAddFirmwareVersion

Der Befehl "dpAddFirmwareVersion" fügt dem DataPower-Gerätemanager eine Firmware-Version hinzu.

Zielobjekt

Ohne.

Erforderliche Parameter

-file
Gibt die Datei im Dateisystem des DataPower-Gerätemanagers an, die das Firmware-Image enthält, das in der Firmware-Version gespeichert werden soll. (String, erforderlich)

Optionale Parameter

-userComment
Gibt den Kommentar an, der in der Firmware-Version gespeichert werden soll. (String, optional)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück. Nach Abschluss der Task entspricht der Wert des Ergebnisattributs der ID der neuen Firmware-Version.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    [Windows]
    AdminTask.dpAddFirmwareVersion('[-file 
     "C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpAddFirmwareVersion('[-file 
     "/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2" -userComment "my new firmware"]')
  • Mit Jython (List):
    [Windows]
    AdminTask.dpAddFirmwareVersion(['-file', 
     '"C:/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])
    [AIX][Solaris][Linux][HP-UX][IBM i][z/OS]
    AdminTask.dpAddFirmwareVersion(['-file', 
     '"/temp/dptestFW/dev-xs-143863-3_6_0_15.scrypt2"', '-userComment', '"my new firmware"'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpAddFirmwareVersion('-interactive')

dpGetAllFirmwareIds

Der Befehl "dpGetAllFirmwareIds" zeigt alle Firmware-IDs des DataPower-Gerätemanagers in der Konfiguration an.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe für jede Firmware-ID in der Konfiguration des DataPower-Gerätemanagers zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpGetAllFirmwareIds()

dpGetAllFirmwareVersionIds

Der Befehl "dpGetAllFirmwareVersionIds" zeigt die IDs aller Firmware-Versionen im DataPower-Gerätemanager an. Eine Firmware-Version stellt ein Firmware-Image dar, das Sie auf einem DataPower-Gerät implementieren können.

Zielobjekt

Ohne.

Erforderliche Parameter

-firmwareId
Gibt die ID der abzufragenden Firmware an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die alle Firmware-Versionen in Ihrer Konfiguration enthält.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllFirmwareVersionIds('-firmwareId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
  • Mit Jython (List):
    AdminTask.dpGetAllFirmwareVersionIds(['-firmwareId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllFirmwareVersionIds('-interactive')

dpGetAllMSIdsUsingFirmwareVersion

Der Befehl "dpGetAllMSIdsUsingFirmwareVersion" zeigt die IDs der verwalteten Gruppen an, die eine Firmware-Version verwenden.

Zielobjekt

Ohne.

Erforderliche Parameter

-firmwareVersionId
Gibt die ID der gewünschten Firmware-Version an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die die IDs der verwalteten Gruppen enthält, die die gewünschte Firmware-Version verwenden.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Mit Jython (List):
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllMSIdsUsingFirmwareVersion('-interactive')

dpGetBestFirmware

Der Befehl "dpGetBestFirmware" zeigt die Firmware im DataPower-Gerätemanager an, die den Parametern am besten entspricht. Die Firmware im DataPower-Gerätemanager enthält eine oder mehrere Firmware-Versionen, die unterschiedliche Versionen der Firmeware darstellen. Der Befehl identifiziert nicht das optimale Firmware-Release von DataPower. Der Befehl identifiziert die Firmware-Version, die dem Gerät entspricht.

Zielobjekt

Ohne.

Erforderliche Parameter

-applianceType
Gibt den Gerätetyp des DataPower-Geräts an, für das die Firmware angezeigt werden soll. (String, erforderlich)
-modelType
Gibt den Modelltyp des DataPower-Geräts an, für das die Firmware angezeigt werden soll. (String, erforderlich)
-applianceFeatures
Gibt die Gerätefeatures des DataPower-Geräts an, für das die Firmware angezeigt werden soll. (String, erforderlich)

Optionale Parameter

-level
Gibt den Stand der Firmware-Version an, der für die Firmware zurückgegeben werden soll. (String, optional)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute der Firmware enthält.
Tabelle 3. Befehlsattribute. In der folgenden Tabelle sind die vom Befehl zurückgegebenen Attribute beschrieben:
Attribut Beschreibung
firmwareId Zeigt die Firmware-ID an.
applianceType Zeigt den Gerätetyp an, für den die Firmware verwendet wird.
modelType Zeigt den Modelltyp der Firmware an.
strictFeatures Zeigt die strikten Features an, für die die Firmware verwendet wird.
nonStrictFeatures Zeigt die nicht strikten Features an, für die die Firmware verwendet wird.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetBestFirmware('-applianceType "XS40" -modelType "9002" 
     -applianceFeatures "JAXP-API" -level "3.6.0.4"')
  • Mit Jython (List):
    AdminTask.dpGetBestFirmware(['-applianceType', 'XS40', '-modelType', '9002', 
     '-applianceFeatures', 'JAXP-API', '-level', '3.6.0.4'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetBestFirmware('-interactive')

dpGetFirmware

Der Befehl "dpGetFirmware" zeigt Attribute für eine bestimmte Firmware des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-firmwareId
Gibt die ID der gewünschten Firmware an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute der gewünschten Firmware enthält.
Tabelle 4. Befehlsattribute. In der folgenden Tabelle sind die vom Befehl zurückgegebenen Attribute beschrieben:
Attribut Beschreibung
firmwareId Zeigt die Firmware-ID an.
applianceType Zeigt den Gerätetyp an, für den die Firmware verwendet wird.
modelType Zeigt den Modelltyp der Firmware an.
strictFeatures Zeigt die strikten Features an, für die die Firmware verwendet wird.
nonStrictFeatures Zeigt die nicht strikten Features an, für die die Firmware verwendet wird.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetFirmware('-firmwareId "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;"')
  • Mit Jython (List):
    AdminTask.dpGetFirmware(['-firmwareId', 'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetFirmware('-interactive')

dpGetFirmwareVersion

Der Befehl "dpGetFirmwareVersion" zeigt eine bestimmte Firmware-Version des DataPower-Gerätemanagers an. Eine Firmware-Version stellt ein Firmware-Image dar, das Sie auf einem DataPower-Gerät implementieren können.

Zielobjekt

Ohne.

Erforderliche Parameter

-firmwareVersionId
Gibt die ID der gewünschten Firmware-Version an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute der Firmware-Version enthält.
Tabelle 5. Befehlsattribute. Die folgende Tabelle enthält weitere Informationen zu den vom Befehl zurückgegebenen Attributen:
Attribut Beschreibung
firmwareVersionId Zeigt die ID der Firmware-Version an.
firmareId Zeigt die ID der Firmware an, die die Firmware-Version enthält.
level Zeigt den Stand der Firmware an.
manufactureDate Zeigt das Datum an, an dem die Firmware hergestellt wurde.
timestamp Zeigt das Datum an, an dem das Firmware-Image in den DataPower-Gerätemanager geladen wurde.
userComment Zeigt den Kommentar an, der mit der Firmware-Version gespeichert wird.
isInUse Zeigt an, ob eine verwaltete Gruppe die Firmware-Version verwendet.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Mit Jython (List):
    AdminTask.dpGetFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetFirmwareVersion('-interactive')

dpRemoveFirmwareVersion

Der Befehl "dpRemoveFirmwareVersion" entfernt eine Firmware-Version aus dem DataPower-Gerätemanager. Die Firmware, die das System der Firmware-Version zuordnet, bleibt erhalten. Vergewissern Sie sich, dass die zu entfernende Firmware-Version von keiner verwalteten Gruppe verwendet wird, bevor Sie diesen Befehl ausführen.

Zielobjekt

Ohne.

Erforderliche Parameter

-firmwareVersionId
Gibt die ID der zu entfernenden Firmware-Version an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpRemoveFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15"')
  • Mit Jython (List):
    AdminTask.dpRemoveFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpRemoveFirmwareVersion('-interactive')

dpSetFirmwareVersion

Der Befehl "dpSetFirmwareVersion" ändert eine Firmware-Version im DataPower-Gerätemanager.

Zielobjekt

Ohne.

Erforderliche Parameter

-firmwareVersionId
Gibt die ID der zu ändernden Firmware-Version an. (String, erforderlich)

Optionale Parameter

-userComment
Gibt den Kommentar an, der in der Firmware-Version gespeichert werden soll. (String, optional)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetFirmwareVersion('-firmwareVersionId 
     "XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15" -userComment "new user comment"')
  • Mit Jython (List):
    AdminTask.dpSetFirmwareVersion(['-firmwareVersionId', 
     'XS40:9002::DataGlue;JAXP-API;PKCS7-SMIME;HSM;:3.6.0.15', '-userComment', 'new user comment'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetFirmwareVersion('-interactive')

dpCopyMSDomainVersion

Der Befehl "dpCopyMSDomainVersion" kopiert eine Version einer verwalteten Domäne des DataPower-Gerätemanagers in eine neue verwaltete Gruppe.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der gewünschten verwalteten Gruppe an. (String, erforderlich)
-msDomainVersionId
Gibt die ID der zu kopierenden Version der verwalteten Domäne an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpCopyMSDomainVersion('[-managedSetId myManagedSet -msDomainVersionId "myManagedSet:default:1"]')
  • Mit Jython (List):
    AdminTask.dpCopyMSDomainVersion(['-managedSetId', 'myManagedSet', '-msDomainVersionId', 'myManagedSet:default:1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpCopyMSDomainVersion('-interactive')

dpGetAllDomainNames

Der Befehl "dpGetAllDomainNames" zeigt die Namen aller Domänen eines DataPower-Geräts an.

Zielobjekt

Ohne.

Erforderliche Parameter

-applianceId
Gibt die ID des Geräts im DataPower-Gerätemanager an, das angezeigt werden soll. (String, erforderlich)

Optionale Parameter

-managed
Gibt an, ob die verwalteten Domänen zurückgegeben werden sollen. Der Befehl gibt den Namen aller Domänen auf dem Gerät an, wenn Sie die Parameter "managed" oder "unmanaged" nicht oder wenn Sie beide Parameter angeben. (String, optional)
-unmanaged
Gibt an, ob der Befehl die nicht verwalteten Domänen zurückgeben soll. Der Befehl gibt den Namen aller Domänen auf dem Gerät an, wenn Sie die Parameter "managed" oder "unmanaged" nicht oder wenn Sie beide Parameter angeben. (String, optional)

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe mit den Namen der Domänen auf dem Gerät zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllDomainNames('[-applianceId "00605 20356" -managed -unmanaged]')
  • Mit Jython (List):
    AdminTask.dpGetAllDomainNames(['-applianceId', '00605 20356', '-managed', 
     '-unmanaged'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllDomainNames('-interactive')

dpGetAllMSDomainIds

Der Befehl "dpGetAllMSDomainIds" zeigt die IDs aller Domänen in einer verwalteten Gruppe des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der gewünschten verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die die IDs der Domänen in der verwalteten Gruppe enthält.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllMSDomainIds('[-managedSetId myManagedSet]')
  • Mit Jython (List):
    AdminTask.dpGetAllMSDomainIds(['-managedSetId', 'myManagedSet'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllMSDomainIds('-interactive')

dpGetAllMSDomainVersionIds

Der Befehl "dpGetAllMSDomainVersionIds" zeigt die IDs aller Domänenversionen für eine Domäne in einer verwalteten Gruppe des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainId
Gibt die ID der anzuzeigenden verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID jeder Domänenversion zurück, die für die Domäne der verwalteten Gruppe vorhanden ist.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllMSDomainVersionIds('[-msDomainId ms1:domain1]')
  • Mit Jython (List):
    AdminTask.dpGetAllMSDomainVersionIds(['-msDomainId', 'ms1:domain1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllMSDomainVersionIds('-interactive')

dpGetMSDomain

Der Befehl "dpGetMSDomain" zeigt eine Domäne in einer verwalteten Gruppe des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainId
Gibt die ID der anzuzeigenden verwalteten Gruppe an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute für die gewünschte Domäne der verwalteten Gruppe enthält.
Tabelle 6. Befehlsattribute. Die folgende Tabelle enthält weitere Informationen zu den vom Befehl zurückgegebenen Attributen:
Attribut Beschreibung
msDomainId Zeigt die ID der Domäne an.
managedSetId Zeigt die ID der verwalteten Gruppe an, zu der die Domäne gehört.
name Zeigt den Namen der domäne an.
desiredDomainVersionId Zeigt die ID der Domänenversion an, die die verwaltete Gruppe für die Domäne verwendet.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetMSDomain('[-msDomainId ms1:domain1]')
  • Mit Jython (List):
    AdminTask.dpGetMSDomain(['-msDomainId', 'ms1:domain1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetMSDomain('-interactive')

dpGetMSDomainVersion

Der Befehl "dpGetMSDomainVersion" zeigt eine verwaltete Domänenversion des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainVersionId
Gibt die ID der gewünschten verwalteten Domänenversion an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute der gewünschten Domänenversion der verwalteten Gruppe enthält.
Tabelle 7. Befehlsattribute. Die folgende Tabelle enthält weitere Informationen zu den Attributen, die der Befehl zurückgibt:
Attribut Beschreibung
msDomainVersionId Zeigt die ID der verwalteten Domänenversion an.
msDomainId Zeigt die ID der verwalteten Domäne an.
versionNumber Zeigt die Versionsnummer an.
timestamp Zeigt das Datum an, an dem das System die Kopie erstellt hat.
userComment Zeigt den Kommentar an, der mit der Domänenversion der verwalteten Gruppe gespeichert wird.
isInUse Zeigt an, ob die verwaltete Gruppe die Domänenversion für die Domäne verwendet.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
  • Mit Jython (List):
    AdminTask.dpGetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetMSDomainVersion('-interactive')

dpManageDomain

Der Befehl "dpManageDomain" fügt die Domäne einer verwalteten Gruppe hinzu und startet die Verwaltung der Domäne.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der zu verwaltenden verwalteten Gruppe an. (String, erforderlich)
-domain
Gibt den Namen der zu verwaltenden Domäne auf dem Mastergerät an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück. Nach Abschluss der Task entspricht der Wert des Ergebnisattributs der ID der neuen Domäne.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpManageDomain('[-managedSetId testMS1 -domain default]') 
  • Mit Jython (List):
    AdminTask.dpManageDomain(['-managedSetId', 'testMS1', '-domain', 'default']) 

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpManageDomain('-interactive')

dpRemoveMSDomainVersion

Der Befehl "dpRemoveMSDomainVersion" entfernt eine verwaltete Domänenversion aus dem DataPower-Gerätemanager.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainVersionId
Gibt die ID der zu entfernenden verwalteten Domänenversion an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpRemoveMSDomainVersion('[-msDomainVersionId ms1:domain1:1]')
  • Mit Jython (List):
    AdminTask.dpRemoveMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpRemoveMSDomainVersion('-interactive')

dpSetMSDomain

Der Befehl "dpSetMSDomain" ändert die verwaltete Domäne eines DataPower-Gerätemanagers.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainId
Gibt die ID der zu ändernden verwalteten Domäne an. (String, erforderlich)

Optionale Parameter

-desiredDomainVersionId
Gibt die ID der auf den Geräten in der verwalteten Gruppe zu synchronisierenden Domänenversion an. (String, optional)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetMSDomain('[-msDomainId  ms1:domain1 -desiredDomainVersionId ms1:domain1:1]')
  • Mit Jython (List):
    AdminTask.dpSetMSDomain(['-msDomainId', 'ms1:domain1', '-desiredDomainVersionId', 'ms1:domain1:1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetMSDomain('-interactive')

dpSetMSDomainVersion

Der Befehl "dpSetMSDomainVersion" ändert eine verwaltete Domänenversion des DataPower+-Gerätemanagers.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainVersionId
Gibt die ID der zu ändernden verwalteten Domänenversion an. (String, erforderlich)

Optionale Parameter

-userComment
Gibt den Kommentar an, der in der Domänenversion gespeichert werden soll. (String, optional)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetMSDomainVersion('[-msDomainVersionId ms1:domain1:2 -userComment "New Web 
     Service proxy for banking application"]')
  • Mit Jython (List):
    AdminTask.dpSetMSDomainVersion(['-msDomainVersionId', 'ms1:domain1:2',  '-userComment', 
     'New web service proxy for banking application'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetMSDomainVersion('-interactive')

dpUnmanageDomain

Der Befehl "dpUnmanageDomain" entfernt die Domäne aus einer verwalteten Gruppe und stoppt die Verwaltung der Domäne.

Zielobjekt

Ohne.

Erforderliche Parameter

-msDomainId
Gibt die ID der verwalteten Domäne an, die aus der verwaltetne Gruppe entfernt werden soll. (String, erforderlich)

Optionale Parameter

-clean
Löscht die Domäne von jedem Gerät in der verwalteten Gruppe. (String, optional)

Rückgabewerte

Wenn Sie den Parameter clean angeben, gibt der Befehl die ID der vom System erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpUnmanageDomain('-msDomainId testMS1:default -clean')
  • Mit Jython (List):
    AdminTask.dpUnmanageDomain(['-msDomainId', 'testMS1:default', '-clean'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpUnmanageDomain('-interactive')

dpCopyMSSettingsVersion

Der Befehl "dpCopyMSSettingsVersion" kopiert eine verwaltete Einstellungsversion des DataPower-Gerätemanagers in eine neue verwaltete Gruppe.

Zielobjekt

Ohne.

Erforderliche Parameter

-managedSetId
Gibt die ID der gewünschten verwalteten Gruppe an. (String, erforderlich)
-msSettingsVersionId
Gibt die ID der zu kopierenden verwalteten Einstellungsversion an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpCopyMSSettingsVersion('[-managedSetId myManagedSet -msSettingsVersionId "myManagedSet1:1"]')
  • Mit Jython (List):
    AdminTask.dpCopyMSSettingsVersion(['-managedSetId', 'myManagedSet', ,-msSettingsVersionId', 
     'myManagedSet1:1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpCopyMSSettingsVersion('-interactive')

dpGetAllMSSettingsVersionIds

Der Befehl "dpGetAllMSSettingsVersionIds" zeigt die IDs aller Einstellungsversionen in einer verwalteten Gruppe des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-msSettingsId
Gibt die ID der gewünschten verwalteten Einstellungen an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt eine Zeichenfolgenfeldgruppe zurück, die die IDs der Versionen der gewünschten Einstellungen enthält.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetAllMSSettingsVersionIds('-msSettingsId ms1:2')
  • Mit Jython (List):
    AdminTask.dpGetAllMSSettingsVersionIds(['-msSettingsId', 'ms1:2'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetAllMSSettingsVersionIds('-interactive')

dpGetMSSettings

Der Befehl "dpGetMSSettings" zeigt die ID der verwalteten Gruppe an, zu der die Einstellungen gehören.

Zielobjekt

Ohne.

Erforderliche Parameter

-msSettingsId
Gibt die ID der gewünschten verwalteten Einstellungen an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute der gewünschten Einstellungen enthält.
Tabelle 8. Befehlsattribute. Die folgende Tabelle enthält weitere Informationen zu den Attributen, die der Befehl zurückgibt:
Attribut Beschreibung
msSettingsId Zeigt die ID der Einstellungen an.
managedSetId Zeigt die ID der verwalteten Gruppe an, der die Einstellungen zugeordnet sind.
desiredSettingsVersionId Zeigt die ID der Einstellungsversion an, die die verwaltete Gruppe verwendet.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetMSSettings('-msSettingsId ms1:2')
  • Mit Jython (List):
    AdminTask.dpGetMSSettings(['-msSettingsId', 'ms1:2'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetMSSettings('-interactive')

dpGetMSSettingsVersion

Der Befehl "dpGetMSSettingsVersion" zeigt eine verwaltete Einstellungsversion des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-msSettingsVersionId
Gibt die ID der gewünschten verwalteten Einstellungsversion an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt ein Eigenschaftenobjekt zurück, das die Attribute der gewünschten verwalteten Einstellungsversion enthält.
Tabelle 9. Befehlsattribute. Die folgende Tabelle enthält weitere Informationen zu den Attributen, die der Befehl zurückgibt:
Attribut Beschreibung
msSetSettingsVersionId Zeigt die ID der Einstellungsversion der verwalteten Gruppe an.
msSettingsId Zeigt die ID der gewünschten Einstellungen der verwalteten Gruppe an.
timestamp Zeigt das Datum an, an dem das System die Kopie erstellt hat.
versionNumber Zeigt die Nummer der Version an.
userComment Zeigt den Kommentar an, der der Einstellungsversion der verwalteten Gruppe zugeordnet ist.
isInUse Zeigt die ID der Einstellungsversion an, die die verwaltete Gruppe verwendet.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetMSSettingsVersion('-msSettingsVersionId ms1:2')
  • Mit Jython (List):
    AdminTask.dpGetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetMSSettingsVersion('-interactive')

dpRemoveMSSettingsVersion

Der Befehl "dpRemoveMSSettingsVersion" entfernt eine verwaltete Einstellungsversion aus dem DataPower-Gerätemanager.

Zielobjekt

Ohne.

Erforderliche Parameter

-msSettingsVersionId
Gibt die ID der zu entfernenden verwalteten Einstellungsversion an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpRemoveMSSettingsVersion('-msSettingsVersionId ms1:2')
  • Mit Jython (List):
    AdminTask.dpRemoveMSSettingsVersion(['-msSettingsVersionId', 'ms1:2'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpRemoveMSSettingsVersion('-interactive')

dpSetMSSettings

Der Befehl "dpSetMSSettings" ändert die verwalteten Einstellungen des DataPower-Gerätemanagers.

Zielobjekt

Ohne.

Erforderliche Parameter

-msSettingsId
Gibt die ID der zu ändernden verwalteten Einstellungen an. (String, erforderlich)

Optionale Parameter

-desiredSettingsVersionId
Gibt die ID der auf allen Geräten in der verwalteten Gruppe zu synchronisierenden Einstellungsversion an. (String, optional)

Rückgabewerte

Der Befehl gibt die ID der vom Befehl erstellten Task zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetMSSettings('-msSettingsId ms1 -desiredSettingsVersionId ms1:1')
  • Mit Jython (List):
    AdminTask.dpSetMSSettings(['-msSettingsId', 'ms1', '-desiredSettingsVersionId', 'ms1:1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetMSSettings('-interactive')

dpSetMSSettingsVersion

Der Befehl "dpSetMSSettingsVersion" ändert die verwaltete Einstellungsversion des DataPower-Gerätemanagers.

Zielobjekt

Ohne.

Erforderliche Parameter

-msSettingsVersionId
Gibt die ID der zu ändernden verwalteten Einstellungsversion an. (String, erforderlich)

Optionale Parameter

-userComment
Gibt den Kommentar an, der in der Einstellungsversion gespeichert werden soll. (String, optional)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpSetMSSettingsVersion('[-msSettingsVersionId ms1:2 -userComment "has new 
     timeserver added"]')
  • Mit Jython (List):
    AdminTask.dpSetMSSettingsVersion(['-msSettingsVersionId', 'ms1:2', '-userComment', 'has 
     new timeserver added'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpSetMSSettingsVersion('-interactive')

dpGetAllTaskIds

Der Befehl "dpGetAllTaskIds" zeigt die IDs aller Tasks des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Rückgabewerte

Der Befehl gibt eine Liste mit den IDs aller asynchronen Tasks zurück, die im DataPower-Gerätemanager vorhanden sind.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String und List):
    AdminTask.dpGetAllTaskIds()

dpGetTask

Der Befehl "dpGetTask" zeigt Informationen für eine bestimmte Task des DataPower-Gerätemanagers an.

Zielobjekt

Ohne.

Erforderliche Parameter

-taskId
Gibt die ID der gewünschten Task an. (String, erforderlich)

Rückgabewerte

Tabelle 10. Befehlsattribute. Der Befehl gibt Informationen zur gewünschten asynchronen Task, einschließlich der folgenden Attribute, zurück:
Attribut Beschreibung
taskId Zeigt die eindeutige ID der Task an.
taskDescription Zeigt eine Beschreibung der Task an.
creationDate Zeigt das Datum, einschließlich Uhrzeit, an, an dem das System die Task erstellt hat.
createdByUser Zeigt den Benutzer an, der die Task erstellt hat.
currentStep Zeigt die Nummer des aktuellen Schritts für die Task an.
currentStepDescription Zeigt eine Beschreibung des aktuellen Schritts an.
currentStepTimestamp Zeigt das Datum, einschließlich der Uhrzeit an, an dem der aktuelle Schritt der Task zuletzt aktualisiert wurde. Das System aktualisiert das Attribut currentTimeStamp, wenn das System das Objekt erstellt, einen Schritt aktualisiert, die Task als abgeschlossen markiert oder eine Ausname feststellt.
error Zeigt eine Fehlernachricht zur Ausnahme an, die zum Beenden der Task geführt hat.
totalSteps Zeigt die geschätzte Anzahl der Schritte für die Task an. Verwenden Sie dieses Argument nicht, um festzustellen, ob die Task abgeschlossen ist. Verwenden Sie das Attribut isComplete, um festzustellen, ob die Task abgeschlossen ist.
hasError Zeigt den Wert true an, wenn die Task nicht erfolgreich abgeschlossen wurde.
hasUpdate Zeigt den Wert true an, wenn die Task aktualisiert wird.
isComplete Zeigt den Wert true an, wenn die Task abgeschlossen ist.
taskStatus Zeigt eine ganze Zahl an, die den Status der Task darstellt. Wenn der zurückgegebene Wert 0 lautet, befindet sich die Task in einer Warteschlange, und das System hat die Task nicht gestartet. Lautet der zurückgegebene Wert 1, ist die Task in Bearbeitung. Wenn der zurückgegebene Wert 2 lautet, wurde die Task erfolgreich abgeschlossen. Lautet der zurückgegebene Wert 3, ist bei der Ausführung der Task eine Ausnahme eingetreten.
result Zeigt das von der Task zurückgegebene Ergebnis an. Verwenden Sie den jeweiligen Befehl, um festzustellen, ob der Befehl eine Ausgabe zurückgibt.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpGetTask('-taskId 1')
  • Mit Jython (List):
    AdminTask.dpGetTask(['-taskId', '1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpGetTask('-interactive')

dpPurgeTask

Der Befehl "dpPurgeTask" löscht eine bestimmte Task des DataPower-Gerätemanagers. Das System löscht Tasks automatisch nach 24 Stunden.

Zielobjekt

Ohne.

Erforderliche Parameter

-taskId
Gibt die ID der aus dem DataPower-Gerätemanager zu löschenden Task an. (String, erforderlich)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.dpPurgeTask('-taskId 1')
  • Mit Jython (List):
    AdminTask.dpPurgeTask(['-taskId', '1'])

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    AdminTask.dpPurgeTask('-interactive')

Symbol, das den Typ des Artikels anzeigt. Referenzartikel



Symbol für Zeitmarke Letzte Aktualisierung: 25.05.2016
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_7dpManagerCommands
Dateiname:rxml_7dpManagerCommands.html