wsadmin スクリプトを使用する AdminConfig オブジェクトのコマンド
構成コマンドの呼び出し、 および WebSphere® Application Server 構成のエレメントの作成または変更 (例えばデータ・ソースの作成) を行う場合には、 AdminConfig オブジェクトを使用します。
操作がローカルに限定されている場合には、サーバーを実行せずにスクリプト・クライアントを開始できます。 ローカル・モードで実行するには、-conntype NONE オプションを使用してスクリプト・クライアントを開始します。ローカル・モードで実行中であるというメッセージを受け取ります。 サーバーが稼働中の場合は、AdminConfig ツールをローカル・モードで実行しないようにしてください。 ローカル・モードで行った構成変更は稼働中のサーバーの構成に反映されません。競合する構成を保存すると、構成が破損するおそれがあります。
デプロイメント・マネージャー環境では、構成の更新は、スクリプト・クライアントがデプロイメント・マネージャーに接続されている場合にのみ可能です。
ノード・エージェントまたは管理対象アプリケーション・サーバーに接続している場合は、構成を更新できません。それらのサーバー・プロセスの構成は、デプロイメント・マネージャー内にあるマスター構成のコピーであるからです。 これらのコピーは、デプロイメント・マネージャーとノード・エージェントの間で構成の同期が行われる際に、ノード・マシン上に作成されます。 サーバー・プロセスに対する構成変更は、スクリプト・クライアントをデプロイメント・マネージャーに接続して行います。このため、構成を変更する際には、ノード・マシン上でスクリプト・クライアントをローカル・モードで実行しないでください。 そのような構成はサポートされません。

