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

Les langages de script Jacl ou Jython permettent de gérer les domaines de services 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 services de catalogue, exécutez la commande suivante avec wsadmin :
wsadmin>$AdminTask help XSDomainManagement 

Commandes

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

createXSDomain

La commande createXSDomain enregistre un nouveau domaine de services de catalogue.
Tableau 1. Arguments de la commande createXSDomain
Argument Description
-name (requis) Spécifie le nom du domaine de services de catalogue à créer.
-default Spécifie si le domaine de services 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 services 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 finaux, 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 services 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 services de catalogue. Les ports doivent être définis dans l'ordre suivant : <client_port>,<listener_port>
Port client
Indique le port utilisé pour la communication entre les serveurs de catalogue et 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 finaux 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 finaux distants WebSphere DataPower XC10 Appliance : utilisez la valeur 2809 pour les noeud finaux distants de dispositif.

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
  • Jacl :
    $AdminTask createXSDomain {-interactive}
  • Chaîne Jython :
    AdminTask.createXSDomain ('[-interactive]')

deleteXSDomain

La commande deleteXSDomain supprime un domaine de services de catalogue.

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

Valeur retournée :

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

getDefaultXSDomain

La commande getDefaultXSDomain retourne le domaine de services de catalogue par défaut de la cellule.

Paramètres requis : aucun.

Valeur retournée : le nom du domaine de services de catalogue par défaut.

Exemples de mode de traitement par lots
  • Jacl :
    $AdminTask getDefaultXSDomain
  • Chaîne Jython :
    AdminTask.getDefaultXSDomain
Exemples de mode interactif
  • Jacl :
    $AdminTask getDefaultXSDomain {-interactive}
  • 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 retournée : la liste de tous les domaines de services de catalogue présents dans la cellule.

Exemples de mode de traitement par lots
  • Jacl :
    $AdminTask listXSDomains
  • Chaîne Jython :
    AdminTask.listXSDomains
Exemples de mode interactif
  • Jacl :
    $AdminTask listXSDomains {-interactive}
  • Chaîne Jython :
    AdminTask.listXSDomains ('[-interactive]')

modifyXSDomain

La commande modifyXSDomain modifie un domaine de services 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 3. Arguments de la commande modifyXSDomain
Argument Description
-name (requis) Spécifie le nom du domaine de services de catalogue que vous souhaitez éditer.
-default Avec la valeur true, spécifie que le domaine de services 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 services de catalogue.
Tableau 4. 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 finaux, mais les valeurs de port client doivent être uniques pour chaque noeud final. Cette valeur doit être un nom qualifié complet de domaine si vous configurez un dispositif.
endpoint_ports
Spécifie les numéros de port du point de contact du domaine de services de catalogue. Les noeuds finaux doivent être définis dans l'ordre suivant : <client_port>,<listener_port>
Port client
Indique le port utilisé pour la communication entre les serveurs de catalogue et le domaine de service de catalogue. Cette valeur est nécessaire pour les serveurs de catalogues 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 finaux 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 finaux distants WebSphere DataPower XC10 Appliance : utilisez la valeur 2809 pour les noeud finaux distants de dispositif.
Tableau 5. 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 finaux, mais les valeurs de port client doivent être uniques pour chaque noeud final. Cette valeur doit être un nom qualifié complet de domaine si vous configurez un dispositif.
custom_properties Spécifie les propriétés personnalisées du point de contact du domaine de services 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 services de catalogue. Les noeuds finaux doivent être définis dans l'ordre suivant : <client_port>,<listener_port>
Port client
Indique le port utilisé pour la communication entre les serveurs de catalogue et 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 finaux 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 finaux distants WebSphere DataPower XC10 Appliance : utilisez la valeur 2809 pour les noeud finaux distants de dispositif.
Tableau 6. Arguments de la procédure removeEndpoints
Argument Description
name_of_endpoint Spécifie le nom du point de contact de domaine de services de catalogue à supprimer.

Valeur retournée :

Exemples de mode de traitement par lots
  • Jacl :
    $AdminTask modifyXSDomain {-name TestDomain -default true -modifyEndpoints 
    {{xhost1.ibm.com "" ,2809}} -addEndpoints {{xhost2.ibm.com "" ,2809}}} 
    -removeEndpoints {{xhost3.ibm.com}}}
  • Chaîne Jython :
    AdminTask.modifyXSDomain('[-name TestDomain  
    -default false -modifyEndpoints [[xhost1.ibm.com "" ,2809]] 
    -addEndpoints [[xhost3.ibm.com "" ,2809]] 
    -removeEndpoints [[xhost2.ibm.com]]]')
Exemples de mode interactif
  • Jacl :
    $AdminTask modifyXSDomain {-interactive}
  • Chaîne Jython :
    AdminTask.modifyXSDomain ('[-interactive]')

testXSDomainConnection

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

Paramètres requis :
-name
Spécifie le nom du domaine de services de catalogue vers lequel tester la connexion.
Paramètres facultatifs
-timeout
Spécifie en secondes pendant combien de temps au maximum attendre la connexion.

Valeur retournée : true s'il est possible d'établir une connexion, sinon, une erreur de connexion est retournée.

Exemples de mode de traitement par lots
  • Jacl :
    $Admintask testXSDomainConnection
  • Chaîne Jython :
    AdminTask.testXSDomainConnection
Exemples de mode interactif
  • Jacl :
    $AdminTask testXSDomainConnection {-interactive}
  • Chaîne Jython :
    AdminTask.testXSDomainConnection ('[-interactive]')

testXSServerConnection

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

Paramètres requis :
hôte
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.

Valeur retournée :

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