CLI エージェント メソッド
目次
casso127jpjp
目次
ConvertFromLegacy メソッド - v4.x エージェントを v5.x エージェントに変換
ConvertFromLegacy メソッドは、v4.x エージェントを v5.x エージェントに変換します。
構文
ConvertFromLegacy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->ConvertFromLegacy( )
[Parameters]
ConvertFromLegacy メソッドは、パラメータを受け入れません。
戻り値
ConvertFromLegacy メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- 失敗の場合は -1
ConvertToLegacy メソッド - v5.x エージェントを v4.x エージェントに変換
ConvertToLegacy メソッドは、v5.x エージェントを v4.x エージェントに変換します。
構文
ConvertToLegacy メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->ConvertToLegacy( )
[Parameters]
ConvertToLegacy メソッドは、パラメータを受け入れません。
戻り値
ConvertToLegacy メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- 失敗の場合は -1
Description メソッド - エージェントの説明を設定または取得
Description メソッドは、エージェントの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->Description([agentDesc])
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- agentDesc(文字列)(オプション)設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- 新規または既存のエージェントの説明
- 失敗の場合は、空の文字列
IPAddress メソッド - エージェントの IP アドレスを設定または取得
IPAddress メソッドは、エージェントの IP アドレスを設定または取得します。
構文
IPAddress メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->IPAddress([ipAddress])
[Parameters]
IPAddress メソッドは以下のパラメータを受け入れます。
- ipAddress(文字列)(オプション)設定する IP アドレスを指定します。
戻り値
IPAddress メソッドは以下のいずれかの値を返します。
- 新規または既存のエージェント IP アドレス
- コールに失敗した場合は、undef
Name メソッド - エージェントの名前を設定または取得
Name メソッドは、エージェントの名前を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->Name([agentName])
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- agentName(文字列)(オプション)エージェントに割り当てる名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存のエージェントの名前
- コールに失敗した場合は、undef
RealmHintAttrID メソッド - ヒント属性を設定または取得
RealmHintAttrID メソッドは、RADIUS エージェントのヒント属性を設定または取得します。
構文
RealmHintAttrID メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->RealmHintAttrID([hintID])
[Parameters]
RealmHintAttrID メソッドは以下のパラメータを受け入れます。
- hintID(int)(オプション)設定するヒント属性 ID を指定します。
戻り値
RealmHintAttrID メソッドは以下のいずれかの値を返します。
- RADIUS エージェント用に設定する新規または既存のレルム ヒント属性
- 失敗した場合は、-1
SharedSecret メソッドは、v4.x エージェント用の共有秘密キーを設定または取得します。これは Web エージェント設定で使用される同じ共有秘密キーです。
構文
SharedSecret メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAgent->SharedSecret([sharedSecret])
[Parameters]
SharedSecret メソッドは以下のパラメータを受け入れます。
- sharedSecret(文字列)(オプション)設定する共有秘密キーを指定します。戻り値
SharedSecret メソッドは以下のいずれかの値を返します。
- 新規または既存の共有秘密キー
- コールに失敗した場合は、undef