AdminTask オブジェクトの Utility コマンド・グループ

Jython または Jacl スクリプト言語を使用すると、wsadmin ツールでサーバーを管理することができます。 ユーティリティー・グループの コマンドおよびパラメーターは、ノードのホスト名の変更、デプロイメント・マネージャーの名前の照会、 およびシステムがシングル・サーバーか Network Deployment かの判断に 使用できます。

AdminTask オブジェクトの Utility コマンド・グループには、以下のコマンドが含まれます。

changeHostName

changeHostName コマンドは、ノードのホスト名を変更する場合に使用します。

問題の回避: IPC コネクターとマルチキャスト・エンドポイントは特殊なエンドポイントです。 これらのエンドポイントは、changeHostName コマンドで変更しないでください。

ターゲット・オブジェクト

なし

パラメーターおよび戻り値

-hostName
新規ホスト名。 (ストリング、必須)
-nodeName
ホスト名が変更されるノードの名前。 (ストリング、必須)

オプション・パラメーター:

-systemName
このノードが稼働する z/OS システムの名前。 このフィールドは、ノードがシステム間で (例えば、システム SYSA からシステム SYSB に) 移動される場合のみ必要です。 このパラメーターに指定する値が明確でない場合は、z/OS システム上で IPLINFO コマンドを発行して、Sysname= フィールドにこのパラメーターの値として表示される名前を使用してください。
注: changeHostName コマンドを対話式に実行すると、 systemName パラメーターが表示されますが、これは z/OS システムでのみ使用されます。 systemName パラメーターは、server.xml ファイルで was.ConfiguredSystemName プロパティーの値として定義された z/OS システム名を表します。 systemName パラメーターが選択されると、このプロパティーは変更されます。
-regenDefaultCert
デフォルトの証明書を再生成する要求。 デフォルトの証明書を再生成する場合、このパラメーターに有効な値は "true" のみです。 その他の値はすべて、デフォルトの証明書を再生成しないことを想定しています。 ストリング引数はブール値として処理されます。 返されるブール値は、ストリング引数が非ヌルの場合、および、大/小文字を無視してストリング「true」と同等の場合に、値 true を示します。 regenDefaultCert パラメーターは AdminTask.createChainedCertificate と同様に機能します。このパラメーターには以下のデフォルト値があります。
  • -keyStoreName "NodeDefaultKeyStore"
  • -keyStoreScope "(node):" + nodeName
  • -certificateAlias" "default_" + hostName
  • -certificateCommonName" nodeName
  • -certificateOrganization" "IBM"
  • -certificateOrganizationalUnit" nodeName
  • -certificateCountry "US"
注: AdminTask.createChainedCertificate パラメーターと regenDefaultCert パラメーターの両方で、デプロイメント・マネージャー・ノードを使用する場合、-keyStoreName 値は-keyStoreName "CellDefaultKeyStore" に変更され、-keyStoreScope 値は-keyStoreScope "(cell):" + cellname に変更されます。

この切り替えは、証明書パラメーターのデフォルト値に関していろいろ仮定する簡易切り替えです。 デフォルト値が使用されない場合は、代わりに AdminTask.createChainedCertificate または regenDefaultCert を使用する必要があります。

以下の機能の詳細に注意してください。
  • keyStoreName および keyStoreScope は、regenDefaultCert パラメーターでは無効です。
  • changeHostName コマンドを実行する時、certificateCommonName (新規証明の CN) を指定することはできません。 新規ホスト名を CN として指定するには、AdminTask.createChainedCertificate を使用する必要があります。

