4 Access ManagerのWLSTコマンド

この章では、Oracle Access Management Access ManagerのカスタムWebLogic Scripting Tool (WLST)コマンドについて、コマンド構文、引数および例を含めて説明します。

次の項では、Oracle Access Management Access ManagerのWLSTコマンドと、コマンド・リファレンスの詳細へのリンクを示します。

Access Managerのコマンド

Access Managerのコマンド

表4-1に示すWLSTコマンドを使用して、認可プロバイダ、アイデンティティ・アサータ、SSOプロバイダなどのOracle Access Management Access Manager (Access Manager)関連コンポーネントを管理します。その他のコマンドを使用すると、メトリックとデプロイメントのトポロジの表示や、サーバーとエージェントの構成およびログ出力設定の管理を行うことができます。

表4-1 WLST Access Managerコマンド

使用するコマンド	目的	WLSTでの使用
displayAuthZCallBackKey	認可ポリシーのリソースURLのハッシュ化に使用されるキーを生成して取得します。	オンライン
updateCustomPages	カスタム・エラーとログイン・ページを有効または無効にします。	オンラインオフライン
createUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を作成します。	オンラインオフライン
editUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を編集します。	オンラインオフライン
deleteUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を削除します。	オンラインオフライン
displayUserIdentityStore	ユーザー・アイデンティティ・ストアの登録を表示します。	オンライン
createOAMServer	Access Managerサーバー構成のエントリを作成します。	オンラインオフライン
editOAMServer	Access Managerサーバー構成のエントリを編集します。	オンラインオフライン
deleteOAMServer	指定されたAccess Managerサーバー構成を削除します。	オンラインオフライン
displayOAMServer	Access Managerサーバー構成の詳細を表示します。	オンラインオフライン
configurePersistentLogin	永続ログイン機能を有効または無効にします。	オンライン
configOAMLoginPagePref	Access Managerログイン・ページのユーザー・プリファレンスを構成します。	オンライン
configRequestCacheType	SSOサーバー・リクエスト・キャッシュ・タイプを構成します。	オンライン
displayRequestCacheType	SSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。	オンラインオフライン
editOssoAgent	OSSOエージェント構成の詳細を編集します。	オンラインオフライン
deleteOssoAgent	指定されたOSSOエージェント構成を削除します。	オンラインオフライン
displayOssoAgent	OSSOエージェント構成の詳細を表示します。	オンラインオフライン
editWebgateAgent	10g Webゲート・エージェントの登録の詳細を編集します。	オンラインオフライン
deleteWebgateAgent	指定された10g Webゲート・エージェント構成を削除します。	オンラインオフライン
displayWebgateAgent	Webゲート・エージェント構成の詳細を表示します。	オンラインオフライン
exportPolicy	テスト(ソース)から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。	オンライン
importPolicy	指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。	オンライン
importPolicyDelta	指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。	オンライン
migratePartnersToProd	ソースAccess Managerサーバーから指定されたターゲットAccess Managerサーバーにパートナを移行します。	オンライン
exportPartners	ソースから指定された中間Access ManagerファイルにAccess Managerパートナをエクスポートします。	オンライン
importPartners	指定された中間Access ManagerファイルからAccess Managerパートナをインポートします。	オンライン
displayTopology	デプロイ済のAccess Managerサーバーの詳細を一覧表示します。	オンラインオフライン
configureOAAMPartner	Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成します。	オンライン
registerOIFDAPPartner	Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。	オンラインオフライン
registerOIFDAPPartnerIDPMode	IDPモードでIdentity Federationを登録します。
registerThirdPartyTAPPartner	任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。	オンライン
disableCoexistMode	共存モードを無効にします。	オンライン
enableOamAgentCoexist	Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。	オンライン
disableOamAgentCoexist	Access Managerエージェントの共存モードを無効にします(10g Webゲートによって設定されたObssocookieからAccess Manager 11gサーバーを無効にします)。	オンライン
editGITOValues	GITO構成パラメータを編集します。	オンライン
editWebgate11gAgent	11g Webゲートの登録を編集します。	オンラインオフライン
deleteWebgate11gAgent	11g Webゲート・エージェントの登録を削除します。	オンラインオフライン
displayWebgate11gAgent	11g Webゲート・エージェントの登録を表示します。	オンラインオフライン
displayOAMMetrics	Access Managerサーバーのメトリックを表示します。	オンラインオフライン
updateOIMHostPort (非推奨)	Access Managerとの統合時にOracle Identity Manager構成を更新します。	オンライン
configureOIM (非推奨)	Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成します。	オンライン
updateOSSOResponseCookieConfig	OSSOプロキシ・レスポンスCookie設定を更新します。	オンライン
deleteOSSOResponseCookieConfig	OSSOプロキシ・レスポンスCookie設定を削除します。	オンライン
configureAndCreateIdentityStore	アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。	オンライン
configAndCreateIdStoreUsingPropFile	ファイル内に定義されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。	オンライン
migrateArtifacts (非推奨)	指定されたアーティファクト・ファイルに基づいてアーティファクトを移行します。	オンライン
displaySimpleModeGlobalPassphrase	システム構成から簡易モードのグローバル・パスフレーズを平文で表示します。	オンライン
exportSelectedPartners	指定された中間Access Managerファイルに、選択されたAccess Managerパートナをエクスポートします。	オンライン
oamMigrate	OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行します。	オンライン
preSchemeUpgrade	preSchemeUpgrade操作を呼び出します。	オンライン
postSchemeUpgrade	postSchemeUpgrade操作を呼び出します。	オンライン
oamSetWhiteListMode	trueに設定すると、Access Managerサーバーは、WhiteListURLリスト内で指定されているURLにのみリダイレクトされます。	オンライン
oamWhiteListURLConfig	構成ファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。	オンライン
enableMultiDataCentreMode	マルチ・データ・センター・モードを有効にします。	オンライン
disableMultiDataCentreMode	マルチ・データ・センター・モードを無効にします。	オンライン
setMultiDataCentreClusterName	マルチ・データ・センター・クラスタ名を設定します。	オンライン
setMultiDataCentreLogoutURLs	マルチ・データ・センター・ログアウトURLを設定します。	オンライン
addPartnerForMultiDataCentre	マルチ・データ・センターのパートナを追加します。	オンライン
removePartnerForMultiDataCentre	マルチ・データ・センターからパートナを削除します。	オンライン
addOAMSSOProvider	OAM SSOプロバイダを追加します。	オンライン

displayAuthZCallBackKey

オンライン・コマンドです。これを使用すると、ポリシーに成功/失敗のURLが構成されている場合、認可時に返されるリソースURLのハッシュ化に使用されるキーの生成と取得が可能です。

説明

認可時にリソースURLのハッシュ化に使用されるキーがすでにある場合は、取得できます。キーがない場合は、作成されて返されます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayAuthZCallBackKey()

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

例

次の例で、ハッシュ・キーを表示します。

displayAuthZCallBackKey()

updateCustomPages

カスタム・エラーとログイン・ページの構成を有効または無効にします。

説明

カスタム・エラーとログイン・ページを含むWARを指し示すoam-config.xmlへのコンテキスト・パスとページ拡張機能を追加します:

<Setting Name="ssoengine" Type="htf:map">
<Setting Name="ErrorConfig" Type="htf:map">
<Setting Name="ErrorMode" Type="xsd:string">EXTERNAL</Setting>
<Setting Name="CustomPageExtension" Type="xsd:string">jsp</Setting>
<Setting Name="CustomPageContext" Type="xsd:string">/SampleApp</Setting>
</Setting>
</Setting>

構文

updateCustomPages(pageExtension="<fileExtension>", context="<contextPath>")

引数	定義
`context`	アプリケーションへのコンテキスト・パスを指定します(例: /SampleApp)。
`pageExtension`	デフォルト値はjspですが、ブランクのままにすることができます。

例

カスタム・エラー・ページの機能を有効にするには、updateCustomPagesをcontextおよびpageExtensionパラメータとともに使用します。これにより、oam-config.xmlファイルが変更され、カスタム・ページ機能が有効になります。

