2. エクスポート/インポート

2.1. ソフトウェア条件

2.1.1. エクスポート対象の環境

エクスポートの対象はWebOTX Application Serverのユーザドメインの設定です。管理ドメイン(WebOTXAdmin または admin)の設定、 V9以前のEnterpriseエディションにあるclusterドメイン、proxyドメインはエクスポートできません。

2.1.2. インポート対象の環境

export-configコマンドで生成したCSVファイルは、import-configコマンドでインポートできます。
ただし、エクスポートした環境とインポート先の環境に関して次の条件がありますので、注意してください。

Caution インポート時には、設定ファイルの一部を環境に合わせて変更する必要があります。主に変更対象となるのは下記の設定です。
Caution インポート後には以下のコマンドを実行してください。
otxadmin> set server.http-service.virtual-server.__otxadmin.hosts=localhost
2.1.2.1. インポート対象外

ドメインの起動/停止などの基本動作に影響を与える属性は、インポート対象外としています。また、V9、V10以降、廃止になったMBeanや属性、またはDottedNameが変更となった属性はインポートの対象外となります。既定値から変更する場合は、インポート完了後に手動で変更してください。 エディション毎にインポート対象外のMBean,及びその属性を記載します。

Expressエディション

インポートされないMBeanは以下の通りです。

インポートされない属性は以下の通りです。

Standardエディション

インポートされないMBeanは以下の通りです。

インポートされない属性は以下の通りです。

MBean以外のインポート対象外の設定

以下の設定はエディションに関わらず、インポート対象外です。それぞれの対処方法に従って再設定してください。

MBean以外のインポート対象外の設定
設定 対処方法
管理ドメイン(WebOTXAdmin または admin)の設定 管理ドメインをインポートするためにはマイグレーションアシスタントを利用してください。
deploydirコマンドで配備されたアプリケーション import-configコマンド実行前に、CSVファイルを編集し、該当のアプリケーションをインポート対象外としてください。そして、import-configコマンド実行後、deploydirコマンドにて該当のアプリケーションを配備してください。
プロファイル インポート先で、再度XMLファイルを所定の場所に手動で配置してください。
JDBCドライバ、キーファイル、証明書ファイルなど、システム構築者が手動でWebOTXディレクトリ配下に配置したファイル インポート先の同じディレクトリ配下に手動で配置してください。
server.policyファイル インポート先のserver.policyファイルに対して必要な定義を追加してください。
ユーザ インポート先のドメインに対して、create-file-userコマンド等を利用して再度作成してください。
clusterドメイン、proxyドメイン 対処策はありません。

2.2. 利用方法

2.2.1. エクスポート

WebOTX Application Serverの管理対象であるユーザドメインの設定情報の抽出(エクスポート)を行う機能です。
オプションを用いて、ドメインに接続し、設定された情報を取得します。

