CLI 初期化メソッド

目次
casso1283
目次
CreateSession メソッド - ポリシー サーバ セッションを作成
CreateSession メソッドは、ポリシー サーバ セッションを作成します。ポリシー サーバ オブジェクトを操作するには、その前にセッションが必要です。必要な初期化およびログ記録はすべてこの段階で実行されます。
構文
CreateSession メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->CreateSession(username, userpwd[, clientIP])
[Parameters]
CreateSession メソッドは、以下のパラメータを受け入れます。
  1. username
    (文字列)
    管理者のログイン ID を指定します。
  2. userpwd
    (文字列)
    管理者のパスワードを指定します。
  3. clientIP
    (文字列)
    (オプション)ローカル マシンの IP アドレスを指定します。
CreateSession メソッドは以下のいずれかの値を返します。
  • PolicyMgtSession オブジェクト
  • コールに失敗した場合は、
    undef
DisableAudit メソッド - 監査を有効または無効にするフラグを設定
DisableAudit メソッドは、監査を有効または無効にするフラグを設定します。
構文
DisableAudit メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->DisableAudit([auditFlag])
[Parameters]
DisableAudit メソッドは以下のパラメータを受け入れます。
  1. auditFlag
    (int)
    (オプション)フラグを設定する値を指定します。
    • 監査を有効にするには 0
    • 監査を無効にするには 1
戻り値
DisableAudit メソッドは以下のいずれかの値を返します。
  • 引数が指定されない場合は、既存の有効化状態(0 または 1)。
  • フラグ値がメソッドに渡される場合は、新しい有効化状態。
注釈
以下の操作の有効化状態を読み込みまたは設定します。
認証、許可および管理アクティビティなどのユーザ アクティビティの監査。管理アクティビティには、ポリシー ストアへの変更が含まれます。
  • ユーザ セッションの監視。
デフォルト状態は有効化です。有効化状態は新しいセッションの開始時にデフォルトに戻ります。
PolicyMgtAPI->CreateSession メソッドをコールした後に、有効化状態の設定を試行しても効果はありません。
DisableCacheUpdates メソッド - 非推奨
DisbleCacheUpdates メソッドは
SiteMinder
v6.0 で廃止されました。このメソッドによって影響を受けるキャッシュは自動的に有効になります。
DisableManagementWatchDog メソッド -
SiteMinder
管理 Watchdog の有効化状態を読み取りまたは設定
DisableManagementWatchdog メソッドは、
SiteMinder
管理 Watchdog の有効化状態を読み取りまたは設定します。
注: ウォッチドッグは内部的に使用され無効にはしません。
構文
DisableManagementWatchdog メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->DisableManagementWatchDog([watchDogFlag])
[Parameters]
DisableManagementWatchdog メソッドは以下のパラメータを受け入れます。
  1. watchDogFlag
    (int)
    (オプション)設定するフラグの値を指定します。
    • WatchDog を有効にするには 0
    • WatchDog を無効にするには 1
戻り値
DisableManagementWatchdog メソッドは以下のいずれかの値を返します。
  • 引数が指定されない場合は、既存の有効化状態(0 または 1)。
  • フラグ値がメソッドに渡される場合は、新しい有効化状態。
注釈
デフォルト状態は有効化です。有効化状態は新しいセッションの開始時にデフォルトに戻ります。
PolicyMgtAPI->CreateSession をコールした後に、有効化状態の設定を試行しても効果はありません。
DisableValidation メソッド - ポリシー サーバ オブジェクトの検証の有効化状態を読み取りまたは設定
DisableValidation メソッドは、ポリシー サーバ オブジェクトの検証に関して有効化状態を読み込みまたは設定します。
構文
DisableValidation メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->DisableValidation([validationFlag])
[Parameters]
DisableValidation メソッドは以下のパラメータを受け入れます。
  1. validationFlag
    (int)
    (オプション)フラグを設定する値を指定します。
    • 検証を有効にするには 0
    • 検証を無効にするには 1
戻り値
DisableValidation メソッドは以下のいずれかの値を返します。
  • 引数が指定されない場合は、既存の有効化状態(0 または 1)。
  • フラグ値がメソッドに渡される場合は、新しい有効化状態。
