CLI ホスト設定メソッド

ここでは、CLI ホスト設定メソッドについて説明します。
casso1283
ここでは、CLI ホスト設定メソッドについて説明します。
AddCluster メソッド - ホスト設定に空のクラスタを追加
AddCluster メソッドは、ホスト設定に空のクラスタを追加します。AddServer メソッドをコールして、クラスタにサーバを追加します。
構文
AddCluster メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->AddCluster( )
[Parameters]
AddCluster メソッドは、パラメータを受け入れません。
戻り値
AddCluster メソッドは以下のいずれかの値を返します。
  • 空のPolicyMgtCluster オブジェクト
  • コールに失敗した場合は、
    undef
注釈
ホスト設定内のクラスタはクラスタ配列で参照されます。クラスタを追加すると、クラスタがクラスタ配列の終わりに追加されます。ホスト設定オブジェクトにクラスタを追加する順序によって、フェールオーバ シーケンスが決定されます。追加する最初のクラスタ(つまりクラスタ配列内の最初のクラスタ)は、プライマリ クラスタです。これは、
SiteMinder
がリクエストを送信するフェールオーバ シーケンスの最初のクラスタです。プライマリ クラスタに使用できる十分なサーバがないと(つまり、クラスタ内の利用可能なサーバの数がフェールオーバしきい値より低い場合)、次のクラスタ(ホスト設定オブジェクトに追加された 2 番目のクラスタ)へのフェールオーバが行われます。そのクラスタも失敗する場合、ホスト設定オブジェクトに追加された 3 番目のクラスタへのフェールオーバが行われます(以後同じ要領)。
AddServer メソッド - ホスト設定に非クラスタ化サーバを追加
AddServer メソッドは、ホスト設定に非クラスタ化サーバを追加します。
構文
AddServer メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->AddServer(Host [, AcctPort] [, AuthPort] [, AzPort])
[Parameters]
AddServer メソッドは、以下のパラメータを受け入れます。
  1. Host
    (文字列)
    ポリシー サーバの IP アドレスを指定します。
  2. AcctPort
    (文字列)
    (オプション)アカウンティング サーバの IP ポートを指定します。
  3. AuthPort
    (文字列)
    (オプション)認証サーバの IP ポートを指定します。
  4. AzPort
    (文字列)
    (オプション)許可サーバの IP ポートを指定します。
戻り値
AddServer メソッドは以下のいずれかの値を返します。
  • 成功の場合は 0
  • 失敗の場合は -1
注釈
SiteMinder
v6.0 で導入された単一プロセス ポリシー サーバが、元々は別個の認証、許可およびアカウンティング プロセスを 1 つの結合プロセスに組み合わせることにより、複数の要求が 1 つの TCP ポートを通ります。その結果、引数 AcctPort、AuthPort および AzPort はすべて同じポート番号を参照します。3 つの引数は下位互換性のために維持されます。
クラスタにサーバを追加するには、PolicyMgtCluster->AddServer メソッドをコールします。
Description メソッド - ホスト設定オブジェクトの説明を設定または取得
Description メソッドは、ホスト設定オブジェクトの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->Description([Description])
[Parameters]
メソッドは以下のパラメータを受け入れます。
  1. Description
    (文字列)
    (オプション)設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
  • 新規または既存の説明
  • コールに失敗した場合は、
    undef
EnableFailover メソッド - フェールオーバ有効化フラグを設定または取得
EnableFailover メソッドは、フェールオーバ有効化フラグを設定または取得します。このフラグは、エージェントとポリシー サーバの通信をフェールオーバまたはラウンド ロビンによって行うかどうかを判定します。
構文
EnableFailover メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->EnableFailover([EnableFailover])
[Parameters]
EnableFailover メソッドは以下のパラメータを受け入れます。
  1. EnableFailover
    (int)
    (オプション)設定するフラグの値を指定します。
戻り値
EnableFailover メソッドは以下のいずれかの値を返します。
  • 新規または既存のフラグ設定:
    • フェールオーバの場合は 1
    • ラウンド ロビンの場合は 0
  • コールに失敗した場合は、-1
FailoverThreshold メソッド - フェールオーバしきい値パーセンテージを設定または取得
FailoverThreshold メソッドは、ホスト設定でのクラスタのフェールオーバしきい値パーセンテージを設定または取得します。
構文
FailoverThreshold メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->FailoverThreshold([FailoverThreshold])
[Parameters]
FailoverThreshold メソッドは以下のパラメータを受け入れます。
  1. FailoverThreshold
    (int)
    (オプション)設定するフェールオーバしきい値パーセンテージを指定します。
戻り値
FailoverThreshold メソッドは以下のいずれかの値を返します。
  • 新規または既存のフェールオーバしきい値パーセンテージ
  • コールに失敗した場合は、
    undef
注釈
しきい値パーセンテージは、要求に対して利用可能である必要があるクラスタ内のサーバの最小数を表します。利用可能なサーバの数がしきい値以下になると、次のクラスタへのフェールオーバが行われます。パーセンテージが表すサーバの数を判定するには、しきい値パーセンテージにクラスタ内のサーバ数を乗算して、次の最も高い整数まで丸めます。例: <nete:proxyrules xmlns:nete="http://www.ca.com/" debug="yes">
5 つのサーバのクラスタの 60 パーセント フェールオーバしきい値では、クラスタ内の利用可能なサーバの数が 3 を下回ると、次のクラスタへのフェールオーバが行われます。
  • 同じクラスタの 61 パーセント フェールオーバしきい値では、クラスタ内の利用可能なサーバの数が 4 を下回ると、フェールオーバが行われます。
