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

Sie können die Scripting-Sprache Jython verwenden, um Ihre CA-Clientkonfigurationen (Certificate Authority, Zertifizierungsstelle) mit dem Tool "wsadmin" zu verwalten. Mit den Befehlen und Parametern in der Gruppe "CAClientCommands" können Sie Verbindungen zu einem CA-Server eines anderen Anbieters erstellen, ändern, abfragen und entfernen.

Verwenden Sie die folgenden Befehle, um Ihre CA-Clientkonfigurationen zu verwalten:

createCAClient

Der Befehl "createCAClient" erstellt ein neues CA-Clientobjekt in Ihrer Konfiguration. Der Anwendungsserver über die Implementierung der Methode "WSPKIClient()" eine Verbindung zu einem CA-Server hier, der alle Verbindungen und die gesamte Kommunikation mit dem CA-Server bearbeitet.

Zielobjekt

Ohne.

Erforderliche Parameter

-caClientName
Gibt einen Namen für die eindeutige Identifizierung des CA-Clientobjekts an. (String, erforderlich)
-pkiClientImplClass
Gibt den Klassenpfad an, der die Schnittstelle "WSPKIClient" implementiert. Die vom Benutzer bereitgestellte Implementierung von WSPKIClient verwendet, um mit einer Zertifizierungsstelle (Certificate Authority, CA) zu kommunizieren. Das System verwendet die Implementierung von WSPKIClient, um ein Zertifkat von einer CA anzufordern.
Lesen Sie hierzu den Artikel WSPKIClient-Schnittstelle für die Kommunikation mit einer Zertifizierungsstelle entwickeln. (String, erforderlich)

Optionale Parameter

-scopeName
Gibt den Verwaltungsbereich für den CA-Client an. Für ein Deployment-Manager-Profil verwendet das System standardmäßig den Geltungsbereich "Zelle". Für ein Anwendungsserverprofil verwendet das System standardmäßig den Geltungsbereich "Knoten". (String, optional)
-host
Gibt den Namen des Hosts in Ihrem System an, auf dem sich die Zertifizierungsstelle befindet. (String, optional)
-port
Gibt den Port auf dem Server an, an dem die Zertifizierungsstelle empfangsbereit ist. (String, optional)
-userName
Gibt den Benutzernamen an, der für die Authentifizierung bei der Zertifizierungsstelle verwendet werden soll. (String, optional)
-password
Gibt das Kennwort für den Benutzernamen an, der für die Authentifizierung bei der Zertifizierungsstelle verwendet wird. (String, optional)
-frequencyCheck
Gibt an, in welchem Intervall (in Minuten) das System mit der Zertifizierungsstelle kommuniziert, um festzustellen, ob ein Zertifikat erstellt wurde. (String, optional)
-retryCheck
Gibt an, wie oft das System mit der Zertifizierungsstelle kommunizieren soll, um festzustellen, ob ein Zertifikat erstellt wurde. (String, optional)
-customProperties
Gibt eine durch Kommas getrennte Liste mit Attribut/Wert-Paaren für angepasste Eigenschaften, die dem CA-Clientobjekt hinzugefügt werden sollen, im folgenden Format an: Attribut=Wert,Attribut=Wert. (String, optional)

Rückgabewerte

Der Befehl gibt den Objektnamen des CA-Clients zurück, den das System erstellt.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.createCAClient('[-caClientName clientObj01 -pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient -host machine011 -port 9022 -userName admin -password pw4admin]')
  • Mit Jython (List):
    AdminTask.createCAClient(['-caClientName', 'clientObj01', '-pkiClientImplClass', 'com.ibm.wsspi.ssl.WSPKIClient', '-host', 'machine011', '-port', '9022', '-userName', 'admin', '-password', 'pw4admin'])

Verwendungsbeispiel für den Dialogmodus

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

modifyCAClient

