2 Access ManagerのWLSTコマンド
「Access Managerコマンド」の項に、Oracle Access Management Access ManagerのWLSTコマンドと、それらの詳細の一覧を示します。
2.1 Access Managerコマンド
表2-1 WLST Access Managerコマンド
使用するコマンド | 目的 | WLSTの使用... |
---|---|---|
認可ポリシーのリソースURLのハッシュ化に使用されるキーを生成して取得します。 |
オンライン |
|
カスタム・エラーとログイン・ページを有効または無効にします。 |
オンライン オフライン |
|
ユーザー・アイデンティティ・ストアの登録を作成します。 |
オンライン オフライン |
|
ユーザー・アイデンティティ・ストアの登録を編集します。 |
オンライン オフライン |
|
ユーザー・アイデンティティ・ストアの登録を削除します。 |
オンライン オフライン |
|
ユーザー・アイデンティティ・ストアの登録を表示します。 |
オンライン |
|
Access Managerサーバー構成のエントリを作成します。 |
オンライン オフライン |
|
Access Managerサーバー構成のエントリを編集します。 |
オンライン オフライン |
|
指定されたAccess Managerサーバー構成を削除します。 |
オンライン オフライン |
|
Access Managerサーバー構成の詳細を表示します。 |
オンライン オフライン |
|
永続ログイン機能を有効または無効にします。 |
オンライン |
|
Access Managerログイン・ページのユーザー・プリファレンスを構成します。 |
オンライン |
|
SSOサーバー・リクエスト・キャッシュ・タイプを構成します。 |
オンライン |
|
SSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。 |
オンライン オフライン |
|
OSSOエージェント構成の詳細を編集します。 |
オンライン オフライン |
|
指定されたOSSOエージェント構成を削除します。 |
オンライン オフライン |
|
OSSOエージェント構成の詳細を表示します。 |
オンライン オフライン |
|
10g Webゲート・エージェントの登録の詳細を編集します。 |
オンライン オフライン |
|
指定された10g Webゲート・エージェント構成を削除します。 |
オンライン オフライン |
|
Webゲート・エージェント構成の詳細を表示します。 |
オンライン オフライン |
|
テスト(ソース)から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。 |
オンライン |
|
指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。 |
オンライン |
|
指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。 |
オンライン |
|
ソースAccess Managerサーバーから指定されたターゲットAccess Managerサーバーにパートナを移行します。 |
オンライン |
|
ソースから指定された中間Access ManagerファイルにAccess Managerパートナをエクスポートします。 |
オンライン |
|
指定された中間Access ManagerファイルからAccess Managerパートナをインポートします。 |
オンライン |
|
デプロイ済のAccess Managerサーバーの詳細を一覧表示します。 |
オンライン オフライン |
|
Access ManagerとOracle Adaptive Access Managerの基本的な統合を構成します。 |
オンライン |
|
Identity FederationをDelegated Authentication Protocol (DAP)パートナとして登録します。 |
オンライン オフライン |
|
IDPモードでIdentity Federationを登録します。 |
||
任意のサード・パーティをTrusted Authentication Protocol (TAP)パートナとして登録します。 |
オンライン |
|
共存モードを無効にします。 |
オンライン |
|
Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。 |
オンライン |
|
Access Managerエージェントの共存モードを無効にします(10g Webゲートによって設定されたObssocookieからAccess Manager 11gサーバーを無効にします)。 |
オンライン |
|
GITO構成パラメータを編集します。 |
オンライン |
|
11g Webゲートの登録を編集します。 |
オンライン オフライン |
|
11g Webゲート・エージェントの登録を削除します。 |
オンライン オフライン |
|
11g Webゲート・エージェントの登録を表示します。 |
オンライン オフライン |
|
Access Managerサーバーのメトリックを表示します。 |
オンライン オフライン |
|
Access Managerとの統合時にOracle Identity Manager構成を更新します。 |
オンライン |
|
Access Managerとの統合時にOracle Identity Manager固有のエージェントの登録を作成します。 |
オンライン |
|
OSSOプロキシ・レスポンスCookie設定を更新します。 |
オンライン |
|
OSSOプロキシ・レスポンスCookie設定を削除します。 |
オンライン |
|
アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。 |
オンライン |
|
ファイル内に定義されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。 |
オンライン |
|
manageAuditEvents | 特定のタイプのイベントの監査を無効にします。 |
オンライン オフライン |
指定されたアーティファクト・ファイルに基づいてアーティファクトを移行します。 |
オンライン |
|
システム構成から簡易モードのグローバル・パスフレーズを平文で表示します。 |
オンライン |
|
指定された中間Access Managerファイルに、選択されたAccess Managerパートナをエクスポートします。 |
オンライン |
|
OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行します。 |
オンライン |
|
preSchemeUpgrade操作を呼び出します。 |
オンライン |
|
postSchemeUpgrade操作を呼び出します。 |
オンライン |
|
trueに設定すると、Access Managerサーバーは、WhiteListURLリスト内で指定されているURLにのみリダイレクトされます。 |
オンライン |
|
構成ファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。 |
オンライン |
|
マルチ・データ・センター・モードを有効にします。 |
オンライン |
|
マルチ・データ・センター・モードを無効にします。 |
オンライン |
|
マルチ・データ・センター・クラスタ名を設定します。 |
オンライン |
|
マルチ・データ・センター・ログアウトURLを設定します。 |
オンライン |
|
マルチ・データ・センターのパートナを追加します。 |
オンライン |
|
マルチ・データ・センターからパートナを削除します。 |
オンライン |
|
OAM SSOプロバイダを追加します。 |
オンライン |
2.1.1 displayAuthZCallBackKey
displayAuthZCallBackKeyコマンドはオンライン・コマンドで、これを使用すると、ポリシーに成功/失敗のURLが構成されている場合、認可時に返されるリソースURLのハッシュ化に使用されるキーの生成と取得が可能です。
説明
認可時にリソースURLのハッシュ化に使用されるキーがすでにある場合は、取得できます。キーがない場合は、作成されて返されます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayAuthZCallBackKey()
ノート:
このコマンドには引数はありません。例
次の例で、ハッシュ・キーを表示します。
displayAuthZCallBackKey()
2.1.2 updateCustomPages
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>")
引数 | 定義 |
---|---|
|
アプリケーションへのコンテキスト・パスを指定します(たとえば、/SampleApp)。 |
|
デフォルト値はjspですが、ブランクのままにすることができます。 |
例
カスタム・エラー・ページの機能を有効にするには、updateCustomPages
をcontext
およびpageExtension
パラメータとともに使用します。これにより、oam-config.xml
ファイルが変更され、カスタム・ページ機能が有効になります。
updateCustomPages(pageExtension ="jsp", context="/SampleApp")
カスタム・エラー・ページ機能を無効にするには、パラメータなしでコマンドを使用します[updateCustomPages()
]。これにより、パラメータを使用してコマンドが実行されたときに行われた変更が元に戻ります。
2.1.3 createUserIdentityStore
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>")
引数 | 定義 |
---|---|
|
必須。作成するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。 |
|
必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、cn=Adminです。 |
|
必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。 |
|
必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。 |
|
必須。作成するLDAPアイデンティティ・ストアのユーザー属性を指定します。 |
|
必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。 |
|
必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、 |
|
必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。たとえば、 |
|
必須。作成するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、 |
|
オプション。作成するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。 |
|
オプション。作成するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。 |
|
オプション。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。 |
|
オプション。Access Managerコンソール管理者権限を持つ1つ以上のグルプをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。 |
|
オプション。Access Managerコンソール管理者権限を持つ1人以上のユーザーをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。 |
|
オプション。作成するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。 |
|
オプション。作成するLDAPアイデンティティ・ストアのシステム・モニターを指定します。 |
|
オプション。作成するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。 |
|
オプション。作成するLDAPアイデンティティ・ストアのシステム管理者を指定します。 |
|
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 |
|
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")
2.1.4 editUserIdentityStore
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>" )
引数 | 定義 |
---|---|
|
必須。変更するLDAPアイデンティティ・ストアの一意の名前を指定します。大文字と小文字の英字および数字のみを使用します。 |
|
変更するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。たとえば、 |
|
変更するLDAPアイデンティティ・ストアのプリンシパル管理者の暗号化パスワードを指定します。 |
|
変更するベース・アイデンティティ・ストアのタイプを指定します。このコマンドでは、値はLDAPになります。 |
|
必須。変更するLDAPアイデンティティ・ストアのユーザー属性を指定します。 |
|
必須。登録するLDAPアイデンティティ・ストアのLDAPタイプを指定します。値は、ODSEE、AD、OID、OVD、SJS、OUDなどです。この値は、Access Manager管理コンソールを使用して新しいユーザー・アイデンティティ・ストアが作成されるときに定義され、ユーザー・アイデンティティ・ストア内のストア・タイプに一致します。 |
|
オプション。Access Managerコンソール管理者権限を持つ1つ以上のグルプをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。 |
|
オプション。Access Managerコンソール管理者権限を持つ1人以上のユーザーをカンマで区切って指定します。IsSystemプロパティがtrueに設定されているシステム・ストアの場合は必須です。 |
|
オプション。変更するLDAPアイデンティティ・ストアのセキュリティ管理者を指定します。 |
|
オプション。変更するLDAPアイデンティティ・ストアのシステム・モニターを指定します。 |
|
オプション。変更するLDAPアイデンティティ・ストアのアプリケーション管理者を指定します。 |
|
オプション。変更するLDAPアイデンティティ・ストアのシステム管理者を指定します。 |
|
必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、 |
|
必須。変更するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。たとえば、 |
|
必須。変更するLDAPアイデンティティ・ストアのサーバー・ホストのURL(ポート番号を含む)を指定します。たとえば、 |
|
オプション。変更するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。 |
|
オプション。変更するLDAPアイデンティティ・ストアがシステム・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。 |
|
オプション。アイデンティティ・ストアへの接続に使用される基礎となるインフラストラクチャを指定します。サポートされているタイプはOracleUserRoleAPIのみです。 |
|
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 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
|
必須。セミコロン区切りのユーザー・フィルタ・オブジェクト・クラスのリストを指定します。 |
|
グループ・フィルタ・オブジェクト・クラスのリスト(セミコロンで区切られたもの)を指定します。 |
|
LDAP参照ポリシー(follow、ignore、throwのいずれか)を指定します。 |
|
LDAP検索操作の時間制限(秒単位)を指定します。 |
|
接続プール内の最小接続数を指定します。 |
|
接続プール内の最大接続数を指定します。 |
|
プールから接続を取得するために待機する秒数を指定します。 |
|
アイデンティティ・ストアへの接続を確立する際の再試行回数を指定します。 |
|
ユーザー・グループを検索するための属性の名前を指定します。たとえば、 |
|
LDAPグループ・キャッシュを有効にするかどうかを指定するブール値。値としてtrueまたはfalseを取ります。 |
|
LDAPグループ・キャッシュ内のエントリの数を指定します。 |
|
LDAPグループ・キャッシュ内の各エントリの合計存続時間を指定します。 |
例
次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。
editUserIdentityStore(name="IdStore1", userSearchBase="cn=users", groupSearchBase="cn=groups")
2.1.5 displayUserIdentityStore
displayUserIdentityStoreコマンドはオンライン・コマンドで、ユーザー・アイデンティティ・ストアの登録に関する情報を表示します。
説明
Access Managerに登録されているアイデンティティ・ストアに関する情報を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayUserIdentityStore(name="<name>", domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
必須。表示するLDAPアイデンティティ・ストアの登録の名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。 |
例
WebSphere用の次の呼出しの例は、ユーザー・アイデンティティ・ストアの登録の詳細を表示します。WebLogicのオンライン・モードでこのコマンドを使用するために、domainHome引数を指定する必要はありません。
displayUserIdentityStore(name="ID_Store1", domainHome="domainHome1")
2.1.6 createOAMServer
createOAMServerコマンドはオンラインおよびオフライン・コマンドで、システム構成内にAccess Managerサーバー・エントリを作成します。
説明
Access Managerサーバーの登録を作成します。詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでOAMプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
createOAMServer(configurationProfile="<configurationProfile>", host="<host>",port="<port>", oamProxyPort="<0000>", oamProxyServerID="<oamProxyServerID>",siteName="<siteName>", domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
必須。OAM Serverの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。 |
|
必須。Access Managerサーバー・ホストの名前を指定します。 |
|
必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。 |
|
必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。 |
|
必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシ・サブタブの下に表示されます。 |
|
必須。インスタンスのsiteName/serverNameを指定します。 |
|
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")
2.1.7 editOAMServer
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>")
引数 | 定義 |
---|---|
|
必須。Access Managerサーバーの構成プロファイルを指定します。プロファイルは、Access Manager管理コンソールの「システム構成」タブの「サーバー・インスタンス」の下に表示されます。 |
|
必須。Access Managerサーバー・ホストの名前を指定します。 |
|
必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。 |
|
必須。Access Managerサーバー・ホストのプロキシ・ポートを指定します。 |
|
必須。Access Managerサーバー・ホストのプロキシ・サーバーIDを指定します。Access Managerプロキシ名は、Access Manager管理コンソールのサーバー・インスタンスのAccess Managerプロキシ・サブタブの下に表示されます。 |
|
必須。インスタンスのsiteName/serverNameを指定します。 |
|
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")
2.1.8 deleteOAMServer
deleteOAMServerコマンドはオンラインおよびオフライン・コマンドで、指定されたAccess Managerサーバーの登録を削除できます。
説明
指定されたAccess Managerサーバー構成を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
deleteOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
必須。Access Managerサーバー・ホストの名前を指定します。 |
|
必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、リスニング・ポートが15000
であるoam_server1
Access Managerサーバーの登録を削除します。
deleteOAMServer(host="oam_server1", port="15000", domainHome="domainHome1")
2.1.9 deleteUserIdentityStore
deleteUserIdentityStoreコマンドはオンラインおよびオフライン・コマンドで、Access Manager用の既存のアイデンティティ・ストアの登録を削除します。
説明
アイデンティティ・ストアの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
deleteUserIdentityStore(name="<name>", domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
必須。削除するLDAPアイデンティティ・ストアの登録の名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例はWebSphereで使用でき、指定されたアイデンティティ・ストアの登録を削除します。WebLogic Serverのオンライン・モードでこのコマンドを使用するためには、domainHome引数を指定する必要はありません。
deleteUserIdentityStore(name="identity_store", domainHome="domainHome1")
2.1.10 displayOAMServer
displayOAMServerコマンドはオンラインおよびオフライン・コマンドで、指定されたAccess Managerサーバーの登録の詳細を表示します。
説明
指定されたAccess Managerサーバーの登録の詳細を表示します。この詳細には、ホスト、ポート、登録名、Access Managerプロキシ・ポート、サーバーID、およびオプションでAccess Managerプロキシ共有シークレットが含まれます。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayOAMServer(host="<host>", port="<port>", domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
必須。Access Managerサーバー・ホストの名前を指定します。 |
|
必須。Access Managerサーバー・ホストのリスニング・ポートを指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、my_host
Access Managerサーバー固有のすべてのメトリックを一覧表示します。
displayOAMServer(host="my_host", port="15000", domainHome="domainHome1")
2.1.11 configurePersistentLogin
configurePersistentLoginコマンドはオンライン・コマンドで、永続ログイン機能を有効または無効にするために使用します。
説明
永続ログイン機能を有効にします。
構文
configurePersistentLogin(enable="true/false", validityInDays="<#>", maxAuthnLevel="<#>", userAttribute="<userAttr>")
引数 | 定義 |
---|---|
|
必須。trueまたはfalseを指定します。 |
|
必須。特定のブラウザ・インスタンスまたはデバイスで永続するユーザー・ログインの日数を指定します。 |
|
必須。永続ログインを通じて自動的に再認証された後で許可される最大認証レベルを指定します。 |
|
必須。永続ログインのプロパティが格納されるユーザー属性を指定します。 |
例
次の例では、登録されているアイデンティティ・ストアの検索ベースの値を変更します。
configurePersistentLogin(enable="true", validityInDays="30", maxAuthnLevel="2" userAttribute="obPSFTID")
2.1.12 configOAMLoginPagePref
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")
引数 | 定義 |
---|---|
|
必須。OAM_LANG_PREF Cookieが永続的であるか非永続的であるかを定義するブール。trueまたはfalseに設定します。 |
|
必須。永続的なOAM_LANG_PREF Cookieの存続期間を示します。 |
|
必須。OAM_LANG_PREF Cookieのドメインを定義します。 |
langPrefOrder |
必須。言語の優先順位を決定します。構文と例としてフォーマットする必要があります。許容される値セットは、(serverOverrideLangPref,oamPrefsCookie,browserAcceptLanguage,defaultLanguage)です。 "oamPrefsCookie, browserAcceptLanguage, serverOverrideLangPref" |
|
Access Managerのサーバー側言語言語コードで定義し、OAM対応の言語から選択している必要があります。デフォルト値はenです。 |
defaultLanguage |
デフォルト言語。 |
|
カンマ区切りリストに定義されているサポートされている言語。 |
表2-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="")
2.1.13 configRequestCacheType
configRequestCacheTypeコマンドはオンラインおよびオフライン・コマンドで、システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義します。
説明
システム構成内にSSOサーバー・リクエスト・キャッシュ・タイプを定義します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
configRequestCacheType(type="<requestCacheType>", domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
必須。リクエスト・キャッシュ・タイプを指定します。値としてBASICまたはCOOKIEを取ります。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、リクエスト・キャッシュ・タイプをCookieとして定義します。
configRequestCacheType(type="COOKIE")
2.1.14 displayRequestCacheType
displayRequestCacheTypeコマンドはオンラインおよびオフライン・コマンドで、指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプを表示します。リクエスト・キャッシュ・タイプは、BASICまたはCOOKIEです。
説明
指定されたドメインに対して定義されているSSOサーバー・リクエスト・キャッシュ・タイプ・エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayRequestCacheType(domainHome="<domainHome>")
引数 | 定義 |
---|---|
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、指定されたドメイン・ホームに対して定義されているリクエスト・キャッシュ・タイプ(BASICまたはCOOKIE)を表示します。
displayRequestCacheType(domainHome="domainHome1")
2.1.15 editOssoAgent
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>")
引数 | 定義 |
---|---|
|
必須。変更するOSSOエージェント・エントリの名前を指定します。 adminIdは、OSSOエージェントの管理者IDです(オプション)。 adminInfoは、OSSOエージェントの管理者情報です(オプション)。 |
|
オプション。OSSOエージェント・インスタンスのエージェント名を指定します。 |
|
オプション。認証の要求時にパートナが使用するアプリケーション・トークンを指定します。 |
|
オプション。OSSOエージェント・インスタンスのSiteName/ServerNameを指定します。 |
|
オプション。認証が成功した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。 |
|
オプション。認証が失敗した場合に、OSSOエージェントが使用するリダイレクトURLを指定します。 |
|
オプション。認証後、ホーム・ページで使用するリダイレクトURLを指定します。 |
|
オプション。ユーザーがログアウトしたときに使用するリダイレクトURLを指定します。 |
|
オプション。アプリケーションへのログインがサーバーによって許可される最初の年月日を指定します。 |
|
オプション。アプリケーションへのログインがサーバーによって許可される最後の年月日を指定します。 |
|
オプション。OSSOエージェントの管理者ログインIDを指定します。 |
|
オプション。トラッキング目的の、OSSOエージェントの管理者IDを指定します。 |
|
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")
2.1.16 deleteOssoAgent
deleteOssoAgentコマンドはオンラインおよびオフライン・コマンドで、システム構成内の、指定されたOSSOエージェントの登録を削除できます。
説明
システム構成内の、指定されたOSSOエージェントの登録を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
deleteOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。削除するOSSOエージェント・エントリの名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、OSSOAgent1
という名前のOSSOエージェントの登録エントリを削除します。
deleteOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")
2.1.17 displayOssoAgent
displayOssoAgentコマンドはオンラインおよびオフライン・コマンドで、システム構成内の、指定されたOSSOエージェント・エントリの詳細を表示します。
説明
Access Manager管理コンソールに、指定されたOSSOエージェント・エントリの詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayOssoAgent(agentName="<AgentName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。表示するOSSOエージェント・エントリの名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、OSSOAgent1
エントリの詳細を表示します。
displayOssoAgent(agentName="OSSOAgent1", domainHome="domainHome1")
2.1.18 editWebgateAgent
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>")
引数 | 定義 |
---|---|
|
必須。変更するWebゲート・エージェントの名前を指定します。 |
|
オプション。Webゲート・エージェントのアクセス・クライアント・パスワードを指定します。 |
|
オプション。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。 |
|
オプション。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。 |
|
オプション。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます) |
|
オプション。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。 |
|
オプション。Access Managerエージェントのデプロイ先のWebサーバー・ドメインを指定します。たとえば、acompany.comです |
|
オプション。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1 |
|
オプション。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000 |
|
オプション。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルト = 1800(秒) |
|
オプション。ObSSOCookieが保持される時間を指定します。デフォルト = 3600(秒) |
|
オプション。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルト = 3600(秒) |
|
ドメイン・ホームの場所を指定します。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
|
オプション。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルト = 1 |
|
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")
2.1.19 deleteWebgateAgent
deleteWebgateAgentコマンドはオンラインおよびオフライン・コマンドで、システム構成内のWebgate_agent登録エントリを削除できます。
説明
システム構成から指定されたWebgate_agent登録エントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
deleteWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。削除するWebゲート・エージェントの名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、WebgateAgent1
という名前のWebゲート・エージェントを削除します。
deleteWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")
2.1.20 displayWebgateAgent
displayWebgateAgentコマンドはオンラインおよびオフライン・コマンドで、Access Manager管理コンソール内に指定されたWebgate_agent登録エントリのすべての詳細を表示します。
説明
Access Manager管理コンソールに、指定されたWebgate_agent登録エントリのすべての詳細を表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayWebgateAgent(agentName="<AgentName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。表示するWebゲート・エージェントの名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、WebgateAgent1
のエントリの詳細を表示します。
displayWebgateAgent(agentName="WebgateAgent1", domainHome="domainHome1")
2.1.21 exportPolicy
exportPolicyコマンドはオンライン・コマンドで、テスト(ソース)環境から指定された中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。
説明
テスト(ソース)環境から中間Access ManagerファイルにAccess Managerポリシー・データをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
exportPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。一時Access Managerファイルへの絶対パスを指定します。 |
例
次の例では、テスト(ソース)環境からポリシー・データをエクスポートするときに使用するtempfile.txt
ファイルへのパスを指定します。
exportPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt")
2.1.22 importPolicy
importPolicyコマンドはオンライン・コマンドで、指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。
説明
指定されたAccess ManagerファイルからAccess Managerポリシー・データをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
importPolicy(pathTempOAMPolicyFile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。一時Access Managerファイルへの絶対パスを指定します。 |
例
次の例では、ポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile.txt
ファイルへのパスを指定します。
importPolicy(pathTempOAMPolicyFile="/exampleroot/parent/tempfile.txt")
2.1.23 importPolicyDelta
importPolicyDeltaコマンドはオンライン・コマンドで、指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。
説明
指定されたAccess ManagerファイルからAccess Managerポリシーの変更をインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
importPolicyDelta(pathTempOAMPolicyFile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。一時Access Managerファイルへの絶対パスを指定します。 |
例
次の例では、変更されたポリシー・データを本番(ターゲット)環境にインポートするときに使用するtempfile_delta.txt
ファイルへのパスを指定します。
importPolicyDelta(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_delta.txt")
2.1.24 migratePartnersToProd
migratePartnersToProdコマンドはオンライン・コマンドで、現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行します。
説明
現在の(ソース)Access Managerサーバーから指定された(ターゲット)Access Managerサーバーにパートナを移行します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
migratePartnersToProd(prodServerHost="<host>", prodServerPort="<port>", prodServerAdminUser="<user>", prodServerAdminPwd="<passwd>")
引数 | 定義 |
---|---|
|
パートナの移行先となるターゲットAccess Managerサーバーのホスト名。 |
|
パートナの移行先となるターゲットAccess Managerサーバーのポート。 |
|
パートナの移行先となるターゲットAccess Managerサーバーの管理者。 |
|
ターゲットAccess Managerサーバーの管理者のパスワード。 |
例
次の例では、パートナの移行に必要な情報を指定します。
migratePartnersToProd(prodServerHost="myhost", prodServerPort="1234", prodServerAdminUser="weblogic", prodServerAdminPwd="welcome")
2.1.25 exportPartners
exportPartnersコマンドはオンライン・コマンドで、ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートします。
説明
ソースから指定されたAccess ManagerファイルにAccess Managerパートナをエクスポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
exportPartners(pathTempOAMPartnerFile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。一時Access Managerファイルへの絶対パスを指定します。 |
例
次の例では、Access Managerパートナ・ファイルへの絶対パスを指定します。
exportPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml")
2.1.26 importPartners
importPartnersコマンドはオンライン・コマンドで、指定されたAccess ManagerファイルからAccess Managerパートナをインポートします。
説明
指定されたAccess ManagerファイルからAccess Managerパートナをインポートします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
importPartners(pathTempOAMPartnerFile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。一時Access Managerパートナ・ファイルへのパスを指定します。 |
例
次の例では、パートナのインポート元となるAccess Managerファイルへの絶対パスを指定します。
importPartners(pathTempOAMPolicyFile="/exampleroot/parent/tempfile_partners.xml")
2.1.27 displayTopology
displayTopologyコマンドはオンラインおよびオフライン・コマンドで、デプロイメント内のすべてのAccess Managerサーバーに関する情報を表示します。
説明
デプロイ済のAccess Managerサーバーのトポロジを一覧表示します。
構文
displayTopology(domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、指定されたドメイン・ホーム内のデプロイ済のすべてのAccess Managerサーバーの詳細を一覧表示します。
displayTopology(domainHome="domainHome1")
2.1.28 configureOAAMPartner
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>")
引数 | 定義 |
---|---|
|
必須。作成するデータ・ソースの名前を指定します。 |
|
必須。データベース・ホストの名前を指定します。 |
|
必須。データベース・ポート番号を指定します。 |
|
必須。データベース・サービス名を指定します。 |
|
必須。OAAMスキーマ名を指定します。 |
|
必須。OAAMスキーマ・パスワードを指定します。 |
|
オプション。接続予約タイムアウトの最大値を指定します。 |
|
オプション。接続プールの最大サイズを指定します。 |
|
オプション。データ・ソースのターゲット・サーバーを指定します。 |
例
次の例では、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")
2.1.29 registerOIFDAPPartner
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")
引数 | 定義 |
---|---|
|
必須。キーストア・ファイル(Identity Federationサーバーで生成されたもの)の場所を指定します。 |
|
必須。Identity FederationサーバーのログアウトURLを指定します。 |
|
オプション。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")
2.1.30 registerOIFDAPPartnerIDPMode
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")
引数 | 定義 |
---|---|
|
必須。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")
2.1.31 registerThirdPartyTAPPartner
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")
引数 | 定義 |
---|---|
|
必須。パートナの名前を指定します。サード・パーティのパートナの識別に使用する任意の名前を指定できます。 |
|
必須。キーストア・ファイルの場所を指定します。 |
|
必須。キーストア・ファイルのパスワードを指定します。 |
|
必須。Trusted Authentication Protocolのバージョンを指定します。 |
|
オプション。リソースの保護に使用するTAPScheme名を指定します(TAPSchemeは即時利用可能)。 |
|
オプション。資格証明コレクタのリダイレクト先となるTAPチャレンジURLを指定します。 |
例
次の例では、パラメータの使用例を示します。
registerThirdPartyTAPPartner(partnerName = "ThirdPartyTAPPartner", keystoreLocation="/scratch/DAPKeyStore/mykeystore.jks", password="test", tapTokenVersion="v2.0", tapScheme="TAPScheme", tapRedirectUrl="http://thirdpartyserverhost:port/loginPage.jsp")
2.1.32 disableCoexistMode
disableCoexistModeコマンドはオンライン・コマンドで、共存モードを無効にします。
説明
共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。
構文
disableCoexistMode()
例
次の例では、共存モードを無効にします。
disableCoexistMode()
2.1.33 enableOamAgentCoexist
enableOamAgentCoexistコマンドはオンライン・コマンドで、Access Managerエージェントの共存モードを有効にします(10g Webゲートによって設定されたObssocookieを所有するために、Access Manager 11gサーバーを有効にします)。
説明
Access Managerエージェントの共存モードを有効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。
構文
enableOamAgentCoexist()
例
次の例では、共存モードを有効にします。
enableOamAgentCoexist
2.1.34 disableOamAgentCoexist
disableOamAgentCoexistコマンドはオンライン・コマンドで、Access Managerエージェントの共存モードを無効にします。
説明
Access Managerエージェントの共存モードを無効にします。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。このコマンドには引数はありません。
構文
disableOamAgentCoexist()
例
次の呼出しは、共存モードを有効にします。
disableOamAgentCoexist
2.1.35 editGITOValues
editGITOValuesコマンドはオンラインおよびオフライン・コマンドで、GITO構成パラメータを編集します。
説明
GITO構成パラメータを編集します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com", gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20", gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")
引数 | 定義 |
---|---|
|
ユーザーによるGITO対応プロパティの設定を許可(または拒否)します。値としてtrueまたはfalseを取ります。 |
|
必須。GITO Cookieドメインを指定します。 |
|
オプション。Cookie名を指定します。 |
|
オプション。GITOバージョンを指定します。値としてv1.0またはv3.0のみを取ります。 |
|
オプション。GITOタイムアウト値を指定します。 |
|
オプション。GITO Cookie対応プロパティを有効にします。値としてtrueまたはfalseを取ります。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、GITO構成パラメータを編集します。
editGITOValues(gitoEnabled="true", gitoCookieDomain=".abc.com", gitoCookieName="ABC", gitoVersion="v1.0", gitoTimeout="20", gitoSecureCookieEnabled="false", domainHome="/abc/def/ijk")
2.1.36 editWebgate11gAgent
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>")
引数 | 定義 |
---|---|
|
必須。変更する11g Webゲート・エージェントの名前を指定します。 |
|
オプション。このWebゲート・エージェントの一意のクライアント・パスワードを指定します。 |
|
オプション。Webゲート・エージェントを有効にするか、無効にするかを指定します。値はそれぞれ、EnabledまたはDisabledです。 |
|
オプション。Webゲート・エージェントの優先ホストを指定します。これにより、ホストの識別子がホスト識別子リストに含まれていない場合に生じる可能性があるセキュリティ・ホールを防ぐことができます。仮想ホスティングでは、ホスト識別子機能を使用する必要があります。 |
|
オプション。Access Managerランタイム・サーバーからの応答を待機する秒数を指定します。このパラメータが設定された場合、アプリケーションのTCP/IPタイムアウトとして、デフォルトのTCP/IPタイムアウトではなくこの値が使用されます。デフォルト = -1(デフォルトのネットワークTCP/IPタイムアウトが使用されます) |
|
オプション。Access Managerランタイム・サーバーに対するトランスポート・セキュリティのレベルを指定します。値としてopen、simpleまたはcertのいずれかを取ります。 |
|
ログアウト・ハンドラをトリガーするURLのリスト。ログアウト・ハンドラは、ObSSOCookieを削除します。 |
|
オプション。このAccess ManagerエージェントがAccess Managerサーバーで確立できる接続の最大数を指定します。この数は、このエージェントに実際に関連付けられている接続の数と同じか、それを超える数である必要があります。デフォルト = 1 |
|
オプション。キャッシュ内で維持される要素の最大数を指定します。キャッシュ要素は、URLまたは認証スキームです。この設定の値は、これら両方のキャッシュ内の要素の最大合計カウントを意味します。デフォルト = 10000 |
|
オプション。キャッシュされた情報が使用も参照もされない場合に、その情報がAccess Managerエージェント・キャッシュ内にとどまる時間を指定します。デフォルト = 1800(秒) |
|
oam_logout_successへのURL。oam_logout_successは、コールバック中にCookieをクリアします。デフォルトでは、これは、エージェントの登録時に指定されたエージェント・ベースURLに基づきます。たとえば:
|
|
オプション。ユーザーの認証セッションが、そのアクティビティに関係なく有効である最大時間(秒単位)を指定します。この時間が経過すると、ユーザーは、再度認証を求められます。これは強制的なログアウトです。値0を指定すると、このタイムアウト設定は無効になります。デフォルト = 3600(秒) |
|
オプション。中央ログアウト・ページ(logout.html)へのURL(絶対パス)を指定します。デフォルトでは、これは、デフォルト・ポート14200のAccess Manager管理コンソールのホスト名に基づきます。 |
|
オプション。このAccess ManagerエージェントがセカンダリAccess Managerサーバーへの接続をオープンするときのポイントを表す数を指定します。デフォルト = 1 |
|
オプション。Access Managerエージェントで保護されているリソースにアクセスすることなく、ユーザーの認証セッションが有効である時間(秒単位)を指定します。 |
|
オプション。この値は、ログアウト時に呼び出され、OPSSレベルで構成されるログアウト・ターゲットURLです。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
|
オプション。管理操作の許可のフラグを設定します |
|
オプション。トークン・スコープ操作の許可のフラグを設定します |
|
オプション。次を指定します |
|
マスター・トークン取得の許可のフラグを設定します |
|
資格証明コレクタ操作の許可のフラグを設定します |
例
次の例では、必須のパラメータとオプションのパラメータをすべて使用しています。
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")
2.1.37 deleteWebgate11gAgent
deleteWebgate11gAgentコマンドはオンラインおよびオフライン・コマンドで、システム構成内の11g Webgate_agentエントリを削除できます。
説明
システム構成内の11g Webgate_agentエントリを削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
deleteWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。削除する11g Webゲート・エージェントの名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、my_11gWebGate
という名前の11g Webgate_agentエントリを削除します。
deleteWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")
2.1.38 displayWebgate11gAgent
displayWebgate11gAgentコマンドはオンラインおよびオフライン・コマンドで、11g Webgate_agent登録エントリを表示できます。
説明
11g Webゲート・エージェント登録エントリを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayWebgate11gAgent(agentName="<AgentName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。変更する11g Webゲート・エージェントの名前を指定します。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、my_11gWebGate
という名前のWebゲート・エージェントを表示します。
displayWebgate11gAgent(agentName="my_11gWebGate", domainHome="domainHome1")
2.1.39 displayOAMMetrics
displayOAMMetricsコマンドはオンラインおよびオフライン・コマンドで、Access Managerサーバーのメトリックを表示できます。
説明
Access Managerサーバーのメトリックを表示します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
displayOAMMetrics(domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、指定されたドメイン内のAccess Managerサーバーのメトリックを表示します。
displayOAMMetrics(domainHome="domainHome1")
2.1.40 updateOIMHostPort(非推奨)
非推奨 - Access Managerとの統合時にOracle Identity Manager構成を更新するオンラインのみのコマンド。
説明
システム構成内のIdentity Manager構成を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
updateOIMHostPort(hostName="<host name>", port="<port number>", secureProtocol="true")
引数 | 定義 |
---|---|
|
Identity Managerホストの名前。 |
|
Identity Managerホストのポート。 |
|
通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。 |
例
次の例では、このコマンドの使用例を示します。
updateOIMHostPort(hostName="OIM.oracle.com", port="7777", secureProtocol="true")
2.1.41 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>")
引数 | 定義 |
---|---|
|
Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。 |
|
Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。 |
|
通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。 |
|
指定する場合は、オープン・モードのエージェント・パスワード。 |
|
Cookieが設定されるドメイン。 |
|
エージェントの登録名。 |
|
可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。 |
例
次の例では、このコマンドの使用例を示します。
configureOIM(oimHost="oracle.com", oimPort="7777", oimSecureProtocolEnabled="true", oimAccessGatePwd = "welcome", oimCookieDomain = "domain1", oimWgId="<OIM Webgate ID>", oimWgVersion="10g")
2.1.42 updateOSSOResponseCookieConfig
updateOSSOResponseCookieConfigコマンドはオンラインおよびオフライン・コマンドで、OSSOプロキシ・レスポンスCookie設定を更新します。
説明
OSSOプロキシ・レスポンスCookie設定を更新します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
updateOSSOResponseCookieConfig(cookieName="<cookieName>",cookieMaxAge="<cookie age in minutes>", isSecureCookie="true | false",cookieDomain="<domain of the cookie>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
オプション。設定が更新されるCookieの名前。指定しない場合、グローバル設定が更新されます。 |
|
Cookieの最大保持時間(分単位)。負の値の場合、セッションCookieが設定されます。 |
|
Cookieを保護する(SSLチャネルで送信する)かどうかを指定するブール・フラグ。 |
|
Cookieのドメイン。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、このコマンドの使用例を示します。
updateOSSOResponseCookieConfig(cookieName = "ORASSO_AUTH_HINT", cookieMaxAge = "525600", isSecureCookie = "false", cookieDomain=".example.com", domainHome = "<domain_home>")
2.1.43 deleteOSSOResponseCookieConfig
deleteOSSOResponseCookieConfigコマンドはオンラインおよびオフライン・コマンドで、システム構成内のOSSOプロキシ・レスポンスCookie設定を削除します。
説明
OSSOプロキシ・レスポンスCookie設定を削除します。このコマンドの有効範囲は、インスタンスのみであって、引数ではありません。
構文
deleteOSSOResponseCookieConfig(cookieName="<cookieName>", domainHome="<domainHomeName>")
引数 | 定義 |
---|---|
|
必須。設定が削除されるCookieの名前。グローバルCookie設定は削除できません。 |
|
Weblogic Serverの場所またはWebSphereのセル・パスを指定します。このパラメータはWebSphereでは必須です。オフラインの場合、この値は必須です。オンラインの場合はオプションです。 |
例
次の例では、このコマンドの使用例を示します。
deleteOSSOResponseCookieConfig(cookieName="ORASSO_AUTH_HINT", domainHome = "<domain_home>")
2.1.44 configureAndCreateIdentityStore
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>"
引数 | 定義 |
---|---|
|
Oracle Identity Managerホストの名前。EDGの場合は、OIMクラスタのフロント・エンドLBRホスト名。 |
|
Oracle Identity Manager管理対象サーバーのポート。EDGの場合は、OIM管理対象サーバー・クラスタのフロント・エンドLBRポート。 |
|
通信がHTTP経由かHTTPS経由かに応じて、値にtrueまたはfalseを取ります。 |
|
指定する場合は、オープン・モードのエージェント・パスワード。 |
|
Cookieが設定されるドメイン。 |
|
エージェントの登録名。 |
|
可能な値は10gまたは11gです。指定しない場合、デフォルトは10gです。 |
|
必須。作成するLDAPアイデンティティ・ストアの名前を指定します。 |
|
必須。作成するLDAPアイデンティティ・ストアのプリンシパルのパスワードを指定します。 |
|
必須。作成するLDAPアイデンティティ・ストア内の、ユーザー・データが格納されるノードを指定します。 |
|
必須。作成するLDAPアイデンティティ・ストアのLDAPホストのURL(ポート番号を含みます)を指定します。 |
|
必須。作成するLDAPアイデンティティ・ストア内の、グループ・データが格納されるノードを指定します。 |
|
必須。作成するLDAPアイデンティティ・ストアのプリンシパル管理者を指定します。 |
|
必須。作成するLDAPアイデンティティ・ストアのタイプを指定します。 |
|
作成するストアのLDAPプロバイダ・タイプを指定します。 |
|
オプション。登録するLDAPアイデンティティ・ストアがプライマリ・アイデンティティ・ストアであるかどうかを指定します。値としてtrueまたはfalseを取ります。 |
|
作成するストアのユーザー・アイデンティティ・プロバイダを指定します。 |
|
必須。ストアのユーザー属性を指定します。 |
例
次の例では、このコマンドの使用例を示します。
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")
2.1.45 configAndCreateIdStoreUsingPropFile
configAndCreateIdStoreUsingPropFileコマンドはオンライン・コマンドで、プロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。
説明
指定されたプロパティ・ファイル内に指定されている値を使用して、アイデンティティ・ストアおよび外部ユーザー・ストアを構成します。
構文
configAndCreateIdStoreUsingPropFile(path="<path_of_property_file>")
引数 | 定義 |
---|---|
|
値が定義されているプロパティ・ファイルへのパス。 |
例
次の例では、このコマンドの使用例を示します。
configAndCreateIdStoreUsingPropFile(path="/prop_file_directory/values.properties")
2.1.46 manageAuditEvents
$$manageAuditEvents
コマンドは、特定のタイプのイベントの監査を無効にする場合に使用します。
説明
manageAuditEvents
は、特定のタイプのイベントの監査を無効にできるイベント・タイプ・フィルタです。このコマンドは、オンライン・モード(domainRuntime()
の実行後)またはオフライン・モードで実行できます。
構文
manageAuditEvents(eventType="<event type>",auditEnabled="<true|false>",[eventStatus="<true|false>"],[presetFilter="<All|Medium|Low>"])
引数 | 定義 |
---|---|
eventType |
必須 フィルタするイベント・タイプを指定します。その値は、 |
auditEnabled |
必須 trueに設定すると、監査が無効になります。 trueに設定することは、フィルタを削除することと同じです。 |
eventStatus |
オプション 特定のイベント・ステータスのイベントの監査を有効または無効にします。 true (false)に設定するとイベントの監査のみが無効になり、そのステータスはtrue (false)です。 |
presetFilter |
オプション 指定した事前設定フィルタに対してのみフィルタをアクティブ化します。 |
例2-1 例
次のコマンドは、オフライン・モードで、すべてのPluginInvocationStart
イベントの監査を無効にします。
manageAuditEvents(eventType="PluginInvocationStart",auditEnabled="false",domainHome="/MW_HOME/user_projects/domains/oam_domain")
次のコマンドは、オンライン・モードで、正常終了したAuthorization
イベントの監査を無効にします。
manageAuditEvents(eventType="Authorization",auditEnabled="false",eventStatus="true")
次のコマンドは、オンライン・モードで、Authorization
タイプのすべてのイベントの監査を無効にします。
manageAuditEvents(eventType="Authorization",auditEnabled="false")
2.1.47 migrateArtifacts (非推奨)
非推奨 - アーティファクトを移行します。
説明
入力アーティファクト・ファイル内に定義されている値に基づいてアーティファクトを移行します。
構文
migrateArtifacts(path="<path_to_artifacts_file>", password="<password>", type="OutOfPlace|InPlace", isIncremental="true|false")
引数 | 定義 |
---|---|
|
アーティファクト・ファイルの場所 |
|
元のアーティファクトの生成時に使用されたパスワード。 |
|
移行のタイプを定義するブール値で、値としてInPlaceまたはOutOfPlaceを取ります |
|
ブール値(値としてtrueまたはfalseを取ります)。trueの場合、増分アップグレードが実行されます。 |
例
次の例では、このコマンドの使用例を示します。
migrateArtifacts(path="/exampleroot/parent/t", password="welcome", type="InPlace", isIncremental="false")
2.1.48 displaySimpleModeGlobalPassphrase
displaySimpleModeGlobalPassphraseコマンドはオンライン・コマンドで、システム構成で定義されている簡易モードのグローバル・パスフレーズを平文で表示します。
説明
簡易モードのグローバル・パスフレーズを平文で表示するオンラインのみのコマンド。このコマンドには引数はありません。
構文
displaySimpleModeGlobalPassphrase()
例
次の例では、このコマンドの使用例を示します。
displaySimpleModeGlobalPassphrase()
2.1.49 exportSelectedPartners
exportSelectedPartnersコマンドはオンライン・コマンドで、指定されたAccess Managerファイルから選択されたAccess Managerパートナをインポートします。
説明
指定されたAccess Managerファイルに、選択されたAccess Managerパートナをエクスポートします。
構文
exportSelectedPartners(pathTempOAMPartnerFile="<absoluteFilePath>", partnersNameList="<comma_separated_partner_names>")
引数 | 定義 |
---|---|
|
必須。情報のエクスポート先となるファイルの場所。 |
|
必須。エクスポートされるパートナIDのカンマ区切りのリストを指定します。 |
例
次の例では、このコマンドの使用例を示します。
exportSelectedPartners(pathTempOAMPartnerFile="/exampleroot/parent/tempfile.extn" partnersNameList="partner1,partner2")
2.1.50 oamMigrate
oamMigrateコマンドはオンライン・コマンドで、OSSO、OAM10g、OpenSSOまたはAM 7.1からOAM11gにポリシー、認証ストアおよびユーザー・ストアを移行します。
説明
移行フレームワークMBeanのbeginMigrate
操作を呼び出します。
構文
oamMigrate(oamMigrateType=<migrationType>, pathMigrationPropertiesFile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。実行する移行のタイプを指定します。値として次のいずれかを取ります: OSSO | OpenSSO | OAM10g ノート: OpenSSOはSAML 7.1とOpenSSOの両方に適用します。 |
|
必須。移行のために必要なアーティファクトの読取り元となるファイルへのパスを指定します。 |
例
次の例では、このコマンドの使用例を示します。
oamMigrate(oamMigrateType=OSSO, pathMigrationPropertiesFile="/middlewarehome/oam-migrate.properties")
2.1.51 preSchemeUpgrade
preSchemeUpgradeコマンドはオンライン・コマンドで、preSchemeUpgrade操作を呼び出します。
説明
preSchemeUpgrade操作を呼び出します。
構文
preSchemeUpgrade (pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")
引数 | 定義 |
---|---|
|
必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。 |
例
次の例では、このコマンドの使用例を示します。
preSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")
2.1.52 postSchemeUpgrade
postSchemeUpgradeコマンドはオンライン・コマンドで、postSchemeUpgrade操作を呼び出します。
説明
postSchemeUpgrade操作を呼び出します。
構文
postSchemeUpgrade (pathUpgradePropertiesFile="/middlewarehome/oam-upgrade.properties")
引数 | 定義 |
---|---|
|
必須。アップグレードのために必要なシステム・プロパティの読取り元となるファイルへのパスを指定します。 |
例
次の例では、このコマンドの使用例を示します。
postSchemeUpgrade(pathUpgradePropertiesFile="/exampleroot/parent/tempfile.extn")
2.1.53 oamSetWhiteListMode
oamSetWhiteListModeコマンドはオンライン・コマンドで、oamSetWhiteListMode
をtrueまたはfalseに設定します。
説明
oamSetWhiteListMode
をtrueまたはfalseに設定します。trueの場合、Access Managerは、使用アプリケーションによって要求された最後のURLにリダイレクトされます(そのURLがホワイトリストURLとして構成されている場合のみ)。
構文
oamSetWhiteListMode(oamWhiteListMode="true|false")
引数 | 定義 |
---|---|
|
必須。Access Managerのホワイトリスト・モードを有効にします。 |
例
次の例では、このコマンドの使用例を示します。
oamSetWhiteListMode(oamWhiteListMode="true")
2.1.54 oamWhiteListURLConfig
oamWhiteListURLConfigコマンドはオンライン・コマンドで、指定された追加、更新または削除操作に基づいて、指定されたファイルにおいて、ホワイトリストURLエントリで操作を実行します。
説明
指定されたファイルにおいて、ホワイトリストURLエントリを追加、更新または削除します。
このコマンドでは、ワイルドカードのポート/ホストが設定されたホワイトリストURLをホワイトリスト構成マップに入力できます。
ワイルドカード文字(*記号)を使用したホスト/ポートが値フィールドに指定されている場合は、その特定の書式に属するすべてのホスト/ポートが許可されます。
*記号を追加すると、ワイルドカード比較メカニズムに基づいてホワイトリストURLに対する照合が実行されます。
構文
oamWhiteListURLConfig(Name="xyz", Value="http://xyz.com:1234", Operation="Remove|Update")
引数 | 定義 |
---|---|
|
必須。このエントリの名前(キー)を表す有効な文字列。 |
|
必須。<protocol>://<host>:<port>という形式の有効なURL。ポートが指定されない場合、デフォルトのHTTP/HTTPSポートがそれぞれ割り当てられます。 |
|
必須。値として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がリダイレクション用に許可されます。
2.1.55 enableMultiDataCentreMode
enableMultiDataCentreModeコマンドはオンライン・コマンドで、マルチ・データ・センター・モードを有効にします。
説明
マルチ・データ・センター・モードを有効にします。
構文
enableMultiDataCentreMode(propfile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。マルチ・データ・センターを有効にするためのプロパティの読取り元となるファイルへの絶対パスを指定します。 |
例
次の例では、このコマンドの使用例を示します。
enableMultiDataCentre(propfile="/middlewarehome/oamMDCProperty.properties")
2.1.56 disableMultiDataCentreMode
disableMultiDataCentreModeコマンドはオンライン・コマンドで、マルチ・データ・センター・モードを無効にします。
説明
マルチ・データ・センター・モードを無効にします。このコマンドには、引数はありません。
構文
disableMultiDataCentreMode()
例
次の例では、このコマンドの使用例を示します。
disableMultiDataCentreMode()
2.1.57 setMultiDataCentreClusterName
setMultiDataCentreClusterNameコマンドはオンライン・コマンドで、マルチ・データ・センター・クラスタ名を設定します。
説明
マルチ・データ・センター・クラスタ名を設定します。
構文
setMultiDataCentreClusterName(clusterName="MyCluster")
引数 | 定義 |
---|---|
|
必須。クラスタの名前を指定します。 |
例
次の例では、このコマンドの使用例を示します。
postSchemeUpgrade(clusterName="MyCluster")
2.1.58 setMultiDataCentreLogoutURLs
setMultiDataCentreLogoutURLsコマンドはオンライン・コマンドで、マルチ・データ・センター・パートナ・ログアウトURLを設定します。
説明
マルチ・データ・センター・パートナ・ログアウトURLを設定します。
構文
setMultiDataCentreLogoutURLs (logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")
引数 | 定義 |
---|---|
|
必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。 |
例
次の例では、このコマンドの使用例を示します。
setMultiDataCentreLogoutURLs(logoutURLs="http://localhost:6666/logout.jsp,http://localhost:8888/logout.jsp")
2.1.59 updateMultiDataCentreLogoutURLs
updateMultiDataCentreLogoutURLsコマンドはマルチ・データ・センター・パートナ・ログアウトURLを更新します。
説明
マルチ・データ・センター・パートナ・ログアウトURLを更新します。
構文
updateMultiDataCentreLogoutURLs (logoutURLs="http://<host>:<port>/logout.jsp,http://<host>:<port>/logout.jsp")
引数 | 定義 |
---|---|
|
必須。マルチ・データ・センター・パートナ・ログアウトURLのカンマ区切りのリストを指定します。 |
例
次の例では、このコマンドの使用例を示します。
updateMultiDataCentreLogoutURLs(logoutURLs="http://localhost:7777/logout.jsp,http://localhost:9999/logout.jsp")
2.1.60 addPartnerForMultiDataCentre
addPartnerForMultiDataCentreコマンドはオンライン・コマンドで、マルチ・データ・センターにパートナを追加します。
説明
マルチ・データ・センターにパートナを追加します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを追加します。
構文
addPartnerForMultiDataCentre(propfile="<absoluteFilePath>")
引数 | 定義 |
---|---|
|
必須。エージェント情報を含むファイルへの絶対パスを指定します。 |
例
次の例では、このコマンドの使用例を示します。
addPartnerForMultiDataCentre(propfile="/middlewarehome/partnerInfo.properties")
2.1.61 removePartnerForMultiDataCentre
removePartnerForMultiDataCentreコマンドはオンライン・コマンドで、マルチ・データ・センターからパートナを削除します。
説明
マルチ・データ・センターからパートナを削除します。このコマンドは、オンライン・モードでのみサポートされ、一度に1つのパートナを削除します。
構文
removePartnerForMultiDataCentre(webgateid="<webgateId")
引数 | 定義 |
---|---|
|
必須。削除するパートナのIDを指定します。 |
例
次の例では、このコマンドの使用例を示します。
removePartnerForMultiDataCentre(webgateid="IAMSuite")
2.1.62 addOAMSSOProvider
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")