概要: 属性 | 操作  詳細: 属性 | 操作  索引

MO名称:
J2EEDomain -  WebOTX管理ドメイン
定義:
ObjectName
{0}:pp=/,type=J2EEDomain
CLIName
domain

属性の概要
name (名前)
この管理対象の名前(ドメイン名)を表します。
objectName (オブジェクト名)
この管理対象のオブジェクト名を表します。
servers (Java EEサーバのリスト)
ドメイン内に存在するJava EEサーバ(のオブジェクト名)のリストを表します。
eventTypes (イベントタイプのリスト)
この管理対象から発行されるイベントの種類を表します。
applicationServerFullVersion (フルバージョン名)
アプリケーションサーバのフルバージョン名を表します。
applicationServerVersion (バージョン名)
アプリケーションサーバのバージョン名を表します。
applicationServerEdition (エディション)
アプリケーションサーバのエディションを表します。数字の意味は次の通りです。
2: Express、3: Standard、4: Enterprise、13: Foundation
applicationServerOSName (マシンのOS名)
アプリケーションサーバが動作しているマシンのOS名を表します。
applicationServerCPUrate (使用しているCPUの割合)
アプリケーションサーバが動作しているマシンで使用しているCPUの割合を表します。(単位 : %)
applicationServerNumOfProcess (プロセス数)
アプリケーションサーバが動作しているマシンで起動中のプロセス数を表します。
applicationServerPhysicalMemSize (物理メモリサイズ)
アプリケーションサーバが動作しているマシンで使用している物理メモリのサイズを表します。(単位 : KB)
applicationServerVirtualMemSize (仮想メモリサイズ)
アプリケーションサーバが動作しているマシンで使用している仮想メモリのサイズを表します。Solaris版、およびLinux版では使用されているスワップのサイズを表します。(単位 : KB)
applicationServerLicense (ライセンス情報)
アプリケーションサーバのライセンス情報を表します。
startTime (起動開始時刻)
ドメインの起動開始時刻を表します。
domains-alive-check-enabled (管理対象ドメインアライブチェックの有効化)
管理対象ドメインに対するアライブチェックの有無を表します。
domains-alive-check-interval (管理対象ドメインアライブチェック間隔)
管理対象ドメインに対するアライブチェックの間隔を表します。(単位 : 秒)
verifyPorts (ポート定義競合の検証の有無)
チェックがある場合、新規ドメイン作成時にドメイン間でのポート定義の競合有無について検証します。
excludeDomainsForVerifyPorts (ポート定義競合の検証の対象外とするドメイン名のリスト)
新規ドメイン作成時にポート定義競合の検証の対象外とするドメイン名のリストを設定します。
dir (ドメインルートパス)
ドメインのルートディレクトリのパスを表します。
application-root (アプリケーション配備パス)
アプリケーションの配備パスを表します。
num-config-backup-generations (リソースのバックアップ世代数)
ドメイン内で使用するリソースのバックアップ世代数を表します。
backup-option (バックアップの対象)
バックアップの対象を表します。
backup-timing (バックアップのタイミング)
バックアップを実行するタイミングを指定します。
hostname (ホスト名)
ホスト名を表します。
ipv6-enable (IPv6優先)
IPv6を優先的に使用します。

