CLI ポリシー メソッド

ここでは、CLI ポリシー メソッドについて説明します。
casso1283
ここでは、CLI ポリシー メソッドについて説明します。
ActiveExpr メソッド - ポリシーに関連付けられたアクティブな式を設定または取得
ActiveExpr メソッドは、ポリシーに関連付けられたアクティブな式を設定または取得します。
構文
ActiveExpr メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->ActiveExpr([activeExpr])
[Parameters]
ActiveExpr メソッドは以下のパラメータを受け入れます。
  1. activeExpr
    (文字列)
    (オプション)設定するアクティブな式を指定します。
戻り値
ActiveExpr メソッドは以下のいずれかの値を返します。
  • 新規または既存のアクティブな式
  • コールに失敗した場合は、
    undef
AddRule メソッド - ポリシーにルールを追加
AddRule メソッドは、ポリシーにルールを追加します。
構文
AddRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->AddRule(rule)
[Parameters]
AddRule メソッドは以下のパラメータを受け入れます。
  1. rule
    (PolicyMgtRule)
    追加するルールを指定します。
戻り値
AddRule メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
AddUser メソッド - ポリシーにユーザを追加
AddUser メソッドは、ポリシーにユーザを追加します。
構文
AddUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->AddUser(user [, iExcludeUser] [, iRecursiveFlag] [, iANDUserFlag])
[Parameters]
AddUser メソッドは、以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser)
    追加するユーザを指定します。
  2. iExcludeUser
    (int)
    (オプション)ユーザを除外するかどうかを指定します。
    • 1 はユーザを除外します
    • 0 はユーザを含めます
  3. iRecursiveFlag
    (int)
    (オプション)AllowNested フラグの設定を指定します。
    • 1 は AllowNested フラグを設定します
    • 0 は AllowNested フラグを無効にします
  4. iANDUserFlag
    (int)
    (オプション)AND フラグの設定を指定します。
    1 は AND フラグを設定します
    0 は AND フラグを無効にします
戻り値
AddUser メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
AllowNested メソッド - AllowNested フラグを設定または取得
AllowNested メソッドは、AllowNested フラグを設定または取得します。
構文
AllowNested メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->AllowNested(user[, iRecursiveFlag])
[Parameters]
AllowNested メソッドは、以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser)
    AllowNested フラグを設定または取得する場合のユーザを指定します。
  2. iRecursiveFlag
    (int)
    (オプション)以下のように、
    AllowNested
    フラグの値を指定します。
    • 非再帰的な評価の場合は 1
    • 非再帰的な評価でない場合は 0
    この値が渡されない場合、関数は
    AllowNested
    フラグの現在の値を返します。フラグは、特定のユーザ ディレクトリのポリシーに追加されるすべてのユーザに適用されます。
戻り値
AllowNested メソッドは以下のいずれかの値を返します。
  • AllowNested フラグが正しく削除される場合は、0
  • AllowNested フラグが正しく設定される場合は、1
  • コールに失敗する場合は、-1
CreateIPHostConfigName メソッド - IP アドレス設定を作成
CreateIPConfigHostName メソッドは、メソッドに渡されるホスト名に基づいて IP アドレス設定を作成します。ポリシーを起動するには、要求を渡されたホスト名を持つマシンから行う必要があります。
構文
CreateIPConfigHostName メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->CreateIPConfigHostName(hostName)
[Parameters]
CreateIPConfigHostName メソッドは以下のパラメータを受け入れます。
  1. hostName
    (文字列)
    ポリシーを起動するのに必要なホスト名を指定します。
戻り値
CreateIPConfigHostName メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
CreateIPConfigRange メソッド - IP アドレス設定を作成
CreateIPConfigRange メソッドは、メソッドに渡される IP アドレスの範囲に基づいて IP アドレス設定を作成します。ポリシーを起動するには、範囲に含まれる IP アドレスを持つマシンから行う必要があります。
構文
CreateIPConfigRange メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->CreateIPConfigRange(ipAddr1, ipAddr2)
[Parameters]
CreateIPConfigRange メソッドは、以下のパラメータを受け入れます。
  1. ipAddr1
    (文字列)
    受け入れられたアドレス範囲内の開始 IP アドレスを指定します。
  2. ipAddr2
    (文字列)
    受け入れられたアドレス範囲内の終了 IP アドレスを指定します。
