Groupe de commandes CAClientCommands de l'objet AdminTask
Le langage de script Jython permet de gérer les configurations de client CA (autorité de certification) à l'aide de l'outil wsadmin. Les commandes et paramètres du groupe CAClientCommands peuvent être utilisés pour créer, modifier, rechercher et supprimer des connexions à un serveur CA tiers.
createCAClient
La commande createCAClient crée un nouvel objet client CA dans la configuration. Le serveur d'applications se connecte au serveur CA par l'implémentation de l'interface WSPKIClient() qui traite toutes les connexions et communications avec le serveur CA.
Objet cible
Aucun.
Paramètres requis
- -caClientName
- Indique un nom permettant d'identifier de façon unique l'objet client CA. (Chaîne, obligatoire)
- -pkiClientImplClass
- Indique le chemin d'accès à la classe d'implémentation de l'interface WSPKIClient. L'implémentation WSPKIClient fournie par l'utilisateur est utilisée pour communiquer avec une autorité de certification (CA). Le système utilise l'implémentation WSPKIClient pour la demande d'un certificat auprès d'une autorité de certification.
- Voir Développement de l'interface WSPKIClient pour la communication avec une autorité de certification. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Indique la portée de la gestion du client CA. Dans le cas d'un profil de gestionnaire de déploiement, la valeur par défaut est la portée de la cellule. Dans le cas d'un profil de serveur d'applications, la valeur par défaut est la portée du noeud. (Chaîne, optionnelle)
- -host
- Indique le nom d'hôte du système qui héberge l'autorité de certification. (Chaîne, optionnelle)
- -port
- Indique le port du serveur sur lequel l'autorité de certification est en mode écoute. (Chaîne, optionnelle)
- -userName
- Indique le nom d'utilisateur à employer pour l'authentification auprès de l'autorité de certification. (Chaîne, optionnelle)
- -password
- Indique le mot de passe du nom d'utilisateur qui s'authentifie auprès de l'autorité de certification. (Chaîne, optionnelle)
- -frequencyCheck
- Indique la fréquence, en minutes, à laquelle le système doit dialoguer avec l'autorité de certification pour déterminer si un certificat a été créé. (Chaîne, optionnelle)
- -retryCheck
- Indique le nombre de dialogues à effectuer avec l'autorité de certification pour déterminer si un certificat a été créé. (Chaîne, optionnelle)
- -customProperties
- Indique une liste séparée par des virgules de paires de propriétés personnalisées attribut-valeur à ajouter à l'objet client CA dans le format suivant : attribut=valeur,attribut=valeur. (Chaîne, optionnelle)
Valeur renvoyée
La commande renvoie le nom d'objet du client CA créé par le système.
Exemple d'utilisation en mode de traitement par lots
- Avec une chaîne Jython :
AdminTask.createCAClient('[-caClientName clientObj01 -pkiClientImplClass com.ibm.wsspi.ssl.WSPKIClient -host machine011 -port 9022 -userName admin -password pw4admin]')
- A l'aide de la liste Jython :
AdminTask.createCAClient(['-caClientName', 'clientObj01', '-pkiClientImplClass', 'com.ibm.wsspi.ssl.WSPKIClient', '-host', 'machine011', '-port', '9022', '-userName', 'admin', '-password', 'pw4admin'])
Exemple d'utilisation en mode interactif
- En langage
Jython :
AdminTask.createCAClient('-interactive')
modifyCAClient
La commande modifyCAClient modifie les données de configuration existantes d'un objet client CA. Vous pouvez modifier un ou plusieurs attributs de configuration pour un client CA déterminé.
Objet cible
Aucun.
Paramètres requis
- -caClientName
- Indique le nom du client CA qui vous intéresse. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Indique la portée de la gestion du client CA. Dans le cas d'un profil de gestionnaire de déploiement, la valeur par défaut est la portée de la cellule. Dans le cas d'un profil de serveur d'applications, la valeur par défaut est la portée du noeud. (Chaîne, optionnelle)
- -pkiClientImplClass
- Indique le chemin d'accès à la classe d'implémentation de l'interface WSPKIClient. Le système utilise ce chemin pour se connecter à l'autorité de certification (CA) et lui envoyer des demandes. (Chaîne, optionnelle)
- -host
- Indique le nom d'hôte du système qui héberge l'autorité de certification. (Chaîne, optionnelle)
- -port
- Indique le port du serveur sur lequel l'autorité de certification est en mode écoute. (Chaîne, optionnelle)
- -userName
- Indique le nom d'utilisateur à employer pour l'authentification auprès de l'autorité de certification. (Chaîne, optionnelle)
- -password
- Indique le mot de passe du nom d'utilisateur qui s'authentifie auprès de l'autorité de certification. (Chaîne, optionnelle)
- -frequencyCheck
- Indique la fréquence, en minutes, à laquelle le système doit vérifier auprès de l'autorité de certification si un certificat a été créé. (Chaîne, optionnelle)
- -retryCheck
- Indique le nombre de vérifications à effectuer auprès de l'autorité de certification pour déterminer si un certificat a été créé. (Chaîne, optionnelle)
- -customProperties
- Indique une liste (séparée par des virgules) de paires de propriétés personnalisées attribut-valeur (attribut=valeur) à modifier pour l'objet client CA. Vous pouvez créer, modifier ou supprimer des propriétés. Pour supprimer une propriété, indiquez l'attribut et la valeur sous la forme suivante : attribut=. (Chaîne, optionnelle)
Valeur renvoyée
Exemple d'utilisation en mode de traitement par lots
- Avec une chaîne Jython :
AdminTask.modifyCAClient('[-caClientName myCAClient -port 4060 -userName admin -password password4admin]')
- A l'aide de la liste Jython :
AdminTask.modifyCAClient(['-caClientName', 'myCAClient', '-port', '4060', '-userName', 'admin', '-password', 'password4admin'])
Exemple d'utilisation en mode interactif
- En langage
Jython :
AdminTask.modifyCAClient('-interactive')
getCAClient
La commande getCAClient affiche la liste des attributs d'un client CA.
Objet cible
Aucun.
Paramètres requis
- -caClientName
- Indique le nom de client CA qui vous intéresse. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Indique la portée de la gestion du client CA qui vous intéresse. (Chaîne, optionnelle)
Valeur renvoyée
'[ [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 ] ]'
Exemple d'utilisation en mode de traitement par lots
- Avec une chaîne Jython :
print AdminTask.getCAClient('-caClientName myCAClient')
- A l'aide de la liste Jython :
print AdminTask.getCAClient('-caClientName', 'myCAClient')
Exemple d'utilisation en mode interactif
- Avec
la chaîne Jython :
print AdminTask.getCAClient('-interactive')
deleteCAClient
La commande deleteCAClient supprime l'objet client CA indiqué dans la configuration. Le paramètre -caClientName permet d'indiquer le client CA à supprimer. Vous pouvez également indiquer la portée de la gestion de l'objet client CA à l'aide du paramètre scopeName.
Objet cible
Aucun.
Paramètres requis
- -caClientName
- Indique le nom du client CA qui vous intéresse. (Chaîne, obligatoire)
Paramètres optionnels
- -scopeName
- Indique la portée de la gestion du client CA qui vous intéresse. (Chaîne, optionnelle)
Valeur renvoyée
La commande ne renvoie pas de sortie si le système supprime correctement le client CA qui vous intéresse. Si vous recevez un message d'erreur, vérifiez que l'objet client CA qui vous intéresse existe dans la configuration et qu'il n'est pas référencé par un objet de certificat dans la configuration de sécurité.
Exemple d'utilisation en mode de traitement par lots
- Avec une chaîne Jython :
AdminTask.deleteCAClient('[-caClientName myCAClient]')
- A l'aide de la liste Jython :
AdminTask.deleteCAClient(['-caClientName', 'myCAClient'])
Exemple d'utilisation en mode interactif
- En langage
Jython :
AdminTask.deleteCAClient('-interactive')
listCAClients
La commande listCAClients répertorie tous les clients CA qui figurent dans votre configuration ou dans une portée déterminée. Si vous n'indiquez pas de valeur pour le paramètre -scopeName, la commande interroge la cellule ou le noeud selon que vous utilisez, respectivement, un profil de gestionnaire de déploiement ou un profil de serveur d'applications. Indiquez le paramètre -all pour interroger votre environnement sans utiliser de portée déterminée.
Objet cible
Aucun.
Paramètres optionnels
- -scopeName
- Indique la portée de la gestion pour la recherche de clients CA. (Chaîne, optionnelle)
- -all
- Indique si le système recherche des clients CA sans portée spécifique. (Booléen, facultatif)
Valeur renvoyée
'[
[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 ] ]'
Exemple d'utilisation en mode de traitement par lots
- Avec une chaîne Jython :
print AdminTask.listCAClients('-all true')
- A l'aide de la liste Jython :
print AdminTask.listCAClients('-all', 'true')
Exemple d'utilisation en mode interactif
- En langage
Jython :
print AdminTask.listCAClients('-interactive')