|
|
WebOTX Manual V11.1 (第6版) 目次を表示 |
|
|
|
WebOTX Manual V11.1 (第6版) 目次を表示 |
名称
create-jms-resource - JMSリソースの登録
形式
create-jms-resource [ --user admin_user ] [ --password admin
_password ] [ --host host_name ] [ --port port_number ] [ --
protocol=rmi|jmxmp ] [ --passwordfile filename ] [ --
encrypted=true|false ] [ --terse=true|false ] [ --echo=true|
false ] [ --interactive=true|false ] [ --secure=true|false ]
[ --help ] --restype type [ --enabled= true ] [ --
description text ] [ --cascade=true|false ] [ --property
name=value[:name=value] * ] [ --wojmsDestinationName
destination_name ] [ --wojmsDestinationDescription
description ] [ --wojmsBrokerHostName host_name ] [ --
wojmsBrokerHostPort host_port ] [ --wojmsBrokerServicePort
port_number ] [ --wojmsConfiguredClientID client_id ] [ --
wojmsConnectionType connection_type ] [ --
wojmsReconnectAttempts reconnect_attempts ] [ --
wojmsReconnectEnabled=true|false ] [ --
wojmsReconnectInterval reconnect_interval ] [ --
wojmsDefaultPassword password ] [ --wojmsDefaultUsername
user-name ] [ --wojmsDisableSetClientID=true|false ] [ --
wojmsAckOnAcknowledge=true|false ] [ --wojmsAckOnProduce=
true|false ] [ --wojmsAckTimeout ack_timeout ] [ --
wojmsConnectionFlowCount flow_count ] [ --
wojmsConnectionFlowLimit flow_limit ] [ --
wojmsConnectionFlowLimitEnabled=true|false ] [ --
wojmsConsumerFlowLimit flow_limit ] [ --
wojmsConsumerFlowThreshold threshold ] [ --
wojmsJMSDeliveryMode delivery_mode ] [ --wojmsJMSExpiration
expiration ] [ --wojmsJMSPriority priority ] [ --
wojmsOverrideJMSDeliveryMode=true|false ] [ --
wojmsOverrideJMSExpiration=true|false ] [ --
wojmsOverrideJMSHeadersToTemporaryDestinations=true|false ]
[ --wojmsOverrideJMSPriority=true|false ] [ --
wojmsSetJMSXAppID=true|false ] [ --wojmsSetJMSXConsumerTXID=
true|false ] [ --wojmsSetJMSXProducerTXID=true|false ] [ --
wojmsSetJMSXRcvTimestamp=true|false ] [ --wojmsSetJMSXUserID
=true|false ] [ --wojmsRedeliveryDelay delay ] [ --
wojmsPingInterval ping_interval ] [ --
wojmsEnableSharedClientID enable_shared_clientID ] [ --
wojmsAddressList address_list ] [ --wojmsAddressListBehavior
behavior ] [ --wojmsAddressListIterations num_list_
iterations ] [ --wojmsSocketConnectTimeout connect_timeout ]
[ --wojmsPortMapperSoTimeout so_timeout ] jndi_name
説明
JMSリソースを登録します。このコマンドはリモートモードでのみ
使用できます。
オプション
-u --user
ドメインの運用管理エージェントの管理ユーザ名。
既にotxadmin loginコマンドでログインしている場合は、--userオ
プションの指定は不要です。
-w --password
ドメインの運用管理エージェントの管理ユーザのパスワード。
-H --host
ドメインの運用管理エージェントが起動しているマシン名。
-p --port
ドメインの運用管理エージェントのポート番号。既定値は6212です
。
--protocol
ドメインの運用管理エージェントとの接続プロトコルを選択します
。指定できるプロトコルは、rmi、jmxmpです。既定値はrmiです。
-W --passwordfile
ドメインの運用管理エージェントのパスワードを含むファイル。
--encrypted
ドメインの運用管理エージェントのパスワードに暗号化されたパス
ワードを利用する場合に指定します。既定値はfalseです。暗号化
されたパスワードの生成にはencryptコマンドを使用してください
。このオプションはpasswordfileオプションが指定されている場合
のみ有効です。
-t --terse
trueを指定すると、出力データがスクリプトによる処理のための簡
潔なデータとなります。既定値はfalseです。
-e --echo
trueを指定すると、標準出力でコマンドライン文が表示されます。
既定値はfalseです。
-I --interactive
true(既定値)を指定すると、パスワードオプション入力用のプロン
プトを表示します。
-s --secure
trueを指定すると、ドメインの運用管理エージェントとの通信に
SSL/TLSを利用します。既定値はfalseです。
--help
コマンドのヘルプを表示します。
--restype
JMSリソースの種類はjavax.jms.Topic、 javax.jms.Queue、javax.
jms.TopicConnectionFactory、javax.jms.QueueConnectionFactory
、javax.jms.ConnectionFactoryです。
--enabled
リソースが動作中に有効化されるかどうかを決定します。既定値は
trueです。
--description
JMSリソースのテキスト記述
--property
JMSリソースを構成するための任意の属性名/値
--cascade
物理的な送信先を同時に生成するかどうかを指定します。trueは
wojmsDestinationNameオプションで指定された名前の物理的な送信
先を生成します。生成される送信先の属性はすべて既定値となりま
す。指定された名前の物理的な送信先が既に存在している場合は生
成しません。既定値はfalse(生成しない)です。
--wojmsDestinationName
物理的な送信先の名前を指定します。この名前には、create-
jmsdestコマンドで作成した送信先名を指定します。
--wojmsDestinationDescription
送信先の説明を指定します。
--wojmsBrokerHostName
接続するJMS サーバのホスト名を指定します(wojmsConnectionType
の設定値がTCPまたはTLSの場合)。値を指定していない場合は、JMS
ホストのホストが使われます。
--wojmsBrokerHostPort
接続するJMS サーバのポート番号を指定します(
wojmsConnectionTypeの設定値がTCPまたはTLSの場合)。値を指定し
ていない場合は、JMSホストのポート番号が使われます。
--wojmsBrokerServicePort
使用するサービスのポート番号を指定します(wojmsConnectionType
の設定値がTCPまたはTLSの場合)。この属性値は、主にファイアウ
ォールを通過させるポート番号を特定するために使用します。0は
特定しません。デフォルト値は0です。
--wojmsConfiguredClientID
クライアントID を指定します。
--wojmsConnectionType
使用するコネクションのタイプを指定します。TCPは通常コネクシ
ョンです。TLSはSSL コネクションです。既定値はTCPです。
--wojmsReconnectAttempts
JMS サーバへの再接続試行回数を指定します。 -1は無制限です。
既定値は0です。
--wojmsReconnectEnabled
JMS サーバへの再接続を有効にするかどうかを指定します。既定値
はfalseです。
--wojmsReconnectInterval
JMS サーバへの再接続遅延時間をミリ秒単位で指定します。指定す
る時間が短すぎる場合、JMSサーバが復旧していない可能性があり
ます。指定する時間が長すぎる場合、再接続処理が失敗したと見な
される可能性があります。既定値は3000（ミリ秒）です。
--wojmsDefaultPassword
JMSサーバの認証に使われるデフォルトのパスワードを指定します
。既定値はguestです。
--wojmsDefaultUsername
JMSサーバの認証に使われるデフォルトのユーザ名を指定します。
既定値はguestです。
--wojmsDisableSetClientID
クライアントがJMS API（setClientID()）を使用して、クライアン
トID を変更できないよう指定します。既定値はfalseです。
--wojmsAckOnAcknowledge
コンシューマからのACKNOWLEDGE(確認通知）に対して、JMSサーバ
が受諾通知を返すか否かを指定します。trueを指定すると、JMSサ
ーバはコンシューマからのすべてのACKNOWLEDGEに対して受諾通知
を返すため、コンシューマはその通知を待ち合わせます。falseを
指定すると、JMSサーバはコンシューマからのどのACKNOWLEDGEに対
しても受諾通知を返さないため、コンシューマはその通知を待ち合
わせません。何も指定しないと、JMSサーバはAUTO_ACKNOWLEDGEと
CLIENT_ACKNOWLEDGEモードのACKNOWLEDGEに対して受諾通知を返し
、コンシューマはその通知を待ち合わせます。DUPS_OK_
ACKNOWLEDGEのACKNOWLEDGEに対しては受諾通知を返さず、コンシュ
ーマはその通知を待ち合わせません。既定値は指定なしです。
--wojmsAckOnProduce
プロデューサからのメッセージに対して、JMSサーバが受諾通知を
返すか否かを指定します。trueの場合、JMSサーバはプロデューサ
から受け付けた、永続/非永続メッセージすべてに対して受諾通知
を返すため、プロデューサの呼び出しスレッドはその受諾通知を待
ち合わせます。falseの場合、JMSサーバはプロデューサから受け付
けた、どの永続/非永続メッセージに対しても受諾通知を返さない
ため、プロデューサの呼び出しスレッドはその通知を待ち合わせま
せん。指定なしの場合、JMSサーバはプロデューサから受け付けた
、永続メッセージに対してのみ受諾通知を返すため、プロデューサ
の呼び出しスレッドはその通知を待ち合わせます。既定値は指定な
しです。
--wojmsAckTimeout
クライアントがJMSサーバからの受諾通知を待ち合わせる、通知タ
イムアウトの時間（ミリ秒単位）を指定します。この時間を超過す
ると例外が発生します。0を指定すると、必ず待ちあわせます。既
定値は0です。
--wojmsConnectionFlowCount
JMSサーバがクライアントランタイムに対して連続して配信できる
JMSメッセージの数を指定します。指定した数のJMSメッセージをク
ライアントランタイムに配信すると配信が一時的にサスペンドされ
、それまで止められていた制御系のメッセージが配信されます。ク
ライアントの状態に応じて、配信が再開されます。0を指定すると
、サスペンドされません。0以外の値を指定すると、負荷の高いJMS
メッセージ配信の影響により制御系メッセージが滞留を防ぐことが
できます。既定値は100です。
--wojmsConnectionFlowLimit
コネクションレベルで滞留させることができるメッセージの最大数
を指定します。（wojmsConnectionFlowLimitEnabledがtrueの場合
にのみ有効）クライアントランタイムに配信されたJMSメッセージ
の数がこの制限に到達すると、メッセージ配信が停止し、制限を下
回ると配信は再開されます。この制限は、メッセージの滞留により
クライアントランタイムで発生するメモリ不足を抑止するのに有効
です。既定値は1000です。
--wojmsConnectionFlowLimitEnabled
コネクションレベルのフロー制御を有効にするか否かを指定します
。trueは有効にします。falseは無効にします。既定値はfalse(無
効)です。
--wojmsConsumerFlowLimit
コンシューマレベルで滞留させることができるメッセージの最大数
を指定します。この制限は、queueのマルチコンシューマの間での
負荷分散を実現するために使用します。この制限値は、queueの
consumerFlowLimit属性で指定した値の方が小さい場合、その値で
オーバライドされます。クライアントランタイムに配信されたJMS
メッセージの数がこの制限に到達すると、メッセージ配信が停止し
、wojmsConsumerFlowThresholdに指定した値を下回ると配信は再開
されます。（すべてのコンシューマの滞留数の合計が
wojmsConnectionFlowLimitの値に到達すると、コネクションレベル
の制限により配信が停止します。）既定値は1000です。
--wojmsConsumerFlowThreshold
コンシューマレベルのフロー制御が解除されるメッセージの数を
wojmsConsumerFlowLimitに対する割合で指定します。既定値は50(%
)です。
--wojmsJMSDeliveryMode
配信モードを指定します。PERSISTENTは永続です。NON_PERSISTENT
は非永続です。既定値は、PERSISTENT（永続)です。この設定を有
効にするには、「配信モード変更許可(
wojmsOverrideJMSDeliveryMode)」の値をtrueにする必要がありま
す。また、一時的な送信先宛てのメッセージの場合は、「一時的な
送信先へのメッセージプロパティの変更許可(
wojmsOverrideJMSHeadersToTemporaryDestinations)」の値もtrue
にする必要があります。
--wojmsJMSExpiration
メッセージの有効期限をミリ秒単位で指定します。0は破棄されま
せん。既定値は0(破棄されない)です。この設定を有効にするには
、「メッセージ有効期限変更許可(wojmsOverrideJMSExpiration)」
の値をtrueにする必要があります。また、一時的な送信先宛てのメ
ッセージの場合は、「一時的な送信先へのメッセージプロパティの
変更許可(wojmsOverrideJMSHeadersToTemporaryDestinations)」の
値もtrueにする必要があります。
--wojmsJMSPriority
メッセージの優先順位を指定します。0〜9 までの数字で大きい数
程優先度は高くなります。既定値は4です。この設定を有効にする
には、「メッセージ優先順位変更許可(wojmsOverrideJMSPriority)
」の値をtrueにする必要があります。また、一時的な送信先宛ての
メッセージの場合は、「一時的な送信先へのメッセージプロパティ
の変更許可(wojmsOverrideJMSHeadersToTemporaryDestinations)」
の値もtrueにする必要があります。
--wojmsOverrideJMSDeliveryMode
クライアントからの配信モードの変更を許可するかどうかを指定し
ます。trueは変更を許可します。falseは変更を許可しません。既
定値は、false(許可しない)です。
--wojmsOverrideJMSExpiration
クライアントからのメッセージ有効期限の変更を許可するかどうか
を指定します。trueは変更を許可します。falseは変更を許可しま
せん。既定値はfalse(変更を許可しない)です。
--wojmsOverrideJMSHeadersToTemporaryDestinations
一時的な送信先宛てのメッセージの優先順位、有効期限、配信モー
ドの変更を許可するかどうかを指定します。優先順位、有効期限、
配信モードの変更にはそれぞれ別途許可が必要となります。trueは
変更を許可します。falseは変更を許可します。既定値は、false(
変更を許可しない)です。
--wojmsOverrideJMSPriority
クライアントからのメッセージ優先順位の変更を許可するかどうか
を指定します。trurは変更を許可します。falseは変更を許可しま
せん。既定値はfalse(変更を許可しない)です。
--wojmsSetJMSXAppID
JMSXAppID メッセージプロパティを有効にするかどうかを指定しま
す。trueは有効になります。falseは無効になります。既定値は
false(無効)です。
--wojmsSetJMSXConsumerTXID
JMSXConsumerTXID メッセージプパティを有効にするかどうかを指
定します。trueは有効になります。falseは無効になります。既定
値はfalse(無効)です。
--wojmsSetJMSXProducerTXID
JMSXProducerTXID メッセージプロパティを有効にするかどうかを
指定します。trueは有効になります。falseは無効になります。既
定値はfalse(無効)です。
--wojmsSetJMSXRcvTimestamp
JMSXRcvTimestamp メッセージプロパティを有効にするかどうかを
指定します。trueは有効になります。falseは無効になります。既
定値はfalse(無効)です。
--wojmsSetJMSXUserID
JMSXUserID メッセージプロパティを有効にするかどうかを指定し
ます。trueは有効になります。falseは無効になります。既定値は
false(無効)です。
--wojmsRedeliveryDelay
メッセージ再配信で、配信の遅延時間を秒単位で指定します。0は
、待ち合わせ無しを意味します。既定値は、0(待ち合わせ無し)で
す。
--wojmsPingInterval
JMSサーバとの接続を確認する間隔を秒単位で指定します。-1は監
視を行わないことを意味します。接続監視は、JMSサーバに制御用
パケット(PING)を定期的に発行して行います。デフォルト値は30(
秒)です。
--wojmsEnableSharedClientID
Topicで、マルチコンシューマ負荷分散や、管理環境下でのプロセ
ス多重を利用する場合にtrue(共有する)を指定します。デフォルト
値はfalse(共有しない)です。
--wojmsAddressList
接続先のアドレスリストを指定します。この値を設定した場合は、
「JMSサーバのホスト名」(wojmsBrokerHostName)と、「JMSサーバ
のホストのポート番号」(wojmsBrokerHostPort)の設定は無視され
ます。
--wojmsAddressListBehavior
アドレスリストから、接続先を選択する方法を指定します。
PRIORITY：アドレスリストに指定された順番に接続します。RANDOM
：ランダムに選択します。デフォルトはPRIORITYです。
--wojmsAddressListIterations
接続の試行を中止して例外を通知するまでの、アドレスリストの繰
り返し回数を指定します。-1は無制限を意味します。
--wojmsSocketConnectTimeout
JMSサーバへのTCPコネクションを確立するときのタイムアウト時間
をミリ秒単位で指定します。0 はタイムアウト無しを意味します。
--wojmsPortMapperSoTimeout
JMSサーバとのコネクション確立処理中に、JMSサーバからの応答を
待機する時間をミリ秒単位で指定します。この値は、JMSサーバと
の接続に関連付けられているソケットのSO_TIMEOUTとして設定され
ます。-1は、SO_TIMEOUTを設定しません。0 はタイムアウト無しを
意味します。
オペランド
jndi_name
作成されるJMSリソースのJNDI名
使用例
例1: JMSトピックコネクションファクトリリソースを作成する
otxadmin> create-jms-resource --user admin
--password adminadmin --host bluestar --port 6212
--restype javax.jms.TopicConnectionFactory --description
"example of creating a JMS Topic connection factory"
--wojmsDefaultUsername javaee --wojmsDefaultPassword javaee
jms/TopicConnectionFactory
Command create-jms-resource executed successfully
jms/TopicConnectionFactoryはリソースのJNDI名であり、
wojmsDefaultUsernameとwojmsDefaultPasswordオプションはコネク
ションファクトリに必要なユーザ名／パスワードを設定します。
JMSリソースに対するJNDI名は慣習的にjms/ namingサブコンテクス
トを含みます。
例2: 永続的な予約としてJMSコネクションファクトリリソースを作成する
otxadmin> create-jms-resource --user admin
--password adminadmin --host bluestar --port 6212
--restype javax.jms.TopicConnectionFactory --description
"example of creating a JMS connection factory"
--wojmsConfiguredClientID MyID jms/DurableTopicConnectionFactory
Command create-jms-resource executed successfully
jms/DurableTopicConnectionFactoryはリソースのJNDI名であり、
wojmsConfiguredClientIDオプションはコネクションファクトリに
永続的な予約として使用されるようにクライアントIDを設定します
。JMSリソースに対するJNDI名は慣習的にjms/ namingサブコンテク
ストを含みます。
例3: JMS送信先リソースの使用法
otxadmin> create-jms-resource --user admin
--password adminadmin --host host_name --port 6212
--restype javax.jms.Queue
--wojmsDestinationName MyPhysicalQueue
--wojmsDestinationDescription "This is sample queue"
jms/MyQueue
Command create-jms-resource executed successfully
jms/MyQueueはリソースのJNDI名であり、wojmsDestinationNameオ
プションはリソースが参照する（create-jmsdestコマンドで生成し
た）物理的な送信先を指定します。wojmsDestinationDescription
オプションは物理的な送信先に関する説明を指定します。
終了ステータス
0 コマンド実行成功
1 コマンド実行失敗
関連事項
delete-jms-resource(1), list-jms-resources(1), create-
jmsdest(1)