WebOTX Application Serverの管理対象であるユーザドメインの設定情報の抽出(エクスポート)を行う機能です。
オプションを用いて、ドメインに接続し、設定された情報を取得します。
使用手順は以下のとおりです。Unix環境の場合は、\ を / に読み換えてください。
otxadmin > export-config --user admin --password password --host localhost --port 6212 --outputfile sample <domain_name>
コマンド引数 | 説明 | 既定値 |
---|---|---|
--user | ドメインの管理ユーザ名です。 | admin |
--password | ドメインの管理ユーザのパスワードです。 | password |
--host | ドメインが起動しているマシン名です。 | localhost |
--port | ドメインの管理ポート番号です。 | 6212 |
--protocol | ドメインとの接続プロトコルを選択します。 指定できるプロトコルは、rmi、jmxmpです。 |
rmi |
--secure | trueを指定すると、ドメインとの通信にSSL/TLSを利用します。 | false |
--help | コマンドで使用できるオプションを表示します。 | false |
--outputfile | CSV形式にて出力するファイル名です。
以下に記述した文字はoutputfile及びディレクトリ名に指定することが出来ません。 \, /, :, *, ?, ", <, >, |, #, % |
<ドメイン名>_<日時>.csv |
--type | 入力する設定の種類を以下より選択する。プロファイルは、エクスポートすることはできますが、インポートはできません。
|
all |
--visibility | 採取できる情報のレベルを指定します。設定できるレベルは1-3です。 レベルが高いほど多くの情報を採取します。 | 1 |
--mask | trueの場合、パスワード情報を暗号化して出力します。 falseの場合、パスワード情報を平文で出力します。 | true |
オペランド | 説明 |
---|---|
domain_name | export対象のドメイン名を指定します。 |
出力場所は outputfile オプションで指定された場所です。既定では ${INSTALL_ROOT}\reports ディレクトリ配下となります。 出力される情報は以下となります。
名称 | 説明 |
---|---|
ノード名 | MBeanの存在する階層を表します。 |
属性名 | 属性の名前です。 |
設定値 | 属性の値です。 |
import | インポート機能の対象とするかを 0 (対象外)か 1 (対象)で指定します。既定値は 1 です。 |
CLIName | CLINameです。 |
"domain1/アプリケーションサーバ/Java EEサーバ" ...ノード名 "Server Vendor","(c) NEC Corporation","1","UT185007" ...属性名, 設定値, import, LIName
インポートとは、エクスポートを利用して出力した設定情報を、対象のユーザドメインに設定を反映(インポート)する機能です。
エクスポートで出力したCSVファイルを読み込み、CSVファイルに記載された設定を対象のドメインに反映します。設定反映は、import-configコマンドで実施します。コマンド実行時は、オプションを用いて、インポート対象のドメインに接続する必要があります。
異なるホスト名のマシンに設定を移行する場合、ホスト名の変更が必要です。
異なるポート番号を使用する場合、値の変更が必要です。
WebOTXのインストール先が異なる場合や、システムプロパティ等でマシン固有のディレクトリを参照している場合に変更が必要です。
otxadmin > import-config --user admin --password password --adminuser admin --adminpassword password --type all --inputfile sample.csv domain_name
otxadmin> set server.http-service.virtual-server.__otxadmin.hosts=localhost
オプション | 説明 | 既定値 |
---|---|---|
--user | ドメインの管理ユーザ名です。 | admin |
--password | ドメインの管理ユーザのパスワードです。 | password |
--host | ドメインが起動しているマシン名です。 | localhost |
--port | ドメインの管理ポート番号です。 | 6212 |
--protocol | ドメインとの接続プロトコルを選択します。 指定できるプロトコルは、rmi、jmxmpです。 |
rmi |
--secure | trueを指定すると、ドメインとの通信にSSL/TLSを利用します。 | false |
--type | 出力する設定の種類を以下より選択します。
|
all |
--create | インポート対象のドメインに設定対象のMBeanが存在しない場合、そのMBeanの作成を行うためのオプションです。 trueを指定した場合、MBeanの作成、及びアプリケーションの配備を行います。 falseを指定した場合、MBeanの作成とそのMBeanに対する設定処理を実行しません。 |
true |
--repository | 配備するアプリケーションが配置されているディレクトリです。 | ${INSTALL_ROOT}\reports |
--adminuser | 管理ドメイン(WebOTXAdmin)の管理ユーザ名です。 | admin |
--adminpassword | 管理ドメイン(WebOTXAdmin)の管理ユーザのパスワードです。 | password |
--adminport | 管理ドメイン(WebOTXAdmin)の管理ポート番号です。 | 6202 |
--adminprotocol | 管理ドメイン(WebOTXAdmin)との接続プロトコルを選択します。 指定できるプロトコルは、rmi、jmxmpです。 |
rmi |
--adminsecure | trueを指定すると、管理ドメイン(WebOTXAdmin)との通信にSSL/TLSを利用します。 | false |
--checkonly | trueを指定した場合、インポート可能な環境かどうかを確認を行います。結果をメッセージとして出力します。また、この時、インポートは実施されません。 | false |
--inputfile | インポート設定が記載されたCSVファイルを指定してください。 | なし |
--importpass | インポート対象の設定がパスワードの場合、設定を反映するか否か判断するためのオプションです。trueの場合、設定を反映します。 | true |
--help | コマンドで使用できるオプションを表示します。 | false |
オペランド | 説明 |
---|---|
domain_name | import対象のドメイン名を指定します。 |
export-configコマンドで生成したCSVファイルは、import-configコマンドでインポートできます。
ただし、エクスポートした環境とインポート先の環境に関して次の条件がありますので、注意してください。
設定の移行は同オペレーションシステム間のみ実行することができます。
エディションがStandard/Enterpriseの環境において、設定の移行は同一のWebコンテナ動作モード間でのみ実行することができます。
V8.3以降のバージョンからエクスポートした設定ファイルは、V9.20以降の環境に対してインポートすることができます。ただし、エディション間によっては移行できない環境があります。下記の表を参考に確認してください。
○:移行可能 ×:不可
インポート対象の環境 | |||||
---|---|---|---|---|---|
V9.20以降の Express | V9.20以降の Standard | V9.20以降の Enterprise | |||
エクスポートした環境 | V8.x Express | ○ | × | × | |
V8.x Foundation | × | ○ | × | ||
V8.x Standard | × | ○ | ○ | ||
V8.x Enterprise | × | × | ○ | ||
V9.x Express | ○ | × | × | ||
V9.x Standard | × | ○ | × | ||
V9.x Enterprise | × | × | ○ |
V9.22以降、エクスポート環境、インポート環境共に、full-profileの場合のみ、インポートを実行することができます。
異なるホスト名のマシンに設定を移行する場合、ホスト名の変更が必要です。
異なるポート番号を使用する場合、値の変更が必要です。
WebOTXのインストール先が異なる場合や、システムプロパティ等でマシン固有のディレクトリを参照している場合に変更が必要です。
otxadmin> set server.http-service.virtual-server.__otxadmin.hosts=localhost
インポートに失敗した場合は、以下の方法でドメインを元の状態に戻してください。
環境変数,FOO,1,UT131030
,"""BAR""",1,UT131030
アプリケーショングループ,apg,1,UT130000
プロセスグループ,corbajava,1,UT130002
コマンドの実行に失敗した場合、${INSTALL_ROOT}\logs配下にエラーログが出力されますので、内容を確認して対処してください。
以下に、コマンド実行に失敗する主なケースと、その対処方法を記載します。該当していないかを確認してください。
ドメインへの接続ができない
user、password、host、port、protocol、secure オプションの値が正しいかを確認してください。
また、情報取得対象のドメインが起動していることを確認してください。
ファイルの上書きができない
outputfileオプションに既に存在するファイル名を指定した場合、実行に失敗します。別の出力ファイル名を指定するか、既に存在しているファイルを削除してください。
2バイト文字のディレクトリをrepositoryオプションで指定すると実行することが出来ない
ディレクトリのパスに2バイト文字が含まれる場合実行に失敗します。ディレクトリパスに2バイト文字を含まない場所に、配備アプリケーションを置いてください。
コマンドの実行でストール
情報取得対象のドメインに、大量のアプリケーション及びリソースが登録されていた場合、typeオプションにall、または applications を指定するとコマンドの実行に時間がかかることがあります。
実行中のコマンドを停止したい場合、Ctrl+Cにてコマンドの実行を停止することが可能です。
export-configコマンド
import-configコマンド
WebOTXのバージョン及びエディション別インポート対象外の設定
エクスポート環境とインポート環境の組み合わせによりインポートできない設定があります。下記の表に記載された設定は、上位バージョンにて廃止された機能のためインポートできません。
×:インポート不可の組み合わせ
インポート対象の環境 | |||||
---|---|---|---|---|---|
V9.20以降の Express | V9.20以降の Standard | V9.20以降の Enterprise | |||
エクスポートした環境 | V8.x Express | /リソース/永続化リソース ※1 console.war |
× | × | |
V8.x Foundation | × | /リソース/永続化リソース /TPシステム/VDインフォメーション /TPシステム/OLFTPリスナ /TPシステム/ダウンローダ管理サービス ※1 console.war |
× | ||
V8.x Standard | × | /リソース/永続化リソース /TPシステム/VDインフォメーション /TPシステム/OLFTPリスナ /TPシステム/ダウンローダ管理サービス ※1 console.war ※2 CORBA関連の設定 |
/リソース/永続化リソース ※1 console.war |
||
V8.x Enterprise | × | × | /リソース/永続化リソース ※1 console.war |
||
V9.10 Express | /アプリケーションサーバ/iiop-service/IIOPリスナ/<IIOPリスナ名> | × | × | ||
V9.20以降の Express | /ドメイン/プロファイル/ | × | × | ||
V9.20以降の Standard | × | /ドメイン/プロファイル/ | × | ||
V9.20以降の Enterprise | × | × | /ドメイン/プロファイル/ |
export-configコマンド
import-configコマンド
対象のMBeanが存在しなかったため、server.http-service.connection-poolの設定に失敗しました。 対象のMBeanが存在しなかったため、server.http-service.http-file-cacheの設定に失敗しました。 対象のMBeanが存在しなかったため、server.http-service.http-listener.admin-listenerの設定に失敗しました。
以下の設定をインポートすると、ドメインの webotx_agent.log に警告ログが出力されます。コマンドが失敗しなければ問題はありませんので、警告ログは無視してください。
設定