注釈
デフォルト状態は有効化です。有効化状態は新しいセッションの開始時にデフォルトに戻ります。
PolicyMgtAPI->CreateSession メソッドをコールした後に、有効化状態の設定を試行しても効果はありません。
EnableCache メソッド - 非推奨
EnableCache メソッドは
SiteMinder
v6.0 で廃止されました。このリリース以降、このメソッドによって影響を受けるキャッシュは自動的に有効になります。
LoadAgentTypeDictionary メソッド - エージェント タイプ ディクショナリの有効化状態を読み取りまたは設定
LoadAgentTypeDirectory メソッドは、ポリシー サーバによるエージェント タイプ ディクショナリのロードの有効化状態を読み込みまたは設定します。
構文
LoadAgentTypeDirectory メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->LoadAgentTypeDictionary([loadFlag])
[Parameters]
LoadAgentTypeDirectory メソッドは以下のパラメータを受け入れます。
  1. loadFlag
    (int)
    (オプション)フラグを設定する値を指定します。
    エージェント タイプ ディクショナリのロードを無効にするには 0
    エージェント タイプ ディクショナリのロードを有効にするには 1
戻り値
LoadAgentTypeDirectory メソッドは以下のいずれかの値を返します。
  • 引数が指定されない場合は、既存の有効化状態(0 または 1)。
  • フラグ値がメソッドに渡される場合は、新しい有効化状態。
注釈
デフォルト状態は無効化です。有効化状態は新しいセッションの開始時にデフォルトに戻ります。
PolicyMgtAPI->CreateSession メソッドをコールした後に、有効化状態の設定を試行しても効果はありません。
New メソッド - ポリシー管理 API のコンストラクタ
New メソッドは、ポリシー管理 API のコンストラクタです。このメソッドは、ポリシー管理 API を使用する前にコールする必要があります。
構文
New メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->New( )
[Parameters]
New メソッドは、パラメータを受け入れません。
戻り値
New メソッドは以下のいずれかの値を返します。
  • PolicyMgtAPI オブジェクト
  • コールに失敗した場合は、
    undef
PreLoadCache メソッド - キャッシュの事前ロードの有効化状態を読み取りまたは設定
PreLoadCache メソッドは、ポリシー サーバによるキャッシュの事前ロードの有効化状態を読み込みまたは設定します。
構文
PreLoadCache メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->PreLoadCache([cacheFlag])
[Parameters]
PreLoadCache メソッドは以下のパラメータを受け入れます。
  1. cacheFlag
    (int)
    (オプション)フラグを設定する値を指定します。
    • 0 はキャッシュ事前ロードを無効にします
    • 1 はキャッシュ事前ロードを有効にします
戻り値
PreLoadCache メソッドは以下のいずれかの値を返します。
  • 引数が指定されない場合は、既存の有効化状態(0 または 1)。
  • フラグ値がメソッドに渡される場合は、新しい有効化状態。
注釈
デフォルト状態は無効化です。有効化状態は新しいセッションの開始時にデフォルトに戻ります。
PolicyMgtAPI->CreateSession メソッドをコールした後に、有効化状態の設定を試行しても効果はありません。
注: このフラグを無効にすると、ポリシー管理スクリプトを使用してポリシー ストアで変更を加えるのにかかる時間を短縮できます。
PrintDebugTrace メソッド - デバッグ(トレース)情報のサンプルの出力を有効化または無効化
PrintDebugTrace メソッドは、コンソールへのデバッグ(トレース)情報の出力を有効化または無効化します。
構文
PrintDebugTrace メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAPI->PrintDebugTrace([debugFlag])
[Parameters]
PrintDebugTrace メソッドは以下のパラメータを受け入れます。
  1. debugFlag
    (int)
    (オプション)フラグを設定する値を指定します。
    • 0 はトレース出力を無効にします
    • 1 はトレース出力を有効にします
戻り値
PrintDebugTrace メソッドは以下のいずれかの値を返します。
  • トレース出力が無効な場合は、0
  • トレース出力が有効な場合は、1