updateCustomPages(pageExtension ="jsp", context="/SampleApp")

カスタム・エラー・ページ機能を無効にするには、パラメータなしでコマンドを使用します[updateCustomPages()]。これにより、パラメータを使用してコマンドが実行されたときに行われた変更が元に戻ります。

createUserIdentityStore

Access Managerシステム構成にアイデンティティ・ストア登録を作成します。

説明

Access Managerに登録する新しいユーザー・アイデンティティ・ストアのための、システム構成のエントリを作成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

createUserIdentityStore(name="<Name>", principal="<Principal>", 
credential="<Credential>", type="<Type>", userAttr="<userAttr>", 
ldapProvider="<ldapProvider>", userSearchBase="<userSearchBase>", 
ldapUrl="<ldapUrl>", isPrimary="<isPrimary>", isSystem="<isSystem>", 
userIDProvider="<userIDProvider>", roleSecAdmin="<roleSecAdmin>", 
roleSysMonitor="<roleSysMonitor>", roleAppAdmin="<roleAppAdmin>", 
roleSysManager="<roleSysManager>", roleSecAdminGroups="<roleSecAdminGroups>", 
roleSecAdminUsers="<roleSecAdminUsers>", groupSearchBase="<groupSearchBase>", 
supplementaryReturnAttributes="<supplementaryReturnAttributes>", 
domainHome="<domainHome>")

引数	定義
`name`	必須。作成するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。
`principal`	必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、cn=Adminです。
`credential`	必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。
`type`	必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。
`userAttr`	必須。作成するLDAPアイデンティティ・ストアのユーザー属性を指定します。
`ldapProvider`	必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。
`userSearchBase`	必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、`cn=users`です。
`groupSearchBase`	必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。たとえば、`cn=groups`です。
`ldapUrl`	必須。作成するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、`ldap://localhost:7001`です。
`isPrimary`	省略可能。作成するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
`isSystem`	省略可能。作成するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
`userIDProvider`	省略可能。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。
`roleSecAdminGroups`	省略可能。Access Managerコンソール管理者権限を持つ1つ以上のグルプをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
`roleSecAdminUsers`	省略可能。Access Managerコンソール管理者権限を持つ1人以上のユーザーをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
`roleSecAdmin`	省略可能。作成するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。
`roleSysMonitor`	省略可能。作成するLDAPアイデンティティ・ストアのシステム・モニターを指定します。
`roleAppAdmin`	省略可能。作成するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。
`roleSysManager`	省略可能。作成するLDAPアイデンティティ・ストアのシステム管理者を指定します。
`supplementaryReturnAttributes`	Userオブジェクトの一部として取得する必要のある属性のカンマ区切りのリストを指定します。例: ORCL_USR_ENC_FIRST_NAME,ORCL_USR_ENC_LAST_NAME,USR_USRNAME,ORCL_USR_CTY_CODE,ORCL_USR_LANG_CODE_S,ORCL_USR_JROLE_ID_S,ORCL_USR_IND_ID,ORCL_USR_COMP_REL_ID,ORCL_USR_ASCII_IND,ORCL_ORA_UCM_VER,ORCL_ORA_UCM_SRVC
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。

例

次の例では、Access Managerで使用するための新しいOracle Internet Directoryユーザー・アイデンティティ・ストア定義を登録します。

createUserIdentityStore(name="Name1", principal="Principal1", 
credential="Credential1", type="Type1", userAttr="userAttr1", 
ldapProvider="ldapProvider", userSearchBase="userSearchBase", ldapUrl="ldapUrl", 
isPrimary="isPrimary", isSystem="isSystem", userIDProvider="userIDProvider", 
roleSecAdmin="<roleSecAdmin>", roleSysMonitor="<roleSysMonitor>",  
roleAppAdmin="<roleAppAdmin>", roleSysManager="<roleSysManager>", 
roleSecAdminGroups="<roleSecAdminGroups>", 
roleSecAdminUsers="<roleSecAdminUsers>", groupSearchBase="groupSearchBase", 
supplementaryReturnAttributes="supplementaryReturnAttributes", 
domainHome="domainHome1")

editUserIdentityStore

Access Manager用の定義済のアイデンティティ・ストアの登録を変更するオンラインおよびオフライン・コマンド。

説明

