WebSphere Application Server - Express for i5/OS, Version 6.1   
             オペレーティング・システム: i5/OS

             目次と検索結果のパーソナライズ化

AdminControl オブジェクトのコマンド

アプリケーション・サーバーのオブジェクトを管理する操作コマンドを呼び出す場合は、AdminControl オブジェクトを使用します。

多くの AdminControl コマンドには、複数のシグニチャーがあり、 Java Management Extensions (JMX) によって指定されるパラメーターを使用する、 またはパラメーターのストリングを使用することによって、raw モードで呼び出すことができます。 AdminControl オブジェクトは、操作コマンドに加え、トレース、サーバーとの再接続、 およびデータ型の変換のためのユーティリティー・コマンドをいくつかサポートしています。

以下のコマンドは、AdminControl オブジェクトで使用可能です。

completeObjectName

completeObjectName コマンドを使用して、フラグメントに基づく完全な ObjectName 値のストリング表記を作成します。 このコマンドは、一致する ObjectName 値を検出するためにサーバーと通信することはありません。このコマンドは、フラグメントと一致する MBean がシステムで複数検出された場合、最初の MBean を戻します。

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

なし。

必須パラメーター

object name
入力するオブジェクトの名前を指定します。 (ObjectName)
template
使用するテンプレートの名前を指定します。 テンプレート名として、例えば、type=Server,* と入力します。(java.lang.String)

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

なし。

出力例

このコマンドは出力を返しません。

getAttribute

getAttribute コマンドは、指定する名前の属性値を戻す場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)
attribute
照会する属性の名前を指定します。 (java.lang.String)

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

なし。

出力例

以下の例に示すように、このコマンドは、照会する属性値を含むストリングを戻します。
'DeploymentManager'

getAttribute_jmx

getAttribute_jmx コマンドは、指定する名前の属性値を戻す場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)
attribute
照会する属性の名前を指定します。 (java.lang.String)

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

なし。

出力例

以下の例に示すように、このコマンドは、照会する属性値を含むストリングを戻します。
'DeploymentManager'

getAttributes

getAttributes コマンドは、指定する名前の属性値を戻す場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)
attribute
照会する属性の名前を指定します。 (java.lang.String[] または java.lang.Object[])

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

なし。

出力例

以下の例に示すように、このコマンドは、照会する属性値を含むストリングを戻します。
'[ [cellName myCell01] [nodeName myCellManager01] ]'

getAttributes_jmx

getAttributes_jmx コマンドは、指定する名前の属性値を戻す場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)
attribute
照会する属性の名前を指定します。 (java.lang.String[] または java.lang.Object[])

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

なし。

出力例

このコマンドは属性リストを戻します。

getCell

getCell コマンドは、接続されたセルの名前を戻す場合に使用します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは照会するセル名を戻します。
Mycell

getConfigId

getConfigId コマンドは、ObjectName または ObjectName フラグメントから構成 ID を作成する場合に使用します。 各 MBean に対応する構成オブジェクトはありません。 ObjectName フラグメントに対応する MBean が複数ある場合、 警告が出され、システムが検出した最初の MBean の構成 ID が形成されます。

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

なし。

必須パラメーター

object name
対象のオブジェクトの名前を指定します。 オブジェクト名のストリングは、アスタリスク文字 (*) で指定したワイルドカードであっても構いません。

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

なし。

出力例

このコマンドは、対象の構成 ID を含むストリングを戻します。

getDefaultDomain

getDefaultDomain コマンドは、サーバーからデフォルトのドメイン・ネームを戻す場合に使用します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、対象のデフォルトのドメイン・ネームを含むストリングを戻します。
WebSphere

getDomainName

getDomainName コマンドを使用して、サーバーからドメイン・ネームを戻します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、対象のドメイン・ネームを含むストリングを戻します。
WebSphere

getHost

getHost コマンドを使用して、使用しているホストの名前を戻します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、対象のホスト名を含むストリングを戻します。
myHost

getMBeanCount

getMBeanCount コマンドは、サーバーに登録済みの MBean の数を戻す場合に使用します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、サーバーに登録済みの MBean の数を含む整数値を戻します。
151

getMBeanInfo_jmx

getMBeanInfo_jmx コマンドは、ObjectName 値に対応する Java Management Extension の MBeanInfo 構造を戻す場合に使用します。 このコマンド用のストリング・シグニチャーはありません。 これは、getMBeanInfo コマンドから使用可能な情報のほとんどを、Help オブジェクトが表示するためです。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)

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

なし。

出力例

以下の例に示すように、このコマンドは、javax.management.MBeanInfo オブジェクトを戻します。
javax.management.modelmbean.ModelMBeanInfoSupport@10dd5f35

getNode

getNode コマンドを使用して、接続されたノードの名前を戻します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、ノードの名前を含むストリングを戻します。
myNode01

