wsadmin スクリプトによるオンライン・ヘルプの取得
管理コマンドのオンライン・ヘルプの 3 つのレベルから選択できます。
始める前に
wsadmin ツールを始動します。
このタスクについて
最上位レベルのヘルプでは AdminTask オブジェクトおよびその関連コマンドの一般情報を提供します。 第 2 レベルのヘルプは、使用可能なすべての管理コマンドおよびコマンド・グループについての情報を提供します。 第 3 レベルのヘルプは、コマンド・グループ、コマンド、またはステップに関する特定のヘルプを提供します。 コマンド・グループの特定のヘルプは、指定するコマンド・グループの説明と、関連するグループに所属するコマンドの説明を提供します。 コマンド特定のヘルプは、指定したコマンドおよび関連したパラメーター とステップの説明を提供します。 ステップ特定のヘルプは、指定したステップの説明と関連したパラメーターの説明を提供します。 コマンドおよびステップ特定のヘルプについては、必要なパラメーターに対してヘルプ出力でアスタリスク (*) のマークが付きます。
手順
- 一般ヘルプを取得するには、help コマンドを実行します。 Jacl を使用:
$AdminTask help
Jython を使用:print AdminTask.help()
出力例:WASX8001I: The AdminTask object enables the execution of available admin commands. AdminTask commands operate in two modes: the default mode is one which AdminTask communicates with the WebSphere server to accomplish its task. A local mode is also available, in which no server communication takes place. The local mode of operation is invoked by bringing up the scripting client using the command line "-conntype NONE" option or setting the "com.ibm.ws.scripting.connectiontype=NONE" property in wsadmin.properties file. The number of admin commands varies and depends on your WebSphere install. Use the following help commands to obtain a list of supported commands and their parameters: help -commands Lists all the admin commands help -commands <pattern> Lists admin commands matching with wildcard "pattern" help -commandGroups Lists all the admin command groups help -commandGroups <pattern> Lists admin command groups matching with wildcard "pattern" help commandName Displays detailed information for the specified command help commandName stepName Displays detailed information for the specified step belonging to the specified command help commandGroupName Displays detailed information for the specified command group There are various flavors to invoke an admin command: commandName Invokes an admin command that does not require any argument. commandName targetObject Invokes an admin command with the specified target object string, for example, the configuration object name of a resource adapter. The expected target object varies with the admin command invoked. Use help command to get information on the target object of an admin command. commandName options Invokes an admin command with the specified option strings. This invocation syntax is used to invoke an admin command that does not require a target object. It is also used to enter interactive mode if "-interactive" mode is included in the options string. commandName targetObject options Invokes an admin command with the specified target object and options strings. If "-interactive" is included in the options string, then interactive mode is entered. The target object and options strings vary depending on the the admin command invoked. Use help command to get information on the target object and options.
- 使用可能なコマンド・グループをリストするには、-commandGroups パラメーターを指定して help コマンドを実行します。 Jacl を使用:
$AdminTask help -commandGroups
Jython を使用:print AdminTask.help('-commandGroups')
出力例:WASX8005I: Available admin command groups: AdminAgentNode - Admin Agent Managed Node related tasks AdminAgentSecurityCommands - Commands used to configure security related items during Admin Agent registration. AdminReports - Admin configuration reports AdminSDKCmds - Admin commands related to pluggable SDKs AdministrativeJobs - This command group contains all the job management commands . AppManagementCommands - Application management commands. ...
- 使用可能なコマンドをリストするには、-commands パラメーターを指定して help コマンドを実行します。 Jacl を使用:
$AdminTask help -commands
Jython を使用:print AdminTask.help('-commands')
出力例:WASX8004I: Available administrative commands: copyResourceAdapter - copy the specified J2C resource adapter to the specified scope createCluster - Creates a new application server cluster. createClusterMember - Creates a new member of an application server cluster. createJ2CConnectionFactory - Create a J2C connection factory deleteCluster - Delete the configuration of an application server cluster. deleteClusterMember - Deletes a member from an application server cluster. listConnectionFactoryInterfaces - list all of the defined connection factory interfaces on the specified J2C resource adapter. listJ2CConnectionFactories - List J2C connection factories that have a specified connection factory interface defined in the specified J2C resouce adapter createJ2CAdminObject - Create a J2C administrative object. listAdminObjectInterfaces - List all the defined administrative object interfaces on the specified J2C resource adapter. interface on the specified J2C resource adapter. listJ2CAdminObjects - List the J2C administrative objects that have a specified administrative object interface defined in the specified J2C resource adapter. createJ2CActivationSpec - Create a J2C activation specification. listMessageListenerTypes - list all of the defined messageListener type on the specified J2C resource adapter. listJ2CActivationSpecs - List the J2C activation specifications that have a specified message listener type defined in the specified J2C resource adapter.
- 特定のコマンド・グループに関するヘルプを取得するには、グループ名を指定して help コマンドを実行します。 Jacl を使用:
$AdminTask help JCAManagement
Jython を使用:print AdminTask.help('JCAManagement')
出力例:WASX8007I: Detailed help for command group: JCAManagement Description: A group of administrative commands that help to configure Java 2 Connector Architecture (J2C)-related resources. Commands: createJ2CConnectionFactory - Create a J2C connection factory listConnectionFactoryInterfaces - list all of the defined connection factory interfaces on the specified J2C resource adapter. listJ2CConnectionFactories - List J2C connection factories that have a specified connection factory interface defined in the specified J2C resouce adapter. createJ2CAdminObject - Create a J2C administrative object. listAdminObjectInterfaces - List all the defined administrative object interfaces on the specified J2C resource adapter. listJ2CAdminObjects - List the J2C administrative objects that have a specified administrative object interface defined in the specified J2C resource adapter. createJ2CActivationSpec - Create a J2C activation specification. listMessageListenerTypes - list all of the defined message listener types on the specified J2C resource adapter. listJ2CActivationSpecs - List the J2C activation specifications that have a specified message listener type defined in the specified J2C resource adapter. copyResourceAdapter - copy the specified J2C resource adapter to the specified scope.
- 特定の管理コマンドに関するヘルプを取得するには、パラメーター名を指定して help コマンドを実行します。 Jacl を使用:
$AdminTask help createJ2CConnectionFactory
Jython を使用:print AdminTask.help('createJ2CConnectionFactory')
出力例:前にリストしたコマンド特定のヘルプ出力では、 管理コマンドは ターゲット・オブジェクト、引数、 およびステップの 3 つの入力域に分かれています。 各領域では、管理コマンドに応じた入力が必要です。 ある入力域に入力が必要な場合、それぞれの入力はその名前と説明によっ て記述されます。ただし、ターゲット・オブジェクト域については、ターゲ ット・オブジェクトの説明のみが含まれています。 バッチ・モードで管理コマンドを使用する場合は、引数名として引数域にある任意の入力名を使用できます。WASX8006I: Detailed help for command: createJ2CConnectionFactory Description: Create a J2C connection factory *Target object: The parent J2C resource adapter of the created J2C connection factory. Arguments: *connectionFactoryInterface - A connection factory interface that is defined in the deployment description of the parent J2C resource adapter. *name - The name of the J2C connection factory. *jndiName - The JNDI name of the created J2C connection factory. description - The description for the created J2C connection factory. authDataAlias - the authentication data alias of the created J2C connection factory. Steps: なし
入力が必要な場合は、名前の前にアスタリスク (*) が付きます。 領域に入力が必要でない場合は、なし というマークが付きます。以下の例では、createJ2CConnectionFactory コマンドに、ヘルプ出力を使用します。- ターゲット・オブジェクト域には J2CResourceAdapter の構成オブジェクト名が必要です。
- 引数域には 5 つの入力項目があり、そのうちの 3 つは必須入力項目です。
引数の名前は、connectionFactoryInterface、name、jndiName、description、および authDataAlias です。
これらの名前はパラメーター名としてオプション・ストリングで使用され、バッチ・モードで管理コマンドを実行します。以下に例を示します。
引数オプションの指定について詳しくは、『wsadmin スクリプトを使用する管理コマンド呼び出し構文』を参照してください。-connectionFactoryInterface javax.resource.cci.ConnectionFactory -name newConnectionFactory -jndiName CF/newConnectionFactory
- この管理コマンドには関連するステップはありません。
- コマンド・ステップに関するヘルプを取得するには、ステップ固有のヘルプを使用します。 ステップ固有のヘルプは、以下のデータを提供します。
- コマンド・ステップの説明。
- このステップがコレクションをサポートしている場合は、それを示す情報。コレクションには同じ種類のオブジェクトが含まれます。 コマンド・ステップでは、コレクションは同じパラメーター・セットを持つオブジェクトを含んでいます。
- 名前と説明による、各ステップ・パラメーターに関する情報。 ステップ・パラメーターが必要な場合は、名前の前にアスタリスク (*) が付きます。
以下の例ではコマンド・ステップに関するヘルプを取得します。
Jacl を使用:$AdminTask help createCluster clusterConfig
Jython を使用:print AdminTask.help('createCluster', 'clusterConfig')
出力例:WASX8013I: Detailed help for step: clusterConfig Description: Specifies the configuration of the new server cluster. Collection: No Arguments: *clusterName - Name of server cluster. preferLocal - Enables node-scoped routing optimization for the cluster.
この例では clusterConfig のステップに関する、以下の情報を示しています。- このステップはコレクションをサポートしていません。clusterName および perferLocal パラメ ーターには 1 セットのパラメーター値のみがサポートされます。
- このステップには 2 つの入力引数があり、そのうちの 1 つは必須
です。
必須引数は clusterName であり、必須ではないパラメーターは preferLocal です。ステップ・パラメーター値を提供する構文は、コマンド引数値とは異なります。
ステップのすべての引数値を、そのステップ固有のヘルプに表示された順番どおりに指定する必要があります。値を指定しないオプションの引数については、値の代わりに二重引用符 ("") を入力します。
例えば、コマンド・ステップがコレクション・タイプの場合、コマンド・
ステップに複数のオブジェクトを含め、各オブジェクトで同じ引数セット
を使用することができるため、各オブジェクトをそれぞれ固有の中括弧で
囲むことにより、複数のオブジェクトを指定することができます。
バッチ・モードで管理コマンドを実行し、このステップをオプション・ストリングに含めるには、以下の構文を使用します。
Jacl を使用:
-clusterConfig {{newCluster false}}
Jython を使用:
パラメーター・オプションの指定について詳しくは、『wsadmin スクリプトによる管理コマンド呼び出し構文 (Administrative command invocation syntax using wsadmin scripting)』を参照してください。-clusterConfig [[newCluster false]]
- ワイルドカード文字を使用して、特定のコマンドのヘルプを検索します。
Java 正規式パターンまたはワイルドカード・パターンを使用して、AdminTask.help('–commands') のコマンド名と AdminConfig list、types、および listTemplates 関数を指定します。
- Java 正規式パターンを使用して、create で始まる管理コマンド名を検索するには、
以下を指定します。
print AdminTask.help("-commands", "create.*")
- ワイルドカード検索パターンを使用して、create で始まる管理コマンド名を検索するには、
以下を指定します。
print AdminTask.help("-commands", "create*")
- Java 式パターンを使用して、SSLConfig を含む管理コマンド名を検索するには、
以下を指定します。
print AdminTask.help("-commands", ".*SSLConfig.*")
- ワイルドカード検索パターンを使用して、SSLConfig を含む管理コマンド名を検索するには、
以下を指定します。
print AdminTask.help("-commands", "*SSLConfig*")
- Java 正規式パターンを使用して、create で始まる管理コマンド名を検索するには、
以下を指定します。


http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=txml_gethelp
ファイル名:txml_gethelp.html