使用手順は以下のとおりです。Unix環境の場合は、\ を / に読み換えてください。

  1. otxadminコマンドを下記のように実行します。 使用できるオプションについては、下記に記載してある「export-configコマンド オプション一覧」を、オペランドについては「export-configコマンド オペランド」を参照してください。

    otxadmin > export-config --user admin --password password --host localhost --port 6212 --outputfile sample <domain_name>
    
    export-configコマンド オプション一覧
    コマンド引数 説明 既定値
    --user ドメインの管理ユーザ名です。 admin
    --password ドメインの管理ユーザのパスワードです。 password
    --host ドメインが起動しているマシン名です。 localhost
    --port ドメインの管理ポート番号です。 6212
    --protocol ドメインとの接続プロトコルを選択します。
    指定できるプロトコルは、rmi、jmxmpです。
    rmi
    --secure trueを指定すると、ドメインとの通信にSSL/TLSを利用します。既定値はfalseです。 false
    --help コマンドで使用できるオプションを表示します。 false
    --outputfile CSV形式にて出力するファイル名です。 以下に記述した文字はoutputfile及びディレクトリ名に指定することが出来ません。
    \, /, :, *, ?, ", <, >, |, #, %
    <ドメイン名>_<日時>.csv
    --type 入力する設定の種類を以下より選択する。プロファイルは、エクスポートすることはできますが、インポートはできません。
    • 全体(all)
    • ドメイン(domain)
    • TPシステム(tpsystem)
    • アプリケーション(applications)
    • リソース(resources)
    • アプリケーションサーバ(server)
    • プロファイル(profiles)
    all
    --visibility 採取できる情報のレベルを指定します。設定できるレベルは1-3です。 レベルが高いほど多くの情報を採取します。 1
    --mask trueの場合、パスワード情報を暗号化して出力します。 falseの場合、パスワード情報を平文で出力します。 true
    export-configコマンド オペランド
    オペランド 説明
    domain_name export対象のドメイン名を指定します。
  2. 指定したオプションに従って、ドメインの設定情報がCSVファイルに出力されます。

    出力場所は outputfile オプションで指定された場所です。既定では ${INSTALL_ROOT}\reports ディレクトリ配下となります。 出力される情報は以下となります。

    export-configコマンド 出力情報一覧
    名称 説明
    ノード名 MBeanの存在する階層を表します。
    属性名 属性の名前です。
    設定値 属性の値です。
    import インポート機能の対象とするかを 0 (対象外)か 1 (対象)で指定します。既定値は 1 です。
    CLIName CLINameです。
    "domain1/アプリケーションサーバ/Java EEサーバ"      ...ノード名
    "Server Vendor","(c) NEC Corporation","1","UT185007"    ...属性名,  設定値,  import,  LIName
    		

2.2.2. インポート

インポートとは、エクスポートを利用して出力した設定情報を、対象のユーザドメインに設定を反映(インポート)する機能です。
エクスポートで出力したCSVファイルを読み込み、CSVファイルに記載された設定を対象のドメインに反映します。設定反映は、import-configコマンドで実施します。コマンド実行時は、オプションを用いて、インポート対象のドメインに接続する必要があります。

  1. import-configコマンドを実行する前に、必ずインポート対象のドメインのファイル(${INSTALL_ROOT}\domains\{対象ドメイン}配下)をdomainsディレクトリ以外の任意の場所にコピーしておいてください。インポートに失敗した際のリカバリ処理に使用します。

  2. 移行先ドメインに配備するアプリケーションを 任意のディレクトリに配置してください。
    ※パスに2バイト文字が含まれると、正しくインポート処理ができませんので注意してください。EJB仕様のMessage Driven Beanは、インポート実行後に手動で配備する必要があるため、ここでは配置しないでください。

  3. インポート時には、設定ファイルの一部を環境に合わせて変更します。主に変更対象となるのは下記の設定です。 その他、[注意事項 > import-configコマンド]を確認して、CSVファイルを編集してください。
  4. import-configコマンドを下記のように実行します。 使用できるオプションについては、下記に記載してある「import-configコマンド オプション一覧」を、オペランドについては「import-configコマンド オペランド」を参照してください。
    otxadmin >  import-config --user admin --password password --adminuser admin --adminpassword password --type all --inputfile sample.csv domain_name
    
    ※存在しないMBeanの属性をインポートしようとした場合は以下のようなログが出力され、設定はスキップされます。
    対象のMBeanが存在しなかったため、server.http-service.connection-poolの設定に失敗しました。
    対象のMBeanが存在しなかったため、server.http-service.http-file-cacheの設定に失敗しました。
    対象のMBeanが存在しなかったため、server.http-service.http-listener.admin-listenerの設定に失敗しました。
    
  5. インポート後には以下のコマンドを実行してください。
    otxadmin> set server.http-service.virtual-server.__otxadmin.hosts=localhost
