Tâches d'administration des domaines de service de catalogue

Les langages de script Jacl ou Jython permettent de gérer les domaines de service de catalogue présents dans votre configuration WebSphere Application Server.

Conditions requises

WebSphere eXtreme Scale Client doit être installé dans votre environnement WebSphere Application Server.

Afficher la liste de toutes les tâches d'administration

Pour obtenir la liste de toutes les tâches d'administration associées aux domaines de service de catalogue, exécutez la commande suivante avec wsadmin :
wsadmin>$AdminTask help XSDomainManagement 

Commandes

Les tâches d'administration de domaines de service de catalogue comprennent les commandes suivantes :

createXSDomain

La commande createXSDomain enregistre un nouveau domaine de service de catalogue.
Tableau 1. Arguments de la commande createXSDomain
Argument Description
-name (requis) Spécifie le nom du domaine de service de catalogue à créer.
-default Spécifie si le domaine de service de catalogue est le domaine par défaut de la cellule. La valeur par défaut est true. (booléen : a soit la valeur true, soit la valeur false).
-properties Spécifie les propriétés personnalisées du domaine de service de catalogue.
Tableau 2. Arguments de la procédure defineDomainServers
Argument Description
name_of_endpoint Spécifie le nom du point de contact du service de catalogue.
  • Pour les serveurs d'applications existants : le nom du noeud final doit avoir le format cell_name\node_name\server_name
  • Pour les serveurs distantes : définit le nom d'hôte du serveur distant. Vous pouvez utiliser le même nom pour plusieurs noeuds finals, mais les valeurs de port client doivent être uniques pour chaque noeud final.
custom_properties Spécifie les propriétés personnalisées du point de contact du domaine de service de catalogue. Si vous ne disposez pas de propriétés personnalisées, utilisez des guillemets doubles ("") pour cet argument.
endpoint_ports
Spécifie les numéros de port du point de contact du domaine de service de catalogue. Les ports doivent être définis dans l'ordre suivant : <client_port>,<listener_port>
Port client
Spécifie le port utilisé pour la communication entre les serveurs de catalogue dans le domaine de service de catalogue. Cette valeur est nécessaire pour les serveurs de catalogue qui s'exécutent uniquement dans des processus WebSphere Application Server et elle peut correspondre à n'importe quel port inutilisé autre part.
Port d'écoute
Indique le port utilisé pour établir des communications avec les clients. Cette valeur est obligatoire pour les noeuds finals distants et elle doit correspondre à la valeur utilisée au démarrage du service de catalogue. Le port d'écoute est utilisé par les clients et les conteneurs pour communiquer avec le service de catalogue.
Pour les noeuds finals distants WebSphere eXtreme Scale : définit le port d'écoute ORB (Object Request Broker) qui permet aux conteneurs et aux clients de communiquer avec le service de catalogue via l'ORB. Pour les noeuds finals WebSphere Application Server, la valeur de port d'écoute est facultative, car elle est héritée de la configuration de port BOOTSTRAP_ADDRESS.
Tableau 3. Arguments de la procédure configureClientSecurity
Argument Description
-securityEnabled Spécifie que la sécurité du client est activée pour le serveur de catalogue. Le fichier des propriétés du serveur qui est associé au serveur de catalogue sélectionné doit avoir un paramètre securityEnabled correspondant dans le fichier des propriétés du serveur. Si ces paramètres ne correspondent pas, une exception est générée. (booléen : a soit la valeur true, soit la valeur false).
-credentialAuthentication (facultatif) Indique si l'authentification des données d'identification est imposée ou prise en charge.
Jamais

Aucune authentification de certificat client n'est imposée.

Requis
L'authentification des données d'identification est toujours appliquée. Si le serveur ne prend pas en charge l'authentification des données d'identification, le client ne peut pas se connecter au serveur.
Pris en charge
(Par défaut) L'authentification des données d'identification est imposée seulement si à la fois le client et le serveur prennent en charge l'authentification des données d'identification.
-authenticationRetryCount (facultatif) Spécifie le nombre de tentatives d'authentification si les données d'identification sont arrivées à expiration.

Si vous ne voulez pas réessayer l'authentification, définissez la valeur à 0. La valeur par défaut est 0.

