2 インフラストラクチャ・セキュリティ・カスタムWLSTコマンド

この章では、Oracle Fusion Middlewareインフラストラクチャ・セキュリティWLSTコマンドについて説明します。

次のトピックが含まれます:

• インフラストラクチャ・コマンド

関連トピック

Oracle Platform Security Servicesでのアプリケーションの保護

『Oracle Fusion Middlewareの管理』のカスタムWLSTコマンドの使用に関する項

2.1 インフラストラクチャ・コマンド

インフラストラクチャWLSTセキュリティ・コマンドは、次のカテゴリに分かれています。

表2-1 WLSTコマンド・カテゴリ

コマンド・カテゴリ	説明
OPSSセキュリティ・ストア・コマンド	ドメインおよび資格ドメイン・ストアを管理し、ドメイン・ポリシー・ストアを移動します。
監査設定コマンド	監査ポリシーおよび監査リポジトリ設定を表示し管理します。
OPSSキーストア・サービス・コマンド	OPSSキーストア・サービスを管理します。
アイデンティティ・ディレクトリ・サービス・コマンド	アイデンティティ・ディレクトリ・サービスのエンティティ属性、エンティティ定義、関係およびデフォルトの操作構成を管理します。
Library Oracle Virtual Directory (libOVD)コマンド	特定のOPSSコンテキストに関連付けられているLibrary Oracle Virtual Directory (libOVD)構成を表示および管理します。

注意: 構文の説明で、オプションの引数は角カッコで囲まれています。それ以外のすべての引数は必須です。

2.1.1 OPSSセキュリティ・ストア・コマンド

表2-2に示されているWLSTセキュリティ・コマンドを使用して、ドメイン・ポリシーまたは資格証明ストアの操作、ソース・リポジトリからターゲット・リポジトリへのポリシーと資格証明の移行および(資格証明の)暗号化鍵のエクスポートとインポートを行います。

表2-2 WLSTセキュリティ・コマンド

使用するコマンド...	目的...	使用するWLST...
addBootStrapCredential	資格証明をブート・ストラップ資格証明ストアに追加します	オフライン
addResourceToEntitlement	資格にリソースを追加します。	オンライン
createAppRole	新しいアプリケーション・ロールを作成します。	オンライン
createCred	新しい資格を作成します。	オンライン
createEntitlement	資格を作成します。	オンライン
createResource	リソースを作成します。	オンライン
createResourceType	新しいリソース・タイプを作成します。	オンライン
deleteAppPolicies	アプリケーション内のすべてのポリシーを削除します。	オンライン
deleteAppRole	アプリケーション・ロールを削除します。	オンライン
deleteCred	資格を削除します。	オンライン
deleteEntitlement	資格を削除します。	オンライン
deleteResource	リソースを削除します。	オンライン
deleteResourceType	既存のリソース・タイプを削除します。	オンライン
exportEncryptionKey	ドメイン暗号化鍵をファイルewallet.p12にエクスポートします。	オフライン
getEntitlement	資格を一覧表示します。	オンライン
getResourceType	既存のリソース・タイプをフェッチします。	オンライン
grantAppRole	ロールにプリンシパルを追加します。	オンライン
grantEntitlement	資格を作成します。	オンライン
grantPermission	新しい特権を作成します。	オンライン
importEncryptionKey	ファイルewallet.p12内の暗号化鍵をドメインにインポートします。	オフライン
listAppRoles	アプリケーション内のすべてのロールを表示します。	オンライン
listAppRolesMembers	アプリケーション・ロール内のすべてのメンバーを表示します。	オンライン
listAppStripes	ポリシー・ストア内のアプリケーション・ストライプを一覧表示します。	オンライン
listCodeSourcePermissions	グローバル・ポリシーのソース・コードに割り当てられている権限を一覧表示します。	オンライン
listEntitlement	資格を一覧表示します。	オンライン
listEntitlements	アプリケーション・ストライプ内の資格を一覧表示します。	オンライン
listPermissions	プリンシパルに付与されたすべての特権を表示します。	オンライン
listResourceActions	リソースのアクションを一覧表示します。	オンライン
listResourceTypes	アプリケーション・ストライプ内のリソース・タイプを一覧表示します。	オンライン
listResources	アプリケーション・ストライプ内のリソースを一覧表示します。	オンライン
listSecurityStoreInfo	OPSSセキュリティ・ストアのタイプと場所、およびアクセスを許可されているユーザーを一覧表示します。	オフライン
migrateSecurityStore	ポリシーまたは資格をソース・リポジトリから対象リポジトリに移動します。	オフライン
modifyBootStrapCredential	ブート・ストラップ資格ストアを更新します。	オフライン
reassociateSecurityStore	ポリシーおよび資格をLDAPリポジトリに再び関連付けます。	オンライン
restoreEncryptionKey	ドメイン暗号化鍵を、直近のインポートの前の状態にリストアします。	オフライン
revokeAppRole	ロールからプリンシパルを削除します。	オンライン
revokeEntitlement	資格を削除します。	オンライン
revokePermission	特権を削除します。	オンライン
revokeResourceFromEntitlement	資格からリソースを削除します	オンライン
rollOverEncryptionKey	現在のドメイン暗号化鍵を新しい暗号化鍵に置換します。	オフライン
updateCred	資格の属性の値を変更します。	オンライン
updateTrustServiceConfig	トラスト・サービスの構成を更新します。	オンライン

2.1.1.1 addBootStrapCredential

資格証明をブート・ストラップ資格証明ストアに追加するオフライン・コマンド。

説明

指定されたマップ、キー、ユーザー名およびユーザー・パスワードを持つパスワード資格証明を、JPS構成ファイルのデフォルトのJPSコンテキストで構成されたブートストラップ資格証明に追加します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

addBootStrapCredential(jpsConfigFile, map, key, username, password)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
map	追加する資格証明のマップを指定します。
key	追加する資格証明のキーを指定します。
username	追加する資格証明のユーザーの名前を指定します。
password	追加する資格証明のユーザーのパスワードを指定します。

例

次の例は、ブートストラップ資格証明ストアに資格証明を追加します。

wls:/mydomain/serverConfig> addBootStrapCredential(jpsConfigFile='./jps-config.xml', map='myMapName', key='myKeyName', username='myUser', password='myPassword')

2.1.1.2 addResourceToEntitlement

指定されたアクションを持つリソースを資格に追加するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格に、指定されたアクションを持つリソースを追加します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

