Befehlsgruppe "AdministrativeJobs" für das Objekt "AdminTask" mit wsadmin-Scripting
Sie können die Scripting-Sprache Jython verwenden, um Verwaltungsjobs mit dem Befehl "wsadmin" zu verwalten.
deleteJob
Der Befehl "deleteJob" löscht einen vorhandenen Job aus dem Job-Manager. Wenn der Job beim Aufruf des Befehls noch aktiv ist, gibt das System trotzdem die Jobergebnisse zurück, unabhängig davon, ob der Job gelöscht bereits gelöscht ist.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobToken
- Gibt die eindeutige Kennung des zu löschenden Jobs an. (String, erforderlich.)
Rückgabewert
Der Befehl gibt keine Ausgabe zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.deleteJob('-jobToken myToken')
- Mit Jython (List):
AdminTask.deleteJob('-jobToken', 'myToken')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.deleteJob('-interactive')
getJobTargets
Der Befehl "getJobTargets" zeigt das Ziel für einen gewünschten Job an. Das Ziel, das der Befehl für einen Job zurückgibt, ist möglicherweise nicht registriert, oder es ist glöscht.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobToken
- Gibt die eindeutige Kennung des gewünschten Jobs an. (String, erforderlich.)
Rückgabewert
Der Befehl gibt den Knotennamen für die Ziele des gewünschten Jobs zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.getJobTargets('-jobToken myToken')
- Mit Jython (List):
AdminTask.getJobTargets('-jobToken', 'myToken')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.getJobTargets('-interactive')
getJobTargetStatus
Der Befehl "getJobTargetStatus" zeigt den letzten Jobzielstatus für den gewünschten Job an.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobToken
- Gibt die eindeutige Kennung des gewünschten Jobs an. (String, erforderlich.)
Optionale Parameter
- -targetList
- Gibt eine Liste mit den Namen von Zielknoten an. (String[], optional)
Rückgabewert
Der Befehl gibt den letzten Jobstatus für die Ziele zurück. Die möglichen Status sind NOT_ATTEMPTED, DISTRIBUTED, ASYNC_IN_PROGRESS, SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, DELAYED und REJECTED.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.getJobTargetStatus('-jobToken myToken')
- Mit Jython (List):
AdminTask.getJobTargetStatus('-jobToken', 'myToken')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.getJobTargetStatus('-interactive')
getJobTargetHistory
Der Befehl "getJobTargetHistory" zeigt das Jobzielprotokoll für den gewünschten Job an.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobToken
- Gibt die eindeutige Kennung des gewünschten Jobs an. (String, erforderlich.)
- -target
- Gibt den Knotennamen des gewünschten Ziels an. (String, erforderlich.)
- -maxReturn
- Gibt die maximale Anzahl zurückzugebender Ergebnisse an. (Integer, erforderlich)
Optionale Parameter
- -startingTime
- Gibt die Startzeit für das Jobzielprotokoll an. (String, optional)
- -endingTime
- Gibt die Endzeit für das Jobzielprotokoll an. (String, optional)
- -ascending
- Gibt an, ob die Ergebnisse in aufsteigender oder absteigender Reihenfolge zurückgegeben werden sollen. Geben Sie true an, wenn die Ergebnisse in aufsteigender Reihenfolge zurückgegeben werden sollen, und false, wenn sie in absteigender Reihenfolge angezeigt werden sollen. (Boolean, optional)
Rückgabewert
Der Befehl gibt eine Liste mit Attributen zurück, in der das erste Attribut die Anzahl der Übereinstimmungen und das zweit Attribut das Protokoll des Jobs auf dem Ziel angibt. Jede Liste enthält die Zeitmarke, den Status, die Nachricht und das Ergebnis.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.getJobTargetHistory('-jobToken 2846493472984754 -target 3820J37H3017N294 -maxReturn 20')
- Mit Jython (List):
AdminTask.getJobTargetHistory('-jobToken', '2846493472984754', '-target', '3820J37H3017N294', '-maxReturn', '20')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.getJobTargetHistory('-interactive')
getJobTypes
Der Befehl "getJobTypes" zeigt die unterstützten Jobtypen für einen gewünschten Endpunkt an.
Zielobjekt
Ohne.
Optionale Parameter
- -targetList
- Gibt die Liste der Knotennamen für das Ziel an. (String[], optional)
- -group
- Gibt den Namen der Gruppe für das Ziel an. (String, optional)
Rückgabewert
Der Befehl gibt eine Liste mit Jobtypen zurück, die von jedem angegebenen Ziel unterstützt werden.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.getJobTypes('-target myProfileKey')
- Mit Jython (List):
AdminTask.getJobTypes('-target', 'myProfileKey')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.getJobTypes('-interactive')
getJobTypeMetadata
Der Befehl "getJobTypeMetadata" zeigt die Metadaten an, die einem bestimmten Jobtyp zugeordnet sind.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobTypeList
- Gibt eine Liste gewünschter Jobtypen an. (String[], optional)
Rückgabewert
Der Befehl gibt eine Liste mit Attributen, einschließlich Name, Kennsatz, Beschreibung, Jobeigenschaften und Jobparametern zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.getJobTypeMetadata('-jobTypeList inventory')
- Mit Jython (List):
AdminTask.getJobTypeMetadata('-jobTypeList', 'inventory')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.getJobTypeMetadata('-interactive')
getOverallJobStatus
Der Befehl "getOverallJobStatus" zeigt den Gesamtjobstatus für einen bestimmten Job oder für eine Liste bestimmter Jobs an.
Zielobjekt
Ohne.
Optionale Parameter
- -jobTokenList
- Gibt eine oder mehrere eindeutige Kennungen gewünschter Jobs an. (String[], optional)
Rückgabewert
- Das Attribut STATE gibt den aktuellen Status des Jobs an.
- Das Attribut TOTAL_RESULTS gibt die Gesamtanzahl der Jobs an.
- Das Attribut DISTRIBUTED gibt die Anzahl verteilter Jobs an.
- Das Attribut ASYNC_IN_PROGRESS gibt die Anzahl asynchroner Jobs an, die in Bearbeitung sind.
- Das Attribut SUCCEEDED gibt die Anzahl erfolgreicher Jobs an.
- Das Attribut PARTIALLY_SUCCEEDED gibt die Anzahl teilweise abgeschlossener Jobs an. Eine teilweise erfolgreiche Ausführung liegt dann vor, wenn ein Knoten beispielsweise mehrere Server darstellt und der Job nur auf einigen der Server dieses Knotens erfolgreich ausgeführt wird.
- Das Attribut FAILED gibt die Anzahl gescheiterter Jobs an.
- Das Attribut NOT_ATTEMPTED gibt die Anzahl der Jobs an, die das System nicht ausgeführt hat.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.getOverallJobStatus('-jobTokenList myJobToken')
- Mit Jython (List):
AdminTask.getOverallJobStatus('-jobTokenList', 'myJobToken')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.getOverallJobStatus('-interactive')
queryJobs
Der Befehl "queryJobs" fragt alle übergebenen Jobs beim Job-Manager ab.
Zielobjekt
Ohne.
Erforderliche Parameter
- -query
- Gibt den für die Jobabfrage zu verwendenen Suchausdruck an. (String, erforderlich.)Verwenden Sie beim Erstellen Ihrer Jobabfragen die folgenden Richtlinien:
- Die Abfrage enthält einen Schlüssel, einen Operator und einen Wert bzw. eine Liste von Werten. Sie können einen einzelnen Wert oder eine durch Kommas getrennte Liste von Werten angeben.
- Mehrere Ausdrücke müssen durch ein Leerzeichen und den Operator AND voneinander getrennt werden.
- Die folgenden Schlüssel, bei denen die Groß-/Kleinschreibung werden muss, werden unterstützt:
- jobToken
- Gibt das Jobtoken für einen bestimmten abzurfragenden Job an.
- group
- Gibt den abzufragenden Knotengruppennamen an.
- description
- Gibt die Beschreibung des abzufragenden Jobs an. Wenn die Beschreibung mehrere Wörter enthält, müssen Sie die Beschreibung in einfache oder doppelte Anführungszeichen einschließen, z. B. description = "job description".
- activationDateTime
- Gibt das Datum, einschließlich Uhrzeit, an, an dem das System den Job aktiviert, z. B. 2006-05-03T10:30:45-0000. Der Abschnitt -0000 im Wert des Schlüssels "activationDateTime" stellt das RFC-822-Format dar. Sie können Z als Kurzform für Greenwich Mean Time (GMT) verwenden, z. B. 2006-05-03T10:30:45Z. Wenn Sie die Zeitzone nicht angeben, verwendet das System die Zeitzone des Servers.
- expirationDateTime
- Gibt das Datum, einschließlich Uhrzeit, an, an dem der Job verfällt, z. B. 2006-05-03T10:30:45-0000. Der Abschnitt -0000 im Wert des Schlüssels "activationDateTime" stellt das RFC-822-Format dar. Sie können Z als Kurzform für Greenwich Mean Time (GMT) verwenden, z. B. 2006-05-03T10:30:45Z. Wenn Sie die Zeitzone nicht angeben, verwendet das System die Zeitzone des Servers.
- state
- Gibt den Status des Jobs an. Die gültigen Werte sind ASYNC_IN_PROGRESS, SUCCEEDED, PARTIALLY_SUCCEEDED, FAILED, DELAYED, REJECTED und NOT_ATTEMPTED.
- target
- Gibt den Zielknoten für einen Job an. Verwenden Sie diesen Schlüssel, wenn die Jobs für einen bestimmten Knoten zurückgegeben werden sollen. Der Befehl gibt die Jobs für den jeweiligen Knoten und die Knotengruppen zurück, zu denen der Knoten gehört. Sie können pro Abfrage nur eine Ziel-ID angeben.
- Die folgenden Operatoren werden unterstützt:
Tabelle 1. Operatoren für "queryJobs -query". Verwendung eines Operators in einer Abfrage. Zeichen Wert = Gleich. Um anzugeben, dass der Wert gleich null ist, verwenden Sie = NULL. != Ungleich. Um anzugeben, dass der Wert nicht gleich null ist, verwenden Sie != NULL. > Größer als < Kleiner als >= Größer-gleich <= Kleiner-gleich
- -maxReturn
- Gibt die maximale Anzahl zurückzugebender Übereinstimmungen an. (Integer, erforderlich)
Rückgabewert
[ [result [{activationDateTime=2008-03-11T11:56:48-0500,
expirationDateTime=2008-05-10T11:56:48-0500, jobToken=120525460839085191,
description=testSubmitJobToValidBaseTargetList}{activationDateTime=2008-03-11T14:05:33-0500,
expirationDateTime=2008-05-10T14:05:33-0500, jobToken=120526233387582472,
description=testSubmitJobToValidBaseTargetList}]] [size 2] ]
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
print AdminTask.queryJobs('-query activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01" -maxReturn 20')
print AdminTask.queryJobs('[-query "target = node3" -maxReturn 2]')
- Mit Jython (List):
AdminTask.queryJobs('-query', 'activationDateTime>= "2006-01-01" activationDateTime<= "2007-01-01"', '-maxReturn', '20')
print AdminTask.queryJobs(['-query', '"target = node3"', '-maxReturn', '2'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython (String):
AdminTask.queryJobs('-interactive')
resumeJob
Der Befehl "resumeJob" setzt einen zuvor gestarteten oder ausgesetzten Job fort.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobToken
- Gibt die eindeutige Kennung des gewünschten Jobs an. (String, erforderlich.)
Rückgabewert
Der Befehl gibt keine Ausgabe zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.resumeJob('-jobToken myToken')
- Mit Jython (List):
AdminTask.resumeJob('-jobToken', 'myToken')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.resumeJob('-interactive')
submitJob
Der Befehl "submitJob" übergibt einen neue Verwaltungsjob an den Job-Manager.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobType
- Gibt den Typ des zu übergebenden Jobs an. (String, erforderlich.)
Optionale Parameter
- -group
- Gibt den Namen der Gruppe für das Ziel an. (String, optional)
- -targetList
- Gibt eine Liste mit Zielknoten an. (String[], optional)
- -jobParams
- Gibt die erforderlichen Parameter für den zu übergebenden Job an. (Properties, optional)
- -username
- Gibt den Benutzernamen an, der für die Übergabe des Jobs verwendet werden soll, wenn die Sicherheit aktiviert ist. (String, optional)
- -password
- Gibt den Kennwort für den Benutzernamen an, der für die Übergabe des Jobs verwendet werden soll, wenn die Sicherheit aktiviert ist. (String, optional)
- -description
- Gibt eine Beschreibung für den Job an. (String, optional)
- -activationDateTime
- Gibt das Datum (inklusive Uhrzeit), an dem der Job aktiviert werden soll, im Format "2006-05-03T10:30:45-0000" an. Der Abschnitt "-0000" im Wert des Parameters "activationDateTime" stellt das Format gemäß RFC 822 dar. Sie können "Z" als Kurzform für Greenwich Mean Time (GMT) verwenden, z. B. "2006-05-03T10:30:45Z". Wenn Sie die Zeitzone nicht angeben, verwendet das System die Zeitzone des Servers. (String, optional)
- -expirationDateTime
- Gibt das Verfallsdatum für den Job an. (String, optional)
- -executionWindow
- Gibt das Wiederholungsintervall für den Job an. (String, optional)
- -executionWindowUnit
- Gibt die Maßeinheit für das Wiederholungsintervall an, dessen Wert mit dem Parameter "executionWindow" angegeben wird. Geben Sie DAILY an, wenn der Job täglich ausgeführt werden soll, WEEKLY, wenn der Job wöchentlich ausgeführt werden soll, MONTHLY, wenn der Job monatlich ausgeführt werden soll, oder YEARLY, wenn der Job jährlich ausgeführt werden soll. Außerdem können Sie CONNECTION angeben, wenn der Job jedes Mal ausgeführt werden soll, wenn der Knoten eine Verbindung zum Job-Manager herstellt, um Jobs abzufragen. Wenn Sie CONNECTION angeben, dürfen Sie den Parameter "executionWindow" nicht setzen. (String, optional)
- Gibt die E-Mail-Adresse an, an die das System Jobbenachrichtigungen sendet. (String, optional)
Rückgabewert
Der Befehl gibt ein Jobtoken für den neu übergebenen Job zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.submitJob('[-jobType createApplicationServer -target profileKey -jobParams "[serverName myServer]" ]')
- Mit Jython (List):
AdminTask.submitJob(['-jobType', 'createApplicationServer', '-target', 'profileKey', '-jobParams', '"[serverName myServer]"'])
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.submitJob('-interactive')
suspendJob
Der Befehl "suspendJob" setzt einen zuvor übergebenen Job aus.
Zielobjekt
Ohne.
Erforderliche Parameter
- -jobToken
- Gibt die eindeutige Kennung des auzzusetzenden Jobs an. (String, erforderlich.)
Rückgabewert
Der Befehl gibt keine Ausgabe zurück.
Verwendungsbeispiel für den Stapelmodus
- Mit Jython (String):
AdminTask.suspendJob('-jobToken myToken')
- Mit Jython (List):
AdminTask.suspendJob('-jobToken', 'myToken')
Verwendungsbeispiel für den Dialogmodus
- Mit Jython:
AdminTask.suspendJob('-interactive')