CLI エージェント管理メソッド

目次
casso126jjp
目次
AddServerConfig メソッド - エージェント API オブジェクトにポリシー サーバ設定を追加
AddServerConfig メソッドは、エージェント API オブジェクトに 1 つ以上のポリシー サーバ設定を追加します。ポリシー サーバとエージェント API 間の接続を確立するには、その前にこのメソッドを少なくとも 1 回コールする必要があります。
構文
AddServerConfig メソッドの構文は以下のとおりです。
Netegrity::AgentAPI->AddServerConfig(IPAddress[, minConn]
[, maxConn][, stepConn][, timeout][, azPort][, auPort]
[, acPort])
[Parameters]
AddServerConfig メソッドは、以下のパラメータを受け入れます。
  1. IPAddress
    (文字列)
    ポリシー サーバの IP アドレスを指定します。
  2. minConn
    (int)
    (オプション)許可されている接続の最小数を指定します。
  3. maxConn
    (int)
    (オプション)許可されている接続の最大数を指定します。
  4. stepConn
    (int)
    (オプション)既存の接続がすべて使用されているときに追加する接続の数を指定します。
  5. timeout
    (int)
    (オプション)エージェント API がポリシー サーバへの接続試行を停止するまでの秒単位の時間を指定します。
  6. azPort
    (int)
    (オプション)許可サービス用のポート番号を指定します。
  7. auPort
    (int)
    (オプション)認証サービス用のポート番号を指定します。
  8. acPort
    (int)
    (オプション)アカウンティング サービス用のポート番号を指定します。
戻り値
AddServerConfig メソッドは、以下の値を返します。
  • AgentSvrCfg (オブジェクト)
注釈
CA Single Sign-on
v6.0 で導入された単一プロセス ポリシー サーバが、元々は別個の認証、許可およびアカウンティング プロセスを 1 つの結合プロセスに組み合わせることにより、複数の要求が 1 つの TCP ポートを通ります。その結果、パラメータ azPort、auPort および acPort はすべて同じポート番号を参照します。3 つの引数は下位互換性のために維持されます。
Connect メソッド - エージェント API とポリシー サーバ間の接続を確立
Connect メソッドは、エージェント API とポリシー サーバ間の接続を確立します。
構文
Connect メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->Connect([bootFile])
[Parameters]
Connect メソッドは以下のパラメータを受け入れます。
  1. bootFile
    (文字列)
    (オプション)v5.x ージェントに接続するために使用される設定ファイルの名前を指定します。
    : SmHost.conf などの既存のファイルを使用するか、新規ファイルを作成できます。詳細については、メソッド AgentAPI>CreateBootstrapFile を参照してください。
戻り値
Connect メソッドは以下のいずれかの値を返します。
  • SM_AGENTAPI_YES(値 = 1)
    接続が成功したことを指定します。
  • SM_AGENTAPI_FAILURE(値 = -1)
    エージェント API がポリシー サーバに到達できなかったことを指定します。
  • SM_AGENTAPI_TIMEOUT(値 = -2)
    メソッドがタイムアウトしたことを指定します。
  • SM_AGENTAPI_NOCONNECTION(値 = -3)
    初期化が失敗したことを指定します。
CreateBootstrapFile メソッド - エージェントに接続するためのブートストラップ ファイルを生成
CreateBootstrapFile メソッドは、v5.x エージェントに接続するためにポリシー サーバが使用できるブートストラップ ファイルを生成します。ブートストラップ ファイルには、メソッドのパラメータによって指定された設定が含まれています。いったん接続されると、ポリシー サーバはその他の設定を提供できます。SmHost.conf はブートストラップ ファイルの例です。
構文
CreateBootstrapFile メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->CreateBootstrapFile(trustedHostName, ipAddress,
hostConfigName, sharedSecret, registrationDataFileName)
[Parameters]
CreateBootstrapFile メソッドは、以下のパラメータを受け入れます。
  1. trustedHostName
    (文字列)
    トラステッド ホストの名前を指定します。
  2. ipAddress
    (文字列)
    ポリシー サーバの IP アドレスを指定します。
  3. hostConfigName
    (文字列)
    ホスト設定オブジェクトの名前を指定します。
  4. sharedSecret
    (文字列)
    ホストによって使用される共有秘密キーの値を指定します。
  5. registrationDataFileName
    (文字列)
    メソッドによって生成されるブートストラップ ファイルの名前を指定します。
戻り値
CreateBootstrapFile メソッドは以下のいずれかの値を返します。
  • file_name (文字列)
    新規に作成したファイルの名前を指定します。
  • empty_string (文字列)
    メソッドが失敗したことを指定します。