getObjectInstance

getObjectInstance コマンドは、入力オブジェクト名と一致するオブジェクト・インスタンスを戻す場合に使用します。

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

なし。

必須パラメーター

object name
対象のオブジェクトの名前を指定します。 (ObjectName)

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

なし。

出力例

以下の例に示すように、このコマンドは、入力オブジェクト名と一致するオブジェクト・インスタンスを戻します。
javax.management.modelmbean.RequiredModelMBean

getPort

getPort コマンドは、スクリプト接続で使用されるポートの名前を戻す場合に使用します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、システムがスクリプト接続を確立するために使用するポートの番号を戻します。
8877

getPropertiesForDataSource (Deprecated)

getPropertiesForDataSource コマンドは非推奨となっていますが、これに置き換わるコマンドはありません。 このコマンドを使用すると、接続モードで稼働中に、構成サービスの可用性が誤って推定されます。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

このコマンドは以下のメッセージを戻します。
WASX7389E: サポートされていないオペレーション。
getPropertiesForDataSource コマンドはサポートされていません。

getType

getType コマンドは、スクリプト接続で使用される接続タイプを戻す場合に使用します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、スクリプト接続で使用する接続タイプを含むストリングを戻します。
SOAP

help

help コマンドは、AdminControl オブジェクトについての一般ヘルプ・テキストを戻す場合に使用します。

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

なし。

必須パラメーター

なし。

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

コマンド
コマンドを指定して、ヘルプ情報を戻します。 コマンド名には、大/小文字の区別はありません。

出力例

以下の例に示すように、このコマンドは、help コマンド固有のオプションに関する詳しいストリングを戻します。
WASX7027I: The AdminControl object enables the manipulation of MBeans that run in a WebSphere
Application Server process. The number and type of MBeans that are available to the scripting client depend
on the server to which the client is connected.  If the client is connected to a deployment manager, then
all the MBeans running in the Deployment Manager are visible, as are all the MBeans running in the node agents
that are connected to this deployment manager, and all the MBeans that run in the application servers
on those nodes.

The following commands are supported by the AdminControl object; more detailed information about each of these
commands is available by using the "help" command of the AdminControl object and supplying the name
of the command as an argument.

Many of these commands support two different sets of signatures: one that accepts and returns strings, and one
low-level set that works with JMX objects like ObjectName and AttributeList. In most situations, the string
signatures are likely to be more useful, but JMX-object signature versions are supplied as well.  Each of these
JMX-object signature commands has "_jmx" appended to the command name, so an "invoke" command, as well as a
"invoke_jmx" command are supported.

completeObjectName		Return a String version of an object name given atemplate name
getAttribute_jmx			Given ObjectName and name of attribute, returns value ofattribute
getAttribute    			Given String version of ObjectName and name of attribute, returns value of attribute
getAttributes_jmx			Given ObjectName and array of attribute names, returns AttributeList
getAttributes   			Given String version of ObjectName and attribute names, returns String of name value pairs
getCell         			returns the cell name of the connected server
getConfigId     			Given String version of ObjectName, return a config id for the corresponding configuration
										object, if any.
getDefaultDomain			returns "WebSphere"
getDomainName   			returns "WebSphere"
getHost         			returns String representation of connected host
getMBeanCount   			returns number of registered beans
getMBeanInfo_jmx			Given ObjectName, returns MBeanInfo structure for MBean
getNode         			returns the node name of the connected server
getPort         			returns String representation of port in use
getType         			returns String representation of connection type in use help  help									Show help information
invoke_jmx      			Given ObjectName, name of command, array of parameters andsignature, invoke command on MBean specified
invoke          			Invoke a command on the specified MBean
isRegistered_jmx			true if supplied ObjectName is registered
isRegistered    			true if supplied String version of ObjectName is registered
makeObjectName  			Return an ObjectName built with the given string
queryNames_jmx  			Given ObjectName and QueryExp, retrieves set of ObjectNames that match.
queryNames      			Given String version of ObjectName, retrieves String of ObjectNames that match.
reconnect       			reconnects with serversetAttribute_jmx Given ObjectName and Attribute object, set attribute for
										MBean specified
setAttribute    			Given String version of ObjectName, attribute name andattribute value, set attribute for MBean specified
setAttributes_jmx			Given ObjectName and AttributeList object, set attributes for the MBean specified
startServer     			Given the name of a server, start that server.
stopServer      			Given the name of a server, stop that server.
testConnection  			Test the connection to a DataSource object
trace           			Set the wsadmin trace specification
help コマンドで特定のコマンドを指定した場合、以下の例に示すように、wsadmin ツールはそのコマンドについての詳細なヘルプを戻します。
WASX7043I: command: getAttribute
Arguments: object name, attribute
Description: Returns value of "attribute" for the MBean described by "object name."