-credentialGeneratorClass Indique la classe d'implémentation de com.ibm.websphere.objectgrid.security.plugins.builtins. WSTokenCredentialGenerator pour que le client récupère les jetons de sécurité de l'unité d'exécution.
-credentialGeneratorProps Spécifie les propriétés de la classe d'implémentation CredentialGenerator. Les propriétés sont envoyées à l'objet avec la méthode setProperties(String). La valeur des propriétés du générateur de données d'identification est utilisée seulement si une valeur est spécifiée pour la zone Classe du générateur de données d'identification.

Valeur retournée :

Exemples de mode de traitement par lots

Le mode de traitement par lots impose de formater correctement l'entrée de commande. Utilisez le mode interactif pour que les valeurs que vous entrez soient correctement traitées. Lorsque vous utilisez le mode de traitement par lots, vous devez définir les arguments d'étape -defineDomainServers en utilisant un tableau de propriétés spécifiques. Ce tableau a le format name_of_endpoint custom_properties endpoint_ports. La valeur endpoint_ports est la liste des ports qui doivent être définis dans l'ordre suivant : <client_port>,<listener_port>.

Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask createXSDomain {-interactive}
  • Avec une chaîne Jython :
    AdminTask.createXSDomain ('[-interactive]')

deleteXSDomain

La commande deleteXSDomain supprime un domaine de service de catalogue.

Paramètres requis :
-name
Spécifie le nom du domaine de service de catalogue à supprimer.

Valeur retournée :

Exemples de mode de traitement par lots
  • A l'aide de Jacl :
    $AdminTask deleteXSDomain {-name TestDomain }
  • Avec une chaîne Jython :
    AdminTask.deleteXSDomain('[-name TestDomain ]')
Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask deleteXSDomain {-interactive}
  • Avec une chaîne Jython :
    AdminTask.deleteXSDomain ('[-interactive]')

getDefaultXSDomain

La commande getDefaultXSDomain renvoie le domaine de service de catalogue par défaut de la cellule.

Paramètres requis : aucun.

Valeur de retour : nom du domaine de service de catalogue.

Exemples de mode de traitement par lots
  • A l'aide de Jacl :
    $AdminTask getDefaultXSDomain
  • Avec une chaîne Jython :
    AdminTask.getDefaultXSDomain
Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask getDefaultXSDomain {-interactive}
  • Avec une chaîne Jython :
    AdminTask.getDefaultXSDomain ('[-interactive]')

listXSDomains

La commande listXSDomains retourne la liste des domaines de services de catalogue existants.

Paramètres requis : aucun.

Valeur de retour : liste de tous les domaines de services de catalogue dans la cellule.

Exemples de mode de traitement par lots
  • A l'aide de Jacl :
    $AdminTask listXSDomains
  • Avec une chaîne Jython :
    AdminTask.listXSDomains
Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask listXSDomains {-interactive}
  • Avec une chaîne Jython :
    AdminTask.listXSDomains ('[-interactive]')

modifyXSDomain

La commande modifyXSDomain modifie un domaine de service de catalogue existant.

Le mode de traitement par lots impose de formater correctement l'entrée de commande. Utilisez le mode interactif pour que les valeurs que vous entrez soient correctement traitées. Lorsque vous utilisez le mode de traitement par lots, vous devez définir les arguments d'étape -modifyEndpoints, -addEndpoints et -removeEndpoints en utilisant un tableau de propriétés spécifiques. Ce tableau a le format name_of_endpoint host_name custom_properties endpoint_ports. La valeur endpoint_ports est la liste des ports qui doivent être définis dans l'ordre suivant : <client_port>,<listener_port>.

Tableau 4. Arguments de la commande modifyXSDomain
Argument Description
-name (requis) Spécifie le nom du domaine de service de catalogue que vous souhaitez éditer.
-default Avec la valeur true, spécifie que le domaine de service de catalogue est le domaine par défaut de la cellule (booléen).
-properties Spécifie les propriétés personnalisées du domaine de service de catalogue.
Tableau 5. Arguments de la procédure modifyEndpoints
Argument Description
name_of_endpoint Spécifie le nom du point de contact du service de catalogue.
  • Pour les serveurs d'applications existants : le nom du noeud final doit avoir le format cell_name\node_name\server_name
  • Pour les serveurs distantes : définit le nom d'hôte du serveur distant. Vous pouvez utiliser le même nom pour plusieurs noeuds finals, mais les valeurs de port client doivent être uniques pour chaque noeud final.