Der Befehl "modifyCAClient" ändert die vorhandenen Konfigurationsdaten des CA-Clientobjekts. Sie können ein oder mehrere Konfigurationsattribute für einen bestimmten CA-Client ändern.

Zielobjekt

Ohne.

Erforderliche Parameter

-caClientName
Gibt den Namen des gewünschten CA-Clients an. (String, erforderlich)

Optionale Parameter

-scopeName
Gibt den Verwaltungsbereich für den CA-Client an. Für ein Deployment-Manager-Profil verwendet das System standardmäßig den Geltungsbereich "Zelle". Für ein Anwendungsserverprofil verwendet das System standardmäßig den Geltungsbereich "Knoten". (String, optional)
-pkiClientImplClass
Gibt den Klassenpfad an, der die Schnittstelle "WSPKIClient" implementiert. Das System verwendet diesen Pfad, um eine Verbindung zur Zertifizierungsstelle herzustellen und Anforderungen an die Zertifizierungsstelle abzusetzen. (String, optional)
-host
Gibt den Namen des Hosts in Ihrem System an, auf dem sich die Zertifizierungsstelle befindet. (String, optional)
-port
Gibt den Port auf dem Server an, an dem die Zertifizierungsstelle empfangsbereit ist. (String, optional)
-userName
Gibt den Benutzernamen an, der für die Authentifizierung bei der Zertifizierungsstelle verwendet werden soll. (String, optional)
-password
Gibt das Kennwort für den Benutzernamen an, der für die Authentifizierung bei der Zertifizierungsstelle verwendet wird. (String, optional)
-frequencyCheck
Gibt an, in welchem Intervall (in Minuten) das System bei der Zertifizierungsstelle nachfragen soll, ob ein Zertifikat erstellt wurde. (String, optional)
-retryCheck
Gibt an, wie oft das System bei der Zertifizierungsstelle nachfragen soll, ob ein Zertifikat erstellt wurde. (String, optional)
-customProperties
Geben Sie eine durch Kommas getrennte Liste mit angepassten Eigenschaften (Attribut=Wert-Paare) an, die im CA-Clientobjekt geändert werden sollen. Sie können Eigenschaften erstellen, ändern oder entfernen. Wenn Sie eine Eigenschaft entfernen möchten, geben SIe das Attribut und den Wert wie folgt an:# Attribute=. (String, optional)

Rückgabewerte

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.modifyCAClient('[-caClientName myCAClient -port 4060 -userName admin -password password4admin]')
  • Mit Jython (List):
    AdminTask.modifyCAClient(['-caClientName', 'myCAClient', '-port', '4060', 
    '-userName', 'admin', '-password', 'password4admin'])

Verwendungsbeispiel für den Dialogmodus

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

getCAClient

Der Befehl "getCAClient" zeigt eine Liste mit Attributen für einen bestimmten CA-Client an.

Zielobjekt

Ohne.

Erforderliche Parameter

-caClientName
Gibt den Namen des gewünschten CA-Clients an. (String, erforderlich)

Optionale Parameter

-scopeName
Gibt den Verwaltungsbereich des gewünschten CA-Clients an. (String, optional)

Rückgabewerte

Der Befehl gibt eine Attributliste zurück, die Attribut/Wert-Paare für den jeweiligen CA-Client enthält, wie im folgenden Beispiel gezeigt:
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementSc
ope_1)] [scopeName (cell):myCell01] [name myCAClient] [baseDn ] [_Websphe
re_Config_Data_Id cells/myCell01|security.xml#CAClient_1181834566882] [por
t 2951] [CACertificate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [u
serId ] [_Websphere_Config_Data_Type CAClient] [retryCheck 0] [properties ] [fre
quencyCheck 0] [password ] [host ] ]'

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    print AdminTask.getCAClient('-caClientName myCAClient')
  • Mit Jython (List):
    print AdminTask.getCAClient('-caClientName', 'myCAClient')

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython (String):
    print AdminTask.getCAClient('-interactive')

