wsadmin スクリプトを使用する AdminTask オブジェクトのコマンド
wsadmin ツールで AdminTask オブジェクトを使用して、管理コマンドを実行します。
管理コマンドは、wsadmin ツールを開始するときに動的にロードされます。使用可能な管理コマンドおよびこれらのコマンドを使用して実行できることは、 ご使用の製品のエディションに応じて異なります。
wsadmin ツールで -conntype NONE オプションを使用することによって、サーバーを実行せずにスクリプト・クライアントを開始できます。 AdminTask 管理コマンドは、接続モードおよびローカル・モードの両方で使用可能です。 サーバーが実行中である場合は、 AdminTask コマンドをローカル・モードで実行することは推奨されません。 これは、ローカル・モードで行われた構成変更はいずれも、 実行中のサーバー構成に反映されず、その逆の場合も同じためです。 競合する構成を保存すると、構成を破壊する場合があります。
デプロイメント・マネージャー環境では、構成の更新は、スクリプト・クライアントがデプロイメント・マネージャーに接続されている場合にのみ可能です。ノード・エージェントまたは管理対象アプリケーション・サーバーに接続している場合は、 構成を更新することはできません。 これは、これらのサーバー・プロセスの構成は、 デプロイメント・マネージャーにあるマスター構成のコピーであるためです。 これらのコピーは、デプロイメント・マネージャーとノード・エージェントの間で構成の同期が行われる際に、ノード・マシン上に作成されます。 サーバー・プロセスに対する構成変更は、スクリプト・クライアントをデプロイメント・マネージャーに接続して行います。構成を変更する際に、 ノード・マシン上でスクリプト・クライアントをローカル・モードで実行することは、サポートされておりませんので、実行しないでください。
set nodeparm "node1"
$AdminTask setJVMMaxHeapSize [subst {-serverName server1 -nodeName $nodeparm -maximumHeapSize 100}]
createTCPEndPoint
createTCPEndPoint コマンドは、TCP インバウンド・チャネルと関連付けることができるエンドポイントを新規に作成します。
ターゲット・オブジェクト
TCPInboundChannel を含む TransportChannelService の親インスタンス。 (ObjectName、必須)必須パラメーター
- -name
- 新規のエンドポイントの名前を指定します。(ストリング、必須)
- -host
- 新規のエンドポイントのホストを指定します。(ストリング、必須)
- -port
- 新規のエンドポイントのポートを指定します。(ストリング、必須)
オプション・パラメーター
なし。出力例
このコマンドは、作成されたエンドポイントのオブジェクト名を戻します。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask createTCPEndPoint (cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1) {-name Sample_End_Pt_Name -host mybuild.location.ibm.com -port 8978}
- Jython ストリングを使用:
AdminTask.createTCPEndPoint('cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1', '[-name Sample_End_Pt_Name -host mybuild.location.ibm.com -port 8978]')
- Jython リストを使用:
AdminTask.createTCPEndPoint('cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TransportChannelService_1', ['-name', 'Sample_End_Pt_Name', '-host', 'mybuild.location.ibm.com', '-port', '8978'])
対話モードの使用例:
- Jacl を使用:
$AdminTask createTCPEndPoint {-interactive}
- Jython の使用:
AdminTask.createTCPEndPoint('-interactive')
getTCPEndPoint
getTCPEndPoint は、 TCP インバウンド・チャネルまたは TCP インバウンド・チャネルを含むチェーンに関連付けられた、 指定のエンドポイントを取得するコマンドです。
ターゲット・オブジェクト
NamedEndPoint に関連付けられた TCPInboundChannel、 またはそれを含むチェーンのインスタンス。 (ObjectName、必須)必須パラメーター
なし。オプション・パラメーター
なし。出力例
このコマンドは、TCP インバウンド・チャネル・インスタンスまたはチャネル・チェーンに関連付けられている、既存の名前付きエンドポイントのオブジェクト名を戻します。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask getTCPEndPoint TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)
$AdminTask getTCPEndPoint DCS(cells/mybuildCell01/nodes/mybuildCellManager01 /servers/dmgr|server.xml#Chain_3)
- Jython ストリングを使用:
print AdminTask.getTCPEndPoint('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)')
print AdminTask.getTCPEndPoint('DCS(cells/mybuildCell01/nodes/mybuildCellManager01 /servers/dmgr|server.xml#Chain_3)')
- Jython リストを使用:
print AdminTask.getTCPEndPoint('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01 /servers/dmgr|server.xml#TCPInboundChannel_1)')
print AdminTask.getTCPEndPoint('DCS(cells/mybuildCell01/nodes/mybuildCellManager01 /servers/dmgr|server.xml#Chain_3)')
対話モードの使用例:
- Jacl を使用:
$AdminTask getTCPEndPoint {-interactive}
- Jython の使用:
print AdminTask.getTCPEndPoint('-interactive')
help
help は、ヘルプ・コマンドの要約と、 管理コマンドを呼び出す方法を提供するコマンドです。コマンド構文内でワイルドカード文字 (*) または Java 正規表現 (.*) を使用して、検索照会をカスタマイズすることができます。
ターゲット・オブジェクト
なし。オプション・パラメーター
- -commands
- help コマンドは、-commands パラメーターを指定する場合に使用可能な管理コマンドのリストを提供します。 (ストリング、オプション)
- -commandGroups
- help コマンドは、-commandGroups パラメーターを指定する場合に使用可能な管理コマンド・グループのリストを提供します。 (ストリング、オプション)
- -commandName
- help コマンドは、所定の管理コマンドのヘルプ情報を提供します。 (ストリング、オプション)
- -stepName
- help コマンドは、管理コマンドの所定のステップのヘルプ情報を提供します。 (ストリング、オプション)
出力例
このコマンドは、AdminTask オブジェクトの汎用コマンド情報を戻します。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask help
- Jython の使用:
print AdminTask.help()
- Jacl を使用:
$AdminTask help -commands
- Jython の使用:
print AdminTask.help('-commands')
- Jacl を使用:
$AdminTask help createJ2CConnectionFactory
- Jython の使用:
print AdminTask.help('createJ2CConnectionFactory')
- Jacl を使用:
$AdminTask help -commands *create*
- Jython の使用:
print AdminTask.help('-commands *create*')
- Jacl を使用:
$AdminTask help -commands <pattern>
- Jython の使用:
print AdminTask.help('-commands <pattern>')
listTCPEndPoints
listTCPEndPoints は、 TCP インバウンド・チャネルと関連付けることのできるすべての指定されたエンドポイントをリストするコマンドです。
ターゲット・オブジェクト
指定されたエンドポイントの候補が リストされる TCP インバウンド・チャネル・インスタンス。 (ObjectName、必須)必須パラメーター
なし。オプション・パラメーター
- -excludeDistinguished
- 指定された非識別のエンドポイントのみを表示するかどうかを指定します。このパラメーターに、値は必要ありません。 (ブール値、オプション)
- -unusedOnly
- 指定されたエンドポイントのうち、他の TCP インバウンド・チャネル・インスタンスで使用されていないものを表示するかどうかを指定します。 このパラメーターに、値は必要ありません。(ブール値、オプション)
出力例
このコマンドは、指定された適格なエンドポイントのオブジェクト名のリストを戻します。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask listTCPEndPoints TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)
$AdminTask listTCPEndPoints TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1) {-excludeDistinguished}
$AdminTask listTCPEndPoints TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1) {-excludeDistinguished -unusedOnly}
- Jython ストリングを使用:
print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished]')
print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished]')
print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', '[-excludeDistinguished -unusedOnly]')
- Jython リストを使用:
print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', ['-excludeDistinguished'])
print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', ['-excludeDistinguished'])
print AdminTask.listTCPEndPoints('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)', ['-excludeDistinguished', '-unusedOnly'])
対話モードの使用例:
- Jacl を使用:
$AdminTask listTCPEndPoints {-interactive}
- Jython の使用:
print AdminTask.listTCPEndPoints('-interactive')
listTCPThreadPools
listTCPThreadPools は、 TCP インバウンド・チャネルまたは TCP アウトバウンド・チャネルと関連付けられるすべてのスレッド・プールをリストするコマンドです。
ターゲット・オブジェクト
ThreadPool 候補がリストされる TCPInboundChannel または TCPOutboundChannel インスタンス。 (ObjectName、必須)必須パラメーター
なし。オプション・パラメーター
なし。出力例
このコマンドは、適格なスレッド・プール・オブジェクト名のリストを戻します。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask listTCPThreadPools TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)
- Jython ストリングを使用:
print AdminTask.listTCPThreadPools('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)')
- Jython リストを使用:
print AdminTask.listTCPThreadPools('TCP_1(cells/mybuildCell01/nodes/mybuildCellManager01/servers/dmgr|server.xml#TCPInboundChannel_1)')
対話モードの使用例:
- Jacl を使用:
$AdminTask listTCPThreadPools {-interactive}
- Jython の使用:
print AdminTask.listTCPThreadPools('-interactive')
updateAppOnCluster
updateAppOnCluster は、ノードを同期し、 クラスターにデプロイされるアプリケーション更新のためにクラスター・メンバーを再始動する場合に使用できるコマンドです。 アプリケーションの更新後は、このコマンドを使用してノードを同期する場合に、 すべてのノード上のすべてのクラスター・メンバーを一度に停止する必要がなくなります。 このコマンドでは、一度に 1 つのノードが同期されます。各ノードを同期するには、 そのアプリケーションがターゲットとなっているクラスター・メンバーを停止し、 ノードの同期オペレーションを実行してから、クラスター・メンバーを再始動します。
このコマンドでは、ターゲット・クラスターに含まれるノード数によって、 デフォルトのコネクター・タイムアウト期間より長い時間がかかることがあります。 SOAP コネクターを使用する場合は profile_root/properties ディレクトリー内の soap.client.props ファイル内に、 JSR160RMI コネクターまたは RMI コネクターを使用する場合は sas.client.props ファイル内に、 IPC コネクターを使用する場合は ipc.client.props ファイル内に、 適切なタイムアウト値を設定してください。
このコマンドは、ローカル・モードではサポートされません。
ターゲット・オブジェクト
なし。必須パラメーター
- -ApplicationNames
- 更新されるアプリケーションの名前を指定します。(ストリング、必須)
オプション・パラメーター
- -timeout
- 各ノード同期のタイムアウト値 (秒) を指定します。 デフォルトは 300 秒です。(整数、オプション)
出力例
このコマンドは出力を返しません。例
バッチ・モードの使用例:
- Jacl を使用:
$AdminTask updateAppOnCluster {-ApplicationNames app1}
$AdminTask updateAppOnCluster { -ApplicationNames app1 -timeout 600}
- Jython ストリングを使用:
AdminTask.updateAppOnCluster('[-ApplicationNames app1]')
AdminTask.updateAppOnCluster('[-ApplicationNames app1 -timeout 600]')
- Jython リストを使用:
AdminTask.updateAppOnCluster(['-ApplicationNames', 'app1'])
AdminTask.updateAppOnCluster(['-ApplicationNames', 'app1', '-timeout', '600'])
対話モードの使用例:
- Jacl を使用:
$AdminTask updateAppOnCluster -interactive
- Jython の使用:
AdminTask.updateAppOnCluster('-interactive')