バッチ・モードの使用例:

  • Jacl を使用:

    $AdminTask changeHostName {-hostName host_name -nodeName node_name 
    -systemName system_name}
  • Jython ストリングを使用:

    AdminTask.changeHostName('-hostName host_name -nodeName node_name 
    -systemName system_name')
  • Jython リストを使用:

    AdminTask.changeHostName(['-hostName', 'host_name', '-nodeName', 'node_name',
    '-systemName', 'system_name'])

対話モードの使用例:

  • Jacl を使用:

    $AdminTask changeHostName {-interactive}
  • Jython ストリングを使用:

    AdminTask.changeHostName ('[-interactive]')
  • Jython リストを使用:

    AdminTask.changeHostName (['-interactive'])

getDmgrProperties

getDmgrProperties コマンドは、デプロイメント・マネージャーの名前を戻す場合に使用します。

ターゲット・オブジェクト

なし

パラメーターおよび戻り値

  • パラメーター: なし
  • 戻り値: Network Deployment システムのデプロイメント・マネージャーの名前。 システムがシングル・サーバーの場合、空ストリングを戻します。

バッチ・モードの使用例:

  • Jacl を使用:

    $AdminTask getDmgrProperties {}
  • Jython を使用:

    AdminTask.getDmgrProperties()

isFederated

isFederated コマンドは、システムが単一サーバーであるのかネットワーク・デプロイメントであるのかを調べるために使用します。

ターゲット・オブジェクト

なし

パラメーターおよび戻り値

  • パラメーター: なし
  • 戻り値: ブール値。 システムが Network Deployment システムの場合は true。 それ以外の場合、false を返します。

バッチ・モードの使用例:

  • Jacl を使用:
    $AdminTask isFederated {}
  • Jython ストリングを使用:
    AdminTask.isFederated ()

renameCell

renameCell コマンドを使用して、スタンドアロン・アプリケーション・サーバー、デプロイメント・マネージャー、管理エージェント、ジョブ・マネージャー、および統合ノードのプロファイルのセル名を変更します。 このコマンドは、wsadmin ローカル・モード ( wsadmin -conntype noneなど) でのみ実行できます。
問題の回避: 異なる WebSphere Application Server バージョンでインストールされたノードがセルに含まれている混合セル環境では、 renameCell コマンドを使用しないでください。

ターゲット・オブジェクト

なし

パラメーターおよび戻り値

-newCellName
新規セル名。 (ストリング、必須)
-dmgr_host
デプロイメント・マネージャー・コンピューターのホストまたは IP アドレスの名前。 (ストリング、コマンドを統合ノードで実行する場合には必須)
-dmgr_port
Java Management Extensions (JMX) 接続ポート。 (ストリング、コマンドを統合ノードで実行する場合には必須。 指定されなかった場合はデフォルト値の「8879」が使用されます。)
-connType
デプロイメント・マネージャーへの接続に使用する JMX コネクター・タイプ。 SOAP は、このコマンドのデフォルトの JMX コネクター・タイプです。 他の有効なタイプには、JSR160RMI やリモート・メソッド呼び出し (RMI) があります。 (ストリング、コマンドを統合ノードで実行する場合には必須。 指定されなかった場合はデフォルト値の「SOAP」が使用されます。)
-userName
セキュリティーが有効な場合、認証のためのユーザー名。 (ストリング、コマンドを統合ノードで実行し、セキュリティーが有効になっている場合には必須)
-password
セキュリティーが有効な場合、認証のためのパスワード。 (ストリング、コマンドを統合ノードで実行し、セキュリティーが有効になっている場合には必須)

オプション・パラメーター:

-regenCerts
セルのすべてのノードの Secure Sockets Layer (SSL) 証明書を再生成するかどうかを決定します。 デフォルトの鍵ストアの証明書だけが再生成されます。 このパラメーターは、z/OS オペレーティング・システム上のセルには適用されません。 証明書を再生成すると、サーバーにアクセスするクライアントは、新しい証明書を取得してサーバーとの信頼関係を再確立することが必要になる点に留意してください。 デフォルト値は false です。 セルのノードの SSL 証明書を再生成するには、true に設定します。 (ブール値、オプション)
-updateJaccContextID
Java Authorization Contract for Containers (JACC) プロバイダーによって使用されるアプリケーションのセキュリティー・コンテキスト ID を更新するかどうかを決定します。 デフォルト値は falseです。 セキュリティー・コンテキスト ID を更新するには、true に設定します。 (ブール値、オプション)

バッチ・モードの使用例:

  • Jython ストリングを使用:
    AdminTask.renameCell('-newCellName new_cell_name')
  • Jython リストを使用:
    AdminTask.renameCell(['-newCellName', 'new_cell_name'])

対話モードの使用例:

  • Jython ストリングを使用:
    AdminTask.renameCell ('[-interactive]')
  • Jython リストを使用:
    AdminTask.renameCell (['-interactive'])

renameCell を使用するシナリオの例

問題の回避: renameCell コマンドを使用してノードのセル名を変更する前に、 profile_root/bin ディレクトリーから backupConfig ツールを使用してノード構成をバックアップすることをお勧めします。 renameCell コマンドの結果が満足できるものでなかった場合、およびrenameCell コマンドの実行が予期せずに失敗した場合は、restoreConfig ツールを使用してバックアップ構成をリストアします。
問題の回避: renameCell コマンドを実行する前に、 profile_root/bin/setupCmdLine スクリプト・ファイルをバックアップしてください。 このコマンドはこのファイル内のセル名を新しいセル名に更新しますが、このコマンドの実行結果として生じた構成変更をユーザーが破棄すると決めた場合、このコマンドでセル名を元に戻すことはできません。 そのように決めた場合は、構成変更を破棄した後に、ファイルをリストアする必要があります。そのようにしないと、このプロファイル内のサーバーを始動できなくなります。
スタンドアロン・アプリケーション・サーバーのセルの名前変更:
  • スタンドアロン・サーバーを停止します。
  • wsadmin をローカル・モードで使用して、次のようにセルの名前を変更します。
    AdminTask.renameCell('-newCellName new_cell_name')
デプロイメント・マネージャーおよびその統合ノードのセルの名前変更:

Network Deployment トポロジーのセルの名前を変更するには、コマンドをデプロイメント・マネージャー・ノード/プロファイルおよびすべての統合ノード/プロファイルに対して実行する必要があります。

問題の回避: セルがマルチセル・トポロジーの一部である場合は、これらのステップの前に他のセルからセルをリンク解除し、ステップの後に再度リンクします。
  • デプロイメント・マネージャー・サーバー、ノード・エージェント・サーバー、およびすべてのアプリケーション・サーバーも含め、セル内のすべてのサーバーを停止します。
  • デプロイメント・マネージャー・ノード/プロファイルのセルを名前変更します。つまり、ローカル・ノードの wsadmin を使用して下記のコマンドを実行します。これにより、セル名の変更のほか、dmgr マスター・リポジトリー内の SSL 証明書の変更も行われます。
    AdminTask.renameCell('[-newCellName new_cell_name]')
  • セル内のすべての統合ノード/プロファイルに対して、セルの名前変更コマンドを実行します。
  • デプロイメント・マネージャー・サーバーを始動します。
  • 各ノード・エージェントのプロファイル、およびデプロイメント・マネージャー・ノードでないすべてのノードで、wsadmin をローカル・モードで開始し、下記のコマンドを実行します。
    AdminTask.renameCell('[-newCellName new_cell_name -dmgr_host dmgr_hostname -dmgr_port dmgr_soap_port -connType SOAP -userName my_user -password my_password]')
管理エージェント・サーバーのセルの名前変更:
  • 管理エージェント・サーバーを停止します。
  • wsadmin をローカル・モードで使用して、次のようにセルの名前を変更します。
    AdminTask.renameCell('-newCellName new_cell_name')
注: 管理エージェント・サーバーに登録されているスタンドアロン・アプリケーション・サーバーのセルの名前を変更する場合は、まずそのスタンドアロン・ノードをその管理サーバーから登録抹消する必要があります。 スタンドアロン・ノードを管理サーバーで引き続き管理する場合は、セルの名前変更コマンドを実行した後に、ノードを管理サーバーに再び登録する必要があります。
ジョブ・マネージャー・サーバーのセルの名前変更:
  • ジョブ・マネージャー・サーバーを停止します。
  • wsadmin をローカル・モードで使用して、次のようにセルの名前を変更します。
    AdminTask.renameCell('-newCellName new_cell_name')
    トラブルの回避: これはスタンドアロン・ジョブ・マネージャー・プロファイル専用です。 ジョブ・マネージャーとして機能しているデプロイメント・マネージャーには使用しないでください。
マルチセル・トポロジー内のセルの名前変更:

スター型トポロジーなどのマルチセル・トポロジー内のセルを名前変更するには、名前変更の前に、セルを他のセルから切り離しておく必要があります。 セルの名前変更の後、セルを他のセルに再び接続してください。