以下のコード フラグメントは、CreateBootstrapFile メソッドの使用方法の例です。
# A shared secret is not specified in the context of a v5.x agent.
# A v5.x agent by the specified name needs to exist in the policy
# store. Use Netegrity::AgentAPI.
$agentapi = Netegrity::AgentAPI->New($agentname);
# Create the bootstrap file.
$agentapi->CreateBootstrapFile($thostname, $ipaddr, $hconfname, $secret, $fname);
# Notice that in the v5.x context, the connect() method takes a filename.
$agentapi->Connect($fname);
CreateUser メソッド - ユーザ オブジェクトを作成
CreateUser メソッドは、パラメータ内のメソッドに渡される情報が含まれるユーザ オブジェクトを作成します。Perl は、ログインなどのユーザ操作を実行するためにこのオブジェクトを使用します。
: このメソッドはユーザ ディレクトリに新規ユーザを作成しません。
構文
CreateUser メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->CreateUser(Username, Password[, cert][, certLength])
[Parameters]
CreateUser メソッドは、以下のパラメータを受け入れます。
  1. Username
    (文字列)
    ユーザの ID を指定します。
  2. Password
    (文字列)
    ユーザのパスワードを指定します。
  3. cert
    (文字列)
    (オプション)ユーザ認証用の X.509 証明書を指定します。
  4. certLength
    (int)
    (オプション)証明書の長さを指定します。
戻り値
CreateUser メソッドは以下のいずれかの値を返します。
  • AgentUser (オブジェクト)
  • undef
    メソッドが失敗したことを指定します。
Disconnect メソッド - エージェントとポリシー サーバ間の接続を閉じる
Disconnect メソッドは、エージェントとポリシー サーバ間の接続を閉じます。
構文
Disconnect メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->Disconnect()
[Parameters]
Disconnect メソッドは、パラメータを受け入れません。
戻り値
Disconnect メソッドは以下のいずれかの値を返します。
  • SM_AGENT_SUCCESS(値 = 0)
    接続が正しく閉じたことを指定します。
  • SM_AGENT_FAILURE(値 = 1)
    接続が正しく閉じなかったことを指定します。
DoManagement メソッド - ポリシー サーバからのエージェント コマンドを要求
DoManagement メソッドは、ポリシー サーバからの保留中のエージェント コマンドのリストを要求し、配列でそれらを返します。配列内のコマンドにアクセスするには、AgentResponseAttr->GetID メソッドを呼び出します。
構文
DoManagement メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->DoManagement()
[Parameters]
DoManagement メソッドは、パラメータを受け入れません。
戻り値
DoManagement メソッドは以下のいずれかの値を返します。
  • AgentResponseAttr (配列)
  • undef
    保留中のエージェント コマンドがないことを指定します。
GetResource メソッド - 指定されたリソースを取得
GetResource メソッドは、指定されたリソースを取得します。
構文
GetResource メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->GetResource(resName[, action][, clientIP])
[Parameters]
GetResource メソッドは、以下のパラメータを受け入れます。
  1. resName
    (文字列)
    取得するリソースの名前を指定します。
  2. action
    (文字列)
    (オプション)実行する HTTP アクションを指定します(たとえば GET、POST または PUT)。
  3. clientIP
    (文字列)
    (オプション)クライアントの IP アドレスを指定します。
戻り値
GetResource メソッドは、以下の値を返します。
  • AgentResource (オブジェクト)
IncrementRefCount メソッド - 参照数をインクリメント
エージェント API がマルチスレッド モードで動作しているときに、IncrementRefCount メソッドをコールできます。Perl 関数フォークをコールした後に、たとえば、子プロセス内のこのメソッドをコールできます。
構文
IncrementRefCount メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->IncrementRefCount()
[Parameters]
IncrementRefCount メソッドは、パラメータを受け入れません。
戻り値
IncrementRefCount メソッドは、値を返しません。
New メソッド- エージェント API を構築
New メソッドは、エージェント API オブジェクトを構築します。エージェント API オブジェクトを使用する前にコールする必要があります。
構文
New メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->New(agentName[, sharedSecret][, failover])
[Parameters]
New メソッドは、以下のパラメータを受け入れます。
  1. pagentName
    (文字列)
    ポリシー ストアに表示されるとおりのエージェントの名前を指定します。
    : エージェント名は大文字/小文字を区別しません。
  2. psharedSecret
    (文字列)
    (オプション)ポリシー ストアに表示されるとおりの共有秘密キーを指定します。
    : 共有秘密キーの値を指定すると、v4.x エージェント オブジェクトが作成されます。共有秘密キーの値を指定しないと、v5.x エージェント オブジェクトが作成されます。共有秘密キー
    大文字と小文字を区別します。
  3. failover
    (int)
    (オプション)以下のようにフェールオーバ操作を有効にすべきか無効にすべきかを指定します。
    • 値 = -1
      フェールオーバ操作の有効化を指定します。
    • 値 = 0
      フェールオーバ操作の無効化を指定します。