操作の概要
generateDiagnosticReport (診断レポートの生成)
ドメイン内のサーバインスタンスに対する診断レポートを生成します。
enableNotificationType (Notificationタイプの有効化)
指定したタイプを持つNotificationを有効化します。
disableNotificationType (Notificationタイプの無効化)
指定したタイプを持つNotificationを無効化します。
enableNotificationObjectName (Notificationを有効化するObjectNameの指定)
指定したオブジェクト名から発行されるNotificationを有効化します。
disableNotificationObjectName (Notificationを無効化するObjectNameの指定)
指定したオブジェクト名にから発行されるNotificationを無効化します。
generateJVMReport (JVMレポートの生成)
対象プロセスに対するJVMレポートを生成します。
generateThreadDump (スレッドダンプの採取)
ドメインのスレッドダンプを採取します。
listOSGiModules (OSGiモジュール一覧の取得)
配備されているOSGiモジュールの一覧を取得します。
getOSGiModuleHeaders (OSGiモジュールのヘッダー取得)
OSGiモジュールのヘッダー(マニフェスト定義)を取得します。
listDomains (全ドメインのリストを取得)
管理ドメインおよび、管理対象ドメインのリストを表示します。
getProperties (プロパティ一覧の取得)
プロパティの一覧を取得します。
setProperty (プロパティの設定)
プロパティの名前と値を設定します。
startDomain (管理対象ドメインの起動)
管理対象のドメインを起動します。
stopDomain (管理対象ドメインの停止)
管理対象のドメインを停止します。
enable (管理対象ドメインの起動の有効化)
管理ドメイン起動時に、管理対象ドメインの自動起動を行うようにします。
disable (管理対象ドメインの起動の無効化)
管理ドメイン起動時に、管理対象ドメインの自動起動を行わないようにします。
changeStartingOrder (管理対象ドメインの起動順序番号を変更)
管理ドメイン起動時における、管理対象ドメインの起動順序番号を変更します。
listDomainStatus (管理対象ドメインの状態一覧を取得)
管理ドメイン内で管理されている管理対象ドメインの状態一覧を取得します。形式は次のようになります。
[管理対象ドメイン名],[状態番号]
また、状態番号の意味は次の通りです。
0:起動中、1:実行中、2:停止中、3:停止、4:起動/停止処理失敗
status (管理対象ドメインの状態を取得)
管理ドメイン内で管理されている指定された管理対象ドメインの状態を取得します。返却値の意味は次のようになります。
0:起動中、1:実行中、2:停止中、3:停止、4:起動/停止処理失敗
replaceConfig (固有情報再設定)
指定されたドメインの固有情報を環境に合わせて再設定します。
setupForProxy (プロキシドメインへのドメイン登録のための設定)
プロキシドメインへのドメイン登録のための設定を行います。
listSetupInfoForProxy (プロキシドメインへのドメイン登録のための設定情報一覧の表示)
プロキシドメインへのドメイン登録のための設定情報一覧を表示します。
enabledRecoveryDomain (管理対象ドメイン再起動復旧の有効化)
ユーザドメイン異常停止時に、管理ドメインから再起動を試みます。
disabledRecoveryDomain (管理対象ドメイン再起動復旧の無効化)
ユーザドメイン異常停止時に、管理ドメインから再起動を試みる処理を無効化します。
getRecoveryDomainStatus (管理対象ドメイン再起動復旧の確認)
再起動復旧機能が有効化どうかの設定値を取得します。
generateThreadDump (スレッドダンプの採取)
ドメインのスレッドダンプを採取します。


属性の詳細
name (名前)

この管理対象の名前(ドメイン名)を表します。

型:
java.lang.String

objectName (オブジェクト名)

この管理対象のオブジェクト名を表します。

型:
java.lang.String

servers (Java EEサーバのリスト)

ドメイン内に存在するJava EEサーバ(のオブジェクト名)のリストを表します。

詳細:
WebOTXにおいて、この属性の要素は0または1つのみです。
型:
java.lang.String[]

eventTypes (イベントタイプのリスト)

この管理対象から発行されるイベントの種類を表します。

詳細:
イベントタイプの詳細は以下の通りです。
''j2ee.object.created'': ドメイン内で管理対象オブジェクトが生成された
''j2ee.object.deleted'': ドメイン内で管理対象オブジェクトが削除された
型:
java.lang.String[]

applicationServerFullVersion (フルバージョン名)

アプリケーションサーバのフルバージョン名を表します。

型:
java.lang.String

applicationServerVersion (バージョン名)

アプリケーションサーバのバージョン名を表します。

型:
java.lang.String

applicationServerEdition (エディション)

アプリケーションサーバのエディションを表します。数字の意味は次の通りです。
2: Express、3: Standard、4: Enterprise、13: Foundation

型:
java.lang.String

applicationServerOSName (マシンのOS名)

アプリケーションサーバが動作しているマシンのOS名を表します。

型:
java.lang.String

applicationServerCPUrate (使用しているCPUの割合)

アプリケーションサーバが動作しているマシンで使用しているCPUの割合を表します。(単位 : %)

型:
java.lang.Double

applicationServerNumOfProcess (プロセス数)

アプリケーションサーバが動作しているマシンで起動中のプロセス数を表します。

型:
java.lang.Long

applicationServerPhysicalMemSize (物理メモリサイズ)

アプリケーションサーバが動作しているマシンで使用している物理メモリのサイズを表します。(単位 : KB)

型:
java.lang.Long

applicationServerVirtualMemSize (仮想メモリサイズ)

アプリケーションサーバが動作しているマシンで使用している仮想メモリのサイズを表します。Solaris版、およびLinux版では使用されているスワップのサイズを表します。(単位 : KB)

型:
java.lang.Long

applicationServerLicense (ライセンス情報)

アプリケーションサーバのライセンス情報を表します。

型:
java.lang.String[]

startTime (起動開始時刻)

ドメインの起動開始時刻を表します。

