AdminTask オブジェクトの SecurityDomainCommands コマンド・グループ
Jython スクリプト言語を使用すると、wsadmin ツールでセキュリティー・ドメインを構成および管理できます。SecurityDomainCommands グループ内のコマンドとパラメーターを使用して、セキュリティー・ドメインを作成および管理したり、サーバーやクラスターをリソースとしてセキュリティー・ドメインに割り当てたり、セキュリティー・ドメイン構成を照会したりします。
- convertServerSecurityToSecurityDomain
- copySecurityDomain
- copySecurityDomainFromGlobalSecurity
- createSecurityDomain
- deleteSecurityDomain
- getSecurityDomainForResource
- listResourcesInSecurityDomain
- listSecurityDomains
- listSecurityDomainsForResources
- mapResourceToSecurityDomain
- modifySecurityDomain
- removeResourceFromSecurityDomain
convertServerSecurityToSecurityDomain
WebSphere® Application Server バージョン 7.0 以降では、サーバー・レベルのセキュリティー構成の代わりに、セキュリティー・ドメインを使用できます。 サーバー・レベルのセキュリティー構成が現在使用されている場合、convertServerSecurityToSecurityDomain コマンドを使用して、それをセキュリティー・ドメインに変換できます。
このコマンドによってセキュリティー・ドメインが作成され、サーバー・レベルのセキュリティー構成に指定されているすべてのセキュリティー設定が、新しく作成されるセキュリティー・ドメインに追加されます。 サーバー・リソースは、セキュリティー・ドメインにマップされます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -serverResource
- セキュリティー・ドメインに変換されるサーバーのリソース名。 (ストリング)
- -securityDomain
- 作成されるセキュリティー・ドメインの名前。このドメインに、サーバー・レベルのセキュリティー構成から設定が追加されます。 (ストリング)
オプション・パラメーター
- -securityDomainDescription
- 新しいセキュリティー・ドメインの説明を指定します。 (ストリング)
- -deleteServer
- true を指定すると、サーバー・レベルのセキュリティー構成が削除され、false を指定すると、サーバー・レベルのセキュリティー構成はそのまま保持されます。 (ストリング)
バッチ・モードの使用例
- Jython を使用:
wsadmin> AdminTask.convertServerSecurityToSecurityDomain ('[serverResource Cell=:Node=myNode:Server=server1 -securityDomain secDomain1 -securityDomainDescription "Migrated from server security configuration" -deleteServer true ]'))
- Jacl を使用:
wsadmin> $AdminTask convertServerSecurityToSecurityDomain {-serverResource Cell=:Node=myNode:Server=server1 -securityDomain secDomain1 -securityDomainDescription "Migrated from server security configuration" -deleteServer true }
copySecurityDomain
copySecurityDomain コマンドは、既存のセキュリティー・ドメインをコピーすることで新しいセキュリティー・ドメインを作成します。セキュリティー構成でアクティブ・ユーザー・レジストリーが定義される場合は、新規作成されるセキュリティー・ドメインのレルム名を指定します。レルム名を指定しなかった場合は、システムによってレルム名が作成されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- システムが別のセキュリティー・ドメインをコピーすることで作成する新しいセキュリティー・ドメインの名前を指定します。 (ストリング)
- -copyFromSecurityDomainName
- システムが新しいセキュリティー・ドメインを作成するために使用する既存のセキュリティー・ドメインの名前を指定します。 (ストリング)
オプション・パラメーター
- -securityDomainDescription
- 新しいセキュリティー・ドメインの説明を指定します。 (ストリング)
- -realmName
- 新しいセキュリティー・ドメイン内のレルムの名前を指定します。このパラメーターの値を指定しなかった場合は、システムによってこのレルムの名前が作成されます。 (ストリング)
戻り値
このコマンドは、新しいセキュリティー・ドメインの構成 ID を返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.copySecurityDomain('-securityDomainName copyOfDomain2 -copyFromSecurityDomainName Domain2')
- Jython リストを使用:
AdminTask.copySecurityDomain('-securityDomainName', 'copyOfDomain2', '-copyFromSecurityDomainName', 'Domain2')
対話モードの使用例
- Jython を使用:
AdminTask.copySecurityDomain('-interactive')
copySecurityDomainFromGlobalSecurity
copySecurityDomainFromGlobalSecurity コマンドは、グローバル・セキュリティー構成をコピーすることでセキュリティー・ドメインを作成します。グローバル・セキュリティー構成のアクティブ・ユーザー・レジストリーが存在する場合は、新規作成されるセキュリティー・ドメインのレルム名を指定します。レルム名を指定しなかった場合は、システムによってレルム名が作成されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- システムによってグローバル・セキュリティー構成からコピーされる、新しいセキュリティー・ドメインの名前を指定します。 (ストリング)
オプション・パラメーター
- -securityDomainDescription
- 新しいセキュリティー・ドメインの説明を指定します。 (ストリング)
- -realmName
- 新しいセキュリティー構成内のレルムの名前を指定します。-realmName パラメーターの値を指定しなかった場合は、システムによってこのレルムの名前が作成されます。 (ストリング)
戻り値
このコマンドは、新しいセキュリティー・ドメインの構成 ID を返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.copySecurityDomainFromGlobalSecurity('-securityDomainName GSCopy -securityDomainDescription "copy of global security" -realmName myRealm')
- Jython リストを使用:
AdminTask.copySecurityDomainFromGlobalSecurity('-securityDomainName', 'GSCopy', '-securityDomainDescription', '"copy of global security"', '-realmName myRealm')
対話モードの使用例
- Jython を使用:
AdminTask.copySecurityDomainFromGlobalSecurity('-interactive')
createSecurityDomain
createSecurityDomain コマンドは、セキュリティーの domain-security.xml ファイルと domain-security-map.xml ファイルを profile_root/config/cells/cellName/securityDomain/configurationName ディレクトリーに作成します。システムによって空の domain-security.xml ファイルが作成されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- 作成する新規セキュリティー・ドメインの名前を指定します。 (ストリング)
オプション・パラメーター
- -securityDomainDescription
- 新しいセキュリティー・ドメインの説明を指定します。 (ストリング)
戻り値
このコマンドは、新しいセキュリティー・ドメインの構成 ID を返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.createSecurityDomain('-securityDomainName newDomain -securityDomainDescription "new security domain"')
- Jython リストを使用:
AdminTask.createSecurityDomain('-securityDomainName', 'newDomain', '-securityDomainDescription', '"new security domain"')
対話モードの使用例
- Jython を使用:
AdminTask.createSecurityDomain('-interactive')
deleteSecurityDomain
deleteSecurityDomain コマンドは、domain-security.xml ファイルと domain-security-map.xml ファイルをセキュリティー・ドメイン・ディレクトリーから削除します。対象のセキュリティー・ドメインにリソースがマップされている場合は、このコマンドはエラーを返します。対象のセキュリティー・ドメインにリソースがマップされている場合にセキュリティー・ドメインを削除するには、-force パラメーターの値を true に指定します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- 削除するセキュリティー・ドメインの名前を指定します。 (ストリング)
オプション・パラメーター
- -force
- リソースが関連付けられているかどうかを確認せずにセキュリティー・ドメインを削除することを指定します。このオプションは、セキュリティー・ドメイン内のリソースが有効でない場合に使用します。-force パラメーターのデフォルト値は false です。(ブール値)
戻り値
セキュリティー・ドメイン構成が正常に削除された場合は、このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteSecurityDomain('-securityDomainName mySecurityDomain -force true')
- Jython リストを使用:
AdminTask.deleteSecurityDomain('-securityDomainName', 'mySecurityDomain', '-force', 'true')
対話モードの使用例
- Jython を使用:
AdminTask.deleteSecurityDomain('-interactive')
getSecurityDomainForResource
getSecurityDomainForResource コマンドは、特定のリソースのセキュリティー・ドメインを表示します。そのリソースがドメインにマップされていない場合は、このコマンドは出力を返しません。
ターゲット・オブジェクト
なし。
必須パラメーター
- -resourceName
- 対象のリソースの名前を指定します。この値は、Cell=:Node=myNode:Server=myServer というフォーマットで指定します。(ストリング)
オプション・パラメーター
- -getEffectiveDomain
- リソースがドメインに直接マップされていない場合に、このコマンドがリソースの有効ドメインを返すかどうかを指定します。デフォルト値は true です。リソースがドメインに直接マップされていない場合に、有効ドメインが表示されないようにするには、false を指定します。(ブール値)
戻り値
このコマンドは、セキュリティー・ドメイン名をストリングとして返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.getSecurityDomainForResource('-resourceName Cell=:Node=myNode:Server=myServer')
- Jython リストを使用:
AdminTask.getSecurityDomainForResource('-resourceName', 'Cell=:Node=myNode:Server=myServer')
対話モードの使用例
- Jython を使用:
AdminTask.getSecurityDomainForResource('-interactive')
listResourcesInSecurityDomain
listResourcesInSecurityDomain コマンドは、特定のセキュリティー・ドメインと関連付けられているサーバーまたはクラスターを表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- 対象のセキュリティー・ドメインの名前を指定します。 (ストリング)
- -expandCell
- セル内のサーバーを表示するかどうかを指定します。特定のサーバーを表示する場合は true を、セル情報のみを表示する場合は false を指定します。(ブール値)
戻り値
このコマンドは、対象のセキュリティー・ドメインにマップされているリソースの名前が含まれた配列を、Cell=cell name:Node=node name:Server=server name というフォーマットで返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.listResourcesInSecurityDomain('-securityDomainName myDomain')
- Jython リストを使用:
AdminTask.listResourcesInSecurityDomain('-securityDomainName', 'myDomain')
対話モードの使用例
- Jython を使用:
AdminTask.listResourcesInSecurityDomain('-interactive')
listSecurityDomains
listSecurityDomains コマンドは、サーバー用に構成された各セキュリティー・ドメインを一覧表示します。
ターゲット・オブジェクト
なし。
オプション・パラメーター
- -listDescription
- セキュリティー・ドメインの説明を表示するかどうかを指定します。 セキュリティー・ドメインの説明を表示するには、true を指定します。 (ブール値)
- -doNotDisplaySpecialDomains
- 特別なドメインを除外するかどうかを指定します。コマンド出力から特別なドメインを除外する場合は true を、特別なドメインを表示する場合は false を指定します。 (ブール値)
戻り値
このコマンドは、サーバー用に構成されたセキュリティー・ドメインの名前が含まれた配列を返します。-listDescription パラメーターを指定した場合は、このコマンドは、各セキュリティー・ドメインの名前と説明が含まれた属性リストの配列を返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.listSecurityDomains('-listDescription true')
- Jython リストを使用:
AdminTask.listSecurityDomains('-listDescription', 'true')
対話モードの使用例
- Jython を使用:
AdminTask.listSecurityDomains('-interactive')
listSecurityDomainsForResources
listSecurityDomainsForResources コマンドは、対象のリソースと関連付けられたセキュリティー・ドメインを一覧表示します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -resourceNames
- コマンドによって、関連付けられたセキュリティー・ドメインが返される、1 つ以上のリソースを指定します。各リソースはプラス符号 (+) で区切って指定します。 (ストリング)
戻り値
このコマンドは、-resourceNames パラメーターによって指定されたリソースと、各リソースがマップされるセキュリティー・ドメインのリストを返します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.listSecurityDomainsForResources('-resourceNames resource1+resource2+resource3')
- Jython リストを使用:
AdminTask.listSecurityDomainsForResources('-resourceNames', 'resource1+resource2+resource3')
対話モードの使用例
- Jython を使用:
AdminTask.listSecurityDomainsForResources('-interactive')
mapResourceToSecurityDomain
mapResourceToSecurityDomain コマンドは、リソースをセキュリティー・ドメインにマップします。 各リソースのエントリーが domain-security-map.xml ファイルに自動的に追加されます。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- 対象のセキュリティー・ドメインの名前を指定します。 (ストリング)
- -resourceName
- 対象のセキュリティー・ドメインをマップするリソースの名前を指定します。この値は、Cell=:Node=myNode:Server=myServer というフォーマットで指定します。(ストリング)
戻り値
リソースが対象のセキュリティー・ドメインに正常に割り当てられた場合は、このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.mapResourceToSecurityDomain('-securityDomainName mySecurityDomain -resourceName -resourceName Cell=:Node=myNode:Server=myServer')
- Jython リストを使用:
AdminTask.mapResourceToSecurityDomain('-securityDomainName', 'mySecurityDomain', '-resourceName', '-resourceName Cell=:Node=myNode:Server=myServer')
対話モードの使用例
- Jython を使用:
AdminTask.mapResourceToSecurityDomain('-interactive')
modifySecurityDomain
modifySecurityDomain コマンドは、セキュリティー・ドメインの説明を変更します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- 編集するセキュリティー・ドメインの名前を指定します。 (ストリング)
オプション・パラメーター
- -securityDomainDescription
- 対象のセキュリティー・ドメインの新しい説明を指定します。 (ストリング)
戻り値
セキュリティー・ドメインが正常に変更された場合は、このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.modifySecurityDomain('-securityDomainName myDomain -securityDomainDescription "my new description"')
- Jython リストを使用:
AdminTask.modifySecurityDomain('-securityDomainName', 'myDomain', '-securityDomainDescription',= '"my new description"')
対話モードの使用例
- Jython を使用:
AdminTask.modifySecurityDomain('-interactive')
removeResourceFromSecurityDomain
removeResourceFromSecurityDomain コマンドは、リソースをセキュリティー・ドメインのマッピングから削除します。このコマンドは、そのリソースのエントリーを domain-security-map.xml ファイルから削除します。
ターゲット・オブジェクト
なし。
必須パラメーター
- -securityDomainName
- リソースを除去するセキュリティー・ドメインの名前を指定します。 (ストリング)
- -resourceName
- 削除するリソースの名前を指定します。この値は、Cell=:Node=myNode:Server=myServer というフォーマットで指定します。(ストリング)
戻り値
リソースがセキュリティー・ドメインから正常に削除された場合は、このコマンドは出力を返しません。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.removeResourceFromSecurityDomain('-securityDomainName myDomain -resourceName Cell=:Node=myNode:Server=myServer')
- Jython リストを使用:
AdminTask.removeResourceFromSecurityDomain('-securityDomainName', 'myDomain', '-resourceName', 'Cell=:Node=myNode:Server=myServer')
対話モードの使用例
- Jython を使用:
AdminTask.removeResourceFromSecurityDomain('-interactive')