Access Managerに登録されているユーザー・アイデンティティ・ストアの属性を1つ以上変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editUserIdentityStore(name="<Name>", [ principal="<Principal>", 
credential="<Credential>", type="<Type>", userAttr="<userAttr>", 
ldapProvider="<ldapProvider>", roleSecAdmin="<roleSecAdmin>", 
roleSysMonitor="<roleSysMonitor>", roleSysManager="<roleSysManager>" , 
roleAppAdmin="<roleAppAdmin>", roleSecAdminGroups="<roleSecAdminGroups>", 
roleSecAdminUsers="<roleSecAdminUsers>", userSearchBase="<userSearchBase>", 
ldapUrl="<ldapUrl>", isPrimary="<isPrimary>", isSystem="<isSystem>", 
userIDProvider="<userIDProvider>" , groupSearchBase="<groupSearchBase>", 
domainHome="<domainHome>", userFilterObjectClasses="<userFilterObjectClasses>",  
groupFilterObjectClasses="<groupFilterObjectClasses>", 
referralPolicy="<referralPolicy>", searchTimeLimit="<searchTimeLimit>",  
minConnections="<minConnections>", maxConnections="<maxConnections>", 
connectionWaitTimeout="<connectionWaitTimeout>",  
connectionRetryCount="<connectionRetryCount>", groupNameAttr="<groupNameAttr>", 
groupCacheEnabled="<groupCacheEnabled>", groupCacheSize="<groupCacheSize>", 
groupCacheTTL=<"groupCacheTTL>", 
supplementaryReturnAttributes="<supplementaryReturnAttributes>" )

引数	定義
`name`	必須。変更するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。
`principal`	変更するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、`cn=Admin`です。
`credential`	変更するLDAPアイデンティティ・ストアのプリンシパル管理者の暗号化パスワードを指定します。
`type`	変更するベース・アイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。
`userAttr`	必須。変更するLDAPアイデンティティ・ストアのユーザー属性を指定します。
`ldapProvider`	必須。登録するLDAPアイデンティティ・ストアのLDAPタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。
`roleSecAdminGroups`	省略可能。Access Managerコンソール管理者権限を持つ1つ以上のグルプをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
`roleSecAdminUsers`	省略可能。Access Managerコンソール管理者権限を持つ1人以上のユーザーをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。
`roleSecAdmin`	省略可能。変更するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。
`roleSysMonitor`	省略可能。変更するLDAPアイデンティティ・ストアのシステム・モニターを指定します。
`roleAppAdmin`	省略可能。変更するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。
`roleSysManager`	省略可能。変更するLDAPアイデンティティ・ストアのシステム管理者を指定します。
`userSearchBase`	必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、`cn=users`です。
`groupSearchBase`	必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、`cn=groups`です。
`ldapUrl`	必須。変更するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、`ldap://localhost:7001`です。
`isPrimary`	省略可能。変更するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
`isSystem`	省略可能。変更するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
`userIDProvider`	省略可能。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。
`supplementaryReturnAttributes`	Userオブジェクトの一部として取得する必要のある属性のカンマ区切りのリストを指定します。例: ORCL_USR_ENC_FIRST_NAME,ORCL_USR_ENC_LAST_NAME,USR_USRNAME,ORCL_USR_CTY_CODE,ORCL_USR_LANG_CODE_S,ORCL_USR_JROLE_ID_S,ORCL_USR_IND_ID,ORCL_USR_COMP_REL_ID,ORCL_USR_ASCII_IND,ORCL_ORA_UCM_VER,ORCL_ORA_UCM_SRVC
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。
`userFilterObjectClasses`	必須。セミコロン区切りのユーザー・フィルタ・オブジェクト・クラスのリストを指定します。
`groupFilterObjectClasses`	グループ・フィルタ・オブジェクト・クラスのリスト(セミコロンで区切られたもの)を指定します。
`referralPolicy`	LDAP参照ポリシー(follow、ignore、throwのいずれか)を指定します。
`searchTimeLimit`	LDAP検索操作の時間制限(秒単位)を指定します。
`minConnections`	接続プール内の最小接続数を指定します。
`maxConnections`	接続プール内の最大接続数を指定します。
`connectionWaitTimeout`	プールから接続を取得するために待機する秒数を指定します。
`connectionRetryCount`	アイデンティティ・ストアへの接続を確立する際の再試行回数を指定します。
`groupNameAttr`	ユーザー・グループを検索するための属性の名前を指定します。たとえば、`ou=people,ou=myrealm,dc=base_domain`です。
`groupCacheEnabled`	LDAPグループ・キャッシュを有効にするかどうかを指定するブール値。値としてtrueまたはfalseを取ります。
`groupCacheSize`	LDAPグループ・キャッシュ内のエントリの数を指定します。
`groupCacheTTL`	LDAPグループ・キャッシュ内の各エントリの合計存続時間を指定します。

例

次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。

editUserIdentityStore(name="IdStore1", userSearchBase="cn=users", groupSearchBase="cn=groups")

deleteUserIdentityStore

Access Manager用の定義済のアイデンティティ・ストアの登録を削除するオンラインおよびオフライン・コマンド。

説明

アイデンティティ・ストアの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteUserIdentityStore(name="<name>", domainHome="<domainHome>")

引数	定義
`name`	必須。削除するLDAPアイデンティティ・ストアの登録の名前を指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例はWebSphereで使用でき、指定されたアイデンティティ・ストアの登録を削除します。WebLogic Serverのオンライン・モードでこのコマンドを使用するためには、domainHome引数を指定する必要はありません。

deleteUserIdentityStore(name="identity_store", domainHome="domainHome1")

displayUserIdentityStore

ユーザー・アイデンティティ・ストアの登録に関する情報を表示するオンライン・コマンド。

説明

Access Managerに登録されているアイデンティティ・ストアに関する情報を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayUserIdentityStore(name="<name>", domainHome="<domainHome>")

引数	定義
`name`	必須。表示するLDAPアイデンティティ・ストアの登録の名前を指定します。
`domainhome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。

例

WebSphere用の次の呼出しの例は、ユーザー・アイデンティティ・ストアの登録の詳細を表示します。WebLogicのオンライン・モードでこのコマンドを使用するために、domainHome引数を指定する必要はありません。

displayUserIdentityStore(name="ID_Store1", domainHome="domainHome1")

createOAMServer

システム構成内にAccess Managerサーバー・エントリを作成するオンラインおよびオフライン・コマンド。

説明

Access Managerサーバーの登録を作成します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでOAMプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

createOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")

引数	定義
`configurationProfile`	必須。OAM Serverの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。
`host`	必須。Access Managerサーバー・ホストの名前を指定します。
`port`	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
`oamProxyPort`	必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。
`oamProxyServerID`	必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシ・サブタブの下に表示されます。
`siteName`	必須。インスタンスのsiteName/serverNameを指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リスニング・ポート15000でmy_hostの構成を作成します。Access Manager管理コンソール内のAccess Manager構成エントリは、oam_server1になります。Access Managerプロキシ・ポートは3004、Access Managerプロキシ・サーバーIDはoamProxyServerID1です。

createOAMServer(configurationProfile="oam_server1", host="my_host",
port="15000", oamProxyPort="3004", oamProxyServerID="oamProxyServerID1",
siteName="siteName1", domainHome="domainHome1")

editOAMServer

Access Managerサーバーの登録の詳細を変更するオンラインおよびオフライン・コマンド。

説明

指定された、Access Managerサーバーの登録のパラメータ値を変更します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットなどが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")

引数	定義
`configurationProfile`	必須。Access Managerサーバーの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。
`host`	必須。Access Managerサーバー・ホストの名前を指定します。
`port`	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
`oamProxyPort`	必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。
`oamProxyServerID`	必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシ・サブタブの下に表示されます。
`siteName`	必須。インスタンスのsiteName/serverNameを指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

任意のオプションの属性を使用して、現在の設定を変更できます。次の呼出しは、Access Managerプロキシ・サーバーIDを構成エントリoam_server1に追加します。

editOAMServer(configurationProfile="oam_server1", host="my_host",
port="15000", oamProxyPort="3004", oamProxyServerID="oamProxyServerID1",
siteName="siteName1", domainHome="domainHome1")

deleteOAMServer

指定されたAccess Managerサーバーの登録を削除するオンラインおよびオフライン・コマンド。

説明

指定されたAccess Managerサーバー構成を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")

引数	定義
`host`	必須。Access Managerサーバー・ホストの名前を指定します。
`port`	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リスニング・ポートが15000であるoam_server1Access Managerサーバーの登録を削除します。

deleteOAMServer(host="oam_server1", port="15000", domainHome="domainHome1")

displayOAMServer

指定されたAccess Managerサーバーの登録の詳細を表示するオンラインおよびオフライン・コマンド。

説明

指定されたAccess Managerサーバーの登録の詳細を表示します。この詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")

引数	定義
`host`	必須。Access Managerサーバー・ホストの名前を指定します。
`port`	必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_host Access Managerサーバー固有のすべてのメトリックを一覧表示します。

displayOAMServer(host="my_host", port="15000", domainHome="domainHome1")

configurePersistentLogin

永続ログイン機能を有効、無効にするオンライン・コマンド。

説明

永続ログイン機能を有効にします。

構文

configurePersistentLogin(enable="true/false", 
 validityInDays="<#>", maxAuthnLevel="<#>", userAttribute="<userAttr>")

引数	定義
`enable`	必須。trueまたはfalseを指定します。
`validityInDays`	必須。特定のブラウザ・インスタンスまたはデバイスで永続するユーザー・ログインの日数を指定します。
`maxAuthnLevel`	必須。永続ログインを通じて自動的に再認証された後で許可される最大認証レベルを指定します。
`userAttr`	必須。永続ログインのプロパティが格納されるユーザー属性を指定します。

例

次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。

configurePersistentLogin(enable="true", validityInDays="30", maxAuthnLevel="2"
 userAttribute="obPSFTID")

configOAMLoginPagePref

Access Managerログイン・ページのユーザー・プリファレンスを構成するオンライン・コマンド。

説明

Access Managerログイン・ページのユーザー・プリファレンスを構成します。

構文

configOAMLoginPagePref(persistentCookie="true", persistentCookieLifetime=14, 
langPrefCookieDomain="oracle.com", langPrefOrder="serverOverrideLangPref, 
oamPrefsCookie, browserAcceptLanguage, defaultLanguage", 
serverOverrideLanguage="en", defaultLanguage="en", 
applicationSupportedLocales="en,fr")

引数	定義
`persistentCookie`	必須。OAM_LANG_PREF Cookieが永続的であるか非永続的であるかを定義するブール。trueまたはfalseに設定します。
`persistentCookieLifetime`	必須。永続的なOAM_LANG_PREF Cookieの存続期間を示します。
`langPrefCookieDomain`	必須。OAM_LANG_PREF Cookieのドメインを定義します。
langPrefOrder	必須。言語の優先順位を決定します。構文と例としてフォーマットする必要があります。許容される値セットは、(serverOverrideLangPref,oamPrefsCookie,browserAcceptLanguage,defaultLanguage)です。 "oamPrefsCookie, browserAcceptLanguage, serverOverrideLangPref"
`serverOverrideLanguage`	Access Managerのサーバー側言語言語コードで定義し、OAM対応の言語から選択している必要があります。デフォルト値はenです。
defaultLanguage	デフォルト言語。
`applicationSupportedLocales`	カンマ区切りリストに定義されているサポートされている言語。`applicationSupportedLocales="en,fr"`を設定することにより、OAMログイン・ページにフランス語と英語を含む値のリストが確実に表示されます。サポートされている言語コードを、次の表4-2に示します。

表4-2 ログイン・ページの言語コード

言語コード	言語	管理者
ar	アラビア語
cs	チェコ語
da	デンマーク語
de	ドイツ語	ドイツ語
el	ギリシャ語
en	英語	英語
es	スペイン語	スペイン語
fi	フィンランド語
fr	フランス語	フランス語
fr-CA	フランス語(カナダ)	フランス語(カナダ)
he	ヘブライ語
hr	クロアチア語
hu	ハンガリー語
it	イタリア語	イタリア語
ja	日本語	日本語
ko	韓国語	韓国語
nl	オランダ語
no	ノルウェー語
pl	ポーランド語
pt-BR	ポルトガル語(ブラジル)	ポルトガル語(ブラジル)
pt	ポルトガル語
ro	ルーマニア語
ru	ロシア語
sk	スロバキア語
sv	スウェーデン語
th	タイ語
tr	トルコ語
zh-CN	簡体字中国語	簡体字中国語
zh-TW	繁体字中国語	繁体字中国語

例

configOAMLoginPagePref(persistentCookie="true", persistentCookieLifetime=14, 
langPrefCookieDomain="oracle.com", langPrefOrder="serverOverrideLangPref, 
oamPrefsCookie, browserAcceptLanguage, defaultLanguage", 
serverOverrideLanguage="en", defaultLanguage="en", 
applicationSupportedLocales="en,fr")

次の例により、管理者は値の言語リストが表示されない、デフォルトの動作に戻ることができます。

configOAMLoginPagePref(persistentCookie="true", 
persistentCookieLifetime=14,langPrefCookieDomain="example.com", 
langPrefOrder="serverOverrideLangPref,oamPrefsCookie,browserAcceptLanguage,
defaultLanguage",serverOverrideLanguage="", 
defaultLanguage="en",applicationSupportedLocales="")

configRequestCacheType

システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義するオンラインおよびオフライン・コマンド。

説明

システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configRequestCacheType(type="<requestCacheType>", domainHome="<domainHome>")

引数	定義
`type`	必須。リクエスト・キャッシュ・タイプを指定します。値としてBASICまたはCOOKIEを取ります。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、リクエスト・キャッシュ・タイプをCookieとして定義します。

configRequestCacheType(type="COOKIE")

displayRequestCacheType

指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプを表示するオンラインおよびオフライン・コマンド。リクエスト・キャッシュ・タイプは、BASICまたはCOOKIEです。

説明

指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayRequestCacheType(domainHome="<domainHome>")

引数	定義
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン・ホームに対して定義されているリクエスト・キャッシュ・タイプ(BASICまたはCOOKIE)を表示します。

displayRequestCacheType(domainHome="domainHome1")

editOssoAgent

システム構成内のOpenSSO (OSSO)エージェントの登録の詳細を変更するオンラインおよびオフライン・コマンド。

説明

サイト・トークン、成功URL、失敗URL、ホームURL、ログアウトURL、開始日、終了日、管理者ID、管理者情報など、OSSOエージェントの登録の詳細を変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editOssoAgent(agentName="AgentName", partnerId = "<partnerId>", 
siteToken = "<siteToken>", siteName = "<siteName>", successUrl ="<successUrl>", 
failureUrl = "<failureUrl>", homeUrl="<homeUrl>", logoutUrl="<logoutUrl>", startDate = "<startDate>", endDate = "<endDate>", adminId = "<adminId>", 
adminInfo = "<AdminInfo>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。変更するOSSOエージェント・エントリの名前を指定します。 adminIdは、OSSOエージェントの管理者IDです(オプション)。 adminInfoは、OSSOエージェントの管理者情報です(オプション)。
`partnerId`	省略可能。OSSOエージェント・インスタンスのエージェント名を指定します。
`siteToken`	省略可能。認証の要求時にパートナが使用するアプリケーション・トークンを指定します。
`siteName`	省略可能。OSSOエージェント・インスタンスのSiteName/ServerNameを指定します。
`successUrl`	省略可能。認証が成功した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。
`failureUrl`	省略可能。認証が失敗した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。
`homeUrl`	省略可能。認証後、ホーム・ページで使用するリダイレクトURLを指定します。
`logoutUrl`	省略可能。ユーザーがログアウトしたときに使用するリダイレクトURLを指定します。
`startDate`	省略可能。アプリケーションへのログインがサーバーによって許可される最初の年月日を指定します。
`endDate`	省略可能。アプリケーションへのログインがサーバーによって許可される最後の年月日を指定します。
`adminId`	省略可能。OSSOエージェントの管理者ログインIDを指定します。
`adminInfo`	省略可能。トラッキング目的の、OSSOエージェントの管理者IDを指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1の登録エントリ内の管理者IDおよび情報を変更します。

editOssoAgent(agentName = "OSSOAgent1", partnerId = "partnerId", 
siteToken = "siteToken", siteName = "siteName", successUrl="successUrl", 
failureUrl = "failureUrl", homeUrl="homeUrl", logoutUrl="logoutUrl", 
startDate = "2009-12-10", endDate = "2012-12-30", adminId = "345", 
adminInfo = "Agent11", domainHome="domainHome1")

deleteOssoAgent

システム構成内の、指定されたOSSOエージェントの登録を削除するオンラインおよびオフライン・コマンド。

説明

システム構成内の、指定されたOSSOエージェントの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。削除するOSSOエージェント・エントリの名前を指定します。
`domainhome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1という名前のOSSOエージェントの登録エントリを削除します。

deleteOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

displayOssoAgent

システム構成内の、指定されたOSSOエージェント・エントリの詳細を表示するオンラインおよびオフライン・コマンド。

説明

Access Manager管理コンソールに、指定されたOSSOエージェント・エントリの詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。表示するOSSOエージェント・エントリの名前を指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、OSSOAgent1エントリの詳細を表示します。

displayOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")

editWebgateAgent

システム構成内の、Webゲート10gの登録エントリを変更するオンラインおよびオフライン・コマンド。

説明

システム構成内の、Webゲート10gの登録エントリを変更します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editWebgateAgent(agentName="<AgentName>",
accessClientPasswd="<accessClientPassword >",state="<state>", preferredHost="<host>", 
aaaTimeOutThreshold="<aaaTimeoutThreshold >", security="<security>",primaryCookieDomain="<primaryCookieDomain>", maxConnections="<maxConnections>",maxCacheElems="<maxCacheElements >", cacheTimeout="<cacheTimeOut>", 
cookieSessionTime="<cookieSessionTime >", maxSessionTime="<maxSessionTime>",
idleSessionTimeout="<idleSessionTimeout >",failoverThreshold="<failoverThreshold >", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。変更するWebゲート・エージェントの名前を指定します。
`accessClientPasswd`	省略可能。Webゲート・エージェントのアクセス・クライアント・パスワードを指定します。
`state`	省略可能。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。
`preferredHost`	省略可能。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。
`aaaTimeOutThreshold`	省略可能。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます)
`security`	省略可能。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。
`primaryCookieDomain`	省略可能。Access Managerエージェントのデプロイ先のWebサーバー・ドメインを指定します。たとえば、acompany.comです。
`maxConnections`	省略可能。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1
`maxCacheElems`	省略可能。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000
`cacheTimeout`	省略可能。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルト = 1800 (秒)
`cookieSessionTime`	省略可能。ObSSOCookieが保持される時間を指定します。デフォルト = 3600 (秒)
`maxSessionTime`	省略可能。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルト = 3600 (秒)
`idleSessionTimeout`	ドメイン・ホームの場所を指定します。オフラインの場合、この値は必須です。オンラインの場合はオプションです。
`failoverThreshold`	省略可能。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルト = 1
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

任意の設定またはすべての設定を変更できます。次の例を使用して、エージェントID、状態、最大接続数、Access Managerサーバーのタイムアウト、プライマリCookieドメイン、キャッシュ・タイムアウト、Cookieセッション・タイムアウト、最大セッション・タイムアウト、アイドル・セッション・タイムアウトおよびフェイルオーバーしきい値を変更します。

editWebgateAgent(agentName="WebgateAgent1", accessClientPasswd="welcome1",
state="Enabled", preferredHost="141.144.168.148:2001", aaaTimeOutThreshold = "10",
security="open", primaryCookieDomain="primaryCookieDomain", maxConnections="16",
maxCacheElems="10000", cacheTimeout="1800", cookieSessionTime="3600",
maxSessionTime="24", idleSessionTimeout="3600", failoverThreshold="1", 
domainHome="domainHome1")

deleteWebgateAgent

システム構成内のWebgate_agent登録エントリを削除するオンラインおよびオフライン・コマンド。

説明

システム構成から指定されたWebgate_agent登録エントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。削除するWebゲート・エージェントの名前を指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、WebgateAgent1という名前のWebゲート・エージェントを削除します。

deleteWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")

displayWebgateAgent

Webgate_agent登録エントリを表示するオンラインおよびオフライン・コマンド。

説明

Access Manager管理コンソールに、指定されたWebgate_agent登録エントリのすべての詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。表示するWebゲート・エージェントの名前を指定します。
`domainhome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、WebgateAgent1のエントリの詳細を表示します。

displayWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")

exportPolicy

テスト(ソース)環境から指定された中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートするオンラインのみのコマンド。

説明

テスト(ソース)環境から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

exportPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")

引数	定義
`pathTempOAMPolicyFile`	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、テスト(ソース)環境からポリシー・データをエクスポートするときに使用するtempfile.txtファイルへのパスを指定します。

exportPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt")

importPolicy

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")

引数	定義
`pathTempOAMPolicyFile`	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、ポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile.txtファイルへのパスを指定します。

importPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt")

importPolicyDelta

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPolicyDelta(pathTempOAMPolicyFile="<absoluteFilePath>")

引数	定義
`pathTempOAMPolicyFile`	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、変更されたポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile_delta.txtファイルへのパスを指定します。

importPolicyDelta(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_delta.txt")

migratePartnersToProd

現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行するオンラインのみのコマンド。

説明

現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

migratePartnersToProd(prodServerHost="<host>", prodServerPort="<port>", 
prodServerAdminUser="<user>", prodServerAdminPwd="<passwd>")

引数	定義
`prodServerHost`	パートナの移行先となるターゲットAccess Managerサーバーのホスト名。
`prodServerPort`	パートナの移行先となるターゲットAccess Managerサーバーのポート。
`prodServerAdminUser`	パートナの移行先となるターゲットAccess Managerサーバーの管理者。
`prodServerAdminPwd`	ターゲットAccess Managerサーバーの管理者のパスワード。

例

次の例では、パートナの移行に必要な情報を指定します。

migratePartnersToProd(prodServerHost="myhost", prodServerPort="1234", 
prodServerAdminUser="weblogic", prodServerAdminPwd="welcome")

exportPartners

ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートするオンラインのみのコマンド。

説明

ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

exportPartners(pathTempOAMPartnerFile="<absoluteFilePath>")

引数	定義
`pathTempOAMPolicyFile`	必須。一時Access Managerファイルへの絶対パスを指定します。

例

次の例では、Access Managerパートナ・ファイルへの絶対パスを指定します。

exportPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml")

importPartners

指定されたAccess ManagerファイルからAccess Managerパートナをインポートするオンラインのみのコマンド。

説明

指定されたAccess ManagerファイルからAccess Managerパートナをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

importPartners(pathTempOAMPartnerFile="<absoluteFilePath>")

引数	定義
`pathTempOAMPartnerFile`	必須。一時Access Managerパートナ・ファイルへのパスを指定します。

例

次の例では、パートナのインポート元となるAccess Managerファイルへの絶対パスを指定します。

importPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml")

displayTopology

デプロイメント内のすべてのAccess Managerサーバーに関する情報を表示するオンラインおよびオフライン・コマンド。

説明

デプロイ済のAccess Managerサーバーのトポロジを一覧表示します。

構文

displayTopology(domainHome="<domainHomeName>")

引数	定義
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン・ホーム内のデプロイ済のすべてのAccess Managerサーバーの詳細を一覧表示します。

displayTopology(domainHome="domainHome1")

configureOAAMPartner

Access ManagerとOracle Adaptive Access Manager (OAAM)の基本的な統合を構成するオンラインのみのコマンド。

説明

Access ManagerとOAAMの基本的な統合を構成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configureOAAMPartner(dataSourceName="<dataSourceName>", hostName="<hostName>", 
port="<port>", serviceName="<serviceName>", userName="<userName>", 
passWord="<passWord>", maxConnectionSize="<maxConnectionSize>", 
maxPoolSize="<maxPoolSize>", serverName="<serverName>")

引数	定義
`dataSourceName`	必須。作成するデータ・ソースの名前を指定します。
`hostName`	必須。データベース・ホストの名前を指定します。
`port`	必須。データベース・ポート番号を指定します。
`serviceName`	必須。データベース・サービス名を指定します。
`userName`	必須。OAAMスキーマ名を指定します。
`passWord`	必須。OAAMスキーマ・パスワードを指定します。
`maxConnectionSize`	省略可能。接続予約タイムアウトの最大値を指定します。
`maxPoolSize`	省略可能。接続プールの最大サイズを指定します。
`serverName`	省略可能。データ・ソースのターゲット・サーバーを指定します。

例

次の例では、Access ManagerとOAAMの基本的な統合を構成します。

configureOAAMPartner(dataSourceName="MyOAAMDS", hostName="host.example.com", 
port="1521", serviceName="sevice1", userName="username", passWord="password", 
maxConnectionSize=None, maxPoolSize=None, serverName="oam_server1")

registerOIFDAPPartner

Oracle Access Management Identity Federation (Identity Federation)をDelegated Authentication Protocol (DAP)パートナとして登録するオンラインおよびオフライン・コマンド。

説明

Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

registerOIFDAPPartner(keystoreLocation="/scratch/keystore" 
logoutURL="http://<oifhost>:<oifport>/fed/user/splooam11g?
 doneURL=http(s)://<oamhost>:<oamport>/oam/server/pages/logout.jsp", 
rolloverTime="nnn")

引数	定義
`keystoreLocation`	必須。キーストア・ファイル(Identity Federationサーバーで生成されたもの)の場所を指定します。
`logoutURL`	必須。Identity FederationサーバーのログアウトURLを指定します。
`rolloverTime`	省略可能。SASSOトークンの暗号化/復号化に使用されたキーをロールオーバーできる時間(秒数)を指定します。

例

次の例では、パラメータの使用例を示します。

registerOIFDAPPartner(keystoreLocation="/scratch/keystore",
logoutURL="http(s)://oif.mycompany.com:1234/fed/user/splooam11g?
doneURL=http(s)://oam.mycompany.com:5678/oam/server/pages/logout.jsp", rolloverTime="500")

registerOIFDAPPartnerIDPMode

Identity FederationをDelegated Authentication Protocol (DAP)パートナとしてIDPモードで登録するオンラインおよびオフライン・コマンド。

説明

Identity FederationをDelegated Authentication Protocol (DAP)パートナとしてIDPモードで登録します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

registerOIFDAPPartnerIDPMode(logoutURL="http://<oifhost>:<oifport>/fed/user/sploosso?doneURL=http://<oamhost>:<oamport>/ngam/server/pages/logout.jsp")

引数	定義
`logoutURL`	必須。Identity FederationサーバーのログアウトURLを指定します。

例

次の例では、ログアウトURLパラメータの使用例を示します。

registerOIFDAPPartner(
logoutURL="http://oif.oracle.com:1234/fed/user/sploosso?
 doneURL=http://oam.oracle.com:5678/ngam/server/pages/logout.jsp")

registerThirdPartyTAPPartner

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

説明

任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。

構文

registerThirdPartyTAPPartner(partnerName="ThirdPartyTAPPartner", 
keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks", 
password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme", 
tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")

引数	定義
`partnerName`	必須。パートナの名前を指定します。サード・パーティのパートナの識別に使用する任意の名前を指定できます。
`keystoreLocation`	必須。キーストア・ファイルの場所を指定します。
`password`	必須。キーストア・ファイルのパスワードを指定します。
`tapTokenVersion`	必須。Trusted Authentication Protocolのバージョンを指定します。
`tapScheme`	省略可能。リソースの保護に使用するTAPScheme名を指定します(TAPSchemeは即時利用可能)。
`tapRedirectUrl`	省略可能。資格証明コレクタのリダイレクト先となるTAPチャレンジURLを指定します。

例

次の例では、パラメータの使用例を示します。

registerThirdPartyTAPPartner(partnerName = "ThirdPartyTAPPartner", 
keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks", 
password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme", 
tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")

disableCoexistMode

共存モードを無効にするオンライン・コマンド。

説明

共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

disableCoexistMode()

例

次の例では、共存モードを無効にします。

disableCoexistMode()

enableOamAgentCoexist

Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。

説明

Access Managerエージェントの共存モードを有効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

enableOamAgentCoexist()

例

次の例では、共存モードを有効にします。

enableOamAgentCoexist

disableOamAgentCoexist

Access Managerエージェントの共存モードを無効にします。

説明

Access Managerエージェントの共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。

構文

disableOamAgentCoexist()

例

次の呼出しは、共存モードを有効にします。

disableOamAgentCoexist

editGITOValues

GITO構成パラメータを編集するオンラインおよびオフライン・コマンド。

説明

GITO構成パラメータを編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com", 
gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20", 
gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")

引数	定義
`gitoEnabled`	ユーザーによるGITO対応プロパティの設定を許可(または拒否)します。値としてtrueまたはfalseを取ります。
`gitoCookieDomain`	必須。GITO Cookieドメインを指定します。
`gitoCookieName`	省略可能。Cookie名を指定します。
`gitoVersion`	省略可能。GITOバージョンを指定します。値としてv1.0またはv3.0のみを取ります。
`gitoTimeout`	省略可能。GITOタイムアウト値を指定します。
`gitoSecureCookieEnabled`	省略可能。GITO Cookie対応プロパティを有効にします。値としてtrueまたはfalseを取ります。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、GITO構成パラメータを編集します。

editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com", 
gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20", 
gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")

editWebgate11gAgent

システム構成内の11g Webgate_entry登録を編集するオンラインおよびオフライン・コマンド。

説明

システム構成内の11g Webgate_entry登録を編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

editWebgate11gAgent(agentName="<AgentName>", 
accessClientPasswd="<accessClientPassword >",state="<state>", preferredHost="<host>", 
aaaTimeoutThreshold="<aaaTimeOutThreshold>", security="<security>",logOutUrls="<logOutUrls>", maxConnections="<maxConnections>",maxCacheElems="<maxCacheElements>", cacheTimeout="<cacheTimeOut>", 
logoutCallbackUrl="<logoutCallbackUrl >",maxSessionTime="<maxSessionTime>", logoutRedirectUrl="<logoutRedirectUrl >",failoverThreshold="<failoverThreshold>",
tokenValidityPeriod="<tokenValidityPeriod>",logoutTargetUrlParamName="<logoutTargetUrlParamName>", domainHome="<domainHome>",allowManagementOperations="<allowManagementOperations>", 
allowTokenScopeOperations="<allowTokenScopeOperations>", 
allowMasterTokenRetrieval="<allowMasterTokenRetrieval>", 
allowCredentialCollectorOperations="<allowCredentialCollectorOperations>")

引数	定義
`agentName`	必須。変更する11g Webゲート・エージェントの名前を指定します。
`accessClientPasswd`	省略可能。このWebゲート・エージェントの一意のクライアント・パスワードを指定します。
`state`	省略可能。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。
`preferredHost`	省略可能。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。
`aaaTimeoutThreshold`	省略可能。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます)
`security`	省略可能。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。
`logOutUrls`	ログアウト・ハンドラをトリガーするURLのリスト。ログアウト・ハンドラは、ObSSOCookieを削除します。
`maxConnections`	省略可能。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1
`maxCacheElems`	省略可能。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000
`cacheTimeout`	省略可能。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルト = 1800 (秒)
`logoutCallbackUrl`	oam_logout_successへのURL。oam_logout_successは、コールバック中にCookieを消去します。デフォルトでは、これは、エージェントの登録時に指定されたエージェント・ベースURLに基づきます。次に例を示します。 `http://<host>:<port>`
`maxSessionTime`	省略可能。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルト = 3600 (秒)
`logoutRedirectUrl`	省略可能。中央ログアウト・ページ(logout.html)へのURL(絶対パス)を指定します。デフォルトでは、これは、デフォルト・ポート14200のAccess Manager管理コンソールのホスト名に基づきます。
`failoverThreshold`	省略可能。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルト = 1
`tokenValidityPeriod`	省略可能。Access Managerエージェントで保護されているリソースにアクセスすることなく、ユーザーの認証セッションが有効である時間(秒単位)を指定します。
`logoutTargetUrlParamName`	省略可能。この値は、ログアウト時に呼び出され、OPSSレベルで構成されるログアウト・ターゲットURLです。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。
`allowManagementOperations`	省略可能。管理操作の許可のフラグを設定します
`allowTokenScopeOperations`	省略可能。トークン・スコープ操作の許可のフラグを設定します
`idleSessionTimeout`	省略可能。次を指定します
`allowMasterTokenRetrieval`	マスター・トークン取得の許可のフラグを設定します
`allowCredentialCollectorOperations`	資格証明コレクタ操作の許可のフラグを設定します

例

次の例では、必須のパラメータとオプションのパラメータをすべて使用しています。

editWebgate11gAgent(agentName="WebgateAgent1", accessClientPasswd="welcome1",
state="Enabled", preferredHost="141.144.168.148:2001", aaaTimeoutThreshold="10",
security="open", logOutUrls="http://host1.oracle.com:1234", maxConnections = "16",
maxCacheElems="10000", cacheTimeout="1800", 
logoutCallbackUrl="http://host2.oracle.com:1234",
maxSessionTime="24", logoutRedirectUrl="logoutRedirectUrl", 
failoverThreshold="1", tokenValidityPeriod="tokenValidityPeriod",
logoutTargetUrlParamName="logoutTargetUrl", domainHome="domainHome1",
allowManagementOperations="false", allowTokenScopeOperations="false", 
allowMasterTokenRetrieval="false", allowCredentialCollectorOperations="false")

deleteWebgate11gAgent

システム構成内の11g Webgate_agentエントリを削除するオンラインおよびオフライン・コマンド。

説明

システム構成内の11g Webgate_agentエントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。削除する11g Webゲート・エージェントの名前を指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_11gWebGateという名前の11g Webgate_agentエントリを削除します。

deleteWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

displayWebgate11gAgent

11g Webgate_agent登録エントリを表示するオンラインおよびオフライン・コマンド。

説明

11g Webゲート・エージェント登録エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")

引数	定義
`agentName`	必須。変更する11g Webゲート・エージェントの名前を指定します。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、my_11gWebGateという名前のWebゲート・エージェントを表示します。

displayWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")

displayOAMMetrics

Access Managerサーバーのメトリックを表示するオンラインおよびオフライン・コマンド。

説明

Access Managerサーバーのメトリックを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

displayOAMMetrics(domainHome="<domainHomeName>")

引数	定義
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、指定されたドメイン内のAccess Managerサーバーのメトリックを表示します。

displayOAMMetrics(domainHome="domainHome1")

updateOIMHostPort (非推奨)

非推奨 - Access Managerとの統合時にOracle Identity Manager構成を更新するオンラインのみのコマンド。

説明

システム構成内のIdentity Manager構成を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

updateOIMHostPort(hostName="<host name>", port="<port number>", secureProtocol="true")

引数	定義
`hostName`	Identity Managerホストの名前。
`port`	Identity Managerホストのポート。
`secureProtocol`	通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。

例

次の例では、このコマンドの使用例を示します。

updateOIMHostPort(hostName="OIM.oracle.com", port="7777", secureProtocol="true")

configureOIM (非推奨)

非推奨 - Access Managerとの統合時にOracle Identity Manager固有のエージェント・プロファイルを登録するオンラインのみのコマンド。

説明

Access Managerとの統合時にOracle Identity Manager固有のエージェント・プロファイルを作成します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

configureOIM(oimHost="<OIM host>", oimPort="<port>", 
oimSecureProtocolEnabled="true | false", oimAccessGatePwd="<AccessGatePassword>", 
oimCookieDomain="<OIMCookieDomain>", oimWgId="<OIMWebgateID>", 
oimWgVersion="<OIMWebgateVersion>")

引数	定義
`oimHost`	Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。
`oimPort`	Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。
`oimSecureProtocolEnabled`	通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。
`oimAccessGatePwd`	指定する場合は、オープン・モードのエージェント・パスワード。
`oimCookieDomain`	Cookieが設定されるドメイン。
`oimWgId`	エージェントの登録名。
`oimWgVersion`	可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。

例

次の例では、このコマンドの使用例を示します。

configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "welcome", oimCookieDomain = "domain1",
oimWgId="<OIM Webgate ID>", oimWgVersion="10g")