型:
java.lang.Long

domains-alive-check-enabled (管理対象ドメインアライブチェックの有効化)

管理対象ドメインに対するアライブチェックの有無を表します。

詳細:
trueの場合、管理対象ドメインに対するアライブチェックが行われます。
変更を反映するにはドメインの再起動が必要です。
型:
java.lang.Boolean

domains-alive-check-interval (管理対象ドメインアライブチェック間隔)

管理対象ドメインに対するアライブチェックの間隔を表します。(単位 : 秒)

詳細:
管理対象ドメインに対するアライブチェックの間隔(秒)を指定します。
変更を反映するにはドメインの再起動が必要です。
型:
java.lang.Long

verifyPorts (ポート定義競合の検証の有無)

チェックがある場合、新規ドメイン作成時にドメイン間でのポート定義の競合有無について検証します。

型:
java.lang.Boolean

excludeDomainsForVerifyPorts (ポート定義競合の検証の対象外とするドメイン名のリスト)

新規ドメイン作成時にポート定義競合の検証の対象外とするドメイン名のリストを設定します。

型:
java.lang.String[]

dir (ドメインルートパス)

ドメインのルートディレクトリのパスを表します。

詳細:
ドメインのルートディレクトリのパスを設定します。このディレクトリはシンボリックリンクであっても問題ありません。
型:
java.lang.String

application-root (アプリケーション配備パス)

アプリケーションの配備パスを表します。

型:
java.lang.String

num-config-backup-generations (リソースのバックアップ世代数)

ドメイン内で使用するリソースのバックアップ世代数を表します。

詳細:
<WebOTXインストールディレクトリ>/domains/<ドメイン名>配下にある各種リソースのバックアップ世代数を指定します。最大3世代まで保存されます。
バックアップされたリソースは<WebOTXインストールディレクトリ>/domains/<ドメイン名>/backup配下に格納されます。
型:
java.lang.String
値の有効範囲:

backup-option (バックアップの対象)

バックアップの対象を表します。

詳細:
バックアップ対象とするファイルを指定します。
configsを指定した場合、<WebOTXインストールディレクトリ>/domains/<ドメイン名>/configフォルダ以下を対象とします。
allを指定した場合は、<WebOTXインストールディレクトリ>/domains/<ドメイン名>配下にある各種リソースファイルをバックアップします。
型:
java.lang.String
値の有効範囲:
configs 
all 

backup-timing (バックアップのタイミング)

バックアップを実行するタイミングを指定します。

詳細:
バックアップを実行するタイミングを指定します。
型:
java.lang.String
値の有効範囲:
before-starting  ドメインの起動前
after-running  ドメインの起動後
before-termination  ドメインの停止前

hostname (ホスト名)

ホスト名を表します。

詳細:
ホスト名を指定します。既定値はマシン固有のホスト名です。
ホスト名を変更した場合、ドメインの再起動が必要になります。
型:
java.lang.String

ipv6-enable (IPv6優先)

IPv6を優先的に使用します。

詳細:
IPv6を優先的に使用します。既定値はfalse(IPv4優先)です。
true(IPv6優先)に変更した場合、ドメインの再起動が必要になります。
型:
java.lang.Boolean

操作の詳細
generateDiagnosticReport (診断レポートの生成)

ドメイン内のサーバインスタンスに対する診断レポートを生成します。

詳細:
この操作は、問題を解決するための各種設定ファイル、ログファイルを収集します。この操作によって収集されたファイル群は、診断レポートとして指定した場所にアーカイブ形式で保存されますので、それを使用して問題解決を行うか、WebOTX ASサポート窓口へ問い合わせを行う際に送付して下さい。
戻り値:
java.lang.String
引数:
generateDiagnosticReport - java.lang.String
Please appoint the absolute path to the diagnostic report.

generateDiagnosticReport - java.lang.String


enableNotificationType (Notificationタイプの有効化)

指定したタイプを持つNotificationを有効化します。

詳細:
例えば、Notificationタイプが''webotx.event''で始まる通知を有効にしたい場合、webotx.eventと入力します。
戻り値:
void
引数:
enableNotificationType - java.lang.String


disableNotificationType (Notificationタイプの無効化)

指定したタイプを持つNotificationを無効化します。

詳細:
例えば、Notificationタイプが''webotx.event''で始まる通知を無効にしたい場合、webotx.eventと入力します。
戻り値:
void
引数:
disableNotificationType - java.lang.String


enableNotificationObjectName (Notificationを有効化するObjectNameの指定)

指定したオブジェクト名から発行されるNotificationを有効化します。