import-configコマンド オプション一覧
オプション 説明 既定値
--user ドメインの管理ユーザ名です。 admin
--password ドメインの管理ユーザのパスワードです。 password
--host ドメインが起動しているマシン名です。 localhost
--port ドメインの管理ポート番号です。 6212
--protocol ドメインとの接続プロトコルを選択します。
指定できるプロトコルは、rmi、jmxmpです。
rmi
--secure trueを指定すると、ドメインとの通信にSSL/TLSを利用します。既定値はfalseです false
--type 出力する設定の種類を以下より選択します。
  • 全体(all)
  • ドメイン(domain)
  • TPシステム(tpsystem)
  • アプリケーション(applications)
  • リソース(resources)
  • アプリケーションサーバ(server)
all
--create インポート対象のドメインに設定対象のMBeanが存在しない場合、そのMBeanの作成を行うためのオプションです。
trueを指定した場合、MBeanの作成、及びアプリケーションの配備を行います。
falseを指定した場合、MBeanの作成とそのMBeanに対する設定処理を実行しません。
true
--repository 配備するアプリケーションが配置されているディレクトリです。 ${INSTALL_ROOT}\reports
--adminuser 管理ドメイン(admin)の管理ユーザ名です。 admin
--adminpassword 管理ドメイン(admin)の管理ユーザのパスワードです。 password
--adminport 管理ドメイン(admin)の管理ポート番号です。 6202
--adminprotocol 管理ドメイン(admin)との接続プロトコルを選択します。
指定できるプロトコルは、rmi、jmxmpです。
rmi
--adminsecure trueを指定すると、管理ドメイン(admin)との通信にSSL/TLSを利用します。既定値はfalseです。 false
--checkonly trueを指定した場合、インポート可能な環境かどうかを確認を行います。結果をメッセージとして出力します。また、この時、インポートは実施されません。 false
--inputfile インポート設定が記載されたCSVファイルを指定してください。 なし
--importpass インポート対象の設定がパスワードの場合、設定を反映するか否か判断するためのオプションです。trueの場合、設定を反映します。 true
--help コマンドで使用できるオプションを表示します。 false
import-configコマンド オペランド
オペランド 説明
domain_name import対象のドメイン名を指定します。
2.2.2.1. リカバリ方法

インポートに失敗した場合は、以下の方法でドメインを元の状態に戻してください。

  1. 対象のドメインを停止してください。
  2. バックアップしておいた${INSTALL_ROOT}\domains\<対象ドメイン>配下で、現在の${INSTALL_ROOT}\domains\<対象ドメイン>配下を置き換えてください。
  3. 対象のドメインを起動してください。

2.2.3. コマンド実行に失敗した場合の対処方法

コマンドの実行に失敗した場合、${INSTALL_ROOT}\logs配下にエラーログが出力されますので、内容を確認して対処してください。

以下に、コマンド実行に失敗する主なケースと、その対処方法を記載します。該当していないかを確認してください。

ドメインへの接続ができない

user、password、host、port、protocol、secure オプションの値が正しいかを確認してください。
また、情報取得対象のドメインが起動していることを確認してください。

ファイルの上書きができない

outputfileオプションに既に存在するファイル名を指定した場合、実行に失敗します。別の出力ファイル名を指定するか、既に存在しているファイルを削除してください。

2バイト文字のディレクトリをrepositoryオプションで指定すると実行することが出来ない

ディレクトリのパスに2バイト文字が含まれる場合実行に失敗します。ディレクトリパスに2バイト文字を含まない場所に、配備アプリケーションを置いてください。

コマンドの実行でストール

情報取得対象のドメインに、大量のアプリケーション及びリソースが登録されていた場合、typeオプションにall、または applications を指定するとコマンドの実行に時間がかかることがあります。
実行中のコマンドを停止したい場合、Ctrl+Cにてコマンドの実行を停止することが可能です。

Caution

2.3. 注意制限事項

2.3.1. 注意事項

2.3.1.1. export-configコマンド
2.3.1.2. import-configコマンド
V8 の Adminutil ツールでエクスポートした CSV ファイルをV9.20以降のバージョンにインポートする場合の注意事項

2.3.2. 制限事項

2.3.2.1. export-configコマンド
2.3.2.2. import-configコマンド