GetAllClusters メソッド - ポリシー管理クラスタ オブジェクトの配列を取得
GetAllClusters メソッドは、ポリシー管理クラスタ オブジェクトの配列を取得します。
構文
GetAllClusters メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->GetAllClusters() (returnCode)
[Parameters]
GetAllClusters メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllClusters メソッドは以下の値を返します。
  • PolicyMgtCluster オブジェクトの配列
GetAllServers メソッド - 非クラスタ化サーバ オブジェクトの配列を取得
GetAllServers メソッドは、ホスト設定の非クラスタ化サーバ オブジェクトの配列を取得します。
構文
GetAllServers メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->GetAllServers() (returnCode)
[Parameters]
GetAllServers メソッドは、以下のパラメータを受け入れます。
  • returnCode
    (int)
    関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllServers メソッドは以下の値を返します。
  • PolicyMgtServer オブジェクトの配列
注釈
クラスタのメンバであるサーバを取得するには、PolicyMgtCluster->GetAllServers メソッドをコールします。
MaxSocketsPerPort メソッド - TCP/IP ソケットの最大数を設定または取得
MaxSocketsPerPort メソッドは、エージェントとポリシー サーバ間で開くことができる TCP/IP ソケットの最大数を設定または取得します。
構文
MaxSocketsPerPort メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->MaxSocketsPerPort([MaxSocketsPerPort])
[Parameters]
MaxSocketsPerPort メソッドは以下のパラメータを受け入れます。
  1. MaxSocketsPerPort
    (int)
    (オプション)ポート当たりのソケットの新しい最大数を指定します。
戻り値
MaxSocketsPerPort メソッドは以下のいずれかの値を返します。
  • ソケットの最大数を示す新規または既存の設定
  • コールに失敗した場合は、-1
MinSocketsPerPort メソッド - TCP/IP ソケットの最小数を設定または取得
MinSocketsPerPort メソッドは、エージェントとポリシー サーバ間で開く必要がある TCP/IP ソケットの最小数を設定または取得します。
構文
MinSocketsPerPort メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->MinSocketsPerPort([MinSocketsPerPort])
[Parameters]
MinSocketsPerPort メソッドは以下のパラメータを受け入れます。
  1. MinSocketsPerPort
    (int)
    (オプション)新しい最小ソケット値を指定します。
戻り値
MinSocketsPerPort メソッドは以下のいずれかの値を返します。
  • ソケットの最小数を示す新規または既存の設定
  • コールに失敗した場合は、-1
Name メソッド - ホスト設定オブジェクトの名前を設定または取得
Description メソッドは、ホスト設定オブジェクトの名前を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->Name([Name])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
  1. Name
    (文字列)
    (オプション)設定する名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
  • 新規または既存の名前
  • コールに失敗した場合は、
    undef
NewSocketStep メソッド - ホスト設定の新しいソケット ステップ値を設定または取得
NewSocketStep メソッドは、ホスト設定の新しいソケット ステップ値を設定または取得します。この値は、需要が増大したときにエージェントとポリシー サーバ間で開く必要がある TCP/IP ソケットの増分数を表します。
構文
NewSocketStep メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->NewSocketStep([NewSocketStep])
[Parameters]
NewSocketStep メソッドは以下のパラメータを受け入れます。
  1. NewSocketStep
    (int)
    (オプション)設定する新しいソケット ステップ値を指定します。
戻り値
NewSocketStep メソッドは以下のいずれかの値を返します。
  • 新規または既存のソケット ステップ値
  • コールに失敗する場合は、-1
RemoveAllClusters メソッド - このホスト設定と関連付けられたすべてのクラスタ オブジェクトを削除
RemoveAllClusters メソッドは、このホスト設定と関連付けられたすべてのクラスタ オブジェクトを削除します。
構文
RemoveAllClusters メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->RemoveAllClusters()
[Parameters]
RemoveAllClusters メソッドは、パラメータを受け入れません。
戻り値
RemoveAllClusters メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
RemoveAllServers メソッド - ホスト設定からすべての非クラスタ化ポリシー サーバ オブジェクトを削除
RemoveAllServers メソッドは、ホスト設定からすべての非クラスタ化 PolicyMgtServer オブジェクトを削除します。
構文
RemoveAllServers メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->RemoveAllServers()
[Parameters]
RemoveAllServers メソッドは、パラメータを受け入れません。
戻り値
RemoveAllServers メソッドは以下のいずれかの値を返します。
  • コールに成功する場合は、0
  • コールに失敗する場合は、-1
RequestTimeout メソッド - 要求タイムアウト値を設定または取得
RequestTimeout メソッドは、秒単位の要求タイムアウト値を設定または取得します。この値は、エージェントがポリシー サーバからのレスポンスを待機する時間の長さを表します。
構文
RequestTimeout メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtHostConfig->RequestTimeout([RequestTimeout])
[Parameters]
RequestTimeout メソッドは以下のパラメータを受け入れます。
  1. RequestTimeout
    (int)
    (オプション)設定する新しいタイムアウト値を指定します。
戻り値
RequestTimeout メソッドは以下のいずれかの値を返します。
  • 新規または既存のタイムアウト値
  • コールに失敗する場合は、-1