詳細:
例えば、通知発行元のオブジェクト名が''domain:a=xxx,b=yyy''である通知を有効にしたい場合、domain:a=xxx,b=yyyと入力します。
戻り値:
void
引数:
enableNotificationObjectName - javax.management.ObjectName


disableNotificationObjectName (Notificationを無効化するObjectNameの指定)

指定したオブジェクト名にから発行されるNotificationを無効化します。

詳細:
例えば、通知発行元のオブジェクト名が''domain:a=xxx,b=yyy''である通知を無効にしたい場合、domain:a=xxx,b=yyyと入力します。
戻り値:
void
引数:
disableNotificationObjectName - javax.management.ObjectName


generateJVMReport (JVMレポートの生成)

対象プロセスに対するJVMレポートを生成します。

戻り値:
java.lang.String
引数:
type - java.lang.String
レポートのタイプを指定します。
値の有効範囲:
summary  概要
class  クラス情報
memory  メモリ情報
thread  スレッドダンプ

processName - java.lang.String
If not specified, reported for the agent process.

outputFile - java.lang.String
If the only file name specify, the file output to [Domain directory]/logs directory.


generateThreadDump (スレッドダンプの採取)

ドメインのスレッドダンプを採取します。

詳細:
採取したスレッドダンプはファイルに保存されます。
ドメインが動作するOSにより、保存されるファイルが異なります。
・Windows系 : <ドメインディレクトリ>\logs\diagnostics\jvminfo\threaddump.txt
・UNIX系 : <ドメインディレクトリ>/logs/server.log
戻り値:
void
引数:
なし

listOSGiModules (OSGiモジュール一覧の取得)

配備されているOSGiモジュールの一覧を取得します。

戻り値:
java.lang.String[][]
引数:
なし

getOSGiModuleHeaders (OSGiモジュールのヘッダー取得)

OSGiモジュールのヘッダー(マニフェスト定義)を取得します。

戻り値:
java.lang.String[]
引数:
getOSGiModuleHeaders - java.lang.String


listDomains (全ドメインのリストを取得)

管理ドメインおよび、管理対象ドメインのリストを表示します。

詳細:
リスト表示される各ドメインの表示形式は次のようになります。
<ドメイン名>:<管理ポート番号>:<接続プロトコル>
戻り値:
java.lang.String[]
引数:
なし

getProperties (プロパティ一覧の取得)

プロパティの一覧を取得します。

詳細:
プロパティの一覧を取得します。
戻り値:
javax.management.AttributeList
引数:
なし

setProperty (プロパティの設定)

プロパティの名前と値を設定します。

詳細:
プロパティの名前と値を設定します。
戻り値:
void
引数:
nameAndValue - javax.management.Attribute
プロパティの名前と値を設定します。


startDomain (管理対象ドメインの起動)

管理対象のドメインを起動します。

戻り値:
void
引数:
domainName - java.lang.String[]
起動したいドメインの名前を指定します。

timeout - java.lang.Integer
起動処理のタイムアウト時間を指定します。(単位 : 秒)
値の範囲:
0-2147483


stopDomain (管理対象ドメインの停止)

管理対象のドメインを停止します。

戻り値:
void
引数:
domainName - java.lang.String[]
停止したいドメインの名前を指定します。

timeout - java.lang.Integer
停止処理のタイムアウト時間を指定します。(単位 : 秒)
値の範囲:
0-2147483

force - java.lang.Boolean
タイムアウトで指定した時間経過してもドメインが停止しない場合、ドメインを強制停止します。
値の範囲:
0-2147483


enable (管理対象ドメインの起動の有効化)

管理ドメイン起動時に、管理対象ドメインの自動起動を行うようにします。

戻り値:
void
引数:
domainName - java.lang.String
自動起動を有効にしたいドメインの名前を指定します。


disable (管理対象ドメインの起動の無効化)

管理ドメイン起動時に、管理対象ドメインの自動起動を行わないようにします。

戻り値:
void
引数:
domainName - java.lang.String
自動起動を無効にしたいドメインの名前を指定します。


changeStartingOrder (管理対象ドメインの起動順序番号を変更)

管理ドメイン起動時における、管理対象ドメインの起動順序番号を変更します。

戻り値:
void
引数:
domainName - java.lang.String
起動順序番号を変更したいドメインの名前を指定します。

startingOrder - java.lang.Integer
新しい起動順序番号を指定します。
値の範囲:
1-2147483647


listDomainStatus (管理対象ドメインの状態一覧を取得)