addResourceToEntitlement(appStripe="appStripeName", name="entName", resourceName="resName",actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	追加するリソースの名前を指定します。
resourceType	追加するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
actions	追加されるリソースのアクションのカンマ区切りのリストを指定します。

例

次の例は、アプリケーション・ストライプmyApplicationの権限myEntitlementにリソースmyResourceを追加します。

wls:/mydomain/serverConfig> addResourceToEntitlement(appStripe="myApplication", 
name="myEntitlement", resourceName="myResource", resourceType="myResType", 
actions="view,edit")

2.1.1.3 createAppRole

新しいアプリケーション・ロールを作成するオンライン・コマンドを示します。

説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアに作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createAppRole(appStripe, appRoleName)

引数	定義
appSripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleを持つ新しいアプリケーション・ロールを作成します。

wls:/mydomain/serverConfig> createAppRole(appStripe="myApp", appRoleName="myRole")

2.1.1.4 createCred

ドメイン資格ストアに新しい資格を作成するオンライン・コマンドを示します。

説明

指定したマップ名、キー名、タイプ、ユーザー名およびパスワード、URLおよびポート番号のドメイン資格ストアに新しい資格を作成します。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

createCred(map, key, user, password, [desc])

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。
user	資格ユーザー名を指定します。
password	資格のパスワードを指定します。
desc	資格を説明する文字列を指定します。

例

次の例は、指定したデータで新しいパスワード資格証明を作成します。

wls:/mydomain/serverConfig> createCred(map="myMap, key="myKey", user="myUsr", 
password="myPassw", desc="updated usr name and passw to connect to app xyz")

2.1.1.5 createEntitlement

新しい資格を作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプに、1つのリソースとアクションのリストを持つ新しい資格を作成します。既存の資格にリソースを追加するにはaddResourceToEntitlementを使用し、既存の資格からリソースを削除するにはrevokeResourceFromEntitlementを使用します。

構文

createEntitlement(appStripe="appStripeName", name="entitlementName", resourceName="resName", actions="actionList" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	資格の作成対象のアプリケーション・ストライプを指定します。
name	作成する資格の名前を指定します。
resourceName	作成する資格の1つのリソース・メンバーの名前を指定します。
actions	リソースresourceNameのアクションのカンマ区切りのリストを指定します。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成する資格の説明を指定します。オプション。

例

次の例は、ストライプmyApplicationにリソースmyResourceのみの権限myEntitlementを作成します。

wls:/mydomain/serverConfig> createEntitlement(appStripe="myApplication", name="myEntitlement", resourceName="myResource", actions="read,write")

2.1.1.6 createResource

新しいリソースを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内に、指定されたタイプのリソースを作成します。渡されるリソース・タイプは、渡されるアプリケーション・ストライプ内に存在している必要があります。

構文

createResource(appStripe="appStripeName", name="resName", type="resTypeName" [,-displayName="dispName"] [,-description="descript"])

引数	定義
appStripe	リソースの作成対象のアプリケーション・ストライプを指定します。
name	作成するリソースの名前を指定します。
type	作成するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。
displayName	作成するリソースの表示名を指定します。オプション。
description	作成するリソースの説明を指定します。オプション。

例

次の例は、ストライプmyApplicationにリソースmyResourceを作成します。

wls:/mydomain/serverConfig> createResource(appStripe="myApplication", name="myResource", type="myResType", displayName="myNewResource")

2.1.1.7 createResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに新しいリソース・タイプを作成するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアに、指定された名前、表示名、説明およびアクションを持つ新しいリソース・タイプ要素を作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createResourceType(appStripe, resourceTypeName, displayName, description [, provider] [, matcher], actions [, delimeter])

引数	定義
appStripe	リソース・タイプの挿入対象のアプリケーション・ストライプを指定します。
resourceTypeName	挿入するリソース・タイプの名前を指定します。
displayName	UIガジェットで使用されるリソース・タイプの名前を指定します。
description	リソース・タイプの簡単な説明を指定します。
provider	リソース・タイプのプロバイダを指定します。
matchere	リソース・タイプのクラスを指定します。指定しない場合、この値はデフォルトのoracle.security.jps.ResourcePermissionに設定されます。
actions	このリソース・タイプのインスタンスで許可されるアクションを指定します。
delimeter	アクションのリストでデリミタとして使用する文字を指定します。指定しない場合、この値はデフォルトのカンマ(,)に設定されます。

例

次の例は、セミコロンで区切って指定したアクションBWPrintおよびアクションColorPrintを設定したリソース・タイプをストライプmyApplicationに作成します。

wls:/mydomain/serverConfig> createResourceType(appStripe="myApplication", 
resourceTypeName="resTypeName", displayName="displName", description="A resource
type", provider="Printer", matcher="com.printer.Printer",
actions="BWPrint;ColorPrint" [, delimeter=";"])

2.1.1.8 deleteAppPolicies

指定したアプリケーション・ストライプのすべてのポリシーを削除するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプのすべてのポリシーを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteAppPolicies(appStripe)

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。

例

次の例は、アプリケーションmyAppのすべてのポリシーを削除します。

wls:/mydomain/serverConfig> deleteAppPolicies(appStripe="myApp")

2.1.1.9 deleteAppRole

アプリケーション・ロールを削除するオンライン・コマンドを示します。

説明

指定したアプリケーションおよびロール名のアプリケーション・ロールをドメイン・ポリシー・ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

createAppRole(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロールを削除します。

wls:/mydomain/serverConfig> deleteAppRole(appStripe="myApp", appRoleName="myRole")

2.1.1.10 deleteEntitlement

資格を削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格を削除します。アプリケーション・ストライプ内の指定された資格へのすべての参照を削除することで、カスケード削除を実行します。

構文

deleteEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
name	削除する資格の名前を指定します。

例

次の例は、ストライプmyApplicationの権限myEntitlementを削除します。

wls:/mydomain/serverConfig> deleteEntitlement(appStripe="myApplication", name="myEntitlement")

2.1.1.11 deleteCred

ドメイン資格ストア内の資格を削除するオンライン・コマンドを示します。

説明

指定したマップ名およびキー名の資格をドメイン資格ストアから削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteCred(map,key)

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。

例

次の例は、マップ名myMapおよびキー名myKeyを持つ資格証明を削除します。

wls:/mydomain/serverConfig> deleteCred(map="myApp",key="myKey")

2.1.1.12 deleteResource

リソースを削除するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格からリソースおよびそのすべての参照を削除します。このコマンドは、カスケード削除を実行します。資格が1つのリソースのみを参照している場合は、その資格を削除し、それ以外の場合は、渡されたタイプのリソース・アクションを資格から削除します。

構文

deleteResource(appStripe="appStripeName", name="resName", type="resTypeName")

引数	定義
appStripe	リソースの削除対象のアプリケーション・ストライプを指定します。
name	削除するリソースの名前を指定します。
type	削除するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の例は、ストライプmyApplicationのリソースmyResourceを削除します。

wls:/mydomain/serverConfig> deleteResource(appStripe="myApplication", name="myResource", type="myResType")

2.1.1.13 deleteResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリを削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

deleteResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプの削除元となるアプリケーション・ストライプを指定します。
resourceTypeName	削除するリソース・タイプの名前を指定します。

例

次の例は、ストライプmyApplicationからリソース・タイプmyResTypeを削除します。

wls:/mydomain/serverConfig> deleteResourceType(appStripe="myApplication", resourceTypeName="myResType")

2.1.1.14 exportEncryptionKey

ドメインのブートストラップ・ウォレットからファイルewallet.p12に暗号化鍵を抽出するオフライン・コマンド。

説明

ドメインの資格証明暗号化鍵をファイルewallet.p12に書き込みます。コマンドimportEncryptionKeyを使用してそのファイルからデータをインポートするには、このコマンドで渡されるパスワードを使用する必要があります。

exportEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

構文

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
keyFilePath	ファイルewallet.p12の作成先となるディレクトリを指定します。このファイルのコンテンツは暗号化されており、keyFilePasswordに渡される値によって保護されていることに注意してください。
keyFilePassword	ファイルewallet.p12を保護するためのパスワードを指定します。このファイルをインポートする際は、これと同じパスワードを使用する必要があることに注意してください。

例

次の例は、ディレクトリmyDirにファイルewallet.p12を書き込みます。

exportEncryptionKey(jpsConfigFile="pathName", keyFilePath="myDir" ,keyFilePassword="password")

2.1.1.15 getEntitlement

資格を取得するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格の名前、表示名およびすべてのリソース(とそれらの資格)を戻します。

構文

getEntitlement(appStripe="appStripeName", name="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	アクセスする資格の名前を指定します。

例

次の例は、ストライプmyApplicationの権限myEntitlementの情報を返します。

wls:/mydomain/serverConfig> getEntitlement(appStripe="myApplication", name="myEntitlement")

2.1.1.16 getResourceType

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアからリソース・タイプをフェッチするオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のドメイン・ポリシー・ストアの、指定された名前を持つ<resource-type>エントリの関連パラメータを取得します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

getResourceType(appStripe, resourceTypeName)

引数	定義
appStripe	リソース・タイプのフェッチ元となるアプリケーション・ストライプを指定します。
resourceTypeName	フェッチするリソース・タイプの名前を指定します。

例

次の例は、ストライプmyApplicationからリソース・タイプmyResTypeをフェッチします。

wls:/mydomain/serverConfig> getResourceType(appStripe="myApplication", resourceTypeName="myResType")

2.1.1.17 grantAppRole

ロールにプリンシパルを追加するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよび名前のロールにプリンシパル(クラスまたは名前)を追加します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

grantAppRole(appStripe, appRoleName,principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。
principalClass	クラスの完全修飾名を指定します。
principalName	プリンシパルの名前を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロールにプリンシパルを追加します。

wls:/mydomain/serverConfig> grantAppRole(appStripe="myApp",  
appRoleName="myRole",principalClass="com.example.xyzPrincipal",
principalName="myPrincipal")

2.1.1.18 grantEntitlement

名前の付けられたプリンシパルに資格を付与するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の指定されたプリンシパルに資格を付与します。

構文

grantEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	プリンシパルが存在するアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が付与されるプリンシパルの名前を指定します。
permSetName	付与する資格の名前を指定します。

例

次の例は、ストライプmyApplicationの資格myEntitlementをプリンシパルmyPrincipalNameに付与します。

wls:/mydomain/serverConfig> grantEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

2.1.1.19 grantPermission

新しい特権を作成するオンライン・コマンドを示します。

説明

指定したコード・ベースおよびURLに対して新しい特権を作成します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

grantPermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
codeBaseURL	特権のあるコードのURLを指定します。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。
permClass	permissionクラスの完全修飾名を指定します。
permTarget	利用可能であれば、特権対象の名前を指定します。一部の特権には、この属性を含むことができない場合があります。
permActions	付与されたアクションのカンマ区切りのリストを指定します。一部の特権には、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

例

次の例は、指定したデータでアプリケーションの新しい特権(アプリケーション・ストライプmyAppのアプリケーション)を作成します。

wls:/mydomain/serverConfig> grantPermission(appStripe="myApp",  
principalClass="my.custom.Principal",  principalName="manager",
permClass="java.security.AllPermission")

次の例は、指定したデータでシステムの新しい特権を作成します。

wls:/mydomain/serverConfig> grantPermission(principalClass="my.custom.Principal", principalName="manager",   
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext", 
permTarget="/tmp/fileName.ext", permActions="read,write")

2.1.1.20 importEncryptionKey

指定されたewallet.p12ファイルからドメインにキーをインポートするオフライン・コマンド。

説明

次の呼出しは、ファイルewallet.p12からドメインに暗号化鍵をインポートします。渡されるパスワードは、コマンドexportEncryptionKeyを使用してファイルを作成する際に使用されたものと同じである必要があります。

構文

importEncryptionKey(jpsConfigFile, keyFilePath, keyFilePassword)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
keyFilePath	ewallet.p12の書込み先となるディレクトリを指定します。
keyFilePassword	ファイルewallet.p12の生成時に使用されたパスワードを指定します。

例

importEncryptionKey(jpsConfigFile="pathName", keyFilePath="dirloc" ,keyFilePassword="password")

2.1.1.21 listAppRoles

アプリケーション内のすべてのロールを表示するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプ内のすべてのロールを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listAppRoles(appStripe)

引数	定義
appStripe	アプリケーション・ストライプを指定します。

例

次の例は、アプリケーション・ストライプmyAppのすべてのロールを返します。

wls:/mydomain/serverConfig> listAppRoles(appStripe="myApp")

2.1.1.22 listAppRolesMembers

ロール内のすべてのメンバーを表示するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよびロール名のロール内のすべてのメンバーを表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listAppRoleMembers(appStripe, appRoleName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロール内のすべてのメンバーを返します。

wls:/mydomain/serverConfig> listAppRoleMembers(appStripe="myApp", appRoleName="myRole")

2.1.1.23 listAppStripes

ポリシー・ストア内のアプリケーション・ストライプを一覧表示するオンラインまたはオフライン・コマンド。

説明

このスクリプトは、オフライン・モードまたはオンライン・モードで実行できます。オフライン・モードで実行する場合は、構成ファイルを渡す必要があります。渡された構成ファイルのデフォルト・コンテキストで構成によって参照されるポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。デフォルトの構成には、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。オンライン・モードで実行する場合は、構成ファイルを渡さないでください。接続しているドメインのポリシー・ストア内のストライプが一覧表示されます。いずれのモードでも、正規表現が渡されると、その正規表現に一致する名前を持つアプリケーション・ストライプが一覧表示されます。それ以外の場合は、すべてのアプリケーション・ストライプが一覧表示されます。

構文

listAppStripes([configFile="configFileName"] [, regularExpression="aRegExp"])

引数	定義
configFile	OPSS構成ファイルへのパスを指定します。オプション。指定した場合、スクリプトはオフラインで実行されます。指定された構成ファイルのデフォルト・コンテキストに、アイデンティティ・ストアへのサービス・インスタンス参照があってはいけません。指定しない場合、スクリプトはオンラインで実行され、ポリシー・ストア内のアプリケーション・ストライプが一覧表示されます。
regularExpression	正規表現を指定します。この正規表現に一致するストライプ名が戻されます。オプション。指定しない場合、すべての名前が一致します。サブストリングに一致させるには、文字*を使用します。

例

次の(オンライン)呼出しは、ポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes

次の(オフライン)呼出しは、指定された構成ファイルのデフォルト・コンテキストで参照されるポリシー・ストア内のアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(configFile=" 
/home/myFile/jps-config.xml")

次の(オンライン)呼出しは、接頭辞Appを含むアプリケーション・ストライプのリストを戻します。

wls:/mydomain/serverConfig> listAppStripes(regularExpression="App*")

2.1.1.24 listCodeSourcePermissions

グローバル・ポリシーのソース・コードに割り当てられている権限を一覧表示するオンライン・コマンド。

説明

このコマンドによって、グローバル・ポリシーのコードベース権限の一覧表示が可能になります。

構文

listCodeSourcePermissions([codeBase="codeUrl"])

引数	定義
codeBaseURL	権限受領者のコードベースURL名を指定します。

例

次の例は、すべてのグローバル・ポリシーのコード・ソースに割り当てられたリスト権限を戻します。

wls:/mydomain/serverConfig> listCodeSourcePermissions(codeBaseURL="file:/tmp/lib/myJars.jar")

2.1.1.25 listEntitlement

指定されたアプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

プリンシパル名およびクラスを指定した場合、指定されたプリンシパルに一致する資格が一覧表示されます。それ以外の場合は、すべての資格が一覧表示されます。

構文

listEntitlement(appStripe="appStripeName" [, principalName="principalName", principalClass="principalClass"])

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalName	一致させるプリンシパルの名前を指定します。オプション。
principalClass	一致させるプリンシパルのクラスを指定します。オプション。

例

次の例は、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlement(appStripe="myApplication")

2.1.1.26 listEntitlements

アプリケーション・ストライプ内の資格を一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内のすべての資格を一覧表示します。リソース名およびリソース・タイプを指定した場合、指定されたリソース名に一致する、指定されたタイプのリソースを持つ資格が一覧表示されます。それ以外の場合は、アプリケーション・ストライプ内のすべての資格が一覧表示されます。

構文

listEntitlements(appStripe="appStripeName" [,resourceTypeName="resTypeName", resourceName="resName"])

引数	定義
appStripe	資格の一覧表示対象のアプリケーション・ストライプを指定します。
resourceTypeName	一覧表示するリソースのタイプの名前を指定します。オプション。
resourceName	一致させるリソースの名前を指定します。オプション。

例

次の例は、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication")

次の例は、リソース・タイプmyResType、およびリソース名がmyResNameに一致するリソースを含む、ストライプmyApplication内のすべての資格を一覧表示します。

wls:/mydomain/serverConfig> listEntitlements(appStripe="myApplication", resourceTypeName="myResType", resourceName="myResName") 

2.1.1.27 listPermissions

指定したプリンシパルに付与したすべての特権を表示するオンライン・コマンドを示します。

説明

指定したプリンシパルに付与されたすべての特権を表示します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

listPermissions([appStripe,] principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。

例

次の例は、アプリケーションmyAppのポリシーによってプリンシパルに付与したすべての特権を表示します。

wls:/mydomain/serverConfig> listPermissions(appStripe="myApp", principalClass="my.custom.Principal",principalName="manager")
                

次の例は、システム・ポリシーによってプリンシパルに付与したすべての特権を表示します。

wls:/mydomain/serverConfig> listPermissions(principalClass="my.custom.Principal", principalName="manager")

2.1.1.28 listResourceActions

資格のリソースとアクションを一覧表示するオンライン・コマンド。

説明

アプリケーション・ストライプ内の資格のリソースとアクションを一覧表示します。

構文

listResourceActions(appStripe="appStripeName", permSetName="entitlementName")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
permSetName	リソースとアクションを一覧表示する資格の名前を指定します。

例

次の例は、ストライプmyApplication内の資格myEntitlementのリソースとアクションを一覧表示します。

wls:/mydomain/serverConfig> listResourceActions(appStripe="myApplication", permSetName="myEntitlement")

2.1.1.29 listResources

指定されたアプリケーション・ストライプ内のリソースを一覧表示するオンライン・コマンド。

説明

リソース・タイプを指定した場合、指定されたリソース・タイプのすべてのリソースが一覧表示されます。それ以外の場合は、すべてのタイプのすべてのリソースが一覧表示されます。

構文

listResources(appStripe="appStripeName" [,type="resTypeName"])

引数	定義
appStripe	リソースの一覧表示対象のアプリケーション・ストライプを指定します。
type	一覧表示するリソースのタイプを指定します。渡されるリソース・タイプは、このスクリプトの呼出し時点でアプリケーション・ストライプ内に存在している必要があります。

例

次の例は、ストライプmyApplication内のタイプmyResTypeのすべてのリソースを一覧表示します。

wls:/mydomain/serverConfig> listResources(appStripe="myApplication", type="myResType")

2.1.1.30 listResourceTypes

リソース・タイプを一覧表示するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内のすべてのリソース・タイプを一覧表示します。

構文

listResourceTypes(appStripe="appStripeName")

引数	定義
appStripe	リソース・タイプが存在するアプリケーション・ストライプを指定します。

例

次の例は、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> listResourceTypes(appStripe="myApplication")

2.1.1.31 listSecurityStoreInfo

ドメイン・セキュリティ・ストアのタイプ、場所および管理ユーザーを一覧表示するオフライン・コマンド。

説明

スクリプトはオフライン・モードで実行され、OPSSセキュリティ・ストアのタイプ(ファイル、OIDまたはDB)、場所、およびアクセスを許可されているユーザー(通常はセキュリティ管理者)を出力します。

構文

listSecurityStoreInfo(domainConfig="configFilePath")

引数	定義
domainConfig	OPSS構成ファイルjps-config.xmlへの完全絶対パスを指定します。渡されるディレクトリには、ファイルjps-config-jse.xmlも含まれている必要があります。

例

次の例は、OPSSポリシー・ストアのタイプ、場所および管理ユーザーを戻します。

wls:/mydomain/serverConfig> listSecurityStoreInfo(domainConfig="/home/myConfigPathDirectory/config/fmwconfig")

次の各行は、このコマンドによって生成されたサンプル出力を示しています。

For jps-config.xml
Store Type: DB_ORACLE
Location/Endpoint: jdbc:oracle:thin:@adc2120515.us.myComp.com:1555/OWSM.US.COM
User: DEV_OPSS
Datasource: jdbc/OpssDataSource
For jps-config-jse.xml
Store Type: DB_ORACLE
Location/Endpoint: jdbc:oracle:thin:@adc2120515.us.myComp.com:1521/OWSM.US.COM
User: DEV_OPSS

2.1.1.32 migrateSecurityStore

ID、アプリケーション特定ポリシー、システム・ポリシー、特定資格フォルダまたはすべての資格を移動するオフライン・コマンドを示します。

説明

セキュリティ・アーティファクトをソース・リポジトリからターゲット・リポジトリに移行します。詳細は、migrateSecurityStoreスクリプトを使用した移行に関する項を参照してください。

2.1.1.33 modifyBootStrapCredential

ブート・ストラップ資格ストアを更新するオフライン・コマンドを示します。

説明

指定したユーザー名およびパスワードでブート・ストラップ資格を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

一般的に、次のシナリオの場合に使用されます: ドメイン・ポリシーおよび資格証明ストアはLDAPベースで、(LDAPサーバーに格納された)LDAPストアにアクセスする資格証明が変更されたとします。その後、このコマンドを使用して、ブート・ストラップ資格ストアにこれらの変更を設定できます。

構文

modifyBootStrapCredential(jpsConfigFile, username, password)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。
username	LDAPストア内のユーザーの識別名を指定します。
password	ユーザーのパスワードを指定します。

例

LDAPストアでは、識別された名cn=orcladminのユーザーのパスワードをwelcome1に変更しており、設定ファイルjps-config.xmlを現在のディレクトリに存在している場合、次の例は、ブート・ストラップ資格ストア内のパスワードをwelcome1に変更します。

wls:/mydomain/serverConfig> modifyBootStrapCredential(jpsConfigFile='./jps-config.xml', username='cn=orcladmin', password='welcome1')

監査サービスに対する任意の出力を無視できます。

2.1.1.34 reassociateSecurityStore

ポリシーおよび資格ストアをLDAPリポジトリに移動するオンライン・コマンドを示します。

説明

スクリプトreassociateSecurityStoreは、OPSSセキュリティ・ストアをソースからLDAPベースまたはDBベースのターゲット・ストアに移行して、jps-config.xmlファイルおよびjps-config-jse.xmlファイル内のサービスをターゲット・リポジトリにリセットします。また、別のドメイン内のOPSSセキュリティ・ストアを指定して共有することもできます(後述のオプション引数joinを参照)。OPSSのバイナリとターゲットのポリシー・ストアには、バージョンの互換性が必要です。

詳細および例は、『Oracle Platform Security Servicesによるアプリケーションの保護』を参照してください。

2.1.1.35 restoreEncryptionKey

ドメイン資格証明暗号化鍵をリストアするオフライン・コマンド。

説明

ドメイン・ブートストラップ・キーの状態を、importEncryptionKeyの実行前の状態にリストアします。

構文

restoreEncryptionKey(jpsConfigFile)

引数	定義
jpsConfigFile	コマンドが実行している場所に対してファイルjps-config.xmlの場所を指定します。

例

restoreEncryptionKey(jpsConfigFile="pathName")

2.1.1.36 revokeAppRole

ロールからプリンシパルを削除するオンライン・コマンドを示します。

説明

指定したアプリケーション・ストライプおよび名前のロールからプリンシパル(クラスまたは名前)を削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

revokeAppRole(appStripe, appRoleName, principalClass, principalName)

引数	定義
appStripe	アプリケーション・ストライプを指定します。
appRoleName	ロール名を指定します。
principalClass	クラスの完全修飾名を指定します。
principalName	プリンシパルの名前を指定します。

例

次の例は、アプリケーション・ストライプmyAppおよびロール名myRoleのロールからプリンシパルを削除します。

wls:/mydomain/serverConfig> revokeAppRole(appStripe="myApp", 
appRoleName="myRole",principalClass="com.example.xyzPrincipal", 
principalName="myPrincipal")

2.1.1.37 revokeEntitlement

資格を削除するオンライン・コマンド。

説明

資格を削除し、指定されたアプリケーション・ストライプ内のプリンシパルからその資格を取り消します。

構文

revokeEntitlement(appStripe="appStripeName", principalClass="principalClass", principalName="principalName" ,-permSetName="entName")

引数	定義
appStripe	資格の削除対象のアプリケーション・ストライプを指定します。
principalClass	プリンシパルに関連付けられているクラスを指定します。
principalName	資格が取り消されるプリンシパルの名前を指定します。
permSetName	削除する資格の名前を指定します。

例

次の例は、ストライプmyApplicationの権限myEntitlementを削除します。

wls:/mydomain/serverConfig> revokeEntitlement(appStripe="myApplication", 
principalClass="oracle.security.jps.service.policystore.ApplicationRole", 
principalName="myPrincipalName", permSetName="myEntitlement")

2.1.1.38 revokePermission

特権を削除するオンライン・コマンドを示します。

説明

指定したコード・ベースおよびURLの特権を削除します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

revokePermission([appStripe,] [codeBaseURL,] [principalClass,] [principalName,]permClass, [permTarget,] [permActions])

引数	定義
appStripe	アプリケーション・ストライプを指定します。指定しない場合、コマンドを使用してシステム・ポリシーが処理されます。
codeBaseURL	特権のあるコードのURLを指定します。
principalClass	クラス(被譲与者)の完全修飾名を指定します。
principalName	被譲与者のプリンシパル名を指定します。
permClass	permissionクラスの完全修飾名を指定します。
permTarget	利用可能であれば、特権対象の名前を指定します。一部の特権には、この属性を含むことができない場合があります。
permActions	付与されたアクションのカンマ区切りのリストを指定します。一部の特権には、この属性が含まれない可能性があり、利用可能なアクションは、permissionクラスによって異なります。

例

次の例は、指定したデータのアプリケーション特権(アプリケーション・ストライプmyAppのアプリケーション)を削除します。

wls:/mydomain/serverConfig> revokePermission(appStripe="myApp",  
principalClass="my.custom.Principal", principalName="manager", 
permClass="java.security.AllPermission")

以下の例は、システムの指定したデータの特権を削除します。

wls:/mydomain/serverConfig> revokePermission(principalClass="my.custom.Principal", principalName="manager",  
permClass="java.io.FilePermission", permTarget="/tmp/fileName.ext", 
permActions="read,write")

2.1.1.39 revokeResourceFromEntitlement

資格からリソースを削除するオンライン・コマンド。

説明

指定されたアプリケーション・ストライプ内の資格からリソースを削除します。

構文

revokeResourceFromEntitlement(appStripe="appStripeName", name="entName", resourceName="resName", resourceType="resTypeName", actions="actionList")

引数	定義
appStripe	資格が存在するアプリケーション・ストライプを指定します。
name	変更する資格の名前を指定します。
resourceName	削除するリソースの名前を指定します。
resourceType	削除するリソースのタイプを指定します。
actions	削除するアクションのカンマ区切りのリストを指定します。

例

次の例は、ストライプmyApplication内の資格myEntitlementからリソースmyResourceを削除します。

wls:/mydomain/serverConfig> revokeResourceFromEntitlement(appStripe="myApplication", name="myEntitlement", 
resourceName="myResource", resourceType="myResType", actions="view,edit")

2.1.1.40 rollOverEncryptionKey

ドメイン暗号化鍵を変更するオフライン・コマンド。

説明

このオフライン・スクリプトは、現在のドメインOPSS暗号化鍵を新しい暗号化鍵に置換します。現在の鍵は削除されずにアーカイブされ、その鍵を使用して暗号化したデータの復号化に使用されます。

次の重要な点に注意してください。

• このコマンドは、ドメイン内の管理サーバーから実行する必要があります。実行後、サーバーを再起動する必要はありません。

• ドメインがセキュリティ・ストアにアクセスしている唯一のドメインである場合は、他に必要な操作はありません。

• ただし、2つ以上のドメインがセキュリティ・ストアを共有している場合は、exportEncryptionKeyおよびimportEncryptionKeyスクリプトを使用して、スクリプトが実行されたドメインから新しく生成された鍵をエクスポートし、セキュリティ・ストアを共有しているその他のドメインそれぞれにインポートする必要があります。

構文

rollOVerEncryptionKey(jpsConfigFile="pathName")

引数	定義
jpsConfigFile	jps-config.xmlファイルの場所を指定します。このスクリプトを実行する場所への相対パスまたはフルパスを指定します。

例

次の例は、ストライプmyApplication内のすべてのリソース・タイプを一覧表示します。

wls:/mydomain/serverConfig> rollOverEncryptionKey(jpsConfigFile="myConfig")

2.1.1.41 updateCred

資格のタイプ、ユーザー名およびパスワードを変更するオンライン・コマンドを示します。

説明

指定したマップ名およびキー名の資格ストア内の資格のタイプ、ユーザー名、パスワード、URLおよびポート番号を変更します。このコマンドは、パスワード・タイプのみの資格にカプセル化されたデータを更新できます。エラーが発生した場合は、WLSTExceptionが返されます。このコマンドは、対話型モードでのみ実行します。

構文

updateCred(map, key, user, password, [desc])

引数	定義
map	マップ名(フォルダ)を指定します。
key	キー名を指定します。
user	資格ユーザー名を指定します。
password	資格のパスワードを指定します。
desc	資格を説明する文字列を指定します。

例

次の例は、指定したデータでパスワード資格証明を更新します。

wls:/mydomain/serverConfig> updateCred(map="myMap", key="myKey", user="myUsr", 
password="myPassw", desc="updated passw cred to connect to app xyz")

2.1.1.42 updateTrustServiceConfig

ドメイン・トラスト・サービスの構成を、プロパティ・ファイルで渡された値で更新するオフライン・コマンド。

説明

ドメイン・トラスト・サービスの構成を更新します。エラーが発生した場合は、WLSTExceptionが返されます。

構文

updateTrustServiceConfig([providerName="<the provider name>",] 
                          propsFile="<path of properties file>")

引数	定義
providerName	(オプション)トラスト・サービス・プロバイダの名前を指定します。指定を省略すると、デフォルトでtrust.provider.embeddedが設定されます。
propsFile	プロパティ値が設定されているファイルへのパスを指定します。

プロパティ・ファイルの例を示します。

trust.keystoreType=KSS
trust.keyStoreName=kss://<stripeName>/<keystoreName>
trust.trustStoreName=kss://<stripeName>/<truststoreName>
trust.aliasName=<aliasName>
trust.issuerName=<aliasName>

指定されるプロパティのリストは、プロパティtrust.keystoreTypeの値によって異なる点に注意してください。可能なタイプはKSSまたはJKSです。プロパティが空の文字列に設定されている場合、そのプロパティはトラスト・サービス構成から削除されます。使用可能なプロパティのリストは、トラスト・サービスのプロパティに関する項を参照してください。

例

次の例は、ファイルmyPropsで指定された値でトラスト・ストア・サービスを更新します。

wls:/mydomain/serverConfig> updateTrustServiceConfig(providerName="myProvider", propsFile="myProps")

2.1.2 監査構成コマンド

表2-3に表示されているWLSTコマンドを使用して、監査ポリシーおよび監査リポジトリ設定を表示し管理します。

表2-3 WLST監査コマンド

使用するコマンド	目的	WLSTでの使用
createIAUView	データベースでIAUビューを作成するSQLスクリプトを生成します。	オンライン
createAuditDBView	データベースで監査定義を作成するSQLスクリプトを生成します。	オンライン
deregisterAudit	指定したコンポーネントの監査定義を監査ストアから削除します。	オンライン
exportAuditConfig	コンポーネントの監査設定をエクスポートします。	オンライン
getIAUViewInfo	ビューに関する情報を取得します。	オンライン
getNonJavaEEAuditMBeanName	Java EE以外のコンポーネントのmBean名を表示します。	オンライン
getAuditPolicy	監査ポリシー設定を表示します。	オンライン
getAuditRepository	監査リポジトリ設定を表示します。	オンライン
importAuditConfig	コンポーネントの監査設定をインポートします。	オンライン
listAuditComponents	監査可能なコンポーネントを一覧表示します。	オンライン
listAuditEvents	1つ またはすべてのコンポーネントの監査イベントを表示します。	オンライン
setAuditPolicy	監査ポリシー設定を更新します。	オンライン
setAuditRepository	監査リポジトリ設定を更新します。	オンライン
registerAudit	指定したコンポーネントの監査定義を監査ストアに登録します。	オンライン

詳細は、『Oracle Platform Security Servicesによるアプリケーションの保護』を参照してください。

2.1.2.1 getNonJavaEEAuditMBeanName

Java EE以外のコンポーネントのmbean名を表示するオンライン・コマンドを示します。

説明

このコマンドは、インスタンス名、コンポーネント名、コンポーネントのタイプおよびコンポーネントの監査mbeanが実行しているOracle WebLogic Serverを指定したJava EE以外のコンポーネントのmbean名を表示します。mbeanは、Java EE以外のコンポーネントを管理するときに別の監査WLSTコマンドに対して必要なパラメータです。

構文

getNonJavaEEAuditMBeanName(instName, compName, compType, svrName)

引数	定義
instName	アプリケーション・サーバー・インスタンスの名前を指定します。
compName	コンポーネント・インスタンスの名前を指定します。
compType	コンポーネントのタイプを指定します。有効な値は、ohs、oid、ovdおよびWebCache。
svrName	Oracle WebLogic Serverの名前を指定します。

例

次の例は、Oracleインターネット・ディレクトリのmBean名を表示します。

wls:/mydomain/serverConfig> getNonJavaEEAuditMBeanName(instName='inst1', compName='oid1', compType='oid', svrName='AdminServer')

2.1.2.2 getAuditPolicy

監査ポリシー設定を表示するオンライン・コマンドを示します。

説明

このコマンドは、フィルタの事前設定、特定ユーザー、カスタム・イベント、ログ・ファイルの最大サイズおよびログ・ディレクトリの最大サイズを含む監査ポリシー設定を表示します。コンポーネントmbean名は、Oracle HTTP ServerなどJava EE以外のコンポーネントに必要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

getAuditPolicy([mbeanName, componentType])

引数	定義
mbeanName	Java EE以外のコンポーネントに対してコンポーネント監査MBeanの名前を指定します。
componentType	監査ストアに登録されている特定のコンポーネントの監査ポリシーを要求します。指定しない場合、jps-config.xml内の監査ポリシーが戻されます。

例

次の例は、Java EEコンポーネントの監査設定を表示します。

wls:/mydomain/serverConfig> getAuditPolicy(componentType='JPS');
Location changed to domainRuntime tree. This is a read-only tree with DomainMBean as the root.
For more help, use help(domainRuntime)
 
FilterPreset:All
Max Log File Size:104857600

次の例は、MBean CSAuditProxyMBeanの監査設定を表示します。

wls:/mydomain/serverConfig> getAuditPolicy(on='oracle.security.audit.test:type=CSAuditMBean,
name=CSAuditProxyMBean')

2.1.2.3 setAuditPolicy

監査ポリシーを更新するオンライン・コマンドを示します。

説明

監査ポリシー設定を行うオンライン・コマンドを示します。フィルタの事前設定、ユーザーの追加/削除およびカスタム・イベントの追加/削除を行うことができます。コンポーネントmbean名は、Oracle HTTP ServerなどJava EE以外のコンポーネントに必要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

setAuditPolicy([mbeanName],[filterPreset],[addSpecialUsers],
[removeSpecialUsers],[addCustomEvents],[removeCustomEvents], [componentType], [maxFileSize], [andCriteria], [orCriteria], [componentEventsFile])

引数	定義
mbeanName	Java EE以外のコンポーネントに対してコンポーネント監査MBeanの名前を指定します。
filterPreset	フィルタの変更する事前設定を指定します。
addSpecialUsers	追加する特定ユーザーを指定します。
removeSpecialUsers	削除する特定ユーザーを指定します。
addCustomEvents	追加するカスタム・イベントを指定します。
removeCustomEvents	削除するカスタム・イベントを指定します。
componentType	更新するコンポーネント定義タイプを指定します。コンポーネントの監査ランタイム・ポリシーが監査ストアに登録されます。指定しない場合、jps-config.xmlに定義されている監査設定が変更されます。
maxFileSize	ログ・ファイルの最大サイズを指定します。
andCriteria	事前定義済のカスタム・フィルタ定義においてand条件を指定します。
orCriteria	事前定義済のカスタム・フィルタ定義においてor条件を指定します。
componentEventsFile	11gリリース1 (11.1.1.6)のメタデータ・モデルのコンポーネント定義ファイルを指定します。11gリリース1 (11.1.1.6)メタデータ・モデル・コンポーネントの監査ストア内の監査ポリシーを作成/更新する場合、フィルタの事前定義済レベルがCustomに設定されているときは、このパラメータが必要です。

例

次の例は、監査ポリシーをNoneレベルに設定し、ポリシーからuser1を削除するときに、user2およびuser3を追加します。

wls:/mydomain/serverConfig> setAuditPolicy (filterPreset=
'None',addSpecialUsers='user2,user3',removeSpecialUsers='user1',componentType='JPS')

wls:/mydomain/serverConfig> getAuditPolicy(componentType='JPS');
Already in Domain Runtime Tree

FilterPreset:None
Special Users:user2,user3
Max Log File Size:104857600

次の例は、ポリシーからログアウト・イベントを削除すると同時に、ログイン・イベントを追加します。

wls:/mydomain/serverConfig> setAuditPolicy(filterPreset=
'Custom',addCustomEvents='UserLogin',removeCustomEvents='UserLogout')
 

次の例は、監査ポリシーをLowレベルに設定します。

wls:/IDMDomain/domainRuntime> setAuditPolicy(filterPreset='Low',componentType='JPS);
Already in Domain Runtime Tree
Audit Policy Information updated successfully

wls:/IDMDomain/domainRuntime> getAuditPolicy(componentType='JPS')
Already in Domain Runtime Tree
FilterPreset:Low
Max Log File Size:104857600

次の例は、カスタム・フィルタを設定して、CheckAuthorizationイベントを監査します。

wls:/IDMDomain/domainRuntime>setAuditPolicy(filterPreset='Custom',
componentType='JPS',addCustomEvents='Authorization:CheckPermission,
CheckSubject;CredentialManagement:CreateCredential,DeleteCredential');
Already in Domain Runtime Tree
 
Audit Policy Information updated successfully
wls:/IDMDomain/domainRuntime> getAuditPolicy(componentType='JPS');
Already in Domain Runtime Tree
 
FilterPreset:Custom
Special Users:user1
Max Log File Size:104857600
Custom Events:JPS:CheckAuthorization

2.1.2.4 getAuditRepository

監査リポジトリ設定を表示するオンライン・コマンドを示します。

説明

このコマンドは、Java EEコンポーネントおよびアプリケーション(Oracleインターネット・ディレクトリなどその他のコンポーネントの場合は、リポジトリ設定は、opmn.xmlに存在しています)の監査リポジトリ設定を表示します。また、リポジトリはデータベース型の場合、データベース設定を表示します。

構文

getAuditRepository 

例

次の例は、監査リポジトリ設定を表示します。

wls:/IDMDomain/domainRuntime> getAuditRepository()
Already in Domain Runtime Tree
 
Repository Type:File

2.1.2.5 setAuditRepository

監査リポジトリ設定を更新するオンライン・コマンドを示します。

説明

このコマンドは、Java EEおよびSEコンポーネントおよびアプリケーション(Oracleインターネット・ディレクトリなどその他のコンポーネントの場合は、リポジトリが、opmn.xmlを編集して設定されます)の監査リポジトリ設定を設定します。

構文

setAuditRepository([switchToDB],[dataSourceName],[interval],
                   [timezone], [repositoryType], [logDirectory],
                   [jdbcString], [dbUser], [dbPassword])

引数	定義
switchToDB	trueの場合、リポジトリをファイルからデータベースに切り替えます。有効な値: true。
dataSourceName	データソースのJNDI名を指定します。このデータ・ソースは、指定したOracle WebLogic Serverドメイン内に構成される必要があります。
interval	監査ローダーのスリープ時間を秒単位で指定します。
timezone	監査ローダーによって監査イベントのタイムスタンプが記録されるタイムゾーンを指定します。有効な値は、utcおよびlocalです。
repostoryType	データをアップロードするデータベースのタイプを指定します。サポートされるデータベース・タイプは、Oracle、MS SQL ServerおよびIBM DB2です。
logDirectory	バス・ストップ・ファイルを格納するSEアプリケーションの監査ログ・ディレクトリを指定します。
jdbcString	SEアプリケーションへの監査レジストリjdbc接続文字列を指定します。
dbUser	監査リポジトリIAUスキーマのユーザーを指定します。
interval	監査リポジトリIAUスキーマのパスワードを指定します。

例

次の例は、監査リポジトリを特定のデータベースに変更し、監査ローダー間隔を14秒に設定し、タイムゾーンをUTCに設定します。

wls:/mydomain/serverConfig> setAuditRepository(switchToDB="true",
        dataSourceName="jdbc/AuditDB",interval="14",timezone="utc",
        repositoryType="DB_ORACLE", logDirectory="/foo",
        jdbcString="jdbc:oracle:thin:@db.example.com:5001:sid", 
        dbUser="scott_iau", dbPassword="tiger")

2.1.2.6 listAuditEvents

コマンドの監査イベントを表示するオンライン・コマンドを示します。

説明

このコマンドは、コンポーネントの監査イベントおよび属性を表示します。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。コンポーネントのタイプを除いて、すべてのコンポーネントに対して適用するすべての一般的な属性が表示されます。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

listAuditEvents([mbeanName],[componentType])

引数	定義
mbeanName	コンポーネントMBeanの名前を指定します。
componentType	コンポーネント・タイプを指定します。リストに表示される情報は、そのコンポーネント・タイプのすべてのイベントに限定されます。

例

次の例は、Oracle Platform Security Servicesコンポーネントの監査イベントを表示します。

wls:/IDMDomain/domainRuntime> listAuditEvents(componentType='JPS');
Already in Domain Runtime Tree
 
Common Attributes
ComponentType
Type of the component. For MAS integrated SystemComponents this is the componentType
InstanceId
Name of the MAS Instance, that this component belongs to
HostId
DNS hostname of originating host
HostNwaddr
IP or other network address of originating host
ModuleId
ID of the module that originated the message. Interpretation is unique within Component ID.
ProcessId
ID of the process that originated the message

次の例は、Oracle HTTP Serverの監査イベントを表示します。

wls:/mydomain/serverConfig> listAuditEvents(componentType='ohs')

次の例は、すべての監査イベントを表示します。

wls:/IDMDomain/domainRuntime> listAuditEvents();

Already in Domain Runtime Tree
Components:
DIP
JPS
OIF
OWSM-AGENT
OWSM-PM-EJB
ReportsServer
WS-PolicyAttachment
WebCache
WebServices
Attributes applicable to all components:
ComponentType
InstanceId
HostId
HostNwaddr
ModuleId
ProcessId
OracleHome
HomeInstance
ECID
RID
...

2.1.2.7 exportAuditConfig

コンポーネントの監査設定をエクスポートするオンライン・コマンドを示します。

説明

このコマンドは、監査設定をファイルにエクスポートします。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

exportAuditConfig([mbeanName],fileName, [componentType])

引数	定義
mbeanName	Java EE以外のコンポーネントのMBeanの名前を指定します。
fileName	監査設定をエクスポートする必要があるパスおよびファイル名を指定します。
componentType	特定のコンポーネントのイベントのみをファイルにエクスポートすることを指定します。指定しない場合、jps-config.xml内の監査設定がエクスポートされます。

例

次の例は、コンポーネントの監査設定をエクスポートします。

wls:/mydomain/serverConfig> exportAuditConfig(on='oracle.security.audit.test:type=CSAuditMBean,
name=CSAuditProxyMBean',fileName='/tmp/auditconfig')

次の例は、Java EEコンポーネントの監査設定をエクスポートします。mBeanは指定されていません。

wls:/mydomain/serverConfig> exportAuditConfig(fileName='/tmp/auditconfig')

2.1.2.8 importAuditConfig

コンポーネントの監査設定をインポートするオンライン・コマンドを示します。

説明

このコマンドは、外部ファイルから監査設定をインポートします。Java EE以外のコンポーネントの場合は、コンポーネントmbean名をパラメータとして渡します。Oracle Platform Security Services (OPSS)などJava EEアプリケーションおよびサービスでは、mbeanパラメータは不要です。

注意: getNonJavaEEAuditMBeanNameコマンドを使用して、Java EE以外のコンポーネントのMBean名を取得できます。

構文

importAuditConfig([mbeanName],fileName, [componentType])

引数	定義
mbeanName	Java EE以外のコンポーネントのMBeanの名前を指定します。
fileName	監査設定をインポートする必要があるパスおよびファイル名を指定します。
componentType	特定のコンポーネントのイベントのみをファイルからインポートすることを指定します。指定しない場合、jps-config.xml内の監査設定がインポートされます。

例

次の例は、コンポーネントの監査設定をインポートします。

wls:/mydomain/serverConfig> importAuditConfig(on='oracle.security.audit.test:type=CSAuditMBean,
name='CSAuditProxyMBean',fileName='/tmp/auditconfig')

次の例は、ファイルから監査設定をインポートします。mBeanは指定されていません。

wls:/mydomain/serverConfig> importAuditConfig(fileName='/tmp/auditconfig')

2.1.2.9 createAuditDBView

データベースで監査のビューを生成するSQLスクリプトを作成します。

説明

このコマンドは、指定したコンポーネントの監査定義のデータベース・ビューを作成するために使用するSQLスクリプトを生成します。スクリプトは指定したファイルに書き込まれるとともに、コンソールに出力されます。

SQLスクリプトを実行すると、サイトの監査モデルに応じて次のように結果になります。

• 11.1.1.6.0モデルを使用していて、コンポーネントが監査ストアに登録されている場合、スクリプトは、指定したコンポーネントのシステム・コンポーネント表(IAU_COMMON、IAU_USERSESSION、IAU_AUDITSERVICEおよびIAU_CUSTOM)を使用してビューを作成します。

• 11.1.1.6.0より前のモデルを使用していて、コンポーネントは監査ストアに登録されていないが、イベント定義はcomponent_events.xmlファイル(oracle_common/modules/oracle.iau_11.1.1/components/componentTypeディレクトリ内)にある場合、IAU_BASEおよびコンポーネント表を使用してビューが作成されます。

構文

createAuditDBView(fileName, componentType, [dbType], [viewType])

引数	定義
fileName	SQLスクリプトが書き込まれるパスとファイル名。
componentType	登録されたコンポーネントの名前。
dbType	データベース・タイプ。次のいずれかになります: DB_ORACLE、MS_SQL_SERVER、IBM_DB2。
viewType	ビュー・タイプ。次のいずれかになります: SIMPLE、INDEXABLE。

例

wls:/mydomain/serverConfig> 
createAuditDBView(fileName="/tmp/JPSAuditView.sql", componentType="JPS", 
                  dbType="DB_ORACLE", viewType=INDEXABLE)

2.1.2.10 createIAUView

データベースでIAUビューを作成するSQLスクリプトを生成します。

説明

生成されたスクリプトは、デフォルトで、コンポーネントが監査サービスに登録されている場合はSIMPLEビューを作成します。SIMPLEからINDEXABLEへとビューを切り替えるか、またはデータベースにビューを作成します。INDEXABLEビューは、Oracleデータベースのみでサポートされています。SIMPLEビューは、IAU_VIEWERスキーマのすべてのサポートされるデータベース用に作成することができます。

構文

createIAUView(componentType, [viewType])

引数	定義
componentType	定義がビューの基礎となるコンポーネントです。
viewType	ビューのタイプ。有効な値はSIMPLEまたはINDEXABLEです。デフォルトはSIMPLEです。

例

wls:/mydomain/serverConfig>createIAUView(componentType="AuditApp, viewType="INDEXABLE")
                                         
wls:/mydomain/serverConfig>createIAUView(componentType="AuditApp, viewType="SIMPLE")

wls:/mydomain/serverConfig>createIAUView(componentType="AuditApp") 

2.1.2.11 getIAUViewInfo

コンポーネントのビューに関する情報を返します。

説明

指定したコンポーネントのビューに関する情報を取得します。

構文

getIAUViewInfo(componentType)

引数	定義
componentType	定義がビューの基礎となるコンポーネントです。

例

wls:/mydomain/serverConfig> getIAUViewInfo(componentType="JPS")

2.1.2.12 listAuditComponents

監査可能なコンポーネントを一覧表示します。

説明

このコマンドは、監査可能なコンポーネントのリストを作成します。11.1.1.6.0モデルおよび11.1.1.6.0より前のモデルを使用する監査ストアに登録されたコンポーネントを一覧表示します。

構文

listAuditComponents(fileName)

引数	定義
fileName	出力が書き込まれるパスとファイル名を指定します。

例

listAuditComponents(fileName = "/tmp/complist.txt")

2.1.2.13 registerAudit

コンポーネントを監査サービスに登録します。

説明

指定したコンポーネントのイベント定義および変換コンテンツを監査ストアに追加します。11.1.1.6.0より前の監査XMLスキーマ定義を使用して登録しようとすると、11.1.1.6.0 XMLスキーマ定義にアップグレードされてから監査ストアに登録されます。

構文

registerAudit(xmlFile, [xlfFile],componentType,[mode=OVERWRITE|UPGRADE],
              [createView=SIMPLE|INDEXABLE|DISABLE]) 

引数	定義
xmlFile	コンポーネント・イベント定義ファイルを指定します。
xlfFile	component xlf jarファイルを指定します。オプション。
componentType	登録するコンポーネントを指定します。
mode	オプション。OVERWRITEまたはUPGRADE。デフォルトはUPGRADEです。
createView	オプション。SIMPLE、INDEXABLEまたはDISABLE。デフォルトはSIMPLEです。

例

wls:/mydomain/serverConfig>registerAudit(xmlFile="/tmp/comp.xml", 
xmlFile="/tmp/comp_xlf.jar", componentType="AuditApp", mode="UPGRADE", createView=INDEXABLE)

2.1.2.14 deregisterAudit

コンポーネントのイベント定義および変換コンテンツを監査ストアから削除します。

説明

指定したコンポーネントの既存のイベント定義および変換コンテンツまたはアプリケーションを監査ストアから削除します。

構文

deregisterAudit(componentType)

引数	定義
componentType	定義を削除するコンポーネントを指定します。

例

wls:/mydomain/serverConfig> deregisterAudit(componentType="AuditApp")

2.1.3 OPSSキーストア・サービス・コマンド

この項では、OPSSキーストア・サービスで使用されるコマンドについて説明します。

注意: キーストア・サービスのコマンドを使用するには、OPSSハンドルを取得する必要があります。以降の説明では、このハンドルをsvcと表記します。詳細は、『Oracle Platform Security Servicesによるアプリケーションの保護』のキーストア・サービスを使用した鍵および証明書の管理に関する項を参照してください。

表2-4では、キーストア・サービスを管理するために使用されるWLSTコマンドを示します。

表2-4 OPSSキーストア・サービス・コマンド

使用するコマンド...	目的...	使用するWLST...
changeKeyPassword	キーのパスワードを変更します。	オンライン
changeKeyStorePassword	キーストアのパスワードを変更します。	オンライン
createKeyStore	キーストアを作成します。	オンライン
deleteKeyStore	キーストアを削除します。	オンライン
deleteKeyStoreEntry	キーストア内のエントリを削除します。	オンライン
exportKeyStore	キーストアをファイルにエクスポートします。	オンライン
exportKeyStoreCertificate	証明書をファイルにエクスポートします。	オンライン
exportKeyStoreCertificateRequest	証明書リクエストをファイルにエクスポートします。	オンライン
generateKeyPair	鍵ペアを生成します。	オンライン
generateSecretKey	秘密鍵を生成します。	オンライン
getKeyStoreCertificates	証明書または信頼できる証明書に関する情報を取得します。	オンライン
getKeyStoreSecretKeyProperties	秘密鍵プロパティを取得します。	オンライン
importKeyStore	ファイルからキーストアをインポートします。	オンライン
importKeyStoreCertificate	証明書または他のオブジェクトをインポートします。	オンライン
listExpiringCertificates	指定された期間内に期限切れとなる証明書を一覧表示します。	オンライン
listKeyStoreAliases	キーストア内の別名を一覧表示します。	オンライン
listKeyStores	ストライプ内のすべてのキーストアを一覧表示します。	オンライン
syncKeyStores	管理サーバーのキーストアをセキュリティ・ストアのキーストアと同期します。	オンライン

2.1.3.1 changeKeyPassword

キーのパスワードを変更します。

説明

キーのパスワードを変更します。

構文

changeKeyPassword(appStripe='stripe', name='keystore', password='password', 
alias='alias', currentkeypassword='currentkeypassword', 
newkeypassword='newkeypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを含むストライプの名前を指定します
name	キーストアの名前を指定します
password	キーストアのパスワードを指定します
alias	パスワードを変更するキー・エントリの別名を指定します
currentkeypassword	キーの現在のパスワードを指定します
newkeypassword	キーの新しいパスワードを指定します

例

次の例は、キー・エントリorakeyのパスワードを変更します。

wls:/mydomain/serverConfig> changeKeyPassword(appStripe='system', 
name='keystore', password='password', 
alias='orakey', currentkeypassword='currentkeypassword', 
newkeypassword='newkeypassword')

2.1.3.2 changeKeyStorePassword

キーストアのパスワードを変更します。

説明

指定されたキーストアのパスワードを変更します。

構文

changeKeyStorePassword(appStripe='stripe', name='keystore', currentpassword='currentpassword', newpassword='newpassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを含むストライプの名前を指定します
name	キーストアの名前を指定します
currentpassword	キーストアの現在のパスワードを指定します
newpassword	キーストアの新しいパスワードを指定します

例

次の例は、keystore2のパスワードを変更します。

wls:/mydomain/serverConfig> changeKeyStorePassword(appStripe='system', name='keystore2', 
currentpassword='currentpassword', newpassword='newpassword')

2.1.3.3 createKeyStore

このキーストア・サービス・コマンドは、新しいキーストアを作成します。

説明

指定されたアプリケーション・ストライプに新しいキーストアを作成します。

構文

createKeyStore(appStripe='stripe', name='keystore', password='password',permission=true|false)

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが作成されるストライプの名前を指定します。
name	新しいキーストアの名前を指定します。
password	キーストアのパスワードを指定します。
permission	キーストアがパーミッションによってのみ保護される場合、このパラメータはtrueです。パーミッションとパスワードの両方によって保護される場合はfalseです。

例

次の例は、keystore1という名前のキーストアを作成します。

wls:/mydomain/serverConfig> createKeyStore(appStripe='system', 
name='keystore1', password='password', permission=true)

2.1.3.4 deleteKeyStore

指定されたキーストアを削除します。

説明

このキーストア・サービス・コマンドは、指定されたキーストアを削除します。

構文

deleteKeyStore(appStripe='stripe', name='keystore', password='password')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	削除するキーストアの名前を指定します。
password	キーストアのパスワードを指定します。

例

次の例は、keystore1という名前のキーストアを削除します。

wls:/mydomain/serverConfig> deleteKeyStore(appStripe='system', name='keystore1', password='password')

2.1.3.5 deleteKeyStoreEntry

キーストア・エントリを削除します。

説明

このコマンドは、キーストア内の指定されたエントリを削除します。

構文

deleteKeyStoreEntry(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	削除するエントリの別名を指定します
keypassword	削除するエントリのキー・パスワードを指定します

例

次の例は、別名orakeyで表されるキーストア・エントリを削除します。

wls:/mydomain/serverConfig> deleteKeyStoreEntry(appStripe='system', name='keystore2', password='password', alias='orakey', keypassword='keypassword')

2.1.3.6 exportKeyStore

キーストアをファイルにエクスポートします。

説明

指定されたファイルにキーストアをエクスポートします。

構文

exportKeyStore(appStripe='stripe', name='keystore', password='password', aliases='comma-separated-aliases', keypasswords='comma-separated-keypasswords', 
type='keystore-type', filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。また、この値は、コマンドの現在の使用方法に基づいて出力ファイルに適用されます。 すべてのタイプのパスワード保護されたキーストアの場合、出力ファイルのパスワードになります。 タイプがJKSまたはJCEKSの権限保護されたキーストアの場合、出力ファイルのパスワードになります。 タイプがOracleWalletの権限保護されたキーストアの場合、パスワード値が空でなければ、出力ファイルのパスワードになります。空値を指定すると自動ログイン・ウォレットが作成されます。 キーストアがパスワードベースの場合、この引数の値は、パスワードベースのキーストアが作成されたときに指定したパスワードと同じである必要があります。そうでない場合、キーストアがパスワードベースでなければ、任意の値が有効です。
aliases	エクスポートする別名のカンマ区切りリストを指定します。
keypasswords	エクスポートするキーのパスワードを指定します。使用方法は、キーストア・タイプによって決まります。 タイプがJKSまたはJCEKSで、キーストアが権限保護されている場合、出力ファイル内の別名に対応するキー・パスワードのカンマ区切りのリストです。 タイプがJKSまたはJCEKSで、キーストアがパスワード保護されている場合、ソース・キーストア内と出力ファイル内の両方の別名に対応するキー・パスワードのカンマ区切りのリストです。 タイプがOracleWalletの場合、このパラメータは無視されます。
type	エクスポートされるキーストアのタイプ。有効な値は、JKS、JCEKS、OracleWalletです。
filepath	タイプがJKSまたはJCEKSの場合、キーストアがエクスポートされるファイルの絶対パス(ファイル名を含む)です。タイプがOracleWalletの場合、キーストアがエクスポートされるディレクトリの絶対パスです。

例

次の例では、指定されたキーストアから2つの別名をエクスポートします。

wls:/mydomain/serverConfig> exportKeyStore(appStripe='system', name='keystore2', 
password='password',aliases='orakey,seckey', 
keypasswords='keypassword1,keypassword2', 
type='JKS',filepath='/tmp/file.jks')

次の例は、キーストアをエクスポートしてOracleウォレット・ファイルを作成します。

wls:/mydomain/serverConfig> exportKeyStore(appStripe='system', name='keystore2', 
password='mypassword',aliases='orakey,seckey', 
keypasswords='', type='OracleWallet',filepath='/tmp')

2.1.3.7 exportKeyStoreCertificate

証明書をエクスポートします。

説明

証明書、信頼できる証明書または証明書チェーンをエクスポートします。

構文

exportKeyStoreCertificate(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
type='entrytype',filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	エクスポートするエントリの別名を指定します
keypassword	キー・パスワードを指定します。
type	エクスポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。
filepath	証明書、信頼できる証明書または証明書チェーンのエクスポート先となるファイルの絶対パスを指定します。

例

次の例は、別名orakeyに対応する証明書をエクスポートします。

wls:/mydomain/serverConfig> exportKeyStoreCertificate(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
type='Certificate', filepath='/tmp/cert.txt')

2.1.3.8 exportKeyStoreCertificateRequest

証明書リクエストをエクスポートします。

説明

証明書リクエストを生成し、キーストアからエクスポートします。

構文

exportKeyStoreCertificateRequest(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	エントリの別名を指定します。
keypassword	キー・パスワードを指定します。
filepath	証明書リクエストのエクスポート先となるファイルの絶対パスを指定します。

例

次の例は、別名orakeyに対応する証明書リクエストをエクスポートします。

wls:/mydomain/serverConfig> exportKeyStoreCertificateRequest(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
filepath='/tmp/certreq.txt')

2.1.3.9 generateKeyPair

キーストアに鍵ペアを生成します。

説明

指定されたアルゴリズムを使用して鍵ペアを生成し、それをデモCA署名付き証明書にラップします。

構文

generateKeyPair(appStripe='stripe', name='keystore', password='password', 
dn='distinguishedname', keysize='keysize', alias='alias', 
keypassword='keypassword'[, algorithm='algoName’])

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
dn	鍵ペアをラップする証明書の識別名を指定します。
keysize	キー・サイズを指定します。
alias	鍵ペア・エントリの別名を指定します。
keypassword	キー・パスワードを指定します。
algorithm	生成されたキーを暗号化するために使用するアルゴリズムを指定します。有効な値はRSAまたはEC (Elliptic Curve Cryptography)のみです。オプション。指定しないと、コマンドではRSAアルゴリズムが使用されます。

例

次の例は、デフォルトのRSAアルゴリズムを使用してkeystore2に鍵ペアを生成します。

wls:/mydomain/serverConfig> generateKeyPair(appStripe='system', name='keystore2', password='password', dn='cn=www.oracle.com', keysize='1024', alias='orakey', keypassword='keypassword')

次の例は、RSAアルゴリズムを使用してkeystore2に鍵ペアを生成します。

wls:/mydomain/serverConfig> generateKeyPair(appStripe='system', name='keystore2', password='password', dn='cn=www.oracle.com', keysize='1024', alias='orakey', keypassword='keypassword', algorithm='RSA’)

次の例は、ECC (Elliptic Curve Cryptography)アルゴリズムを使用してkeystore2に鍵ペアを生成します。

wls:/mydomain/serverConfig> generateKeyPair(appStripe='system', name='keystore2', password='password', dn='cn=www.oracle.com', keysize='1024', alias='orakey', keypassword='keypassword', algorithm='EC’)

2.1.3.10 generateSecretKey

秘密鍵を生成します。

説明

キーストアに対称鍵を生成します。

構文

generateSecretKey(appStripe='stripe', name='keystore', password='password', 
algorithm='algorithm', keysize='keysize', alias='alias', 
keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
algorithm	対称鍵のアルゴリズムを指定します。
keysize	キー・サイズを指定します。
alias	キー・エントリの別名を指定します。
keypassword	キー・パスワードを指定します。

例

次の例は、keystore2にキー・サイズ128の鍵ペアを生成します。

wls:/mydomain/serverConfig> generateSecretKey(appStripe='system', name='keystore2', password='password', 
algorithm='AES', keysize='128', alias='seckey', keypassword='keypassword')

2.1.3.11 getKeyStoreCertificates

キーストアから証明書を取得します。

説明

証明書または信頼できる証明書に関する情報を取得します。

構文

getKeyStoreCertificates(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	表示する証明書、信頼できる証明書または証明書チェーンの別名を指定します。
keypassword	キー・パスワードを指定します。

例

次の例は、keystore3に関連付けられている証明書を取得します。

wls:/mydomain/serverConfig> getKeyStoreCertificates(appStripe='system', name='keystore3', password='password', alias='orakey', keypassword='keypassword')

2.1.3.12 getKeyStoreSecretKeyProperties

秘密鍵のプロパティを取得します。

説明

アルゴリズムなどの秘密鍵のプロパティを取得します。

構文

getKeyStoreSecretKeyProperties(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	プロパティを表示する秘密鍵の別名を指定します。
keypassword	秘密鍵のパスワードを指定します。

例

次の例は、秘密鍵seckeyのプロパティを取得します。

wls:/mydomain/serverConfig> getKeyStoreSecretKeyProperties(appStripe='system', name='keystore3', 
password='password', alias='seckey', keypassword='keypassword')

2.1.3.13 importKeyStore

ファイルからキーストアをインポートします。

説明

システム・ファイルからキーストアをインポートします。

構文

importKeyStore(appStripe='stripe', name='keystore', password='password', aliases='comma-separated-aliases', keypasswords='comma-separated-keypasswords', 
type='keystore-type', permission=true|false, filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが配置されるストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。次のルールが適用されます。 自動ログインOracleウォレット・ファイルのインポートの場合、パスワードは不要です。 パスワード保護されたOracleウォレット・ファイル(ewallet.p12)のインポートの場合、8文字以上のパスワードを入力します。
aliases	ファイルからインポートするエントリの別名をカンマで区切って指定します。タイプがOracleWalletに設定されている場合、必須ではありません。それ以外は必須の引数です。
keypasswords	ファイル内のキーのパスワードを指定します。次のルールが適用されます。 タイプがJKSまたはJCEKSの場合、キーのパスワードをカンマで区切って入力します。 タイプがOracleWalletの場合、パスワードは不要です。キー・パスワードは、キーストア・パスワードと同じになります。
type	インポートされるキーストアのタイプを指定します。有効な値は、JKS、JCEKS、OracleWalletです。
filepath	タイプがJKSまたはJCEKSの場合、インポートされるキーストア・ファイルの絶対パス(ファイル名を含む)を指定します。タイプがOracleWalletに設定されている場合、Oracleウォレットが存在するディレクトリの絶対パスを指定します。
permission	キーストアがパーミッションによってのみ保護される場合はtrue、パーミッションとパスワードの両方によって保護される場合はfalseを指定します。trueに設定されると、インポートされるファイルの権限は保護されるので、getKeyStoreまたはgetKeyを呼び出すとパスワードはnullに設定されます。

例

次の例は、JKSキーストア・ファイルをkeystore2にインポートします。

wls:/mydomain/serverConfig> importKeyStore(appStripe='system', name='keystore2', 
password='password',aliases='orakey,seckey', keypasswords='keypassword1, 
keypassword2', type='JKS', permission=true, filepath='/tmp/file.jks')

次の例は、Oracleウォレットをkeystore2にインポートします。

importKeyStore(appStripe='system', name='keystore2', 
password='mypassword',aliases='orakey,seckey', keypasswords='', type='OracleWallet', permission=true, filepath='/tmp')

2.1.3.14 importKeyStoreCertificate

証明書または指定された他のオブジェクトをインポートします。

説明

証明書、信頼できる証明書または証明書チェーンをインポートします。

構文

importKeyStoreCertificate(appStripe='stripe', name='keystore', 
password='password', alias='alias', keypassword='keypassword', 
type='entrytype',filepath='absolute_file_path')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
alias	インポートするエントリの別名を指定します。
keypassword	新たにインポートされるエントリのキー・パスワードを指定します。
type	インポートするキーストア・エントリのタイプを指定します。有効な値は、Certificate、TrustedCertificateまたはCertificateChainです。
filepath	証明書、信頼できる証明書または証明書チェーンのインポート元となるファイルの絶対パスを指定します。

例

次の例は、keystore2に証明書をインポートします。

wls:/mydomain/serverConfig> importKeyStoreCertificate(appStripe='system', name='keystore2', 
password='password', alias='orakey', keypassword='keypassword', 
type='Certificate', filepath='/tmp/cert.txt')

2.1.3.15 listExpiringCertificates

期限切れになる証明書を一覧表示します。

説明

期限切れになる証明書を一覧表示し、オプションでそれらの期限を更新します。

構文

listExpiringCertificates(days='days', autorenew=true|false)

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
days	日数を指定します。リストには、指定された日数内に期限切れとなる証明書のみが含まれます。
autorenew	期限切れとなる証明書を自動的に更新する場合はtrue、それらを一覧表示するのみの場合はfalseを指定します。

例

次の例は、1年以内に期限切れとなる証明書を一覧表示し、それらの更新を要求します。

wls:/mydomain/serverConfig> listExpiringCertificates(days='365', autorenew=true)

2.1.3.16 listKeyStoreAliases

キーストア内の別名を一覧表示します。

説明

キーストア内の、指定されたエントリ・タイプの別名を一覧表示します。

構文

listKeyStoreAliases(appStripe='stripe', name='keystore', 
password='password', type='entrytype')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアが存在するストライプの名前を指定します。
name	キーストアの名前を指定します。
password	キーストアのパスワードを指定します。
type	別名を一覧表示するエントリのタイプを指定します。有効な値は、Certificate、TrustedCertificate、SecretKeyまたは*です。

例

次の例は、keystore2内の秘密鍵を一覧表示します。

wls:/mydomain/serverConfig> listKeyStoreAliases(appStripe='system', name='keystore2', 
password='password', type='SecretKey')

2.1.3.17 listKeyStores

ストライプ内のすべてのキーストアを一覧表示します。

説明

指定されたストライプ内のすべてのキーストアを一覧表示します。

構文

listKeyStores(appStripe='stripe')

引数	定義
svc	getOpssService()のコールによって取得されるサービス・コマンド・オブジェクトを指定します。
appStripe	キーストアを一覧表示するストライプの名前を指定します。

例

次の例は、すべてのストライプ上のすべてのキーストアを一覧表示します。

wls:/mydomain/serverConfig> listKeyStores(appStripe='*')

2.1.3.18 syncKeyStores

中央リポジトリにあるOracle WebLogic Serverのキーストアおよびシステムのキーストアを、管理サーバー上のconfigドメイン・ディレクトリと同期します。

説明

中央のセキュリティ・ストアにあるキーストアを、ドメイン・ディレクトリ内のキーストアと同期します。

ターゲット形式がOracleウォレットの場合、指定されたストライプについて、すべてのKSSキーストアの内容をサーバー上の自動ログイン・ウォレットと同期します。

構文

構文は次のとおりです:

syncKeyStores(stripeName='component-type#component-name', keystoreFormat='exported_file_format', 
rootDirectory='root_dir_absolute_path') 

引数	定義
StripeName	コンポーネントに対応するストライプの名前を指定します。 keystoreFormatが'OracleWallet'の場合、'component-type#component-name'という形式でストライプ名を入力します。このストライプ内のキーストアは権限保護のみで、パスワード保護できません。
keystoreFormat	ターゲット・キーストアの形式を指定します。有効な形式は、KSSおよびOracleWalletです。
rootDirectory	OracleWallet形式の場合、ウォレットが作成されるサーバー・ディレクトリの絶対パスを指定します。指定しない場合、デフォルトのAdmin_Server_Root/config/fmwconfig/に設定されます。

注意: svc引数はこのコマンドには適用されません。

例

次の例は、中央リポジトリでsystemストライプを検索して、その内容をDOMAIN_HOME/config/fmwconfigディレクトリのkeystores.xmlファイルにダウンロードします。同じファイルにドメイン・トラスト・ストアのコンテンツもダウンロードします。

wls:/mydomain/serverConfig> syncKeyStores()
 

次の例は、ストライプohs#ohs1内のすべてのキーストアに対応するOracleウォレットを生成します。

syncKeyStores(stripeName=”ohs#ohs1”, 
keystoreFormat=”OracleWallet”, rootDirectory=”/tmp/bin”)

2.1.4 アイデンティティ・ディレクトリ・サービス・コマンド

表2-5に示されているWLSTコマンドを使用して、アイデンティティ・ディレクトリ・サービスのエンティティ属性、エンティティ定義、関係およびデフォルトの操作構成を管理します。

表2-5 WLSTアイデンティティ・ディレクトリ・サービス・コマンド

使用するコマンド...	目的...	使用するWLST...
activateIDSConfigChanges	アイデンティティ・ディレクトリ・サービス構成を再ロードします。	オンライン
addAttributeInEntityConfig	エンティティ構成に新しい属性を追加します。	オンライン
addAttributePropsInEntityConfig	エンティティ構成内の属性に新しいプロパティを追加します。	オンライン
addAttributeRefForEntity	指定されたエンティティに新しい属性を追加します。	オンライン
addAttrrefPropsInEntityConfig	エンティティ構成内の属性参照に新しいプロパティを追加します。	オンライン
addCommonPropertyForOperationConfig	指定された操作構成に新しいプロパティを追加します。	オンライン
addEntity	エンティティ構成に新しいエンティティを追加します。	オンライン
addEntityProps	エンティティ構成内のエンティティに新しいプロパティを追加します。	オンライン
addEntityRelation	エンティティ構成に新しいエンティティ関係を追加します。	オンライン
addIdentityDirectoryService	構成に新しいアイデンティティ・ディレクトリ・サービスを追加します。	オンライン
addOperationConfig	エンティティ構成に新しい操作構成を追加します。	オンライン
addPropertyForOperationConfig	指定された操作構成に新しいプロパティを追加します。	オンライン
deleteAttributeInEntityConfig	エンティティ構成から属性を削除します。	オンライン
deleteAttributePropsInEntityConfig	エンティティ構成内の属性プロパティを削除します。	オンライン
deleteAttrrefPropsInEntityConfig	エンティティ構成内の属性参照プロパティを削除します。	オンライン
deleteEntity	エンティティ構成からエンティティを削除します。	オンライン
deleteEntityProps	エンティティ構成内のエンティティ・プロパティを削除します。	オンライン
deleteEntityRelation	指定されたエンティティ関係を削除します。	オンライン
deleteIdentityDirectoryService	構成内の指定されたアイデンティティ・ディレクトリ・サービスを削除します。	オンライン
deleteOperationConfig	エンティティ構成内の操作構成を削除します。	オンライン
listAllAttributeInEntityConfig	エンティティ構成内のすべての属性を一覧表示します。	オンライン
listAllEntityInEntityConfig	指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します。	オンライン
listAllIdentityDirectoryService	構成内のすべてのアイデンティティ・ディレクトリ・サービスを一覧表示します。	オンライン
removeAttributeRefForEntity	指定されたエンティティから属性を削除します。	オンライン
removeCommonPropertyForOperationConfig	指定された操作構成のプロパティを削除します。	オンライン
removePropertyForOperationConfig	指定された操作構成のプロパティを削除します。	オンライン
updateAttributeInEntityConfig	エンティティ構成内の属性を更新します。	オンライン
updateAttributePropsInEntityConfig	エンティティ構成内の属性プロパティを更新します。	オンライン
updateAttrrefPropsInEntityConfig	エンティティ構成内の属性参照プロパティを更新します。	オンライン
updateEntity	エンティティ構成内のエンティティのプロパティを更新します。	オンライン
updateEntityAttrs	エンティティ構成内のエンティティのプロパティを更新します。	オンライン
updateEntityProps	エンティティ構成内のエンティティ・プロパティを更新します。	オンライン

2.1.4.1 activateIDSConfigChanges

アイデンティティ・ディレクトリ・サービス構成を再ロードするオンライン・コマンド。

説明

アイデンティティ・ディレクトリ・サービス構成を再ロードします。

構文

activateIDSConfigChanges()

このコマンドには、引数はありません。

例

次のコマンドは、アイデンティティ・ディレクトリ・サービス構成を再ロードします。

activateIDSConfigChanges()

2.1.4.2 addAttributeInEntityConfig

エンティティ構成に属性を追加するオンライン・コマンド。

説明

エンティティ構成に新しい属性を追加します

構文

addAttributeInEntityConfig(name, datatype, description, readOnly, pwdAttr, appName)

表2-6 addAttributeInEntityConfigの引数

引数	定義
name	追加する属性の名前。
datatype	属性のタイプは、次のいずれかとして定義されます。 binary boolean datetime double integer rfc822name string x500name
description	追加する属性の説明。
readOnly	属性が読取り専用であるか、変更可能であるかを指定するフラグ。
pwdAttr	属性でパスワードが定義されるかどうかを指定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、userroleエンティティのcommonname属性を追加します。

addAttributeInEntityConfig('commonname','string','common name',false,false,'userrole')

2.1.4.3 addAttributePropsInEntityConfig

エンティティ構成内の属性にプロパティを追加するオンライン・コマンド。

説明

エンティティ構成内の属性に新しいプロパティを追加します。

構文

addAttributePropsInEntityConfig(name, propNames, propVals, appName)

表2-7 addAttributePropsInEntityConfigの引数

引数	定義
name	追加する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。 プロパティ(propNamesおよびpropVals)は、使用されていないキー/値ペアです。アプリケーションでは、これらのプロパティの属性レベルに必要なメタデータを格納できます。アイデンティティ・ディレクトリ・サービスでは、これらのプロパティ名に対して検証を実行せず、内部でこれらのプロパティを解釈または使用しません。 しかし、構成属性に対してはスキーマ・チェックを実行し、構成名とその値を解釈します。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、userroleエンティティのorgunit属性を追加します。

addAttributePropsInEntityConfig('orgunit','labelname|multivalued','common name|true','userrole')

2.1.4.4 addAttributeRefForEntity

エンティティに属性を追加するオンライン・コマンド。

説明

指定されたエンティティに新しい属性を追加します。

構文

addAttributeRefForEntity(name, attrRefName, attrRefFilter, attrRefDefaultFetch, appName)

表2-8 addAttributeRefForEntityの引数

引数	定義
name	属性の追加先となるエンティティの名前。
attrRefName	エンティティに追加する属性の名前。
attrRefFilter	属性で使用されるフィルタのタイプで、次のいずれかとして定義されます。 beginswith contains doesnotcontain dynamic endswith equals greaterequal greaterthan lessequal lessthan none notequals
attrRefDefaultFetch	属性がデフォルトでフェッチされるかどうかを指定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、userroleエンティティにUser属性を追加します。

addAttributeRefForEntity('User','givenname','none','true','userrole')

2.1.4.5 addAttrrefPropsInEntityConfig

属性参照にプロパティを追加するオンライン・コマンド。

説明

エンティティ構成内の属性参照に新しいプロパティを追加します。

構文

addAttrrefPropsInEntityConfig(entityName, attrName, propNames, propVals, appName)

表2-9 addAttrrefPropsInEntityConfigの引数

引数	定義
entityName	エンティティの名前。
attrName	属性参照の名前。
propNames	"|"で区切られたプロパティ名のリスト。 プロパティ(propNamesおよびpropVals)は、使用されていないキー/値ペアです。アプリケーションでは、これらのプロパティの属性レベルに必要なメタデータを格納できます。アイデンティティ・ディレクトリ・サービスでは、これらのプロパティ名に対して検証を実行せず、内部でこれらのプロパティを解釈または使用しません。 しかし、構成属性に対してはスキーマ・チェックを実行し、構成名とその値を解釈します。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、orgエンティティの複数値プロパティlabelnameを追加します。

addAttrrefPropsInEntityConfig('org', 'orgunit','labelname|multivalued','common name|true','userrole')

2.1.4.6 addCommonPropertyForOperationConfig

操作構成にプロパティを追加するオンライン・コマンド。

説明

指定された操作構成に新しいプロパティを追加します。

構文

addCommonPropertyForOperationConfig(entityName, propName, propValue, appName)

表2-10 addCommonPropertyForOperationConfigの引数

引数	定義
entityName	エンティティの名前。
propName	この操作構成に追加するプロパティの名前。
propValue	この操作構成に追加するプロパティの値。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、新しいプロパティmemberを追加します。

addCommonPropertyForOperationConfig('groupmember.attr', 'member', 'userrole')

2.1.4.7 addEntity

構成にエンティティを追加するオンライン・コマンド。

説明

エンティティ構成に新しいエンティティを追加します。

構文

addEntity(name, type, idAttr, create, modify, delete, search, attrRefNames, attrRefFilters, attrRefDefaultFetches, appName)

表2-11 addEntityの引数

引数	定義
name	属性の追加先となるエンティティの名前。
type	エンティティに追加する属性の名前。
idAttr	追加するエンティティのアイデンティティ属性。
create	作成が許可されていることを指定するフラグ。
modify	変更が許可されていることを指定するフラグ。
delete	削除が許可されていることを指定するフラグ。
search	検索が許可されていることを指定するフラグ。
attrRefNames	属性名の配列。
attrRefFilters	フィルタ・タイプ値の配列で、次のいずれかとして定義されます。 beginswith contains doesnotcontain dynamic endswith equals greaterequal greaterthan lessequal lessthan none notequals
attrRefDefaultFetches	ブール文字列の配列(true、false)。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Groupエンティティにgroup属性を追加します。

addEntity('Group','group','commonname',true,true,true,true,'name|commonname','none|none','true|false','userrole')

2.1.4.8 addEntityProps

エンティティにプロパティを追加します。

説明

エンティティ構成内のエンティティに新しいプロパティを追加するオンライン・コマンド。

構文

addEntityProps(name, propNames, propVals, appName)

表2-12 addEntityPropsの引数

引数	定義
name	エンティティの名前。
propNames	"|"で区切られたプロパティ名のリスト。
propValues	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、inclobjclassesおよびexclobjclassesプロパティを追加します。

addEntityProps('User','inclobjclasses|exclobjclasses','inetorgperson|orclidxperson','userrole')

2.1.4.9 addEntityRelation

エンティティにエンティティ関係を追加するオンライン・コマンド。

説明

指定した属性のエンティティ構成に新しいエンティティ関係を追加します。

構文

addEntityRelation(name, type, fromEntity, fromAttr, toEntity, toAttr, recursive, appName)

表2-13 addEntityRelationの引数

引数	定義
name	指定された属性のエンティティ間の関係の名前。
type	エンティティ関係のタイプ(ManyToMany、ManyToOne、OneToMany、OneToOne)。
fromEntity	関係元となるエンティティの名前。
fromAttr	関係元となる属性の名前。
toEntity	関係先となるエンティティの名前。
toAttr	関係先となる属性の名前。
recursive	エンティティ関係を再帰的として設定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、managerおよびUserエンティティ間のmanager関係を追加します。

addEntityRelation('manager', 'ManyToOne', 'User', 'manager', 'User', 'principal', false, 'userrole')

2.1.4.10 addIdentityDirectoryService

アイデンティティ・ストア・サービスを追加するオンライン・コマンド。

説明

アイデンティティ・ディレクトリ・サービス構成に新しいIdentityStoreServiceを追加します。

構文

addIdentityDirectoryService(name, description, propNames, propValues)

表2-14 addIdentityDirectoryServiceの引数

引数	定義
name	追加するIdentityStoreServiceの名前。
description	IdentityStoreServiceの説明。
propNames	IdentityStoreService構成に追加するプロパティ名の配列。
propValues	IdentityStoreService構成に追加するプロパティ名に対して定義される値の配列。

例

次のコマンドは、userrole IdentityStoreServiceを追加します。

addIdentityDirectoryService('userrole', 'user role', 'ovd.context|entity.config', 'default|userrole')

2.1.4.11 addOperationConfig

エンティティに操作構成を追加するオンライン・コマンド。

説明

エンティティ構成に新しい操作構成を追加します。

構文

addOperationConfig(entityName, propNames, propValues, appName)

表2-15 addOperationConfigの引数

引数	定義
entityName	操作構成の追加先となるエンティティの名前。
propNames	操作構成に追加するプロパティ名の配列。
propValues	操作構成に追加するプロパティのプロパティ値の配列。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、操作構成が追加されるUserエンティティを追加します。

addOperationConfig('User', 'entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

2.1.4.12 addPropertyForOperationConfig

操作構成にプロパティを追加するオンライン・コマンド。

説明

指定された操作構成に新しいプロパティを追加します。

構文

addPropertyForOperationConfig(entityName, propName, propValue, appName)

表2-16 addPropertyForOperationConfigの引数

引数	定義
entityName	操作構成の追加先となるエンティティの名前。
propName	操作構成に追加するプロパティ名。
propValue	操作構成に追加するプロパティの値。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、操作構成にプロパティを追加します。

addPropertyForOperationConfig('User','entity.searchbase', 'cn=users,dc=oracle,dc=com', 'userrole')

2.1.4.13 deleteAttributeInEntityConfig

エンティティから属性を削除するオンライン・コマンド。

説明

エンティティ構成から属性を削除します。

構文

deleteAttributeInEntityConfig(name, appName)

表2-17 deleteAttributeInEntityConfigの引数

引数	定義
name	削除する属性の名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、commonname属性を削除します。

deleteAttributeInEntityConfig('commonname', 'userrole')

2.1.4.14 deleteAttributePropsInEntityConfig

属性のプロパティを削除するオンライン・コマンド。

説明

エンティティ構成内の属性プロパティを削除します。

構文

deleteAttributePropsInEntityConfig(name, propNames, appName)

表2-18 deleteAttributePropsInEntityConfigの引数

引数	定義
name	属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次の例は、userroleエンティティからプロパティlabelnameを削除します。

deleteAttributePropsInEntityConfig('orgunit','labelname|multivalued','userrole')

2.1.4.15 deleteAttrrefPropsInEntityConfig

エンティティ内の属性参照プロパティを削除するオンライン・コマンド。

説明

エンティティ構成内の1つまたは複数の属性参照プロパティを削除します。

構文

deleteAttrrefPropsInEntityConfig(entityName, attrName, propNames, appName)

表2-19 deleteAttrrefPropsInEntityConfigの引数

引数	定義
entityName	エンティティの名前。
attrName	属性参照の名前。
propNames	削除するプロパティ名のリスト。複数のプロパティを削除する場合は、"|"で区切る必要があります。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、orgエンティティのorgunit属性参照から2つのプロパティを削除します。

deleteAttrrefPropsInEntityConfig('org', 'orgunit','labelname|multivalued','userrole')

2.1.4.16 deleteEntity

エンティティを削除するオンライン・コマンド。

説明

エンティティ構成からエンティティを削除します。

構文

deleteEntity(name, appName)

表2-20 deleteEntityの引数

引数	定義
name	削除するエンティティの名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティを削除します。

deleteEntity('User', 'userrole')

2.1.4.17 deleteEntityProps

エンティティのプロパティを削除するオンライン・コマンド。

説明

エンティティ構成内のエンティティ・プロパティを削除します。

構文

deleteEntityProps(name, propNames, appName)

表2-21 deleteEntityPropsの引数

引数	定義
name	エンティティの名前。
propNames	"|"で区切られたプロパティ名のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティの2つのプロパティinclobjclassesおよびexclobjclassesを削除します。

deleteEntityProps('User','inclobjclasses|exclobjclasses','userrole')

2.1.4.18 deleteEntityRelation

エンティティ間の関係を削除するオンライン・コマンド。

説明

指定された属性のエンティティ間の指定したエンティティ関係を削除します。

構文

deleteEntityRelation(name, appName)

表2-22 deleteEntityRelationの引数

引数	定義
name	指定された属性のエンティティ間の関係の名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、指定したエンティティ間のmanager関係を削除します。

deleteEntityRelation('manager', 'userrole')

2.1.4.19 deleteIdentityDirectoryService

指定したIdentityStoreServiceを削除するオンライン・コマンド。

説明

アイデンティティ・ディレクトリ・サービス構成内の指定されたIdentityStoreServiceを削除します。

構文

deleteIdentityDirectoryService(name)

ここで、nameは、削除するIdentityStoreService構成の名前です。

例

次の例は、ids1 IdentityStoreService構成を削除します。

deleteIdentityDirectoryService('ids1')

2.1.4.20 deleteOperationConfig

操作構成を削除するオンライン・コマンド。

説明

エンティティ構成内の操作構成を削除します。

構文

deleteOperationConfig(entityName, appName)

表2-23 deleteOperationConfigの引数

引数	定義
entityName	操作構成の削除元となるエンティティの名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、エンティティUserとアプリケーションuserroleと関連する操作構成を削除します。

deleteOperationConfig('User','userrole')

2.1.4.21 listAllAttributeInEntityConfig

すべての属性を一覧表示するオンライン・コマンド。

説明

エンティティ構成内のすべての属性を一覧表示します。

構文

listAllAttributeInEntityConfig(appName)

ここで、appNameは、属性のリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前です。

例

次のコマンドは、userroleエンティティから属性のリストを取得します。

listAllAttributeInEntityConfig('userrole')

2.1.4.22 listAllEntityInEntityConfig

エンティティ構成のすべてのエンティティを一覧表示するオンライン・コマンド。

説明

指定されたエンティティ構成内に定義されているすべてのエンティティを一覧表示します。

構文

listAllEntityInEntityConfig(appName)

ここで、appNameは、エンティティのリストの取得元となるエンティティ構成を含むアイデンティティ・ディレクトリ・サービスの名前です。

例

次のコマンドは、userroleエンティティに関連するエンティティのリストを取得します。

listAllEntityInEntityConfig('userrole') 

2.1.4.23 listAllIdentityDirectoryService

アイデンティティ・ディレクトリ・サービス構成のすべてのIdentityStoreServiceを一覧表示するオンライン・コマンド。

説明

アイデンティティ・ディレクトリ・サービス構成内のすべてのIdentityStoreServiceを一覧表示します。

構文

listAllIdentityDirectoryService()

このコマンドには、引数はありません。

例

次のコマンドは、アイデンティティ・ディレクトリ・サービス構成のすべてのIdentityStoreServiceを一覧表示します。

listAllIdentityDirectoryService()

2.1.4.24 removeAttributeRefForEntity

エンティティから属性を削除するオンライン・コマンド。

説明

指定されたエンティティから属性を削除します。

構文

removeAttributeRefForEntity(name, attrRefName, appName)

表2-24 removeAttributeRefForEntityの引数

引数	定義
name	属性の削除元となるエンティティの名前。
attrRefName	削除する属性の名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティと関連するgivenname属性を削除します。

removeAttributeRefForEntity('User','givenname','userrole')

2.1.4.25 removeCommonPropertyForOperationConfig

操作構成のプロパティを削除するオンライン・コマンド。

説明

指定された操作構成のプロパティを削除します。

構文

removeCommonPropertyForOperationConfig(entityName, propName, appName)

表2-25 removeCommonPropertyForOperationConfigの引数

引数	定義
entityName	エンティティの名前。
propName	この操作構成について削除するプロパティの名前。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティと関連するgroupmember.attrプロパティを削除します。

removeCommonPropertyForOperationConfig('User','groupmember.attr','userrole')

2.1.4.26 removePropertyForOperationConfig

操作構成のプロパティを削除するオンライン・コマンド。

説明

指定された操作構成のプロパティを削除します。

構文

removePropertyForOperationConfig(entityName, propName, appName)

表2-26 removePropertyForOperationConfigの引数

引数	定義
entityName	操作構成の削除元となるエンティティの名前。
propName	操作構成から削除するプロパティ名。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティと関連するsearchbaseプロパティを削除します。

removePropertyForOperationConfig('User','entity.searchbase','userrole')

2.1.4.27 updateAttributeInEntityConfig

エンティティ構成の属性を更新するオンライン・コマンド。

説明

エンティティ構成内の属性を更新します。

構文

updateAttributeInEntityConfig(name, attrNames, attrVals, appName)

表2-27 updateAttributeInEntityConfigの引数

引数	定義
name	更新するエンティティ属性の名前。
attrNames	"|"で区切られた構成属性名のリスト。有効な構成属性名は次のとおりです。 dataType description readOnly pwdAttr attrInUse
attrVals	"|"で区切られた対応する属性値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、commonname属性を更新します。

updateAttributeInEntityConfig('commonname','readOnly|pwdAttr|attrInUse','true|false|false','userrole')

2.1.4.28 updateAttributePropsInEntityConfig

エンティティの属性のプロパティを更新するオンライン・コマンド。

説明

エンティティ構成内の属性プロパティを更新します。

構文

updateAttributePropsInEntityConfig(name, propNames, propVals, appName)

表2-28 updateAttributePropsInEntityConfigの引数

引数	定義
name	更新する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、userroleアプリケーションと関連するorgunit属性のプロパティを更新します。

updateAttributePropsInEntityConfig('orgunit','multivalued','multivalued','userrole')

2.1.4.29 updateAttrrefPropsInEntityConfig

エンティティの属性参照プロパティを更新するオンライン・コマンド。

説明

エンティティ構成内の属性参照プロパティを更新します。

構文

updateAttrrefPropsInEntityConfig(entityName, attrName, propNames, propVals, appName)

表2-29 updateAttrrefPropsInEntityConfigの引数

引数	定義
entityName	エンティティの名前。
attrName	属性参照の名前。
propNames	"|"で区切られたプロパティ名のリスト。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、属性参照プロパティを更新します。

updateAttrrefPropsInEntityConfig('org', 'orgunit','entity.searchbase','multivalued','userrole')

2.1.4.30 updateEntity

エンティティのプロパティを更新するオンライン・コマンド。

説明

エンティティ構成内のエンティティのプロパティを更新します。

構文

updateEntity(name, type, idAttr, create, modify, delete, search, appName)

表2-30 updateEntityの引数

引数	定義
name	更新するエンティティの名前。
type	エンティティのタイプ。
idAttr	エンティティのアイデンティティ属性。
create	作成が許可されていることを指定するフラグ。
modify	変更が許可されていることを指定するフラグ。
delete	削除が許可されていることを指定するフラグ。
search	検索が許可されていることを指定するフラグ。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Groupエンティティと関連するプロパティを更新します。

updateEntity('Group','group','commonname',true,true,true,true,'userrole')

2.1.4.31 updateEntityAttrs

エンティティの構成属性を更新するオンライン・コマンド。

説明

エンティティ属性の構成属性を更新します。

構文

updateEntityAttrs(name, attrNames, attrVals, appName)

表2-31 updateEntityAttrsの引数

引数	定義
name	エンティティ属性の名前。 エンティティ属性のプロパティを更新するには、「updateAttributePropsInEntityConfig」を参照してください。
attrNames	構成属性名のリスト。複数の構成属性を更新する場合は、"|"で区切る必要があります。有効な構成属性名は次のとおりです。 idAttr pwdAttr firstnameAttr lastnameAttr mailAttr displaynameAttr descriptionAttr challengeQnAttr challengeAnsAttr commonIdAttr.
attrVals	"|"で区切られた対応する構成属性値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティと関連する構成属性を更新します。

updateEntityAttrs('User','idAttr|firstnameAttr','uid|givenname','userrole')

2.1.4.32 updateEntityProps

エンティティのプロパティを更新するオンライン・コマンド。

説明

エンティティ構成内のエンティティ・プロパティを更新します。

構文

updateEntityProps(name, propNames, propVals, appName)

表2-32 updateEntityPropsの引数

引数	定義
name	更新する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
propVals	"|"で区切られた対応するプロパティ値のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、Userエンティティと関連するプロパティを更新します。

updateEntityProps('User','inclobjclasses|exclobjclasses','inetorgperson|orclidxperson','userrole')

2.1.4.33 deleteAttributePropsInEntityConfig

エンティティ構成内の属性プロパティを削除するオンライン・コマンド。

説明

エンティティ構成内の属性プロパティを削除します。

構文

deleteAttributePropsInEntityConfig(name, propNames, appName)

表2-33 deleteAttributePropsInEntityConfig

引数	定義
name	削除する属性の名前。
propNames	"|"で区切られたプロパティ名のリスト。
appName	アイデンティティ・ディレクトリ・サービスの名前。

例

次のコマンドは、userroleから属性プロパティorgunitを削除します。

deleteAttributePropsInEntityConfig('orgunit','labelname|validvalues','userrole')

2.1.5 Library Oracle Virtual Directory (libOVD)コマンド

表2-34に示されているWLSTコマンドを使用して、特定のOracle Platform Security Services (OPSS)コンテキストに関連付けられているlibOVD構成を管理します。

表2-34 WLST libOVDコマンド

使用するコマンド...	目的...	使用するWLST...
addDNAttribute	既存のアダプタのDN属性リストに属性を追加します。	オンライン
activateLibOVDConfigChanges	LibOVD構成を再ロードします。	オンライン
addAttributeExclusionRule	属性除外ルールを追加します。	オンライン
addAttributeRule	新しい属性マッピング・ルールを追加します。	オンライン
addDomainExclusionRule	ドメイン除外ルールを追加します。	オンライン
addDomainRule	新しいドメイン・マッピング・ルールを追加します。	オンライン
addJoinRule	libOVD構成の既存の結合アダプタに結合ルールを追加します。	オンライン
addLDAPHost	既存のLDAPアダプタに新しいリモート・ホストを追加します。	オンライン
addMappingContext	新しいマッピング・コンテキストを作成します。	オンライン
addPlugin	既存のアダプタに、またはグローバル・レベルでプラグインを追加します。	オンライン
addPluginParam	既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。	オンライン
addToRequestControlExcludeList	既存のLDAPアダプタ構成のリクエスト制御除外リストにコントロールを追加します。	オンライン
addToRequestControlIncludeList	既存のLDAPアダプタ構成のリクエスト制御対象リストにコントロールを追加します。	オンライン
assignViewToAdapter	指定されたビューをアダプタに割り当てます。	オンライン
createJoinAdapter	libOVD構成の新しい結合アダプタを作成します。	オンライン
createLDAPAdapter	libOVD構成の新しいLDAPアダプタを作成します。	オンライン
createLDAPAdapterWithDefaultPlugins	指定されたディレクトリ・タイプに基づいて、デフォルトのプラグインで新しいLDAPアダプタを作成します。	オンライン
createView	新しいビューを作成します。	オンライン
deleteAdapter	libOVD構成の既存のアダプタを削除します。	オンライン
deleteAttributeExclusionRule	属性除外ルールを削除します。	オンライン
deleteAttributeRule	属性マッピング・ルールを削除します。	オンライン
deleteDomainExclusionRule	ドメイン除外ルールを削除します。	オンライン
deleteDomainRule	ドメイン・マッピング・ルールを削除します。	オンライン
deleteMappingContext	指定されたマッピング・コンテキストを削除します。	オンライン
deleteView	指定されたビューを削除します。	オンライン
getAdapterDetails	libOVD構成の既存のアダプタの詳細を表示します。	オンライン
listAdapters	libOVD構成用に構成されているすべてのアダプタの名前とタイプを一覧表示します。	オンライン
listAllMappingContextIds	すべてのマッピング・コンテキストを一覧表示します。	オンライン
listAttributeRules	すべての属性ルールを一覧表示します。	オンライン
listDomainRules	すべてのドメイン・ルールを一覧表示します。	オンライン
listViews	すべてのビューを一覧表示します。	オンライン
modifyLDAPAdapter	既存のLDAPアダプタ構成を変更します。	オンライン
modifySocketOptions	既存のLDAPアダプタ構成のソケット・オプションを変更します。	オンライン
removeAllRequestControlExcludeList	既存のLDAPアダプタ構成のリクエスト制御除外リストからすべてのコントロールを削除します。	オンライン
removeAllRequestControlIncludeList	既存のLDAPアダプタ構成のリクエスト制御対象リストからすべてのコントロールを削除します。	オンライン
removeDNAttribute	既存のLDAPアダプタ構成のDN属性リストから属性を削除します。	オンライン
removeFromRequestControlExcludeList	既存のLDAPアダプタ構成のリクエスト制御除外リストからコントロールを削除します。	オンライン
removeFromRequestControlIncludeList	既存のLDAPアダプタ構成のリクエスト制御対象リストからコントロールを削除します。	オンライン
removeJoinRule	libOVD構成用に構成されている結合アダプタから結合ルールを削除します。	オンライン
removeLDAPHost	既存のLDAPアダプタ構成からリモート・ホストを削除します。	オンライン
removePlugin	既存のアダプタから、またはグローバル・レベルでプラグインを削除します。	オンライン
removePluginParam	構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します。	オンライン
replacePluginParam	アダプタ・レベル・プラグインまたはグローバル・プラグインの既存のパラメータ値を置換します。	オンライン
unassignViewFromAdapter	アダプタからビューを割当て解除します。	オンライン
listSSLStoreType	libOVD用に使用されているSSLストアのタイプをリストします。	オンライン
enableKSSForSSL	KSSをlibOVD用に有効化します。	オンライン
enableJKSForSSL	JKSをlibOVD用に有効化します。	オンライン
createKeyStoreAndEnableJKSForSSL	JKSをlibOVD用に有効化します。	オンライン
importTrustedCertificateIntoSSLStore	所定の信頼できる証明書をSSLストアにインポートします。	オンライン
migrateAllTrustedCertificatesFromJKSToKSS	すべての信頼できる証明書をJKSからKSSストアに移行します。	オンライン
migrateTrustedCertificatesFromJKSToKSS	指定の信頼できる証明書をJKSからKSSストアに移行します。	オンライン
changeLDAPHostPort	既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更します。	オンライン
removeLDAPHostPort	既存のLDAPアダプタ構成からリモート・ホストとポートを削除します。	オンライン
setReadOnlyForLDAPHost	既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定します。	オンライン

2.1.5.1 addDNAttribute

DN属性リストに属性を追加するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成用に構成されている既存のアダプタのDN属性リストに属性を追加します。

構文

addDNAttribute(adapterName, attributeName, [contextName])

表2-35 addDNAttributeの引数

引数	定義
adapterName	更新するアダプタの名前。
attributeName	追加する新しいDN属性の名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトはdefaultです。

例

次のコマンドは、ldap1アダプタにmemberof属性を追加します。

addDNAttribute(adapterName='ldap1', attributeName='memberof', contextName='default')

2.1.5.2 activateLibOVDConfigChanges

libOVD構成をロードするオンライン・コマンド。

説明

特定のOPSSコンテキストに関連付けられているlibOVD構成を再ロードします。

構文

activateLibOVDConfigChanges([contextName])

表2-36 activateLibOVDConfigChangesの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトはdefaultです。

例

次のコマンドは、指定したOPSSコンテキストのデフォルトのlibOVD構成を再ロードします。

activateLibOVDConfigChanges('default')

2.1.5.3 addAttributeExclusionRule

属性除外ルールを追加するオンライン・コマンド。

説明

除外リストに属性除外ルールを追加します。

構文

addAttributeExclusionRule(attribute, mappingContextId, [contextName])

表2-37 addAttributeExclusionRuleの引数

引数	定義
attribute	除外リストに追加する属性の名前。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトはdefaultです。

例

次のコマンドは除外リストにobjectsidを追加します。

addAttributeExclusionRule('objectsid','userrole')

2.1.5.4 addAttributeRule

新しい属性マッピング・ルールを追加するオンライン・コマンド。

説明

特定のOPSSコンテキストに関連付けられているlibOVD構成に新しい属性マッピング・ルールを追加します。

構文

addAttributeRule(srcAttrs, srcObjectClass, srcAttrType, dstAttr, dstObjectClass, dstAttrType, mappingExpression, direction, mappingContextId, [contextName])

表2-38 addAttributeRuleの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、libOVD構成のマッピング・ルールを作成します。ここでは、lastnameはcnにマッピングされます。

addAttributeRule('lastname','','','sn','','','','Inbound','userrole')

2.1.5.5 addDomainExclusionRule

ドメイン除外ルールを追加するオンライン・コマンド。

説明

除外リストにドメイン除外ルールを追加します。

構文

addDomainExclusionRule(domain, mappingContextId, [contextName])

表2-39 addDomainExclusionRuleの引数

引数	定義
domain	除外リストに追加する属性の識別名(DN)。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは除外リストにcn=group,dc=oracle,dc=comを追加します。

addDomainExclusionRule('cn=group,dc=oracle,dc=com','userrole')

2.1.5.6 addDomainRule

新しいドメイン・マッピング・ルールを追加するオンライン・コマンド。

説明

新しいドメイン・マッピング・ルールを追加します。

構文

addDoma]inRule(srcDomain, destDomain, domainConstructRule, mappingContextId, [contextName])

表2-40 addDomainRuleの引数

引数	定義
srcDomain	ソース・ドメイン。
destDomain	宛先ドメイン。
domainConstructRule	除外リストに追加する属性の名前。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトはdefaultです。

例

次のコマンドは、ドメイン・マッピング・ルールを作成します。

addDomainRule('dc=oracle,dc=com', 'dc=oracle,dc=com', '', 'defaultContext', 'default')

2.1.5.7 addJoinRule

結合アダプタに結合ルールを追加するオンライン・コマンド。

説明

指定されたOPSSコンテキストに関連付けられているlibOVD構成の既存の結合アダプタに結合ルールを追加します。

構文

addJoinRule(adapterName, secondary, condition, [joinerType], [contextName])

表2-41 addJoinRuleの引数

引数	定義
adapterName	変更する結合アダプタの名前。
secondary	結合先のアダプタの名前。
condition	結合する属性。
joinerType	オプション。結合のタイプを定義します。指定可能な値は、Simple(デフォルト)、Conditional、OneToManyまたはShadowです。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトはdefaultです。

例

次のコマンドは、既存の結合アダプタに様々な結合ルールを作成します。

addJoinRule('join1','secondaryldap','cn=cn', 'Simple', 'default')

addJoinRule('join1','secondaryldap','cn=cn', 'Conditional', 'default')

addJoinRule(adapterName='join1', secondary='LDAP3', condition='uid=cn', JoinerType='OneToMany')

addJoinRule(adapterName='join1', secondary='LDAP2',condition='uid=cn', contextName='myContext')

2.1.5.8 addLDAPHost

新しいリモート・ホストを追加するオンライン・コマンド。

説明

既存のLDAPアダプタに新しいリモート・ホスト(ホストおよびポート)を追加します。デフォルトでは、新しいホストは、読取り-書込みモード(パーセンテージは100に設定されます)で構成されます。

構文

addLDAPHost(adapterName, host, port, [contextName])

表2-42 addLDAPHostの引数

引数	定義
adapterName	変更する結合アダプタの名前。
host	LDAPアダプタの通信先となるリモートLDAPホスト。
port	リモートLDAPホストのポート。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、既存のLDAPアダプタ構成にホストとポートを追加します。

addLDAPHost(adapterName='ldap1', host='myhost.example.com', port=389)

addLDAPHost('ldap1', 'myhost.example.com','389', 'myContext')

2.1.5.9 addMappingContext

新しいマッピング・コンテキストを作成するオンライン・コマンドを示します。

説明

指定されたOPSSコンテキストに関連付けられているlibOVD構成の新しいマッピング・コンテキストを作成します。

構文

addMappingContext(mappingContextId, [contextName])

表2-43 addMappingContextの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、libOVD構成のマッピング・コンテキストを作成します。

addMappingContext('defaultContext','context')

2.1.5.10 addPlugin

既存のアダプタにプラグインを追加、またはグローバル・レベルでプラグインを追加するオンライン・コマンド。

説明

既存のアダプタに、またはグローバル・レベルでプラグインを追加します。i番目のキーはi番目の値に対応しています。プラグインは、デフォルト・チェーンに追加されます。

構文

addPlugin(pluginName, pluginClass, paramKeys, paramValues, [adapterName], [contextName])

表2-44 addPluginの引数

引数	定義
pluginName	作成するプラグインの名前。
pluginClass	プラグインのクラス。
paramKeys	|で区切られた初期化パラメータ・キー。
paramValues	|で区切られた初期化パラメータ値。
adapterName	オプション。変更するアダプタの名前。指定しない場合、プラグインはグローバル・レベルで追加されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、既存のアダプタにプラグインを追加します。

wls:/mydomain/serverConfig> addPlugin(adapterName='ldap1', pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com')

wls:/mydomain/serverConfig> addPlugin(pluginName='VirtualAttr',pluginClass='oracle.ods.virtualization.engine.chain.plugins.virtualattr.VirtualAttributePlugin', paramKeys='AddAttribute | MatchFilter | ContainerDN', paramValues='cn=%uid% | objectclass=person | dc=oracle,dc=com')
 
wls:/mydomain/serverConfig> addPlugin(pluginName='DMSMetrics',pluginClass='oracle.ods.virtualization.engine.chain.plugins.DMSMetrics.MonitorPerformance', paramKeys='None',paramValues='None',adapterName='ldap1',contextName='default')

2.1.5.11 addPluginParam

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加するオンライン・コマンド。

説明

既存のアダプタ・レベル・プラグインまたはグローバル・プラグインに新しいパラメータ値を追加します。パラメータがすでに存在している場合、既存の値のセットに新しい値が追加されます。i番目のキーはi番目の値に対応しています。

構文

addPluginParam(pluginName, paramKeys, paramValues, [adapterName], [contextName])

表2-45 addPluginParamの引数

引数	定義
pluginName	変更するプラグインの名前。
paramKeys	|で区切られた初期化パラメータ・キー。
paramValues	|で区切られた初期化パラメータ値。
adapterName	オプション。変更するアダプタ名。指定しない場合、グローバル・プラグインが変更されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、既存のプラグインに新しいプラグイン・パラメータを追加します。

wls:/mydomain/serverConfig> addPluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', paramValues='cn=%uid% | objectclass=person')

wls:/mydomain/serverConfig> addPluginParam(pluginName='VirtualAttr', paramKeys='ReplaceAttribute | MatchFilter', par)

2.1.5.12 addToRequestControlExcludeList

リクエスト制御除外リストにコントロールを追加するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のリクエスト制御除外リストにコントロールを追加します。

構文

addToRequestControlExcludeList(adapterName, control, [contextName])

表2-46 addToRequestControlExcludeListの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御除外リストに2.16.840.1.113894.1.8.31コントロールを追加します。

addToRequestControlExcludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

2.1.5.13 addToRequestControlIncludeList

リクエスト制御対象リストにコントロールを追加するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のリクエスト制御対象リストにコントロールを追加します。

構文

addToRequestControlIncludeList(adapterName, control, [contextName])

表2-47 addToRequestControlIncludeListの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御対象リストに2.16.840.1.113894.1.8.31コントロールを追加します。

addToRequestControlIncludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

2.1.5.14 assignViewToAdapter

LDAPアダプタにビューを割り当てるオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成内のLDAPアダプタにビューを割り当てます。

構文

assignViewToAdapter(viewName, adapterName, [contextName])

表2-48 assignViewToAdapterの引数

引数	定義
viewName	ビューの名前。
adapterName	LDAPアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタにuserViewを割り当てます。

assignViewToAdapter('userView','ldap1', 'default')

2.1.5.15 createJoinAdapter

新しい結合アダプタを作成するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の新しい結合アダプタを作成します。

構文

createJoinAdapter(adapterName, root, primaryAdapter, [bindAdapter],[contextName])

Table 2-49 createJoinAdapterの引数

引数	定義
adapterName	作成する結合アダプタの名前。
primaryAdapter	プライマリ・アダプタ(結合操作で最初に検索されるアダプタ)の識別子を指定します。
root	root
bindAdapter	バインド・アダプタ(LDAP操作でプロキシ・アカウントがバインドに使用されるアダプタ)の識別子を指定します。デフォルトでは、primaryAdapterは、bindAdapterと設定されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、結合アダプタを作成します。

createJoinAdapter('join1','dc=join','primaryldap','myldap', 'myContext')

createJoinAdapter(adapterName='join1', root='dc=join', primaryAdapter='myldap')

2.1.5.16 createLDAPAdapter

新しいLDAPアダプタを作成するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の新しいLDAPアダプタを作成します。

構文

createLDAPAdapter(adapterName, root, host, port, remoteBase, [isSecure], [bindDN], [bindPasswd], [passCred], [contextName])

Table 2-50 createLDAPAdapterの引数

引数	定義
adapterName	作成するLDAPアダプタの名前。
root	LDAPアダプタの仮想ネームスペース。
host	LDAPアダプタの通信先となるリモートLDAPホスト。
port	リモートLDAPホストのポート番号。
remoteBase	ルートが対応するリモートDIT内の場所。
isSecure	オプション。trueに設定された場合、リモート・ホストへのセキュアなSSL/TLS接続を可能にするブール値。デフォルトはfalseです。
bindDN	オプション。リモート・ホストとの通信に使用されるプロキシのBindDN。デフォルトは""です。
bindPasswd	オプション。リモート・ホストとの通信に使用されるプロキシのBindPasswd。デフォルトは""です。
passCred	オプション。libOVD構成によってバックエンド(リモート・ホスト) LDAPサーバーに渡される資格証明がある場合は、それを制御します。指定可能な値は、Always(デフォルト)、NoneまたはBindOnlyです。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、LDAPアダプタを作成します。

createLDAPAdapter("testLDAP", "dc=us,dc=oracle,dc=com", "myhost.example.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "Always", "myContext"

createLDAPAdapter(adapterName='ldap1', root='dc=com', host='myhost.example.com', port=5566, remoteBase='dc=oid')

2.1.5.17 createLDAPAdapterWithDefaultPlugins

新しいLDAPアダプタを作成するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成のディレクトリ・タイプに基づいて、デフォルトのプラグインで新しいLDAPアダプタを作成します。

構文

createLDAPAdapterWithDefaultPlugins(adapterName, directoryType, root, host, port, remoteBase, [isSecure], [bindDN], [bindPasswd], [contextName])

表2-51 createLDAPAdapterWithDefaultPluginsの引数

引数	定義
adapterName	作成するLDAPアダプタの名前。
directoryType	ディレクトリ・タイプ。指定できる値は、次のディレクトリのいずれかです。 OID - Oracle Internet Directory OUD - Oracle Unified Directory SUNONE- Sun Java System Directory Server OVD - Oracle Virtual Directory ACTIVE_DIRECTORY - Microsoft Active Directory EDIRECTORY - Novell eDirectory OPEN_LDAP - Open LDAP WLS_OVD - Oracle WebLogic Server OVD TIVOLI - IBM Tivoli Directory Server
root	LDAPアダプタの仮想ネームスペース。
host	LDAPアダプタの通信先となるリモートLDAPホスト。
port	リモート・ホストのポート。
remoteBase	ルートが対応するリモートDIT内の場所。
isSecure	オプション。trueに設定された場合、リモート・ホストへのセキュアなSSL/TLS接続を可能にするブール値。デフォルトはfalseです。
bindDN	オプション。リモート・ホストとの通信に使用されるプロキシのBindDN。デフォルトは""です。
bindPasswd	オプション。リモート・ホストとの通信に使用されるプロキシのBindPasswd。デフォルトは""です。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ディレクトリ・タイプに基づいて、デフォルトのプラグインでLDAPアダプタを作成します。

wls:/mydomain/serverConfig> createLDAPAdapterWithDefaultPlugins("testLDAP", "OID", "dc=us,dc=oracle,dc=com", "myhost.example.domain.com", 3060, "dc=uk,dc=oid", false, "cn=testuser", "welcome1", "myContext")

wls:/mydomain/serverConfig> createLDAPAdapterWithDefaultPlugins(adapterName='ldap1', directoryType="OID", root='dc=com', host='myhost.example.domain.com', port=5566, remoteBase='dc=oid',bindDN="cn=testuser",bindPasswd="welcome1",contextName='default')

2.1.5.18 createView

新しいビューを作成するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の新しいビューを作成します。

構文

createView(viewName, [contextName])

表2-52 createViewの引数

引数	定義
viewName	新しいビューの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、userViewという名前のビューを作成します。

createView('userView','default')

2.1.5.19 deleteAdapter

既存のアダプタを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の既存のアダプタを削除します。

構文

deleteAdapter(adapterName, [contextName])

表2-53 deleteAdapterの引数

引数	定義
adapterName	削除する結合アダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、join1アダプタを削除します。

deleteAdapter(adapterName='join1') deleteAdapter('join1', 'default'))

2.1.5.20 deleteAttributeExclusionRule

属性除外ルールを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の属性除外ルールを削除します。

構文

deleteAttributeExclusionRule(attribute, mappingContextId, [contextName])

表2-54 deleteAttributeExclusionRuleの引数

引数	定義
attribute	除外リストから削除する属性の名前。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、関連するlibOVD構成のobjectsid属性除外ルールを削除します。

deleteAttributeExclusionRule('objectsid','userrole')

2.1.5.21 deleteAttributeRule

属性マッピング・ルールを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の属性マッピング・ルールを削除します。

構文

deleteAttributeRule(srcAttrs, dstAttr, mappingContextId, [contextName])

表2-55 deleteEntityRelationの引数

引数	定義
srcAttrs	ソース属性。
dstAttr	宛先属性。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、cnからlastname属性マッピング・ルールを削除します。

deleteAttributeRule('lastname','sn')

2.1.5.22 deleteDomainExclusionRule

ドメイン除外ルールを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成のドメイン除外ルールを削除します。

構文

deleteDomainExclusionRule(domain, mappingContextId, [contextName])

表2-56 deleteEntityRelationの引数

引数	定義
domain	除外リストから削除するコンテナの識別名。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、'cn=group,dc=oracle,dc=com'ドメイン除外ルールを削除します。

deleteDomainExclusionRule('cn=group,dc=oracle,dc=com')

2.1.5.23 deleteDomainRule

ドメイン・マッピング・ルールを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成のドメイン・マッピング・ルールを削除します。

構文

deleteDomainRule(srcDomain, destDomain, mappingContextId, [contextName])

表2-57 deleteDomainRuleの引数

引数	定義
srcDomain	ソース・ドメイン。
destDomain	宛先ドメイン。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、'dc=oracle,dc=com'ドメイン・マッピング・ルールを削除します。

deleteDomainRule('dc=oracle,dc=com','dc=oracle,dc=com','userrole')

2.1.5.24 deleteDomainExclusionRule

ドメイン除外ルールを削除します。

説明

OPSSコンテキストに関連付けられたlibOVD構成のドメイン除外ルールを削除します。

構文

deleteDomainExclusionRule(domain, mappingContextId, [contextName])

表2-58 deleteDomainExclusionRule属性

引数	定義
domain	除外リストから削除するコンテナの識別名。
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

deleteDomainExclusionRule('cn=group,dc=oracle,dc=com','userrole')

2.1.5.25 deleteMappingContext

マッピング・コンテキストを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成の指定されたマッピング・コンテキストを削除します。

構文

deleteMappingContext(mappingContextId, [contextName])

表2-59 deleteMappingContextの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、libOVD構成のマッピング・コンテキストを削除します。

deleteMappingContext('defaultContext','context)

2.1.5.26 deleteView

ビューを削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成のビューを削除します。

構文

createView(viewName, [contextName])

表2-60 createViewの引数

引数	定義
viewName	削除するビューの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、userViewビューを削除します。

deleteView('userView','default')

2.1.5.27 getAdapterDetails

既存のアダプタの詳細を表示するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD構成用に構成されている既存のアダプタの詳細を表示します。

構文

getAdapterDetails(adapterName, [contextName])

表2-61 getAdapterDetailsの引数

引数	定義
adapterName	表示する詳細を含むアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、それぞれldap1およびjoin1アダプタの詳細を表示します。

getAdapterDetails(adapterName='ldap1', contextName='default')

getAdapterDetails(adapterName='join1')

2.1.5.28 listAdapters

すべてのアダプタの名前とタイプを一覧表示するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられているlibOVD構成用に構成されているすべてのアダプタの名前とタイプを一覧表示します。

構文

listAdapters([contextName])

表2-62 listAdaptersの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、libOVD構成用に構成されたすべてのアダプタの名前およびタイプを表示します。

listAdapters()

listAdapters(contextName='myContext')

2.1.5.29 listAllMappingContextIds

すべてのマッピング・コンテキストを一覧表示するオンライン・コマンド。

説明

指定されたOPSSコンテキストに関連付けられているマッピング・コンテキストを一覧表示します。

構文

listAllMappingContextIds([contextName])

表2-63 listAllMappingContextIdsの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、すべてのマッピング・コンテキストを一覧表示します。

listAllMappingContextIds('default')

2.1.5.30 listAttributeRules

すべての属性ルールを一覧表示するオンライン・コマンド。

説明

SOURCE_ATTRIBUTE:DESTINATION_ATTRIBUTE:DIRECTIONという形式で、すべての属性ルールを一覧表示します。

構文

listAttributeRules(mappingContextId, [contextName])

表2-64 listAttributeRulesの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、すべての属性ルールを一覧表示します。

listAttributeRules('defaultContext','default')

2.1.5.31 listDomainRules

すべてのドメイン・ルールを一覧表示するオンライン・コマンド。

説明

SOURCE_DOMAIN:DESTINATION_DOMAINという形式で、すべてのドメイン・ルールを一覧表示します。

構文

listDomainRules(mappingContextId, [contextName])

表2-65 listDomainRulesの引数

引数	定義
mappingContextId	マッピング・コンテキストの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、すべてのドメイン・ルールを一覧表示します。

listDomainRules('defaultContext','default')

2.1.5.32 listViews

すべてのビューを一覧表示するオンライン・コマンド

説明

OPSSコンテキストに関連付けられたlibOVD構成のすべてのビューを一覧表示します。

構文

listViews([contextName])

表2-66 listViewsの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、すべてのビューを一覧表示します。

listViews('default')

2.1.5.33 modifyLDAPAdapter

LDAPアダプタのパラメータを変更します。

説明

次のLDAPアダプタ・パラメータを変更します。

• リモート・ベース

• ルート

• セキュア

• BindDN

• BindPassword

• PassCredentials

• MaxPoolSize

• MaxPoolChecks

• MaxPoolWait

• InitialPoolSize

• PoolCleanupInterval

• MaxPoolConnectionIdleTime

• Active

• PingProtocol

• PingBindDN

• PingBindPassword

• PageSize

• HeartBeatInterval

• OperationTimeout

• SearchCountLimit

• Visible

• Critical

• InclusionFilter

• ExclusionFilter

• DNPattern

• RequestControlAllowServerSupported

• MaxPoolConnectionReuseTime

• ConnectTimeout

• PoolConnectionReclaimTime

構文

modifyLDAPAdapter(adapterName, attribute, value, [contextName])

表2-67 modifyLDAPAdapterの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
attribute	変更する属性の名前
value	属性の新しい値。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次の例は、ldap1に属性を設定する方法を示しています。

modifyLDAPAdapter(adapterName='ldap1', attribute='Root', value='dc=us, dc=oracle, dc=com', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='RemoteBase', value='dc=org', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PassCredentials', value='BindOnly', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='BindDN', value='cn=proxyuser,dc=com', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='BindPassword', value='testwelcome123', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Secure', value=true, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolSize', value=500, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolChecks', value=10, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolWait', value=120000, contextName='mydefault') [value is in milliseconds] 

modifyLDAPAdapter(adapterName='ldap1', attribute='InitialPoolSize', value=10, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PoolCleanupInterval', value=300, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolConnectionIdleTime', value=300, contextName='mydefault')  [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='Active', value=false, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingProtocol', value='LDAP', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingBindDN', value='cn=proxyuser', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PingBindPassword', value='welcome1', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='PageSize', value=500, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='HeartBeatInterval', value=120, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='OperationTimeout', value=120000, contextName='mydefault') [value is in milliseconds] 

modifyLDAPAdapter(adapterName='ldap1', attribute='SearchCountLimit', value=100, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Visible', value='Yes', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='Critical', value='false', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='InclusionFilter', value='objectclass=inetorgperson#base', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='ExclusionFilter', value='uniquemember=*#base', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='DNPattern', value='(.*)cn=[a-z0-9]*$', contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='RequestControlAllowServerSupported', value=false, contextName='mydefault')

modifyLDAPAdapter(adapterName='ldap1', attribute='MaxPoolConnectionReuseTime', value=3600, contextName='mydefault') [value is in seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='ConnectTimeout', value=10000, contextName='mydefault') [value is in milli seconds]

modifyLDAPAdapter(adapterName='ldap1', attribute='PoolConnectionReclaimTime', value=180, contextName='mydefault')

2.1.5.34 modifySocketOptions

ソケット・オプションを変更するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のソケット・オプションを変更します。

構文

modifySocketOptions(adapterName, reuseAddress, keepAlive, tcpNoDelay, readTimeout, [contextName])

表2-68 modifySocketOptionsの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
reuseAddress	reuseAddressの値。
keepAlive	keepAliveの値。
tcpNoDelay	tcpNoDelayの値。
readTimeout	readTimeoutの値(秒)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのソケット・オプションを変更します。

modifySocketOptions(adapterName='ldap1', reuseAddress=true, keepAlive=true, tcpNoDelay=true, readTimeout=180000, contextName='default')

2.1.5.35 removeAllRequestControlExcludeList

リクエスト制御除外リストからすべてのコントロールを削除するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のリクエスト制御除外リストからすべてのコントロールを削除します。

構文

removeAllRequestControlExcludeList(adapterName, [contextName])

表2-69 removeAllRequestControlExcludeListの引数

引数	定義
adapterName	更新するアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御除外リストからすべてのコントロールを削除します。

removeAllRequestControlExcludeList(adapterName='ldap1', contextName='default')

2.1.5.36 removeAllRequestControlIncludeList

リクエスト制御対象リストからすべてのコントロールを削除するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のリクエスト制御対象リストからすべてのコントロールを削除します。

構文

removeAllRequestControlIncludeList(adapterName, [contextName])

表2-70 removeAllRequestControlIncludeList引数

引数	定義
adapterName	更新するアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御対象リストからすべてのコントロールを削除します。

removeAllRequestControlIncludeList(adapterName='ldap1', contextName='default')

2.1.5.37 removeFromRequestControlExcludeList

リクエスト制御除外リストからコントロールを削除するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のリクエスト制御除外リストからコントロールを削除します。

構文

removeFromRequestControlExcludeList(adapterName, control, [contextName])

表2-71 removeFromRequestControlExcludeListの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御除外リストから2.16.840.1.113894.1.8.31コントロールを削除します。

removeFromRequestControlExcludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

2.1.5.38 removeDNAttribute

DN属性リストから属性を削除するオンライン・コマンド。

説明

OPSSコンテキストに関連付けられたlibOVD用に構成されている既存のアダプタのDN属性リストから属性を削除します。

構文

removeDNAttribute(adapterName attributeName, [contextName])

表2-72 removeDNAttributeの引数

引数	定義
adapterName	更新するアダプタの名前。
attributeName	削除する新しいDN属性の名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタの属性リストからmemberof属性を削除します。

removeDNAttribute(adapterName='ldap1', attributeName='memberof', contextName='default')

2.1.5.39 removeFromRequestControlIncludeList

リクエスト制御対象リストからコントロールを削除するオンライン・コマンド。

説明

既存のLDAPアダプタ構成のリクエスト制御対象リストからコントロールを削除します。

構文

removeFromRequestControlIncludeList(adapterName, control, [contextName])

表2-73 removeFromRequestControlIncludeListの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
control	LDAPコントロール・オブジェクト識別子(OID)。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御対象リストから2.16.840.1.113894.1.8.31コントロールを削除します。

removeFromRequestControlIncludeList(adapterName='ldap1', control='2.16.840.1.113894.1.8.31', contextName='default')

2.1.5.40 removeJoinRule

結合アダプタから結合ルールを削除するオンライン・コマンド。

説明

指定されたOPSSコンテキストに関連付けられているlibOVD構成用に構成されている結合アダプタから結合ルールを削除します。

構文

removeJoinRule(adapterName, secondary, [contextName])

表2-74 removeJoinRuleの引数

引数	定義
adapterName	変更する結合アダプタの名前。
secondary	このセカンダリ・アダプタに対応する結合ルールが結合アダプタから削除されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタのリクエスト制御対象リストから2.16.840.1.113894.1.8.31コントロールを削除します。

removeJoinRule('join1','secondaryldap1', 'default')

removeJoinRule(adapterName='join1', secondary='LDAP3')

2.1.5.41 removeLDAPHost

既存のLDAPアダプタからリモート・ホストを削除するオンライン・コマンド。

説明

既存のLDAPアダプタからリモート・ホスト(host:port)を削除します。

構文

removeLDAPHost(adapterName, host, [contextName])

表2-75 removeLDAPHostの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
host	LDAPアダプタの通信先となるリモートLDAPホストの場所。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタからホストとポートを削除します。

removeLDAPHost(adapterName='ldap1', host='myhost.example.com')

removeLDAPHost('ldap1', 'myhost.example.com', 'myContext')

2.1.5.42 removePlugin

既存のアダプタからプラグインを削除するオンライン・コマンド。

説明

既存のアダプタから、またはグローバル・レベルでプラグインを削除します。

構文

removePlugin(pluginName, [adapterName], [contextName])

表2-76 removePluginの引数

引数	定義
pluginName	削除するプラグインの名前。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが削除されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタからVirtualAttrプラグインを削除します。

removePlugin(adapterName='ldap1', pluginName='VirtualAttr')

removePlugin(pluginName='VirtualAttr')

2.1.5.43 removePluginParam

構成済のアダプタ・レベル・プラグインから既存のパラメータを削除するオンライン・コマンド。

説明

構成済のアダプタ・レベル・プラグインまたはグローバル・プラグインから既存のパラメータを削除します。このコマンドは、プラグインから特定のパラメータのすべての値を削除します。

構文

removePluginParam(pluginName, paramKey, [adapterName], [contextName])

表2-77 removePluginParamの引数

引数	定義
pluginName	変更するプラグインの名前。
paramKey	削除するパラメータ。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、VirtualAttrプラグインからReplaceAttributeプラグイン・パラメータを削除します。

removePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramKey='ReplaceAttribute')

removePluginParam(pluginName='VirtualAttr', paramKey='ReplaceAttribute')

2.1.5.44 replacePluginParam

プラグインのパラメータ値を置換するオンライン・コマンド。

説明

指定されたアダプタ・レベル・プラグインまたはグローバル・プラグインの既存のパラメータ値を置換します。

構文

replacePluginParam(pluginName, paramName, paramValues, [adapterName,][contextName])

表2-78 replacePluginParamの引数

引数	説明
pluginName	変更するプラグインの名前。
paramName	置換するパラメータの名前。
paramValues	パラメータの新しい値。新しい値が複数の場合、それぞれの新しいパラメータ値を"|"で区切ります。
adapterName	オプション。変更するアダプタの名前。指定しない場合、グローバル・プラグインが変更されます。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、アダプタの関連プラグインのパラメータ値を置き換えます。

replacePluginParam(adapterName='ldap1', pluginName='VirtualAttr', paramName='ReplaceAttribute', paramValues='cn=%uid%')

replacePluginParam(adapterName='ldap1', pluginName='UserManagement', paramName='mapAttribute', paramValues='orclguid=objectGuid | uniquemember=member')

2.1.5.45 unassignViewFromAdapter

アダプタからビューを割当て解除するオンライン・コマンド。

説明

LDAPアダプタ構成からビューを割当て解除します。

構文

unassignViewFromAdapter(viewName, adapterName, [contextName])

表2-79 unassignViewFromAdapterの引数

引数	定義
viewName	ビューの名前。
adapterName	LDAPアダプタの名前。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルトは"default"です。

例

次のコマンドは、ldap1アダプタと関連するuserViewの割当てを解除します。

unassignViewFromAdapter('userView','ldap1', 'default')

2.1.5.46 listSSLStoreType

使用中のSSLストアのタイプをリストするオンライン・コマンド。

説明

このコマンドは、libOVDのために使用されるSSLストアのタイプ(JKSまたはKSS)をリストします。

構文

listSSLStoreType(contextName=[contextName])

表2-80 listSSLStoreTypeの引数

引数	定義
contextName	libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、使用するSSLストア・タイプを一覧表示します。

listSSLStoreType(contextName='default')

2.1.5.47 enableKSSForSSL

KSSをlibOVD用に有効化するオンライン・コマンド。

説明

このコマンドはKSSをSSL用に有効化し、JKSがその前に有効だった場合、無効にします。KSSの詳細は、『Oracle® Fusion Middleware Oracle Platform Security Servicesによるアプリケーションの保護』を参照してください。

構文

enableKSSForSSL(contextName=[contextName])

表2-81 enableKSSForSSLの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、KSSをSSL用に有効化します。

enableKSSForSSL(contextName='default')

2.1.5.48 enableJKSForSSL

JKSをlibOVD用に有効化するオンライン・コマンド。

説明

このコマンドはJKSをSSL用に有効化し、KSSがその前に有効だった場合、無効にします。コマンドは、libOVD adapters.jksファイルが存在すると想定します。

構文

enableJKSForSSL(contextName=[contextName])

表2-82 enableJKSForSSLの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、JKSをSSL用に有効化します。

enableJKSForSSL(contextName='default')

2.1.5.49 createKeyStoreAndEnableJKSForSSL

JKSをSSL用に有効化するオンライン・コマンド。

説明

このコマンドはJKSをSSL用に有効化し、KSSがその前に有効だった場合、無効にします。コマンドは、libOVD adapters.jksファイルを作成します。

構文

createKeyStoreAndEnableJKSForSSL(keystorePassword=[password], contextName=[contextName])

表2-83 createKeyStoreAndEnableJKSForSSLの引数

引数	定義
keystorePassword	libOVD adapters.jksファイルのパスワード。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、JKSをSSL用に有効化します。

createKeyStoreAndEnableJKSForSSL(keystorePassword='welcome1', contextName='default')

2.1.5.50 importTrustedCertificateIntoSSLStore

信頼できる証明書をSSLストアにインポートするオンライン・コマンド。

説明

このコマンドは、提供された信頼できる証明書をSSLストアにインポートします。

構文

importTrustedCertificateIntoSSLStore(certificateFileName=[cert_file],aliasName=[aliasName],contextName=[contextName])

表2-84 importTrustedCertificateIntoSSLStoreの引数

引数	定義
certificateFileName	証明書を含むファイル名。
aliasName	証明書の別名。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、提供された信頼できる証明書をSSLストアにインポートします。

importTrustedCertificateIntoSSLStore(certificateFileName='/tmp/cert.txt',aliasName='myCert1',contextName='default')

2.1.5.51 migrateAllTrustedCertificatesFromJKSToKSS

すべての信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行するオンライン・コマンド。

説明

このコマンドは、すべての信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行します。

構文

migrateAllTrustedCertificatesFromJKSToKSS(contextName=[contextName])

表2-85 migrateAllTrustedCertificatesFromJKSToKSSの引数

引数	定義
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、すべての信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行します。

migrateAllTrustedCertificatesFromJKSToKSS(contextName='default')

2.1.5.52 migrateTrustedCertificatesFromJKSToKSS

指定の信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行するオンライン・コマンド。

説明

このコマンドは、指定の信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行します。

構文

migrateTrustedCertificatesFromJKSToKSS(aliasNames=[alias_names], contextName=[contextName])

表2-86 migrateTrustedCertificatesFromJKSToKSSの引数

引数	定義
aliasNames	移行する別名のカンマ区切りのリスト。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、指定した信頼できる証明書を、JKSベースのlibOVDトラストストアからKSSストアに移行します。

migrateTrustedCertificatesFromJKSToKSS (aliasNames='alias1,alias2', contextName='default')

2.1.5.53 changeLDAPHostPort

既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更するオンライン・コマンド。

説明

このコマンドは、既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更します。

構文

changeLDAPHostPort(adapterName=[adapterName], oldHost=[oldHost], oldPort=[oldPort], newHost=[newHost], newPort=[newPort], contextName=[contextName])

表2-87 changeLDAPHostPortの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
oldHost	古いLDAPホスト。
oldPort	古いLDAPポート。
newHost	新しいLDAPホスト。
newPort	新しいLDAPポート。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、既存のLDAPアダプタ構成内にある指定のLDAPホストとポートを、新しいホストとポートに変更します。

changeLDAPHostPort(adapterName='ldap1', oldHost='oldhost.example.domain.com', oldPort=389, newHost='newhost.example.domain.com', newPort=389)

2.1.5.54 removeLDAPHostPort

既存のLDAPアダプタ構成からリモート・ホストとポートを削除するオンライン・コマンド。

説明

このコマンドは、既存のLDAPアダプタ構成からリモート・ホストとポートを削除します。

構文

removeLDAPHostPort(adapterName=[adapterName], host=[host], port=[port], contextName=[contextName])

表2-88 removeLDAPHostPortの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
host	リモートLDAPホスト。
port	リモートLDAPポート。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、既存のLDAPアダプタ構成からリモート・ホストとポートを削除します。

removeLDAPHostPort(adapterName='ldap1', host='myhost.example.domain.com', port=389)

2.1.5.55 setReadOnlyForLDAPHost

既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定するオンライン・コマンド。

説明

このコマンドは、既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定します。

構文

setReadOnlyForLDAPHost(adapterName=[adapterName], host=[host], port=[port], readOnly=[true/false], contextName=[contextName])

表2-89 setReadOnlyForLDAPHostの引数

引数	定義
adapterName	変更するLDAPアダプタの名前。
host	LDAPホスト。
port	LDAPポート。
readOnly	値はtrueまたはfalseです。
contextName	オプション。libOVD構成が関連付けられているOPSSコンテキストの名前。デフォルト値はdefaultです。

例

次のコマンドは、既存のLDAPアダプタ構成内の指定のホストとポートを読取り専用または書き込み可能に設定します。

setReadOnlyForLDAPHost(adapterName='ldap1', host='myhost.example.domain.com', port=389, readOnly=true)