updateOSSOResponseCookieConfig

OSSOプロキシ・レスポンスCookie設定を更新するオンラインおよびオフライン・コマンド。

説明

OSSOプロキシ・レスポンスCookie設定を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

updateOSSOResponseCookieConfig(cookieName="<cookieName>",cookieMaxAge="<cookie age in minutes>", isSecureCookie="true | false",cookieDomain="<domain of the cookie>", domainHome="<domainHomeName>")

引数	定義
`cookieName`	省略可能。設定が更新されるCookieの名前。指定しない場合、グローバル設定が更新されます。
`cookieMaxAge`	Cookieの最大保持時間(分単位)。負の値の場合、セッションCookieが設定されます。
`isSecureCookie`	Cookieを保護する(SSLチャネルで送信する)かどうかを指定するブール・フラグ。
`cookieDomain`	Cookieのドメイン。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、このコマンドの使用例を示します。

updateOSSOResponseCookieConfig(cookieName = "ORASSO_AUTH_HINT",
cookieMaxAge = "525600", isSecureCookie = "false",
cookieDomain=".example.com", domainHome = "<domain_home>")

deleteOSSOResponseCookieConfig

システム構成内のOSSOプロキシ・レスポンスCookie設定を削除するオンラインおよびオフライン・コマンド。