管理ドメイン内で管理されている管理対象ドメインの状態一覧を取得します。形式は次のようになります。
[管理対象ドメイン名],[状態番号]
また、状態番号の意味は次の通りです。
0:起動中、1:実行中、2:停止中、3:停止、4:起動/停止処理失敗

戻り値:
java.lang.String[]
引数:
なし

status (管理対象ドメインの状態を取得)

管理ドメイン内で管理されている指定された管理対象ドメインの状態を取得します。返却値の意味は次のようになります。
0:起動中、1:実行中、2:停止中、3:停止、4:起動/停止処理失敗

戻り値:
java.lang.Integer
引数:
domainName - java.lang.String
状態を取得したいドメインの名前を指定します。


replaceConfig (固有情報再設定)

指定されたドメインの固有情報を環境に合わせて再設定します。

詳細:
指定されたドメインの固有情報を、現在のマシン環境に合わせて再設定を行います。
戻り値:
void
引数:
domainName - java.lang.String
再設定を行うドメイン名を指定してください。指定できるドメインは管理ドメイン(WebOTXAdmin)の管理下にあるユーザドメインのみです。また、対象のドメインは停止している必要があります。


setupForProxy (プロキシドメインへのドメイン登録のための設定)

プロキシドメインへのドメイン登録のための設定を行います。

詳細:
現在接続中の管理ドメインが管理する管理対象ドメインを、WebOTX Clusterの分散管理サーバによって集中管理するためのセットアップを行います。
本操作により、分散管理サーバの管理対象となった全てのドメインに対して、システム運用者は分散管理サーバのプロキシドメインから配備や設定などの運用操作を一括して行えるようになります。
戻り値:
void
引数:
domainName - java.lang.String
登録対象のドメイン名を指定します。

jmxProxyRemoteURL - java.lang.String
分散管理サーバのプロキシドメインと接続するためのJMX Remote URLを指定します。
ホスト名やポート番号の箇所は、プロキシドメインの動作状況に合わせて適時変更してください。
接続に使用するプロトコルがJMXMPの場合は、service:jmx:jmxmp://[ホスト名]:[ポート番号]と指定してください。

jmxProxyRemoteSecure - java.lang.Boolean
プロキシドメインに対するJMXリモート接続時のセキュリティ機能の有無を指定します。

groupNames - java.lang.String[]
登録対象の全てのドメイングループがエディションの混在を許可しない限り、指定できるグループは1つのみです。

replace - java.lang.Boolean
チェックした場合、ドメイングループへのドメイン情報の登録の際、指定されたドメインの固有情報を、現在のマシン環境に合わせて再設定します。


listSetupInfoForProxy (プロキシドメインへのドメイン登録のための設定情報一覧の表示)

プロキシドメインへのドメイン登録のための設定情報一覧を表示します。

詳細:
表示される結果のうち、「登録実施の有無」が true のドメインにおいては、次回起動時にプロキシドメインへのドメイン登録処理が行われます。
戻り値:
java.lang.String
引数:
なし

enabledRecoveryDomain (管理対象ドメイン再起動復旧の有効化)

ユーザドメイン異常停止時に、管理ドメインから再起動を試みます。

戻り値:
void
引数:
domainName - java.lang.String
再起動を試みるドメインの名前を指定してください。

retryCount - java.lang.Integer
指定可能な値は[1-5]の間です。
値の範囲:
1-5

startTimeout - java.lang.Integer
指定可能な値は[1-2147483647]の間です。
値の範囲:
0-2147483647

stopTimeout - java.lang.Integer
指定可能な値は[1-2147483647]の間です。
値の範囲:
0-2147483647


disabledRecoveryDomain (管理対象ドメイン再起動復旧の無効化)

ユーザドメイン異常停止時に、管理ドメインから再起動を試みる処理を無効化します。

戻り値:
void
引数:
domainName - java.lang.String
再起動復旧を無効にしたいドメイン名を指定してください。


getRecoveryDomainStatus (管理対象ドメイン再起動復旧の確認)

再起動復旧機能が有効化どうかの設定値を取得します。

戻り値:
java.lang.String[]
引数:
domainName - java.lang.String
設定を確認したいドメイン名を指定してください。


generateThreadDump (スレッドダンプの採取)

ドメインのスレッドダンプを採取します。

詳細:
採取したスレッドダンプはファイルに保存されます。
ドメインが動作するOSにより、保存されるファイルが異なります。
・Windows系 : <ドメインディレクトリ>\logs\diagnostics\jvminfo\threaddump.txt
・UNIX系 : <ドメインディレクトリ>/logs/server.log
戻り値:
void
引数:
domainName - java.lang.String
スレッドダンプを採取したいドメイン名を指定してください。