戻り値
CreateIPConfigRange メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
CreateIPConfigSingleHost メソッド - IP 設定オブジェクトを作成
CreateIPConfigSingleHost メソッドは、メソッドに渡される IP アドレスに基づいて IP アドレス設定を作成します。ポリシーを起動するには、要求を渡された IP アドレスを持つマシンから行う必要があります。
構文
CreateIPConfigSingleHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->CreateIPConfigSingleHost(ipAddr)
[Parameters]
CreateIPConfigSingleHost メソッドは以下のパラメータを受け入れます。
  1. ipAddr
    (文字列)
    ポリシーを起動するのに必要な IP アドレスを指定します。
戻り値
CreateIPConfigSingleHost メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
CreateIPConfigSubnetMask メソッド - IP アドレスおよびサブネット マスクに基づいて IP 設定オブジェクトを作成
CreateIPConfigSubnetMask メソッドは、メソッドに渡される IP アドレスおよびサブネット マスクに基づいて IP アドレス設定を作成します。ポリシーを起動するには、要求を渡された IP アドレスおよびサブネット マスクから引き出されるサブネット アドレスから行う必要があります。
構文
CreateIPConfigSubnetMask メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->CreateIPConfigSubnetMask(ipAddr, subnetMask)
[Parameters]
CreateIPConfigSubnetMask メソッドは、以下のパラメータを受け入れます。
  1. ipAddr
    (文字列)
    サブネット アドレスを引き出すために使用する IP アドレスを指定します。
  2. subnetMask
    (署名なし long)
    サブネット アドレスを引き出すために使用するサブネット マスクを指定します。
戻り値
CreateIPConfigSubnetMask メソッドは以下のいずれかの値を返します。
  • PolicyMgtIPConfig オブジェクト
  • コールに失敗した場合は、
    undef
注釈
サブネット マスク値は、ビット数で表します。この値を取得するには、アドレスのバイナリ値内のビットをカウントします。たとえば、サブネット マスクが 255.255.255.128 であるとします。バイナリ形式では以下のようになります。
11111111 11111111 11111111 10000000
左から右にカウントして、subnetMask で渡す数は 25 です。
DeleteIPConfig メソッド - 指定された IP 設定オブジェクトを削除
DeleteIPConfig メソッドは、指定された IP 設定オブジェクトを削除します。
構文
DeleteIPConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->DeleteIPConfig(ipConfig)
[Parameters]
DeleteIPConfig メソッドは、以下のパラメータを受け入れます。
  1. IPConfig
    (PolicyMgtIPConfig)
    削除する IP 設定オブジェクトを指定します。
戻り値
DeleteIPConfig メソッドは以下のいずれかの値を返します。
  • 削除に成功する場合は、-0
  • コールに失敗する場合は、-1
Description メソッド - ポリシーの説明を設定または取得
Description メソッドは、ポリシーの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->Description([policyDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
  1. policyDesc
    (文字列)
    設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
  • 新規または既存のポリシーの説明
  • コールに失敗した場合は、空
EnforceANDEvaluation メソッド - ANDUser Group フラグを設定または取得
EnforceANDEvaluation メソッドは、iANDUserFlag の値に応じて、ANDUser/Group フラグを設定または取得します。
構文
EnforceANDEvaluation メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->EnforceANDEvaluation(user[, iANDUserFlag])
[Parameters]
EnforceANDEvaluation メソッドは、以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser)
    iANDUserFlag
    を設定または取得する場合のユーザを指定します。
  2. iANDUserFlag
    (int)
    (オプション)以下のように、AND 評価を強制するかどうかを指定します。
    AND 評価を強制するには 1
    AND 評価を削除するには 0
    この引数が渡されない場合、関数は
    iANDUserFlag
    の現在の値を返します。このフラグは、特定のユーザ ディレクトリのポリシーに追加されるすべてのユーザに適用されます。
戻り値
EnforceANDEvaluation メソッドは以下のいずれかの値を返します。
  • ANDUser/Group フラグが正しく削除される場合は、0
  • ANDUser/Group フラグが正しく設定される場合は、1
  • コールに失敗する場合は、-1
ExcludeUser メソッド - ポリシーに対してユーザを除外または含める
ExcludeUser メソッドは、
iExcludeFlag
の値に応じて、ユーザをポリシーから除外または含みます。
構文
ExcludeUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->ExcludeUser(user[, iExcludeFlag])
[Parameters]
ExcludeUser メソッドは、以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser)
    除外または含むユーザを指定します。
  2. iExcludeFlag
    (int)
    (オプション)以下のように、指定されたユーザを除外するかどうかを指定します。
    • ユーザを除外するには 1
    • ユーザを含むには 0
    この引数が渡されない場合、関数は
    iExcludeFlag
    の現在の値を返します。
戻り値
ExcludeUser メソッドは以下のいずれかの値を返します。
  • ユーザが正しく含まれる場合は、0
  • ユーザが正しく除外される場合は、1
  • コールに失敗する場合は、-1