説明

OSSOプロキシ・レスポンスCookie設定を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。

構文

deleteOSSOResponseCookieConfig(cookieName="<cookieName>", 
domainHome="<domainHomeName>")

引数	定義
`cookieName`	必須。設定が削除されるCookieの名前。グローバルCookie設定は削除できません。
`domainHome`	Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。

例

次の例では、このコマンドの使用例を示します。

deleteOSSOResponseCookieConfig(cookieName="ORASSO_AUTH_HINT",
domainHome = "<domain_home>")

configureAndCreateIdentityStore

アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

説明

指定された値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

構文

configureOIM(oimHost="<OIM host>", oimPort="<port>", 
oimSecureProtocolEnabled="true | false", oimAccessGatePwd="<AccessGatePassword>", 
oimCookieDomain="<OIMCookieDomain>", oimWgId="<OIMWebgateID>", 
oimWgVersion="<OIMWebgateVersion>"), nameOfIdStore="<nameOfIdStore>", 
idStoreSecurityCredential="<idStoreSecurityCredential>",
userSearchBase="<userSearchBase>", ldapUrl="<ldapUrl>", 
groupSearchBase="<groupSearchBase>", securityPrincipal="<securityPrincipal>", idStoreType="<idStoreType>", ldapProvider="<ldapProvider>",
isPrimary="<isPrimary>", userIDProvider="<userIDProvider>", 
userNameAttr="<userNameAttr>"

