Obtention de l'aide en ligne à l'aide de l'outil de scriptage wsadmin
Trois niveaux d'aide en ligne sont disponibles pour les commandes de la console d'administration.
Avant de commencer
Démarrez l'outil wsadmin.
Pourquoi et quand exécuter cette tâche
Le premier niveau fournit des informations générales sur l'objet AdminTask et les commandes associées. L'aide de deuxième niveau donne des informations sur les commandes et les groupes de commandes d'administration disponibles. Le troisième niveau fournit une aide spécifique sur un groupe de commandes, une commande ou une étape. L'aide relative aux groupes de commandes propose une description du groupe de commandes indiqué et des commandes appartenant à ce groupe. L'aide relative aux commandes comprend une description de la commande indiquée et de ses paramètres et étapes. L'aide relative aux étapes fournit une description de l'étape indiquée et de ses paramètres. Dans l'aide relative aux commandes et aux étapes, les paramètres obligatoires sont précédés par une étoile (*) dans la sortie de l'aide.
Procédure
- Pour obtenir l'aide générale, exécutez la commande help. Langage Jacl :
$AdminTask help
Langage Jython :print AdminTask.help()
Exemple de sortie :WASX8001I: L'objet AdminTask active l'exécution des commandes d'administration disponibles. Les commandes AdminTask fonctionnent dans deux modes : le mode par défaut dans lequel AdminTask communique avec le serveur WebSphere pour exécuter sa tâche, et un mode local dans lequel aucune communication avec le serveur n'est établie. Le mode de fonctionnement local est appelé en activant le client de scriptage à l'aide de l'option de de ligne de commande "-conntype NONE" ou en définissant la propriété "com.ibm.ws.scripting.connectiontype=NONE" dans le fichier wsadmin.properties. Le nombre de commandes admin dépend de l'installation WebSphere. Utilisez les commandes help suivantes pour obtenir la liste des commandes prises en charge et des paramètres associés : help -commands Affiche la liste de toutes les commandes admin help -commands <modèle> Répertorie les commandes admin correspondant à un "modèle" de caractères génériques help -commandGroups Répertorie tous les groupes de commandes admin help -commandGroups <pattern> Répertorie les groupes de commandes admin correspondant à un "modèle" de caractères génériques help commandName Affiche les informations détaillées sur la commande spécifiée help commandName stepName Affiche les informations détaillées sur l'étape spécifiée appartenant à la commande spécifiée help commandGroupName Affiche les informations détaillées sur le groupe de commandes spécifié Vous disposez de plusieurs méthodes pour appeler une commande admin : commandName Appelle une commande admin qui ne requiert aucun argument commandName targetObject Appelle une commande admin avec l'objet cible indiquée, par exemple, le nom de l'objet de configuration d'un adaptateur de ressources. ressources. L'objet cible prévu varie en fonction de la commande admin appelée. Utilisez la commande help pour obtenir des informations sur l'objet cible d'une commande admin. commandName options Appelle une commande admin avec les Chaînes d'options spécifiées. Cette syntaxe est utilisée pour appeler une commande admin qui ne requiert pas d'objet cible. Elle permet également de passer en mode interactif si l'option "-interactive" figure dans la chaîne d'options. commandName targetObject options Appelle une commande admin avec l'objet cible et les options indiqués. Si "-interactive" est inclus dans la chaîne d'options, vous êtes alors en mode interactif. L'objet cible et les chaînes d'options varient en fonction de la commande d'administration appelée. Utilisez la commande help pour obtenir des informations sur l'objet cible et les options.
- Pour répertorier les groupes de commandes disponibles, exécutez la commande help
avec le paramètre -commandGroups. Langage Jacl :
$AdminTask help -commandGroups
Langage Jython :print AdminTask.help('-commandGroups')
Exemple de sortie :WASX8005I : Groupes de commandes admin disponibles : AdminAgentNode - Tâches liées au noeud géré de l'agent d'administration AdminAgentSecurityCommands - Commandes utilisées pour configurer les éléments liés à la sécurité durant l'enregistrement de l'agent d'administration. AdminReports - Rapports de configuration administrateur AdminSDKCmds - Commandes admin liées aux SDK connectables AdministrativeJobs - Ce groupe de commandes contient l'ensemble des commandes de gestion des travaux . AppManagementCommands - Commandes de gestion des applications. ...
- Pour répertorier les commandes disponibles, exécutez la commande help
avec le paramètre -commands. Langage Jacl :
$AdminTask help -commands
Langage Jython :print AdminTask.help('-commands')
Exemple de sortie :WASX8004I : Commandes d'administration disponibles : copyResourceAdapter - Copie l'adaptateur de ressource J2C indiqué dans la portée indiquée. createCluster : Crée un cluster sur le serveur d'applications. createClusterMember : Crée un membre dans le cluster du serveur d'applications. createJ2CConnectionFactory - Crée une fabrique de connexions J2C. deleteCluster : Supprime la configuration d'un cluster sur le serveur d'applications. deleteClusterMember : Supprime le membre d'un cluster sur un serveur d'applications. listConnectionFactoryInterfaces - Répertorie toutes les interfaces de fabriques de connexions définies sur l'adaptateur de ressource J2C indiqué. listJ2CConnectionFactories - Répertorie les fabriques de connexions J2C dont l'interface de fabrique de connexions indiquée est définie dans l'adaptateur des ressource J2C indiqué. createJ2CAdminObject - Crée un objet d'administration J2C. listAdminObjectInterfaces - Répertorie les interfaces d'objet d'administration définies dans l'adaptateur de ressource J2C indiqué. listJ2CAdminObjects - Répertorie les objets d'administration J2C dont l'interface d'objet d'administration indiquée est définie dans l'adaptateur de ressource J2C indiqué. createJ2CActivationSpec - Crée une spécification d'activation J2C. listMessageListenerTypes - Répertorie les types messageListener définis sur l'adaptateur de ressource J2C indiqué. listJ2CActivationSpecs - Répertorie les spécifications d'activation J2C dont le type de module d'écoute indiqué est défini dans l'adaptateur de ressource J2C indiqué.
- Pour obtenir de l'aide sur un groupe de commandes, exécutez la commande help avec le nom du groupe. Langage Jacl :
$AdminTask help JCAManagement
Langage Jython :print AdminTask.help('JCAManagement')
Exemple de sortie :WASX8007I : Aide détaillée pour le groupe de commandes : JCAManagement Description : Un groupe de commandes d'administration qui vous aide à configurer les ressources liées à J2C (Java 2 ConnecCtor Architecture). Commandes : createJ2CConnectionFactory - Crée une fabrique de connexions J2C. listConnectionFactoryInterfaces - Répertorie toutes les interfaces de fabrique de connexions définies sur l'adaptateur de ressource J2C indiqué. listJ2CConnectionFactories - Répertorie les fabriques de connexions J2C dont l'interface de fabrique de connexions indiquée est définie dans l'adaptateur de ressource J2C défini. createJ2CAdminObject - Crée un objet d'administration J2C. listAdminObjectInterfaces - Répertorie les interfaces d'objet d'administration définies sur l'adaptateur de ressource J2C indiqué. listJ2CAdminObjects - Répertorie les objets d'administration J2C dont l'interface a indiqué l'interface objet administrative définie dans l'adaptateur de ressource J2C indiqué. createJ2CActivationSpec - Crée une spécification d'activation J2C. listMessageListenerTypes - Répertorie les types de module d'écoute de messages définis sur l'adaptateur de ressource J2C indiqué. listJ2CActivationSpecs - Répertorie les spécifications d'activation J2C dont le type de module d'écoute de messages indiqué est défini dans l'adaptateur de ressource J2C indiqué. copyResourceAdapter - Copie l'adaptateur de ressource J2C indiqué dans la portée indiquée.
- Pour obtenir de l'aide sur une commande d'administration, exécutez la commande help
avec le nom du paramètre. Langage Jacl :
$AdminTask help createJ2CConnectionFactory
Langage Jython :print AdminTask.help('createJ2CConnectionFactory')
Exemple de sortie :Dans la sortie de l'aide de la commande ci-dessus, une commande d'administration est composée de trois zones d'entrée : l'objet cible, les arguments et les étapes. Chaque zone est renseignée en fonction de la commande d'administration utilisée. Chaque entrée est associée à un nom et à une description, à l'exception de la zone objet cible qui contient uniquement une description. Lorsque vous utilisez une commande d'administration en mode différé, vous pouvez indiquer n'importe quel nom d'entrée figurant dans la zone argument comme nom de l'argument.WASX8006I: Aide détaillée pour la commande : createJ2CConnectionFactory Description : Création d'une fabrique de connexions J2C *Objet cible : l'adaptateur de ressources J2C parent de la fabrique de connexions J2C créée. Arguments : *connectionFactoryInterface - Interface de fabrique de connexions définie dans la description du déploiement de l'adaptateur de ressources J2C parent. *name - Nom de la fabrique de connexions J2C. *jndiName - Le nom JNDI de la fabrique de connexions J2C créée. description - Description de la fabrique de connexions J2C créée. authDataAlias - L'alias des données d'authentification de la fabrique de connexions J2C créée. Etapes : Aucun
Si une entrée est obligatoire, un astérisque (*) précède son nom. Si une zone est facultative, aucun est indiqué. L'exemple suivant utilise la sortie de l'aide de la commande createJ2CConnectionFactory :- La zone objet cible est un nom d'objet de configuration d'un J2CResourceAdapter.
- La zone arguments comporte cinq entrées dont trois sont obligatoires. Les noms d'argument sont connectionFactoryInterface, name, jndiName,
description et authDataAlias. Ces noms sont utilisés comme noms de paramètre dans la chaîne d'options permettant d'exécuter une commande administrative en mode différé. Par exemple :
Pour plus d'informations sur la définition des options d'argument, reportez-vous à la rubrique relative à la syntaxe d'appel de la commande d'administration à l'aide de l'outil de scriptage wsadmin.-connectionFactoryInterface javax.resource.cci.ConnectionFactory -name newConnectionFactory -jndiName CF/newConnectionFactory
- Aucune étape n'est associée à cette commande d'administration.
- Pour obtenir de l'aide sur une étape de commande, accédez à l'aide de cette étape. L'aide de l'étape fournit les informations suivantes :
- Une description de l'étape.
- Indication sur la prise en charge de la collection dans cette étape. Une collection regroupe des objets de même type. Dans une étape de commande, une collection contient des objets ayant le même jeu de paramètres.
- Des informations sur chaque paramètre de l'étape (nom et description). Si un paramètre d'étape est obligatoire, un astérisque (*) précède son nom.
L'exemple suivant permet d'accéder à l'aide d'une étape de commande :
Langage Jacl :$AdminTask help createCluster clusterConfig
Langage Jython :print AdminTask.help('createCluster', 'clusterConfig')
Exemple de sortie :WASX8013I : Aide détaillée de l'étape : clusterConfig Description : Indique la configuration du nouveau cluster de serveurs. Collection : Non Arguments : *clusterName - Nom du cluster de serveurs. preferLocal - Active l'optimisation de l'acheminement dans la portée du noeud pour le cluster.
Cet exemple indique que les informations suivantes sur l'étape clusterConfig :- Cette étape ne prend pas en charge la collection. Un seul jeu de valeurs est autorisé pour les paramètres clusterName et perferLocal.
- Cette étape comporte deux arguments d'entrée dont l'un est obligatoire. L'argument obligatoire est clusterName et le paramètre facultatif est preferLocal. La syntaxe permettant de fournir les valeurs de paramètre de l'étape est différente de celle relative aux valeurs d'argument de la commande. Vous devez indiquer toutes les valeurs des arguments d'une étape dans l'ordre approprié, telles qu'elles apparaissent dans l'aide de l'étape indiquée. Si vous ne souhaitez pas indiquer de valeur pour un argument facultatif, indiquez des doubles guillemets ("") au lieu de la valeur. Si l'étape d'une commande correspond à un type de collection contenant, par exemple, plusieurs objets associés chacun au même ensemble d'arguments, vous pouvez indiquer plusieurs valeurs pour chaque objet placé entre accolades. Pour exécuter une commande d'administration en mode différé et inclure cette étape dans la chaîne d'options, utilisez la syntaxe suivante :
Langage Jacl :
-clusterConfig {{newCluster false}}
Langage Jython :
Pour plus d'informations sur la définition des options de paramètre, reportez-vous à la rubrique relative à la syntaxe d'appel de la commande d'administration à l'aide de l'outil de scriptage wsadmin.-clusterConfig [[newCluster false]]
- Utilisez un caractère générique pour rechercher de l'aide à propos d'une commande spécifique.
Un modèle d'expression Java régulière ou un modèle générique permet d'indiquer le nom de la commande pour AdminTask.help('–commands') et les fonctions AdminConfig list, types et listTemplates.
- Pour utiliser un modèle d'expression Java régulière afin de rechercher des noms de commandes administratives commençant par create, indiquez :
print AdminTask.help("-commands", "create.*")
- Pour utiliser un modèle générique pour rechercher les noms des commandes administratives commençant par create, indiquez :
print AdminTask.help("-commands", "create*")
- Pour utiliser un modèle d'expression Java pour rechercher les noms des commandes administratives qui contiennent SSLConfig, indiquez :
print AdminTask.help("-commands", ".*SSLConfig.*")
- Pour utiliser un modèle générique pour rechercher les noms des commandes administratives qui contiennent SSLConfig, indiquez :
print AdminTask.help("-commands", "*SSLConfig*")
- Pour utiliser un modèle d'expression Java régulière afin de rechercher des noms de commandes administratives commençant par create, indiquez :


http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=txml_gethelp
Nom du fichier : txml_gethelp.html