invoke

invoke コマンドを使用して、パラメーター付き、またはパラメーターなしでオブジェクト・オペレーションを呼び出します。 このコマンドは、ユーザーの指定するパラメーター・リストを使用して、オブジェクト・オペレーションを呼び出します。 シグニチャーは、自動的に生成されます。 パラメーターの型は、MBean が提供する MBeanInfo を調べて指定されます。 呼び出しの結果のストリングを戻します。戻されるストリングは、呼び出す Mbean メソッドによって制御されます。 Mbean メソッドが synchronous の場合、オペレーションが完了するまでは、wsadmin ツールに制御が戻されません。 Mbean メソッドが asynchronous の場合、呼び出されたタスクが完了していなくても、 wsadmin ツールに制御が戻されます。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。
operation
呼び出すオペレーションを指定します。

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

arguments
オペレーションに必要な引数を指定します。 対象のオペレーションに引数が必要ない場合は、引数パラメーターを省いてもかまいません。

出力例

このコマンドは、呼び出しの結果を表示するストリングを戻します。

invoke_jmx

invoke_jmx コマンドは、パラメーター・リストをシグニチャーに適合させて、オブジェクト・オペレーションを呼び出す場合に使用します。 このコマンドは、呼び出しの結果を表示します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)
operation
呼び出すオペレーションを指定します。 (java.lang.String)

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

arguments
オペレーションに必要な引数を指定します。 対象のオペレーションに引数が必要ない場合は、引数パラメーターを省いてもかまいません。 (java.lang.String[] または java.lang.Object[])

出力例

このコマンドは、呼び出しの結果を表示するストリングを戻します。

isRegistered

isRegistered コマンドは、特定のオブジェクト名が登録済みであるかどうかを確認する場合に使用します。

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

なし。

必須パラメーター

object name
対象のオブジェクト名を指定します。 (java.lang.String)

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

なし。

出力例

このコマンドは、対象のオブジェクトのブール値を戻します。 以下の例に示すように、ObjectName 値がサーバーに登録済みの場合、この値は true になります。
true

isRegistered_jmx

isRegistered_jmx コマンドは、特定のオブジェクト名が登録済みであるかどうかを確認する場合に使用します。

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

なし。

必須パラメーター

object name
対象のオブジェクト名を指定します。 (java.lang.String)

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

なし。

出力例

このコマンドは、対象のオブジェクトのブール値を戻します。 以下の例に示すように、ObjectName 値がサーバーに登録済みの場合、この値は true になります。
true

makeObjectName

makeObjectName コマンドは、入力ストリングに基づく ObjectName 値を作成する場合に使用します。 このコマンドはサーバーと通信しないため、結果の ObjectName 値が存在しないことがあります。 指定するストリングに余分な二重引用符のセットがあれば除去されます。 このストリングが Java Management Extensions (JMX) ドメインで開始しない場合、 あるいはストリングの後にコロンが続く場合は、「WebSphere Application Server」というストリングが名前の前に付加されます。

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

なし。

必須パラメーター

object name
対象のオブジェクト名を指定します。 (java.lang.String)

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

なし。

出力例

このコマンドは、オブジェクト名ストリングで構成された Objectname オブジェクトを戻します。

queryMBeans

queryMBeans コマンドは、ユーザーの指定するオブジェクト名と一致するオブジェクト・インスタンスのリストを照会する場合に使用します。

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

なし。

必須パラメーター

object name
対象のオブジェクト名を指定します。 (ObjectName)

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

query
照会式を指定します。 (QueryExp)

出力例

以下の例に示すように、このコマンドは、指定されたオブジェクト名のオブジェクト・インスタンスのリストを戻します。
WebSphere:name=PlantsByWebSphere,process=server1,platform=dynamicproxy,node=Goodog,
J2EEName=PlantsByWebSphere,Server=server1,version=6.1.0.0,type=Application,
mbeanIdentifier=cells/GooddogNode02Cell/applications/PlantsByWebSphere.ear/
deployments/PlantsByWebSphere/deployment.xml#ApplicationDeployment_1126623343902,
cell=GooddogNode02Cell

queryNames

queryNames コマンドは、名前テンプレートに基づいて、各 ObjectName のリストを照会する場合に使用します。

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

なし。

必須パラメーター

object name
対象のオブジェクト名を指定します。 object name パラメーターには、アスタリスク文字 (*) でワイルドカードを指定することができます。 (java.lang.String)

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

なし。

出力例

以下の例に示すように、このコマンドは、入力オブジェクト名に一致する ObjectNames を含むストリングを戻します。
WebSphere:cell=BaseApplicationServerCell,
name=server1,mbeanIdentifier=server1,
type=Server,node=mynode,process=server1 

queryNames_jmx