引数	定義
`oimHost`	Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。
`oimPort`	Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。
`oimSecureProtocolEnabled`	通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。
`oimAccessGatePwd`	指定する場合は、オープン・モードのエージェント・パスワード。
`oimCookieDomain`	Cookieが設定されるドメイン。
`oimWgId`	エージェントの登録名。
`oimWgVersion`	可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。
`nameOfIdStore`	必須。作成するLDAPアイデンティティ・ストアの名前を指定します。
`idStoreSecurityCredential`	必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。
`userSearchBase`	必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。
`ldapUrl`	必須。作成するLDAPアイデンティティ・ストアのLDAPホストのURL(ポート番号を含みます)を指定します。
`groupSearchBase`	必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。
`securityPrincipal`	必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。
`idStoreType`	必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。
`ldapProvider`	作成するストアのLDAPプロバイダ・タイプを指定します。
`isPrimary`	省略可能。登録するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。
`userIDProvider`	作成するストアのユーザー・アイデンティティ・プロバイダを指定します。
`userNameAttr`	必須。ストアのユーザー属性を指定します。

例

次の例では、このコマンドの使用例を示します。

configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true",
oimAccessGatePwd = "welcome", oimCookieDomain = "domain1",
oimWgId="<OIM Webgate ID>", oimWgVersion="10g"
nameOfIdStore="nameOfIdStore", 
idStoreSecurityCredential="idStoreSecurityCredential", 
userSearchBase="userSearchBase", ldapUrl="ldapUrl", 
groupSearchBase="groupSearchBase", securityPrincipal="securityPrincipal", idStoreType="idStoreType", ldapProvider="ldapProvider", isPrimary="true", userIDProvider="userIDProvider", userNameAttr="userNameAttr")