戻り値
New メソッドは、以下の値を返します。
  • AgentAPI (オブジェクト)
PrintDebugTrace メソッド - コンソールにトレース情報を出力
PrintDebugTrace メソッドは、コンソールへのエラーまたはトレース情報の出力を有効または無効にし、それぞれ 1 または 0 の値を返します。
構文
PrintDebugTrace メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->PrintDebugTrace([debugFlag])
[Parameters]
PrintDebugTrace メソッドは以下のパラメータを受け入れます。
  1. debugFlag
    (int)
    (オプション)以下のように、コンソールへのエラーまたはトレース情報の出力の有効化または無効化を指定します。
    • 値 = 1
      出力の有効化を指定します。
    • 値 = 0
      出力の無効化を指定します。
戻り値
PrintDebugTrace メソッドは以下のいずれかの整数値を返します。
  • 値 = 1
    出力が有効であることを指定します。
  • 値 = 0
    出力が無効であることを指定します。
ProcessAuthResponse メソッド -- パスワードの変更ログインから情報を抽出
ProcessAuthResponse メソッドは、ログインまたはパスワードの変更から返される適切な情報を抽出します。
構文
ProcessAuthResponse メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->GetResource(UserCreds)
[Parameters]
ProcessAuthResponse メソッドは以下のパラメータを受け入れます。
  1. UserCreds
    (UserCredentials)
    ログインまたはパスワードの変更コールからのユーザ認証情報を指定します。
戻り値
ProcessAuthResponse メソッドは、適切な情報を文字列として返します。
SetErrorCallback メソッド - エラー メッセージを処理するサブルーチンを登録
SetErrorCallback メソッドは、
CA Single Sign-on
エラー メッセージを処理するユーザ定義の Perl サブルーチンを登録します。複数のサブルーチンが登録された場合、
CA Single Sign-on
は最新の登録済みサブルーチンをコールします。
構文
SetErrorCallback メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->SetErrorCallback(subref)
[Parameters]
SetErrorCallback メソッドは以下のパラメータを受け入れます。
  1. subref
    (文字列)
    以下のように、Perl サブルーチンの名前またはサブルーチンの参照を指定します。
    • 名前
      例:
      $agentapi->SetErrorCallback("CustomErrorHandler");
    • 参照
      例:
      $agentapi->SetErrorCallback(\&CustomErrorHandler);
戻り値
SetErrorCallback メソッドは以下のいずれかの整数値を返します。
  • 値 = 1
    登録が成功したことを指定します。
  • 値 = 0
    登録が失敗したことを指定します。
SetTraceCallback メソッド - トレース メッセージを処理するサブルーチンを登録
SetTraceCallback メソッドは、
CA Single Sign-on
トレース メッセージを処理するユーザ定義の Perl サブルーチンを登録します。複数のサブルーチンが登録された場合、
CA Single Sign-on
は最新の登録済みサブルーチンをコールします。
構文
SetTraceCallback メソッドの形式は以下のとおりです。
Netegrity::AgentAPI->SetTraceCallback(subref[, mode][, delim]
[, configFileName])
[Parameters]
SetTraceCallback メソッドは、以下のパラメータを受け入れます。
  1. subref
    (文字列)
    以下のように、Perl サブルーチンの名前またはサブルーチンの参照を指定します。
    • 名前
      例:
      $agentapi->SetErrorCallback("CustomTraceHandler");
    • 参照
      例:
      $agentapi->SetErrorCallback(\&CustomTraceHandler);
  2. mode
    (文字列)
    (オプション)以下のようにトレース メッセージの出力形式を指定します。
    • default
      角かっこによって囲まれたフィールドを指定します。
    • fixed
      固定幅フィールドを指定します。
    • delim
      フィールドを区切るための文字の使用を指定します。
    • xml
      XML のようなタグで囲まれたフィールドを指定します。
  3. delim
    (文字列)
    (オプション)モードが delim に設定されるときに区切り文字として使用する文字を指定します。
  4. configFileName
    (文字列)
    (オプション)トレースに含めるデータを指定する設定ファイルの名前を指定します。
    デフォルト
    : ファイル名が指定されない場合は、デフォルト設定が使用されます。
戻り値
SetTraceCallback メソッドは以下のいずれかの整数値を返します。
  • 値 = 1
    登録が成功したことを指定します。
  • 値 = 0
    登録が失敗したことを指定します。