params='[[name name1] [nameInNameSpace nameSpace_Name] [string_to_bind "value, withComma"]]'
AdminConfig.create(type, parent, params)
次の
ような modify コマンドも使用できます。AdminConfig.modify(type, params)
- attributes
- checkin
- convertToCluster
- 作成
- createClusterMember
- createDocument
- createUsingTemplate
- defaults
- deleteDocument
- existsDocument
- extract
- getCrossDocumentValidationEnabled
- getid
- getObjectName
- getObjectType
- getSaveMode
- getValidationLevel
- getValidationSeverityResult
- hasChanges
- help
- installResourceAdapter
- list
- listTemplates
- modify
- parents
- queryChanges
- remove
- required
- reset
- resetAttributes
- save
- setCrossDocumentValidationEnabled
- setSaveMode
- setValidationLevel
- show
- showall
- showAttribute
- types
- uninstallResourceAdapter
- unsetAttributes
- validate
attributes
所定のタイプの最上位の属性のリストを戻すには、attributes コマンドを使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- object type
- XML 構成ファイルに基づくオブジェクト・タイプの名前を指定します。 オブジェクト・タイプは、管理コンソールに表示される名前と同じにする必要はありません。
オプション・パラメーター
なし。出力例
"properties Property*" "serverSecurity ServerSecurity"
"server Server@" "id Long" "stateManagement StateManageable"
"name String" "moduleVisibility EEnumLiteral(MODULE,
COMPATIBILITY, SERVER, APPLICATION)" "services Service*"
"statisticsProvider StatisticsProvider"
例
- Jacl を使用:
$AdminConfig attributes ApplicationServer
- Jython の使用:
print AdminConfig.attributes('ApplicationServer')
checkin
checkin コマンドは、文書 URI で記載されている構成リポジトリーにファイルをチェックインするために使用します。 この方法は、デプロイメント・マネージャー構成にのみ適用されます。
ターゲット・オブジェクト
なし。必須パラメーター
- URI
- 文書 URI は構成リポジトリーのルートに相対的になります。例を以下に示します。
app_server_root¥config
/WebSphere/AppServer/config
¥WebSphere¥AppServer¥config
- file name
- チェックインするソース・ファイルの名前を指定します。
- opaque object
- AdminConfig オブジェクトの extract コマンドが事前の呼び出しで戻すオブジェクトを指定します。
オプション・パラメーター
なし。出力例
"properties Property*" "serverSecurity ServerSecurity"
"server Server@" "id Long" "stateManagement StateManageable"
"name String" "moduleVisibility EEnumLiteral(MODULE,
COMPATIBILITY, SERVER, APPLICATION)" "services Service*"
"statisticsProvider StatisticsProvider"
例
- Jacl を使用:
$AdminConfig checkin cells/MyCell/Node/MyNode/serverindex.xml /mydir/myfile $obj
$AdminConfig checkin cells/MyCell/Node/MyNode/serverindex.xml c:¥¥mydir¥myfile $obj
$AdminConfig checkin cells/MyCell/Node/MyNode/serverindex.xml ¥mydir¥myfile $obj
- Jython の使用:
print AdminConfig.checkin('cells/MyCell/Node/MyNode/serverindex.xml', '/mydir/myfile', obj)
print AdminConfig.checkin('cells/MyCell/Node/MyNode/serverindex.xml', 'c:¥mydir¥myfile', obj)
print AdminConfig.checkin('cells/MyCell/Node/MyNode/serverindex.xml', '¥mydir¥myfile', obj)
convertToCluster
convertToCluster コマンドは、新規サーバー・クラスターの 1 番目のメンバーになるようにサーバーを変換するために使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- server ID
- 対象のサーバーの構成 ID です。
- cluster name
- 対象のクラスターの名前を指定します。
オプション・パラメーター
なし。出力例
myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)
例
- Jacl を使用:
set serverid [$AdminConfig getid /Server:myServer/] $AdminConfig convertToCluster $serverid myCluster
- Jython の使用:
serverid = AdminConfig.getid('/Server:myServer/') print AdminConfig.convertToCluster(serverid, 'myCluster')
作成
create コマンドを使用して、構成オブジェクトを作成します。
ターゲット・オブジェクト
なし。必須パラメーター
- type
- XML 構成ファイルに基づくオブジェクト・タイプの名前を指定します。 このパラメーター値は、管理コンソールに表示される名前と同じにする必要はありません。
- parent ID
- 親オブジェクトの構成 ID の名前を指定します。
- attributes
- 構成 ID に追加する任意の属性を指定します。
オプション・パラメーター
なし。出力例
ds1(cells/mycell/nodes/DefaultNode/servers/server1|resources.xml#DataSource_6)
例
- Jacl を使用:
set jdbc1 [$AdminConfig getid /JDBCProvider:jdbc1/] $AdminConfig create DataSource $jdbc1 {{name ds1}}
- Jython ストリング属性の使用:
jdbc1 = AdminConfig.getid('/JDBCProvider:jdbc1/') print AdminConfig.create('DataSource', jdbc1, '[[name ds1]]')
- オブジェクト属性を持つ Jython の使用:
jdbc1 = AdminConfig.getid('/JDBCProvider:jdbc1/') print AdminConfig.create('DataSource', jdbc1, [['name', 'ds1']])
- ポートを作成するには、以下の例を使用します。
#replace server1 with your server name serverName = 'server1' #replace smtitant24Node03 with your node name node = AdminConfig.getid('/Node:smtitan24Node03') #print node serverEntries = AdminConfig.list('ServerEntry', node).split(java.lang.System.getProperty('line.separator')) for serverEntry in serverEntries: sName = AdminConfig.showAttribute(serverEntry, "serverName") if sName == serverName: #print serverEntry #replace OVERLAY_TEST with the value you want for your endPointName id = AdminConfig.create('NamedEndPoint', serverEntry, '[[endPointName "OVERLAY_TEST"]]') #print id start = id.find('#') #print start end = id.find(')',start) #print end str = id[start:end] server = id[0:start] #print server #print str #replace 8888 with the value you want for your port AdminConfig.create('EndPoint', server+str+')', '[[port "8888"] [host "*"]]') AdminConfig.save() #AdminConfig.reset()
createClusterMember
createClusterMember コマンドを使用して、新規のサーバー・オブジェクトを、node id パラメーターで指定するノード上に作成します。 このサーバーは、cluster id パラメーターで指定される既存クラスターの新規メンバーとして作成され、member attributes パラメーターで指定される属性を含みます。 このサーバーは、template id 属性で指定したサーバー・テンプレートを使用して作成され、 memberName 属性で指定した名前になります。 memberName 属性は必須です。テンプレート・オプションは、最初に作成するクラスター・メンバーについてのみ 選択可能です。作成した 2 つ目以降のクラスター・メンバーはすべて同じになります。
ターゲット・オブジェクト
なし。必須パラメーター
- cluster ID
- 対象のクラスターに構成 ID を指定します。
- node ID
- 対象のノードに構成 ID を指定します。
- template ID
- サーバーの作成に使用するテンプレート ID を指定します。
- member attributes
- クラスター・メンバーに追加する任意の属性を指定します。 memberName 属性は必須であり、作成するクラスター・メンバーの名前を定義します。
オプション・パラメーター
なし。出力例
myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)
例
- Jacl を使用:
set clid [$AdminConfig getid /ServerCluster:myCluster/] set nodeid [$AdminConfig getid /Node:mynode/] $AdminConfig createClusterMember $clid $nodeid {{memberName newMem1} {weight 5}}
- Jython ストリング属性の使用:
clid = AdminConfig.getid('/ServerCluster:myCluster/') nodeid = AdminConfig.getid('/Node:mynode/') print AdminConfig.createClusterMember(clid, nodeid, '[[memberName newMem1] [weight 5]]')
- オブジェクト属性を持つ Jython の使用:
clid = AdminConfig.getid('/ServerCluster:myCluster/') nodeid = AdminConfig.getid('/Node:mynode/') print AdminConfig.createClusterMember(clid, nodeid, [['memberName', 'newMem1'], ['weight', 5]])
createDocument
createDocument は、構成リポジトリー内に新規文書を作成する場合に使用するコマンドです。
ターゲット・オブジェクト
なし。必須パラメーター
- document URI
- リポジトリー内に作成する文書の名前を指定します。
- file name
- 作成する文書の有効なローカル・ファイル名を指定します。
オプション・パラメーター
なし。例
- Jacl を使用:
$AdminConfig createDocument cells/mycell/myfile.xml /mydir/myfile
$AdminConfig createDocument cells/mycell/myfile.xml c:/mydir/myfile
$AdminConfig createDocument cells/mycell/myfile.xml /mydir/myfile
- ストリング属性を持つ Jython の使用:
AdminConfig.createDocument('cells/mycell/myfile.xml', 'c:/mydir/myfile')
AdminConfig.createDocument('cells/mycell/myfile.xml', '/mydir/myfile')
AdminConfig.createDocument('cells/mycell/myfile.xml', '/mydir/myfile')
createUsingTemplate
createUsingTemplate コマンドでは、テンプレートを使用して、特定の親を持つオブジェクト・タイプを作成できます。 このコマンドは、APPLICATION_SERVER タイプのサーバーを作成する場合にしか使用できません。APPLICATION_SERVER 以外の タイプのサーバーを作成する場合は、createGenericServer コマンド または createWebServer コマンドを使用してください。
ターゲット・オブジェクト
なし。必須パラメーター
- type
- 作成するオブジェクトのタイプを指定します。
- parent
- 親の構成 ID を指定します。
- template
- 既存オブジェクトの構成 ID を指定します。 このオブジェクトは、listTemplates コマンドを使用して戻されるテンプレート・オブジェクト、または、その他の正しいタイプの既存オブジェクトです。
オプション・パラメーター
- attributes
- オブジェクトの属性値を指定します。このパラメーターを使用して指定された属性は、テンプレートの設定をオーバーライドします。
出力例
myCluster(cells/mycell/clusters/myCluster|cluster.xml#ClusterMember_2)
例
- Jacl を使用:
set node [$AdminConfig getid /Node:mynode/] set templ [$AdminConfig listTemplates JDBCProvider "DB2 JDBC Provider (XA)"] $AdminConfig createUsingTemplate JDBCProvider $node {{name newdriver}} $templ
- ストリング属性を持つ Jython の使用:
node = AdminConfig.getid('/Node:mynode/') templ = AdminConfig.listTemplates('JDBCProvider', "DB2 JDBC Provider (XA)") print AdminConfig.createUsingTemplate('JDBCProvider', node, '[[name newdriver]]', templ)
- オブジェクト属性を持つ Jython の使用:
node = AdminConfig.getid('/Node:mynode/') templ = AdminConfig.listTemplates('JDBCProvider', "DB2 JDBC Provider (XA)") print AdminConfig.createUsingTemplate('JDBCProvider', node, [['name', 'newdriver']], templ)
defaults
defaults コマンドは、所定のタイプの属性のデフォルト値を表示する場合に使用します。 このメソッドは、特定のタイプのオブジェクトに含まれる可能性のある属性をすべて表示します。 属性がデフォルト値を持つ場合、このメソッドは属性ごとに型とデフォルト値も表示します。
ターゲット・オブジェクト
なし。必須パラメーター
- type
- 戻す対象であるオブジェクトのタイプを指定します。 指定するオブジェクト・タイプの名前は、XML 構成ファイルに基づくものです。 この名前は、管理コンソールに表示される名前と同じにする必要はありません。
オプション・パラメーター
なし。出力例
Attribute Type Default
usingMultiRowSchema Boolean false
maxInMemorySessionCount Integer 1000
allowOverflow Boolean true
scheduleInvalidation Boolean false
writeFrequency ENUM
writeInterval Integer 120
writeContents ENUM
invalidationTimeout Integer 30
invalidationSchedule InvalidationSchedule
例
- Jacl を使用:
$AdminConfig defaults TuningParams
- Jython の使用:
print AdminConfig.defaults('TuningParams')
deleteDocument
deleteDocument コマンドは、構成リポジトリーから文書を削除する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- documentURI
- リポジトリーから削除する文書を指定します。
オプション・パラメーター
なし。例
- Jacl を使用:
$AdminConfig deleteDocument cells/mycell/myfile.xml
- Jython の使用:
AdminConfig.deleteDocument('cells/mycell/myfile.xml')
existsDocument
existsDocument コマンドは、構成リポジトリーに文書が存在するかどうかを検査する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- documentURI
- リポジトリー内の、検査する文書を指定します。
オプション・パラメーター
なし。出力例
1
例
- Jacl を使用:
$AdminConfig existsDocument cells/mycell/myfile.xml
- Jython の使用:
print AdminConfig.existsDocument('cells/mycell/myfile.xml')
extract
extract コマンドは、文書 URI で指定される構成リポジトリー・ファイルを抽出して、filename で指定されたファイルに入れる場合に使用します。 この方法は、デプロイメント・マネージャー構成にのみ適用されます。
ターゲット・オブジェクト
なし。必須パラメーター
- documentURI
- 構成リポジトリーから抽出する文書を指定します。
文書 URI はリポジトリー内に存在しなければなりません。
文書 URI は構成リポジトリーのルートに相対的になります。例を以下に示します。
/WebSphere/AppServer/config
app_server_root¥config
- filename
- 文書の抽出先ファイル名を指定します。 ファイル名は、文書の内容が書き込まれる有効なローカル・ファイル名でなければなりません。 filename パラメーターで指定されたファイルがある場合には、そのファイルが抽出されたファイルと置き換えられます。
オプション・パラメーター
なし。出力例
このコマンドは、checkin コマンドでファイルをチェックインして戻す場合に使用する、 内容が見えない「ダイジェスト」オブジェクトを返します。
例
- Jacl を使用:
set obj [$AdminConfig extract cells/MyCell/nodes/MyNode/serverindex.xml /mydir/myfile]
set obj [$AdminConfig extract cells/MyCell/nodes/MyNode/serverindex.xml c:¥¥mydir¥myfile]
set obj [$AdminConfig extract cells/MyCell/nodes/MyNode/serverindex.xml ¥mydir¥myfile]
- Jython の使用:
obj = AdminConfig.extract('cells/MyCell/nodes/MyNode/serverindex.xml','/mydir/myfile')
obj = AdminConfig.extract('cells/MyCell/nodes/MyNode/serverindex.xml', 'c:¥mydir¥myfile')
obj = AdminConfig.extract('cells/MyCell/nodes/MyNode/serverindex.xml','¥mydir¥myfile')
getCrossDocumentValidationEnabled
getCrossDocumentValidationEnabled コマンドを使用して、現行のクロス文書使用可能設定を含むメッセージを戻します。 このメソッドは、クロス文書妥当性検査が使用可能であれば、true を戻します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。
オプション・パラメーター
なし。
出力例
WASX7188I: Cross-document validation enablement set to true
例
- Jacl を使用:
$AdminConfig getCrossDocumentValidationEnabled
- Jython の使用:
print AdminConfig.getCrossDocumentValidationEnabled()
getid
getid コマンドは、オブジェクトの構成 ID を戻す場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- containment path
- 対象の抑制パスを指定します。
オプション・パラメーター
なし。
出力例
Db2JdbcDriver(cells/testcell/nodes/testnode|resources.xml#JDBCProvider_1)
例
- Jacl を使用:
$AdminConfig getid /Cell:testcell/Node:testNode/JDBCProvider:Db2JdbcDriver/
- Jython の使用:
print AdminConfig.getid('/Cell:testcell/Node:testNode/JDBCProvider:Db2JdbcDriver/')
getObjectName
getObjectName コマンドは、対応する実行中の MBean のオブジェクト名のストリング・バージョンを戻す場合に使用します。 対応する実行中の MBean がない場合、このメソッドは空ストリングを戻します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 戻すオブジェクト名の構成 ID を指定します。
オプション・パラメーター
なし。
出力例
WebSphere:cell=mycell,name=server1,mbeanIdentifier=cells/mycell/nodes/mynode/servers/server1/
server.xml#Server_1,type=Server,node=mynode,process=server1,processType=UnManagedProcess
例
- Jacl を使用:
set server [$AdminConfig getid /Node:mynode/Server:server1/] $AdminConfig getObjectName $server
- Jython の使用:
server = AdminConfig.getid('/Node:mynode/Server:server1/') print AdminConfig.getObjectName(server)
getObjectType
getObjectType コマンドを使用して、対象のオブジェクト構成 ID のオブジェクト・タイプを表示します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 戻すオブジェクト名の構成 ID を指定します。
オプション・パラメーター
なし。
例
- Jacl を使用:
set server [$AdminConfig getid /Node:mynode/Server:server1/] $AdminConfig getObjectType $server
- Jython の使用:
server = AdminConfig.getid('/Node:mynode/Server:server1/') print AdminConfig.getObjectType(server)
getSaveMode
- overwriteOnConflict - 別の構成の変更内容と矛盾する場合であっても、変更内容を保管します
- rollbackOnConflict - 別の構成の変更内容と矛盾する場合には、保管操作が失敗します。 この値がデフォルトです。
ターゲット・オブジェクト
なし。必須パラメーター
なし。
オプション・パラメーター
なし。
出力例
rollbackOnConflict
例
- Jacl を使用:
$AdminConfig getSaveMode
- Jython の使用:
print AdminConfig.getSaveMode()
getValidationLevel
getValidationLevel コマンドを使用して、ファイルをリポジトリーから抽出するときに使用する妥当性検査を戻します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。
オプション・パラメーター
なし。
出力例
WASX7189I: Validation level set to HIGH
例
- Jacl を使用:
$AdminConfig getValidationLevel
- Jython の使用:
print AdminConfig.getValidationLevel()
getValidationSeverityResult
getValidationSeverityResult コマンドは、最新の妥当性検査から、指定された重大度を持つ妥当性検査メッセージの数を戻す場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- severity
- 妥当性検査メッセージの数を戻す対象となる重大度レベルを指定します。 0 から 9 の整数値を指定してください。
オプション・パラメーター
なし。
出力例
16
例
- Jacl を使用:
$AdminConfig getValidationSeverityResult 1
- Jython の使用:
print AdminConfig.getValidationSeverityResult(1)
hasChanges
hasChanges コマンドは、保存されていない構成変更がないか確認する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。
オプション・パラメーター
なし。
出力例
1
例
- Jacl を使用:
$AdminConfig hasChanges
- Jython の使用:
print AdminConfig.hasChanges()
help
help コマンドは、AdminConfig オブジェクトに関する静的ヘルプ情報を表示する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。
オプション・パラメーター
なし。
出力例
WASX7053I: The AdminConfig object communicates with the configuration service in a product to manipulate
configuration data for an Application Server installation. The AdminConfig object has commands to list,
create, remove, display, and modify configuration data, as well as commands to display information about configuration data types.
Most of the commands supported by the AdminConfig object operate in two modes: the default mode is one in which the AdminConfig
object communicates with the Application Server to accomplish its tasks.
A local mode is also
possible, in which no server communication takes place. The local mode of operation is invoked by bringing up
the scripting client without a server connected using the command line "-conntype NONE" option or setting the
"com.ibm.ws.scripting.connectionType=NONE" property in the wsadmin.properties file.
The following commands are supported by the AdminConfig object; more detailed information about each of these commands is available by using the help command of the AdminConfig object and by supplying the name of the command as an argument.
attributes Shows the attributes for a given type
checkin Checks a file into the configuration repository.
convertToCluster Converts a server to be the first member of a new server cluster
create Creates a configuration object, given a type, a parent, and a list of attributes, and
optionally an attribute name for the new object
createClusterMember Creates a new server that is a member of an existing cluster.
createDocument Creates a new document in the configuration repository.
installResourceAdapter Installs a J2C resource adapter with the given RAR file name and an option string in the node.
createUsingTemplate Creates an object using a particular template type.
defaults Displays the default values for the attributes of a given type.
deleteDocument Deletes a document from the configuration repository.
existsDocument Tests for the existence of a document in the configuration repository.
extract Extracts a file from the configuration repository.
getCrossDocumentValidationEnabled Returns true if cross-document validation is enabled.
getid Show the configuration ID of an object, given a string version of its containment
getObjectName Given a configuration ID, returns a string version of the ObjectName
for the corresponding running MBean, if any.
getSaveMode Returns the mode used when "save" is invoked
getValidationLevel Returns the validation that is used when files are extracted from the repository.
getValidationSeverityResult Returns the number of messages of a given severity from the most recent validation.
hasChanges Returns true if unsaved configuration changes exist
help Shows help information
list Lists all the configuration objects of a given type
listTemplates Lists all the available configuration templates of a given type.
modify Changes the specified attributes of a given configuration object
parents Shows the objects which contain a given type
queryChanges Returns a list of unsaved files
remove Removes the specified configuration object
required Displays the required attributes of a given type.
reset Discards the unsaved configuration changes
save Commits the unsaved changes to the configuration repository
setCrossDocumentValidationEnabled Sets the cross-document validation enabled mode.
setSaveMode Changes the mode used when "save" is invoked
setValidationLevel Sets the validation used when files are extracted from the repository.
show Shows the attributes of a given configuration object
showall Recursively shows the attributes of a given configuration
object, and all the objects that are contained within each attribute.
showAttribute Displays only the value for the single attribute that is specified.
types Shows the possible types for configuration
validate Invokes validation
例
- Jacl を使用:
$AdminConfig help
- Jython の使用:
print AdminConfig.help()
installResourceAdapter
installResourceAdapter コマンドは、所定のリソース・アダプター・アーカイブ (RAR) ファイル名およびオプション・ストリングを使用して、Java 2 コネクター (J2C) リソース・アダプターをノードにインストールする場合に使用します。 インストール済みアプリケーションを組み込み RAR で編集すると、 既存の J2C 接続ファクトリー、J2C アクティベーション・スペック、J2C 管理オブジェクトのみが編集されます。 新規の J2C オブジェクトは作成されません。
ターゲット・オブジェクト
なし。必須パラメーター
- ノード
- 対象のノードを指定します。
- RAR file name
- 指定するノードにある RAR ファイルの完全修飾ファイル名を指定します。
オプション・パラメーター
- options
- リソース・アダプターのインストールに関する他のオプションを指定します。
有効なオプションとしては、以下のようなものがあります。
- rar.name
- rar.desc
- rar.archivePath
- rar.classpath
- rar.nativePath
- rar.threadPoolAlias
- rar.propertiesSet
rar.archivePath は、このファイルを抽出するパスの名前です。 このオプションを指定しないと、アーカイブは $¥{CONNECTOR_INSTALL_ROOT¥} ディレクトリーに抽出されます。 rar.classpath オプションは追加のクラスパスです。
rar.propertiesSet は、以下のように構成されます。
プロパティーの各属性は、 {} で指定します。プロパティーは、{} で指定します。複数のプロパティーを、 {} で指定することもできます。name String value String type String *desc String *required true/false * means the item is optional
出力例
myResourceAdapter(cells/mycell/nodes/mynode|resources.xml#J2CResourceAdapter_1)
例
- Jacl を使用:
$AdminConfig installResourceAdapter /rar/mine.rar mynode{-rar.name myResourceAdapter -rar.desc "My rar file"}
$AdminConfig installResourceAdapter c:/rar/mine.rar mynode {-rar.name myResourceAdapter -rar.desc "My rar file"}
- Jython の使用:
print AdminConfig.installResourceAdapter('/rar/mine.rar', 'mynode', '[-rar.name myResourceAdapter -rar.desc "My rar file"]')
print AdminConfig.installResourceAdapter('c:/rar/mine.rar', 'mynode', '[-rar.name myResourceAdapter -rar.desc "My rar file"]')
resourceProperties (name=myName,value=myVal)
をリソース・アダプター構成に追加するには、以下のコマンドを実行します。
pSet = [['propertySet',[['resourceProperties',[[['name','myName'], ['type', 'String'], ['value','myVal']]]]]]]
myRA =AdminConfig.installResourceAdapter('/query.rar','mynodeCellManager05', ['-rar.desc','mydesc'])
myRA =AdminConfig.installResourceAdapter('c:¥query.rar','mynodeCellManager05', ['-rar.desc','mydesc'])
AdminConfig.modify(myRA,pSet)
list
list コマンドを使用して、特定のタイプのオブジェクトのリストを取得できます。また、コマンド構文で、タイプのほかに有効範囲を限定する親を指定したり、ワイルドカード文字 (*) や Java 正規表現 (.*) パターンを指定したりして、検索照会をカスタマイズして絞り込むこともできます。
ターゲット・オブジェクト
なし。必須パラメーター
- object type
- オブジェクト・タイプの名前を指定します。オブジェクト・タイプの名前は、 XML 構成ファイルに基づいています。管理コンソールに表示される名前と同じにする必要はありません。
オプション・パラメーター
- scope
- 有効範囲を限定する親を使用して、検索照会の追加情報を指定します。
- pattern
- ワイルドカード文字 (*) や Java 正規表現パターン (.*) を使用して、検索照会の追加情報を指定します。
出力例
Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xml#JDBCProvider_1)
Db2JdbcDriver(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml#JDBCProvider_1)
Db2JdbcDriver(cells/mycell/nodes/DefaultNode/servers/nodeAgent|resources.xml#JDBCProvider_1)
例
- Jacl を使用:
$AdminConfig list JDBCProvider
- Jython の使用:
print AdminConfig.list('JDBCProvider')
注: 単一引用符または二重引用符を使用してください。
- Jacl を使用:
$AdminConfig list JDBCProvider derby*
- Jython の使用:
print AdminConfig.list('JDBCProvider', 'derby*')
Java 正規表現パターンとワイルドカード・パターンを使用して、$AdminConfig リストのコマンド名、タイプ、listTemplates 関数を指定できます。
- Jacl を使用:
$AdminConfig list Server server1.*
- Jython の使用:
print AdminConfig.list("Server", "server1.*")
オブジェクト・タイプのほかに、親の有効範囲構成 ID を指定して、サーバー構成オブジェクトをリストする例を以下に示します。
- Jacl を使用:
$AdminConfig list Server myNode(cells/myCell/nodes/myNode|node.xml#Node_1)
- Jython の使用:
print AdminConfig.list("Server", "myNode(cells/myCell/nodes/myNode|node.xml#Node_1)")
- Jacl および Java 正規表現パターンを使用:
$AdminConfig types SSLConfig.*
- Jacl およびワイルドカード・パターンを使用:
$AdminConfig types SSLConfig*
- Jython および Java 正規表現パターンを使用:
print AdminConfig.types("SSLConfig.*")
- Jython およびワイルドカード・パターンを使用:
print AdminConfig.types("SSLConfig*")
listTemplates
listTemplates コマンドは、テンプレート・オブジェクト ID のリストを表示する場合に使用します。 コマンド構文内でワイルドカード文字 (*) または Java 正規表現 (.*) を使用して、検索照会をカスタマイズすることができます。
ターゲット・オブジェクト
なし。必須パラメーター
- object type
- オブジェクト・タイプの名前を指定します。オブジェクト・タイプの名前は、 XML 構成ファイルに基づいています。管理コンソールに表示される名前と同じにする必要はありません。
- pattern
- ワイルドカード文字または Java 正規表現を使用して、検索照会の情報をさらに指定します。
オプション・パラメーター
なし。出力例
"Derby JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#builtin_jdbcprovider)"
"Derby JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/defaultZOS|resources.xml#builtin_jdbcprovider)"
"Derby JDBC Provider (XA)(templates/servertypes/APPLICATION_SERVER/servers/default|resources.xml#builtin_jdbcprovider)"
"Derby JDBC Provider (XA)(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_4)"
"Derby JDBC Provider 40 (XA)(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_2)"
"Derby JDBC Provider 40 Only (XA)(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_2)"
"Derby JDBC Provider 40 Only(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_1)"
"Derby JDBC Provider 40(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_Derby_1)"
"Derby JDBC Provider Only (XA)(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_4)"
"Derby JDBC Provider Only(templates/system|jdbc-resource-provider-only-templates.xml#JDBCProvider_derby_3)"
"Derby JDBC Provider(templates/servertypes/APPLICATION_SERVER/servers/DeveloperServer|resources.xml#JDBCProvider_1124467079638)"
"Derby JDBC Provider(templates/system|jdbc-resource-provider-templates.xml#JDBCProvider_derby_3)"
例
- Jacl を使用:
$AdminConfig listTemplates JDBCProvider
- Jython の使用:
print AdminConfig.listTemplates('JDBCProvider')
- Jacl を使用:
$AdminConfig listTemplates JDBCProvider sybase*
- Jython の使用:
print AdminConfig.listTemplates('JDBCProvider', 'sybase*')
modify
modify コマンドは、オブジェクト属性の変更をサポートする場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 変更するオブジェクトの構成 ID を指定します。
- attributes
- 対象の構成 ID に関して変更する属性を指定します。
オプション・パラメーター
なし。例
- Jacl を使用:
$AdminConfig modify ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml# GenericJMSConnectionFactory_1) {{userID newID} {password newPW}}
- ストリング属性を持つ Jython の使用:
AdminConfig.modify('ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml# GenericJMSConnectionFactory_1)', '[[userID newID] [password newPW]]')
- オブジェクト属性を持つ Jython の使用:
AdminConfig.modify('ConnFactory1(cells/mycell/nodes/DefaultNode/servers/deploymentmgr|resources.xml# GenericJMSConnectionFactory_1)', [['userID', 'newID'], ['password', 'newPW']])
parents
parents コマンドは、オブジェクト・タイプに関する情報を取得する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- object type
- 対象のオブジェクト・タイプを指定します。 オブジェクト・タイプの名前は、 XML 構成ファイルに基づいています。管理コンソールに表示される名前と同じにする必要はありません。
オプション・パラメーター
なし。出力例
Cell
Node
サーバー
例
- Jacl を使用:
$AdminConfig parents JDBCProvider
- Jython の使用:
print AdminConfig.parents('JDBCProvider')
queryChanges
queryChanges コマンドは、未保存の構成ファイルを戻す場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
なし。出力例
WASX7146I: The following configuration files contain unsaved changes:
cells/mycell/nodes/mynode/servers/server1|resources.xml
例
- Jacl を使用:
$AdminConfig queryChanges
- Jython の使用:
print AdminConfig.queryChanges()
remove
remove コマンドは、構成オブジェクトを削除する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 対象の構成オブジェクトを指定します。
オプション・パラメーター
なし。例
- Jacl を使用:
set ds [$AdminConfig list DataSource "Default Datasource*"] $AdminConfig remove $ds
- Jython の使用:
ds = AdminConfig.list('DataSource', 'Default Datasource*') AdminConfig.remove(ds)
required
required コマンドは、特定のタイプのオブジェクトに含まれる必須の属性を表示する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- type
- 必須属性を表示する対象のオブジェクト・タイプを指定します。 オブジェクト・タイプの名前は、XML 構成ファイルに基づきます。 管理コンソールに表示される名前と同じにする必要はありません。
オプション・パラメーター
なし。出力例
Attribute Type
streamHandlerClassName String
protocol String
例
- Jacl を使用:
$AdminConfig required URLProvider
- Jython の使用:
print AdminConfig.required('URLProvider')
reset
reset コマンドは、構成への更新を保持する一時ワークスペースをリセットする場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
なし。例
- Jacl を使用:
$AdminConfig reset
- Jython の使用:
AdminConfig.reset()
resetAttributes
resetAttributes コマンドを使用して、対象の構成オブジェクトの特定の属性を再設定します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 対象の構成オブジェクトの構成 ID を指定します。
- attributes
- 再設定する属性、およびその属性を再設定する値を指定します。
オプション・パラメーター
なし。例
- Jacl を使用:
set ds [$AdminConfig list DataSource "Default Datasource*"] $AdminConfig resetAttributes $ds {{"description" "A new description for the data source"}}
- Jython の使用:
ds = AdminConfig.list('DataSource', 'Default Datasource*') AdminConfig.resetAttributes(ds, [["description", "A new description for the data source"]])
save
save コマンドは、変更内容を構成リポジトリーに保存する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
なし。出力例
save コマンドは出力を返しません。
例
- Jacl を使用:
$AdminConfig save
- Jython の使用:
AdminConfig.save()
setCrossDocumentValidationEnabled
setCrossDocumentValidationEnabled コマンドを使用して、クロス文書妥当性検査の使用可能モードを設定します。 値には true または false があります。
ターゲット・オブジェクト
なし。必須パラメーター
- flag
- クロス文書妥当性検査を使用可能にするかどうかを指定します。クロス文書妥当性検査は、true を指定すると使用可能に、false を指定すると使用不可に設定されます。
オプション・パラメーター
なし。出力例
WASX7188I: Cross-document validation enablement set to true
例
- Jacl を使用:
$AdminConfig setCrossDocumentValidationEnabled true
- Jython の使用:
print AdminConfig.setCrossDocumentValidationEnabled('true')
setSaveMode
setSaveMode コマンドは、save コマンドの振る舞いを変更する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- save mode
- 使用する save モードを指定します。 デフォルト値は rollbackOnConflict です。システムが保存中に矛盾を検出すると、未保存の変更はコミットされません。 この他の値に、矛盾があっても変更を構成リポジトリーに保存する overwriteOnConflict が選択可能です。 overwriteOnConflict をこのコマンドの値として使用するには、デプロイメント・マネージャーで構成の上書きが有効になっている必要があります。
オプション・パラメーター
なし。出力例
setSaveMode コマンドは出力を返しません。
例
- Jacl を使用:
$AdminConfig setSaveMode overwriteOnConflict
- Jython の使用:
AdminConfig.setSaveMode('overwriteOnConflict')
setValidationLevel
setValidationLevel コマンドは、ファイルをリポジトリーから抽出するときに使用する妥当性検査を設定する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- level
- 使用する妥当性検査を指定します。 妥当性検査には、none、low、medium、high、 または highest の 5 つのレベルがあります。
オプション・パラメーター
なし。出力例
WASX7189I: Validation level set to HIGH
例
- Jacl を使用:
$AdminConfig setValidationLevel high
- Jython の使用:
print AdminConfig.setValidationLevel('high')
show
show コマンドは、所定のオブジェクトの最上位の属性を戻す場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 対象のオブジェクトの構成 ID を指定します。
オプション・パラメーター
なし。出力例
[name "Sample Datasource"] [description "Data source for the Sample entity beans"]
例
- Jacl を使用:
$AdminConfig show Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xmlJDBCProvider_1)
- Jython の使用:
print AdminConfig.show('Db2JdbcDriver(cells/mycell/nodes/DefaultNode|resources.xmlJDBCProvider_1)')
showall
showall コマンドは、所定の構成オブジェクトの属性を再帰的に表示する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 対象のオブジェクトの構成 ID を指定します。
オプション・パラメーター
なし。出力例
以下の例に示すように、このコマンドは属性値を含むストリングを戻します。
tcpNoDelay: null
SoTimeout: 0
bytesRead: 6669
{authMechanismPreference BASIC_PASSWORD}
{connectionPool {{agedTimeout 0}
{connectionTimeout 180}
{freePoolDistributionTableSize 0}
{maxConnections 10}
{minConnections 1}
{numberOfFreePoolPartitions 0}
{numberOfSharedPoolPartitions 0}
{numberOfUnsharedPoolPartitions 0}
{properties {}}
{purgePolicy EntirePool}
{reapTime 180}
{stuckThreshold 0}
{stuckTime 0}
{stuckTimerTime 0}
{surgeCreationInterval 0}
{surgeThreshold -1}
{testConnection false}
{testConnectionInterval 0}
{unusedTimeout 1800}}}
{datasourceHelperClassname com.ibm.websphere.rsadapter.DerbyDataStoreHelper}
{description "Datasource for the WebSphere Default Application"}
{diagnoseConnectionUsage false}
{jndiName DefaultDatasource}
{logMissingTransactionContext true}
{manageCachedHandles false}
{name "Default Datasource"}
{properties {}}
{propertySet {{resourceProperties {{{name databaseName}
{required false}
{type java.lang.String}
{value ${APP_INSTALL_ROOT}/${CELL}/DefaultApplication.ear/DefaultDB}} {{name shu
tdownDatabase}
{required false}
{type java.lang.String}
{value {}}} {{name dataSourceName}
{required false}
{type java.lang.String}
{value {}}} {{name description}
{required false}
{type java.lang.String}
{value {}}} {{name connectionAttributes}
{required false}
{type java.lang.String}
{value upgrade=true}} {{name createDatabase}
{required false}
{type java.lang.String}
{value {}}}}}}}
{provider "Derby JDBC Provider(cells/isthmusCell04/nodes/isthmusNode14/servers/s
erver1|resources.xml#JDBCProvider_1183122153343)"}
{providerType "Derby JDBC Provider"}
{relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/isthmusC
ell04/nodes/isthmusNode14/servers/server1|resources.xml#builtin_rra)"}
{statementCacheSize 10}
[datasourceHelperClassname com.ibm.websphere.rsadapter.DerbyDataStoreHelper]
[description "Datasource for the WebSphere Default Application"]
[jndiName DefaultDatasource]
[name "Default Datasource"]
[propertySet [[resourceProperties [[[description "Location of Apache Derby default database."]
[name databaseName]
[type string]
[value ${WAS_INSTALL_ROOT}/bin/DefaultDB]] [[name remoteDataSourceProtocol]
[type string]
[value []]] [[name shutdownDatabase]
[type string]
[value []]] [[name dataSourceName]
[type string]
[value []]] [[name description]
[type string]
[value []]] [[name connectionAttributes]
[type string]
[value []]] [[name createDatabase]
[type string]
[value []]]]]]]
[provider "Apache Derby JDBC Driver(cells/pongo/nodes/pongo/servers/server1|resources.xml#JDBCProvider_1)"]
[relationalResourceAdapter "WebSphere Relational Resource Adapter(cells/pongo/nodes/pongo/servers/server1|
resources.xml#builtin_rra)"][statementCacheSize 0]
ストリングによる Jython 出力をさらに処理するため、リストに変換する必要がある場合があります。例
- Jacl を使用:
$AdminConfig showall "Default Datasource(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_1)"
- Jython の使用:
print AdminConfig.showall ("Default Datasource(cells/mycell/nodes/DefaultNode/servers/server1:resources.xml#DataSource_1)")
showAttribute
showAttribute コマンドは、指定した 1 つの属性の値のみを表示する場合に使用します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 対象のオブジェクトの構成 ID を指定します。
- attribute
- 照会する属性を指定します。
オプション・パラメーター
なし。出力例
mynode
例
- Jacl を使用:
set ns [$AdminConfig getid /Node:mynode/] $AdminConfig showAttribute $ns hostName
- Jython の使用:
ns = AdminConfig.getid('/Node:mynode/') print AdminConfig.showAttribute(ns, 'hostName')
7.0.0.5 より前のバージョンの場合、Jython スクリプト言語では特殊文字が認識されません。また、属性パラメーターの間にコンマやシングル・スペース文字がある場合、それらの文字は区切り文字として扱われ、属性値の保存時に無視されます。例えば、以下のような Jython コマンド・セットがあるとします。
値を印刷する場合は、以下のコマンドを使用できます。value='{"param1","param2"}' serverId=AdminConfig.getid('/Cell:cell_name/Node:node_name/Server:server_name') nameSpace=AdminConfig.create('StringNameSpaceBinding',serverId,[['name','TestName'], ['nameInSpace','TestNameSpace'],['stringToBind',value] ])
出力は以下のようになります。print AdminConfig.showAttribute(nameSpace, 'stringToBind')
バージョン 7.0.0.5 以降では、コンマの前に円記号文字 (¥) がある場合は、Jython スクリプト言語でそのコンマが認識されます。例えば、上記の Jython コマンド・セット例で、最初の行を以下のコマンドに変更します。{"param1" "param2"}
値を印刷すると、以下の出力が返されます。value='{"param1"¥,"param2"}'
{"param1","param2"}
types
types コマンドを使用して、構成オブジェクト・タイプのリストを戻します。コマンド構文で、ワイルドカード文字 (*) や Java 正規表現 (.*) パターンを追加して、検索照会を操作したりカスタマイズしたりすることもできます。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
- pattern
- ワイルドカード文字 (*) や Java 正規表現パターン (.*) を使用して、検索照会の追加情報を指定します。
出力例
AdminService
Agent
ApplicationConfig
ApplicationDeployment
ApplicationServer
AuthMechanism
AuthenticationTarget
AuthorizationConfig
AuthorizationProvider
AuthorizationTableImpl
BackupCluster
CMPConnectionFactory
CORBAObjectNameSpaceBinding
Cell
CellManager
Classloader
ClusterMember
ClusteredTarget
CommonSecureInteropComponent
例
- Jacl を使用:
$AdminConfig types
- Jython の使用:
print AdminConfig.types()
- Jacl を使用:
$AdminConfig types *security*
- Jython の使用:
print AdminConfig.types('*security*')
uninstallResourceAdapter
uninstallResourceAdapter コマンドは、所定の J2C リソース・アダプター構成 ID およびオプション・リストを使用して、Java 2 コネクター (J2C) リソース・アダプターをアンインストールする場合に使用します。 J2CResourceAdapter オブジェクトを構成リポジトリーから除去すると、 そのインストール・ディレクトリーは、同期を行うときに除去されます。 除去された J2CResourceAdapter MBean には、停止要求が送信されます。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 除去するリソース・アダプターの構成 ID を指定します。
オプション・パラメーター
- options list
- コマンドのアンインストール・オプションを指定します。 有効なオプションは force です。 このオプションは、リソース・アダプターがアプリケーションによって使用されているかどうかを確認することなく、 リソース・アダプターのアンインストールを強制します。 それを使用しているアプリケーションは、アンインストールされません。 force オプションが指定されておらず、 指定されたリソース・アダプターがまだ使用中である場合、 リソース・アダプターはアンインストールされません。
出力例
WASX7397I: The following J2CResourceAdapter objects are removed:
MyJ2CRA(cells/juniarti/nodes/juniarti|resources.xml#J2CResourceAdapter_1069433028609)
例
- Jacl を使用:
set j2cra [$AdminConfig getid /J2CResourceAdapter:MyJ2CRA/] $AdminConfig uninstallResourceAdapter $j2cra {-force}
- Jython の使用:
j2cra = AdminConfig.getid('/J2CResourceAdapter:MyJ2CRA/') print AdminConfig.uninstallResourceAdapter(j2cra, '[-force]')
unsetAttributes
unsetAttributes コマンドを使用して、構成オブジェクトの特定の属性をデフォルト値に再設定します。
ターゲット・オブジェクト
なし。必須パラメーター
- configuration ID
- 対象の構成オブジェクトの構成 ID を指定します。
- attributes
- 属性をデフォルト値に再設定するように指定します。
オプション・パラメーター
なし。例
- Jacl を使用:
set cluster [$AdminConfig getid /ServerCluster:myCluster] $AdminConfig unsetAttributes $cluster {"enableHA", "preferLocal"}
- Jython の使用:
cluster = AdminConfig.getid("/ServerCluster:myCluster") AdminConfig.unsetAttributes(cluster, ["enableHA", "preferLocal"])
validate
validate コマンドは、ワークスペースにあるファイル、クロス文書妥当性検査使用可能フラグ、および妥当性検査レベル設定に基づき、構成の妥当性検査結果を要求する場合に使用します。 オプションで、有効範囲を設定するための構成 ID を指定することができます。構成 ID を指定した場合、この要求の有効範囲は、configuration ID パラメーターで指定されるオブジェクトになります。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
- configuration ID
- 対象のオブジェクトの構成 ID を指定します。
出力例
WASX7193I: Validation results are logged in c:\WebSphere5\AppServer\logs\wsadmin.valout: Total number of messages: 16
WASX7194I: Number of messages of severity 1: 16
例
- Jacl を使用:
$AdminConfig validate
- Jython の使用:
print AdminConfig.validate()