configAndCreateIdStoreUsingPropFile

プロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

説明

指定されたプロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。

構文

configAndCreateIdStoreUsingPropFile(path="<path_of_property_file>")

引数	定義
`path`	値が定義されているプロパティ・ファイルへのパス。

例

次の例では、このコマンドの使用例を示します。

configAndCreateIdStoreUsingPropFile(path="/prop_file_directory/values.properties")

migrateArtifacts (非推奨)

非推奨 - アーティファクトを移行します。

説明

入力アーティファクト・ファイル内に定義されている値に基づいてアーティファクトを移行します。

構文

migrateArtifacts(path="<path_to_artifacts_file>", password="<password>", 
type="OutOfPlace|InPlace", isIncremental="true|false")

引数	定義
`path`	アーティファクト・ファイルの場所
`password`	元のアーティファクトの生成時に使用されたパスワード。
`type`	移行のタイプを定義するブール値で、値としてInPlaceまたはOutOfPlaceを取ります
`isIncremental`	ブール値(値としてtrueまたはfalseを取ります)。trueの場合、増分アップグレードが実行されます。

例

次の例では、このコマンドの使用例を示します。

migrateArtifacts(path="/exampleroot/parent/t", password="welcome", 
type="InPlace", isIncremental="false")

displaySimpleModeGlobalPassphrase

システム構成内に定義されている簡易モードのグローバル・パスフレーズを平文で表示します。

説明

簡易モードのグローバル・パスフレーズを平文で表示するオンラインのみのコマンド。このコマンドには引数はありません。

構文

displaySimpleModeGlobalPassphrase()

例

次の例では、このコマンドの使用例を示します。

displaySimpleModeGlobalPassphrase()

exportSelectedPartners

指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

説明

指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。

構文

exportSelectedPartners(pathTempOAMPartnerFile="<absoluteFilePath>", 
partnersNameList="<comma_separated_partner_names>")

引数	定義
`pathTempOAMPartnerFile`	必須。情報のエクスポート先となるファイルの場所。
`partnersNameList`	必須。エクスポートされるパートナIDのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

exportSelectedPartners(pathTempOAMPartnerFile="/exampleroot/parent/tempfile.extn"
partnersNameList="partner1,partner2")

oamMigrate

OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行するオンラインのみのコマンド。

説明

移行フレームワークMBeanのbeginMigrate操作を呼び出します。