endpoint_ports
Spécifie les numéros de port du point de contact du domaine de service de catalogue. Les noeuds finals doivent être définis dans l'ordre suivant : <client_port>,<listener_port>
Port client
Spécifie le port utilisé pour la communication entre les serveurs de catalogue dans le domaine de service de catalogue. Cette valeur est nécessaire pour les serveurs de catalogue qui s'exécutent uniquement dans des processus WebSphere Application Server et elle peut correspondre à n'importe quel port inutilisé autre part.
Port d'écoute
Indique le port utilisé pour établir des communications avec les clients. Cette valeur est obligatoire pour les noeuds finals distants et elle doit correspondre à la valeur utilisée au démarrage du service de catalogue. Le port d'écoute est utilisé par les clients et les conteneurs pour communiquer avec le service de catalogue.
Pour les noeuds finals distants WebSphere eXtreme Scale : définit le port d'écoute ORB (Object Request Broker) qui permet aux conteneurs et aux clients de communiquer avec le service de catalogue via l'ORB. Pour les noeuds finals WebSphere Application Server, la valeur de port d'écoute est facultative, car elle est héritée de la configuration de port BOOTSTRAP_ADDRESS.
Tableau 6. Arguments de la procédure addEndpoints
Argument Description
name_of_endpoint Spécifie le nom du point de contact du service de catalogue.
  • Pour les serveurs d'applications existants : le nom du noeud final doit avoir le format cell_name\node_name\server_name
  • Pour les serveurs distantes : définit le nom d'hôte du serveur distant. Vous pouvez utiliser le même nom pour plusieurs noeuds finals, mais les valeurs de port client doivent être uniques pour chaque noeud final.
custom_properties Spécifie les propriétés personnalisées du point de contact du domaine de service de catalogue. Si vous ne disposez pas de propriétés personnalisées, utilisez des guillemets doubles ("") pour cet argument.
endpoint_ports
Spécifie les numéros de port du point de contact du domaine de service de catalogue. Les noeuds finals doivent être définis dans l'ordre suivant : <client_port>,<listener_port>
Port client
Spécifie le port utilisé pour la communication entre les serveurs de catalogue dans le domaine de service de catalogue. Cette valeur est nécessaire pour les serveurs de catalogue qui s'exécutent uniquement dans des processus WebSphere Application Server et elle peut correspondre à n'importe quel port inutilisé autre part.
Port d'écoute
Indique le port utilisé pour établir des communications avec les clients. Cette valeur est obligatoire pour les noeuds finals distants et elle doit correspondre à la valeur utilisée au démarrage du service de catalogue. Le port d'écoute est utilisé par les clients et les conteneurs pour communiquer avec le service de catalogue.
Pour les noeuds finals distants WebSphere eXtreme Scale : définit le port d'écoute ORB (Object Request Broker) qui permet aux conteneurs et aux clients de communiquer avec le service de catalogue via l'ORB. Pour les noeuds finals WebSphere Application Server, la valeur de port d'écoute est facultative, car elle est héritée de la configuration de port BOOTSTRAP_ADDRESS.
Tableau 7. Arguments de la procédure removeEndpoints
Argument Description
name_of_endpoint Spécifie le nom du point de contact de domaine de service de catalogue à supprimer.
Tableau 8. Arguments de la procédure configureClientSecurity
Argument Description
-securityEnabled Spécifie que la sécurité du client est activée pour le serveur de catalogue. Le fichier des propriétés du serveur qui est associé au serveur de catalogue sélectionné doit avoir un paramètre securityEnabled correspondant dans le fichier des propriétés du serveur. Si ces paramètres ne correspondent pas, une exception est générée. (booléen : a soit la valeur true, soit la valeur false).
-credentialAuthentication (facultatif) Indique si l'authentification des données d'identification est imposée ou prise en charge.
Jamais

Aucune authentification de certificat client n'est imposée.

Requis
L'authentification des données d'identification est toujours appliquée. Si le serveur ne prend pas en charge l'authentification des données d'identification, le client ne peut pas se connecter au serveur.
Pris en charge
(Par défaut) L'authentification des données d'identification est imposée seulement si à la fois le client et le serveur prennent en charge l'authentification des données d'identification.
-authenticationRetryCount (facultatif) Spécifie le nombre de tentatives d'authentification si les données d'identification sont arrivées à expiration.