deleteCAClient

Der Befehl "deleteCAClient" entfernt das gewünschte CA-Clientobjekt aus Ihrer Konfiguration. Verwenden Sie den Parameter "-caClientName", um den zu löschenden CA-Client anzugeben. Optional können Sie mit dem Parameter "scopeName" den Verwaltungsbereich des CA-Clientobjekts angeben.

Zielobjekt

Ohne.

Erforderliche Parameter

-caClientName
Gibt den Namen des gewünschten CA-Clients an. (String, erforderlich)

Optionale Parameter

-scopeName
Gibt den Verwaltungsbereich des gewünschten CA-Clients an. (String, optional)

Rückgabewerte

Der Befehl gibt keine Ausgabe zurück, wenn das System den gewünschten CA-Client erfolgreich entfernt hat. Wenn Sie eine Fehlernachricht empfangen, stellen Sie sicher, dass das gewünschte CA-Clientobjekt in der Konfiguration enthalten ist und nicht in einem Zertifikatsobjekt in Ihrer Sicherheitskonfiguration referenziert wird.

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    AdminTask.deleteCAClient('[-caClientName myCAClient]')
  • Mit Jython (List):
    AdminTask.deleteCAClient(['-caClientName', 'myCAClient'])

Verwendungsbeispiel für den Dialogmodus

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

listCAClients

Der Befehl "listCAClients" listet alle CA-Clients in Ihrer Konfiguration bzw. in einem bestimmten Geltungsbereich auf. Wenn Sie keinen Wert für den Parameter "-scopeName" angeben, fragt der Befehl die Zelle ab, sofern Sie ein Deployment-Manager-Profil verwenden, bzw. den Knoten, falls Sie ein Anwendungsserverprofil verwenden. Verwenden Sie den Parameter "-all", wenn Sie Ihre Umgebung ohne Einschränkung auf einen bestimmten Geltungsbereichs abfragen möchten.

Zielobjekt

Ohne.

Optionale Parameter

-scopeName
Gibt den Verwaltungsbereich an, in dem nach CA-Clients gesucht werden soll. (String, optional)
-all
Gibt an, ob das System CA-Clients ohne Einschränkung auf einen bestimmten Geltungsbereich suchen soll. (Boolean, optional)

Rückgabewerte

Der Befehl gibt, wie in der folgenden Beispielausgabe gezeigt, einen Bereich von Attributlisten zurück und zeigt für jeden CA-Client jeweils eine Attributliste an:
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementScope_1)
] [scopeName (cell):myCell01] [name jenCAClient] [baseDn ] [_Websphere_Config_Da
ta_Id cells/myCell01|security.xml#CAClient_1181834566881] [port 2950] [CACertifi
cate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [userId ] [_Webspher
e_Config_Data_Type CAClient] [retryCheck 0] [properties ] [frequencyCheck 0] [pa
ssword ] [host ] ]'
'[ [backupCAs ] [managementScope (cells/myCell01|security.xml#ManagementScope_1)
] [scopeName (cell):myCell01] [name myCAClient] [baseDn ] [_Websphere_Config_Dat
a_Id cells/myCell01|security.xml#CAClient_1181834566882] [port 2951] [CACertific
ate ] [pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient] [userId ] [_Websphere
_Config_Data_Type CAClient] [retryCheck 0] [properties ] [frequencyCheck 0] [pas
sword ] [host ] ]'

Verwendungsbeispiel für den Stapelmodus

  • Mit Jython (String):
    print AdminTask.listCAClients('-all true')
  • Mit Jython (List):
    print AdminTask.listCAClients('-all', 'true')

Verwendungsbeispiel für den Dialogmodus

  • Mit Jython:
    print AdminTask.listCAClients('-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_7CAClientCommands
Dateiname:rxml_7CAClientCommands.html