構文

oamMigrate(oamMigrateType=<migrationType>, 
pathMigrationPropertiesFile="<absoluteFilePath>")

引数	定義
`oamMigrateType`	必須。実行する移行のタイプを指定します。値として次のいずれかを取ります: OSSO \| OpenSSO \| OAM10g 注: OpenSSOはSAML 7.1とOpenSSOの両方に適用します。
`pathMigrationPropertiesFile`	必須。移行のために必要なアーティファクトの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

oamMigrate(oamMigrateType=OSSO,
pathMigrationPropertiesFile="/middlewarehome/oam-migrate.properties")

preSchemeUpgrade

preSchemeUpgrade操作を呼び出すオンラインのみのコマンド。

説明

preSchemeUpgrade操作を呼び出します。

構文

preSchemeUpgrade
(pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")

引数	定義
`pathUpgradePropertiesFile`	必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

preSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")

postSchemeUpgrade

postSchemeUpgrade操作を呼び出します。

説明

postSchemeUpgrade操作を呼び出します。

構文

postSchemeUpgrade
(pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")

引数	定義
`pathUpgradePropertiesFile`	必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。

例

次の例では、このコマンドの使用例を示します。

postSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")

oamSetWhiteListMode

oamSetWhiteListModeをtrueまたはfalseに設定します。

説明

oamSetWhiteListModeをtrueまたはfalseに設定します。trueの場合、Access Managerは、使用アプリケーションによって要求された最後のURLにリダイレクトされます(そのURLがホワイトリストURLとして構成されている場合のみ)。

構文

oamSetWhiteListMode(oamWhiteListMode="true|false")

引数	定義
`oamWhiteListMode`	必須。Access Managerのホワイトリスト・モードを有効にします。

例

次の例では、このコマンドの使用例を示します。

oamSetWhiteListMode(oamWhiteListMode="true")

oamWhiteListURLConfig

指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

説明

指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。

このコマンドでは、ワイルドカードのポート/ホストが設定されたホワイトリストURLをホワイトリスト構成マップに入力できます。

ワイルドカード文字(*記号)を使用したホスト/ポートが値フィールドに指定されている場合は、その特定の書式に属するすべてのホスト/ポートが許可されます。

*記号を追加すると、ワイルドカード比較メカニズムに基づいてホワイトリストURLに対する照合が実行されます。

構文

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234", 
Operation="Remove|Update")

引数	定義
`Name`	必須。このエントリの名前(キー)を表す有効な文字列。
`Value`	必須。<protocol>://<host>:<port>という形式の有効なURL。ポートが指定されない場合、デフォルトのHTTP/HTTPSポートがそれぞれ割り当てられます。
`Operation`	必須。値としてUpdateまたはRemoveを取ります。大/小文字は区別されません。

例

次の例では、このコマンドの使用例を示します。

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234", Operation="Update")

次に、ホワイトリスト・ポートに対してワイルドカードを使用した、このコマンドの使用例を示します。

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:*", Operation="Update")
oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:*", Operation="Remove")

次に、ワイルドカード文字を使用して値フィールドにホスト/ポートを指定したときのこのコマンドの例を示します。

oamWhiteListURLConfig(Name="xyz", Value="http://*.com:7777", Operation="Update")

前述のコマンドでは、http://xyz.com:7777、http://abc.com:7777などのURLがリダイレクション用に許可されます。

oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:*", Operation="Update")

前述のコマンドでは、http://xyz.com:8000、http://abc.com:4040などのURLがリダイレクション用に許可されます。

enableMultiDataCentreMode

マルチ・データ・センター・モードを有効にするオンラインのみのコマンド。

説明

マルチ・データ・センター・モードを有効にします。

構文

enableMultiDataCentreMode(propfile="<absoluteFilePath>")

引数	定義
`propFile`	必須。マルチ・データ・センターを有効にするためのプロパティの読取り元となるファイルへの絶対パスを指定します。

例

次の例では、このコマンドの使用例を示します。

enableMultiDataCentre(propfile="/middlewarehome/oamMDCProperty.properties")

disableMultiDataCentreMode

マルチ・データ・センター・モードを無効にするオンラインのみのコマンド。

説明

マルチ・データ・センター・モードを無効にします。このコマンドには、引数はありません。

構文

disableMultiDataCentreMode()

例

次の例では、このコマンドの使用例を示します。

disableMultiDataCentreMode()

setMultiDataCentreClusterName

マルチ・データ・センター・クラスタ名を設定します。

説明

マルチ・データ・センター・クラスタ名を設定します。

構文

setMultiDataCentreClusterName(clusterName="MyCluster")

引数	定義
`clusterName`	必須。クラスタの名前を指定します。

例

次の例では、このコマンドの使用例を示します。

postSchemeUpgrade(clusterName="MyCluster")

setMultiDataCentreLogoutURLs

マルチ・データ・センター・パートナ・ログアウトURLを設定します。

説明

マルチ・データ・センター・パートナ・ログアウトURLを設定します。

構文

setMultiDataCentreLogoutURLs
(logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")

引数	定義
`logoutURLs`	必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

setMultiDataCentreLogoutURLs(logoutURLs="http://localhost:6666/logout.jsp,http://localhost:8888/logout.jsp")

updateMultiDataCentreLogoutURLs

マルチ・データ・センター・パートナ・ログアウトURLを更新します。

説明

マルチ・データ・センター・パートナ・ログアウトURLを更新します。

構文

updateMultiDataCentreLogoutURLs
(logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")

引数	定義
`logoutURLs`	必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。

例

次の例では、このコマンドの使用例を示します。

updateMultiDataCentreLogoutURLs(logoutURLs="http://localhost:7777/logout.jsp,http://localhost:9999/logout.jsp")

addPartnerForMultiDataCentre

マルチ・データ・センターにパートナを追加するオンライン・コマンド。

説明

マルチ・データ・センターにパートナを追加します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを追加します。

構文

addPartnerForMultiDataCentre(propfile="<absoluteFilePath>")

引数	定義
`propFile`	必須。エージェント情報を含むファイルへの絶対パスを指定します。

例

次の例では、このコマンドの使用例を示します。

addPartnerForMultiDataCentre(propfile="/middlewarehome/partnerInfo.properties")

removePartnerForMultiDataCentre

マルチ・データ・センターからパートナを削除します。

説明

マルチ・データ・センターからパートナを削除します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを削除します。

構文

removePartnerForMultiDataCentre(webgateid="<webgateId")

引数	定義
`webgateid`	必須。削除するパートナのIDを指定します。

例

次の例では、このコマンドの使用例を示します。

removePartnerForMultiDataCentre(webgateid="IAMSuite")

addOAMSSOProvider

指定されたログインURI、ログアウトURIおよび自動ログインURIを持つAccess Manager SSOプロバイダを追加するオンライン・コマンド。

説明

このコマンドは、必要なプロパティを持つAccess Manager SSOサービス・インスタンスを追加することにより、ドメインjps-config.xmlを変更します。エラーが発生した場合、コマンドはWLSTExceptionを返します。

構文

addOAMSSOProvider(loginuri, logouturi, autologinuri)

引数	定義
loginuri	ログイン・ページのURIを指定します。必須です。
logouturi	ログアウト・ページのURIを指定します。省略可能。指定されていない場合、デフォルトはlogouturi=NONEです。 ADFセキュリティがOPSSログアウト・サービスを確実に呼び出すよう、""に設定します。これは、クラスOAMSSOServiceImplの実装を使用してCookie ObSSOCookieをクリアします。ユーザーをログアウトすることなくCookieをクリアする必要があるADFセキュアなWebアプリケーションでは、この設定を使用してください。
autologinuri	自動ログイン・ページのURIを指定します。省略可能。指定されていない場合、デフォルトはautologin=NONEです。

例

次の例では、このコマンドの使用例を示します。

addOAMSSOProvider(loginuri="/${app.context}/adfAuthentication", 
 logouturi="/oamsso/logout.html", autologinuri="/example.cgi")