GetAllIPConfigs メソッド - ポリシー内のすべての IP アドレス制限オブジェクトを取得
GetAllIPConfigs メソッドは、ポリシー内のすべての IP アドレス制限オブジェクトを取得します。
構文
GetAllIPConfigs メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->GetAllIPConfigs() (returnCode)
[Parameters]
GetAllIPConfigs メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllIPConfigs メソッドは以下の値を返します。
  • PolicyMgtIPConfig オブジェクトの配列
注釈
IP アドレス制限および IP アドレス制限タイプの詳細については、PolicyMgtIPConfig->GetType メソッドを参照してください。
GetAllRules メソッド - ポリシーと関連付けられたすべてのルールを取得
GetAllRules メソッドは、ポリシーと関連付けられたすべてのルールを取得します。
構文
GetAllRules メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->GetAllRules() (returnCode)
[Parameters]
GetAllRules メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllRules メソッドは以下の値を返します。
  • PolicyMgtRule オブジェクトの配列
GetAllUsers メソッド - ポリシーと関連付けられたすべてのユーザを取得
GetAllUsers メソッドは、ポリシーと関連付けられたすべてのユーザを取得します。ユーザ ディレクトリが指定される場合は、そのディレクトリと関連付けられたユーザのみが取得されます。
構文
GetAllUsers メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->GetAllUsers([userDir]) (returnCode)
[Parameters]
GetAllUsers メソッドは以下のパラメータを受け入れます。
  1. userDir
    (PolicyMgtUserDir)
    (オプション)このユーザ ディレクトリと関連付けられたユーザのみが取得されることを指定します。
  2. returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllUsers メソッドは以下の値を返します。
  • PolicyMgtUser オブジェクトの配列
IsEnabled メソッド - ポリシーを有効化または無効化
IsEnabled メソッドは、ポリシーを有効化または無効化します。
構文
IsEnabled メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->IsEnabled([enableFlag])
[Parameters]
IsEnabled メソッドは以下のパラメータを受け入れます。
  1. enableFlag
    (int)
    (オプション)以下のようにポリシーを有効または無効にするかどうかを指定します。
    • 0 はポリシーを無効にします。
    • 1 はポリシーを有効にします。
戻り値
IsEnabled メソッドは以下のいずれかの値を返します。
  • ポリシーが有効な場合は、1。
  • ポリシーが無効な場合は、0。
  • コールに失敗する場合は、-1
Name メソッド - ポリシー名を設定または取得
Name メソッドは、ポリシー名を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->Name([policyName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
  1. policyName
    (文字列)
    (オプション)ポリシーに割り当てる名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
  • 新規または既存のポリシー名
  • コールに失敗した場合は、
    undef
RemoveResponse メソッド - ポリシー内の設定済みルール用のレスポンスを削除
RemoveResponse メソッドは、ポリシー内の設定されたルール用のレスポンスを削除します。
構文
RemoveResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->RemoveResponse(rule)
[Parameters]
RemoveResponse メソッドは以下のパラメータを受け入れます。
  1. rule
    (PolicyMgtRule)
    そのレスポンスを削除するルールを指定します。
戻り値
RemoveResponse メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
RemoveRule メソッド - ポリシーから指定されたルールを削除
RemoveRule メソッドは、ポリシーから指定されたルールを削除します。
構文
RemoveRule メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->RemoveRule(rule)
[Parameters]
RemoveRule メソッドは以下のパラメータを受け入れます。
  1. rule
    (PolicyMgtRule)
    削除するルールを指定します。
戻り値
RemoveRule メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
RemoveUser メソッド - ポリシーからユーザを削除
RemoveUser メソッドは、ポリシーからユーザを削除します。
構文
RemoveUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->RemoveUser(user)
[Parameters]
RemoveUser メソッドは、以下のパラメータを受け入れます。
  1. user
    (PolicyMgtUser)
    削除するユーザを指定します。
戻り値
RemoveUser メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
SetResponse メソッド - ポリシー内の定済みルール用のレスポンスを設定
SetResponse メソッドは、ポリシー内の設定されたルール用のレスポンスを設定します。
構文
SetResponse メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtPolicy->SetResponse(rule, response)
[Parameters]
SetResponse メソッドは、以下のパラメータを受け入れます。
  1. rule
    (PolicyMgtRule)
    そのレスポンスを設定するルールを指定します。
  2. response
    (PolicyMgtResponse)
    設定するレスポンスを指定します。
戻り値
SetResponse メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、-0。
  • コールに失敗する場合は、-1。