Si vous ne voulez pas réessayer l'authentification, définissez la valeur à 0. La valeur par défaut est 0.

-credentialGeneratorClass Indique la classe d'implémentation de com.ibm.websphere.objectgrid.security.plugins.builtins. WSTokenCredentialGenerator pour que le client récupère les jetons de sécurité de l'unité d'exécution.
-credentialGeneratorProps Spécifie les propriétés de la classe d'implémentation CredentialGenerator. Les propriétés sont envoyées à l'objet avec la méthode setProperties(String). La valeur des propriétés du générateur de données d'identification est utilisée seulement si une valeur est spécifiée pour la zone Classe du générateur de données d'identification.

Valeur retournée :

Exemples de mode de traitement par lots
  • A l'aide de Jacl :
    $AdminTask modifyXSDomain {-name TestDomain -default true -modifyEndpoints 
    {{xhost1.ibm.com "" ,2809}} -addEndpoints {{xhost2.ibm.com "" ,2809}}} 
    -removeEndpoints {{xhost3.ibm.com}}}
  • Avec une chaîne Jython :
    AdminTask.modifyXSDomain('[-name TestDomain  
    -default false -modifyEndpoints [[xhost1.ibm.com "" ,2809]] 
    -addEndpoints [[xhost3.ibm.com "" ,2809]] 
    -removeEndpoints [[xhost2.ibm.com]]]')
  • Utilisation de la sécurité du client avec la commande modify :
    $AdminTask modifyXSDomain {-name monDomaine -default false 
    -configureClientSecurity {-securityEnabled true - 
    Supported -authenticationRetryCount 1 -credentialGeneratorClass 
    com.ibm.websphere.objectgrid.security.plugins.builtins.UserPasswordCredentialGenerator
     -credentialGeneratorProps "manager manager1"}}
Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask modifyXSDomain {-interactive}
  • Avec une chaîne Jython :
    AdminTask.modifyXSDomain ('[-interactive]')

testXSDomainConnection

La commande testXSDomainConnection teste la connexion à un domaine de service de catalogue.

Paramètres requis :
-name
Spécifie le nom du domaine de service de catalogue vers lequel tester la connexion.
Paramètres facultatifs
-timeout
Spécifie le délai d'attente maximal, en secondes, de la connexion.

Valeur de retour : si la connexion peut être établie, retourne true. Dans le cas contraire, des informations d'erreur de connexion sont retournées.

Exemples de mode de traitement par lots
  • A l'aide de Jacl :
    $Admintask testXSDomainConnection
  • Avec une chaîne Jython :
    AdminTask.testXSDomainConnection
Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask testXSDomainConnection {-interactive}
  • Avec une chaîne Jython :
    AdminTask.testXSDomainConnection ('[-interactive]')

testXSServerConnection

La commande testXSServerConnection teste la connexion à un serveur de catalogue. Cette commande fonctionne pour les serveurs autonomes et les serveurs qui font partie d'un domaine de service de catalogue.

Paramètres requis :
host
Spécifie l'hôte sur lequel réside le serveur de catalogue.
listenerPort
Spécifie le port d'écoute du serveur de catalogue.
Paramètres facultatifs
timeout
Spécifie en secondes pendant combien de temps au maximum attendre la connexion au serveur de catalogue.
domain
Spécifie le nom du domaine de service de catalogue. Si vous définissez une valeur pour ce paramètre, les propriétés de la sécurité du client pour le domaine de service de catalogue spécifié sont utilisées pour tester la connexion. Sinon, une recherche est effectuée pour trouver le domaine de service de catalogue pour l'hôte et le port d'écoute spécifié. Si un domaine de service de catalogue est trouvé, les propriétés de la sécurité du client qui sont définies pour le domaine de service de catalogue sont utilisées pour tester le serveur. Sinon, aucune propriété de la sécurité du client n'est utilisée lors du test.

Valeur retournée :

Exemples de mode de traitement par lots
  • A l'aide de Jacl :
    $Admintask testXSServerConnection {-host xhost1.ibm.com -listenerPort 2809}
  • Avec une chaîne Jython :
    AdminTask.testXSServerConnection('[-host xshost3.ibm.com -listenerPort 2809]')
Exemples de mode interactif
  • A l'aide de Jacl :
    $AdminTask testXSServerConnection {-interactive}
  • Avec une chaîne Jython :
    AdminTask.testXSServerConnection ('[-interactive]')