queryNames_jmx コマンドは、ユーザーの指定する名前テンプレートや照会の条件に基づいて、各 ObjectName オブジェクトのリストを照会するために使用します。

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

なし。

必須パラメーター

object name
対象のオブジェクト名を指定します。 object name パラメーターには、アスタリスク文字 (*) でワイルドカードを指定することができます。 (ObjectName)
query
使用する照会式を指定します。 (javax.management.QueryExp)

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

なし。

出力例

以下の例に示すように、このコマンドは、入力オブジェクト名に一致する ObjectNames を含むストリングを戻します。
[WebSphere:cell=BaseApplicationServerCell,name=server1,mbeanIdentifier=
server1,type=Server,node=mynode,process=server1] 

reconnect

reconnect コマンドは、サーバーに再接続してローカル・キャッシュから情報をクリアする場合に使用します。

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

なし。

必須パラメーター

なし。

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

なし。

出力例

以下の例に示すように、このコマンドは、オペレーションの状況が表示されたメッセージを戻します。
WASX7074I: Reconnect of SOAP connector to host myhost completed.

setAttribute

setAttribute コマンドは、ユーザーの指定する名前の属性値を設定する場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (java.lang.String)
attribute name
設定する属性の名前を指定します。 (java.lang.String)
attribute value
対象の属性の値を指定します。 (java.lang.String)

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

なし。

出力例

このコマンドは出力を返しません。

setAttribute_jmx

setAttribute_jmx コマンドは、ユーザーの指定する名前の属性値を設定する場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ObjectName)
attribute
設定する属性の名前を指定します。 (Attribute)

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

なし。

出力例

このコマンドは出力を返しません。

setAttributes

setAttributes コマンドは、ユーザーの指定するオブジェクト名の属性値を設定する場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ストリング)
attributes
設定する属性の名前を指定します。 (java.lang.String[] or java.lang.Object[])

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

なし。

出力例

以下の例に示すように、このコマンドは、コマンドの呼び出しによって正常に設定されたオブジェクト名のリストを戻します。
'[traceSpecification com.ibm.ws.*=all=enabled]'

setAttributes_jmx

setAttributes_jmx コマンドは、ユーザーの指定するオブジェクト名の属性値を設定する場合に使用します。

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

なし。

必須パラメーター

object name
対象の MBean のオブジェクト名を指定します。 (ストリング)
attributes
設定する属性の名前を指定します。 (javax.management.AttributeList)

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

なし。

出力例

以下の例に示すように、このコマンドは、コマンドの呼び出しによって正常に設定されたオブジェクト名の属性リストを戻します。
'[traceSpecification com.ibm.ws.*=all=enabled]'

testConnection

testConnection コマンドは、データ・ソース接続をテストする場合に使用します。 このコマンドは、構成リポジトリー内にあるデータ・ソースを処理します。 検査するデータ・ソースが、リポジトリーへの更新を保持する一時ワークスペース内にある場合、このコマンドを実行する前に、構成リポジトリーへの更新を保管する必要があります。 このコマンドは、データ・ソースおよび WAS40DataSource オブジェクト・タイプに対応する構成 ID と一緒に使用してください。

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

なし。

必須パラメーター

configuration ID
対象のデータ・ソース・オブジェクトの構成 ID を指定します。 (java.lang.String)

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

なし。

出力例

このコマンドは、正常な接続が行われたこと、または警告付きの接続が行われたことを示すメッセージを戻します。 接続が失敗すると、サーバーからエラーを示す例外が作成されます。以下に例を示します。
WASX7217I: Connection to provided datasource was successful.

  • Jacl を使用:
    set ds [lindex [$AdminConfig list DataSource] 0]
    $AdminControl testConnection $ds
  • Jython を使用:
    # get line separator
    import  java.lang.System  as sys
    lineSeparator = sys.getProperty('line.separator')
    ds = AdminConfig.list('DataSource').split(lineSeparator)[0]
    print AdminControl.testConnection(ds)

trace

trace コマンドは、スクリプト・プロセスのトレース仕様を、ユーザーの指定する値に設定する場合に使用します。

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

なし。

必須パラメーター

trace specification
トレースがスクリプト・プロセスで使用可能になるように指定します。 (java.lang.String)

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

なし。

出力例

このコマンドは出力を返しません。

  • Jacl を使用:
    $AdminControl trace com.ibm.ws.scripting.*=all=enabled
  • Jython を使用:
    print AdminControl.trace('com.ibm.ws.scripting.*=all=enabled')



関連タスク
スクリプト管理のための AdminControl オブジェクトの使用
参照トピック    

ご利用条件 | フィードバック

最終更新: Jan 21, 2008 7:05:28 PM EST
http://publib.boulder.ibm.com/infocenter/wasinfo/v6r1/index.jsp?topic=/com.ibm.websphere.express.iseries.doc/info/iseriesexp/ae/rxml_admincontrol.html