CLI トラステッド ホスト メソッド
目次
casso127jpjp
目次
GetDescription メソッド - トラステッド ホストの説明を取得
GetDescription メソッドは、トラステッド ホストの説明を取得します。
構文
GetDescription メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtTrustedHost->GetDescription()
[Parameters]
GetDescription メソッドは、パラメータを受け入れません。
戻り値
GetDescription メソッドは、以下の値を返します。
- trusted_host_description
GetIPAddress メソッド - トラステッド ホストの IP アドレスを取得
GetIPAddress メソッドは、トラステッド ホストの IP アドレスを取得します。
構文
GetIPAddress メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtTrustedHost->GetIPAddress()
[Parameters]
GetIPAddress メソッドは、パラメータを受け入れません。
戻り値
GetIPAddress メソッドは、以下の値を返します。
- trusted_host_ip_address
GetName メソッド - トラステッド ホストの名前を取得
GetName メソッドは、トラステッド ホストの名前を取得します。
構文
GetName メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtTrustedHost->GetName()
[Parameters]
GetName メソッドは、パラメータを受け入れません。
戻り値
GetName メソッドは、以下の値を返します。
- trusted_host_name
GetSecret メソッドは、クリア テキスト内のトラステッド ホストの共有秘密キーを取得します。
構文
GetSecret メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtTrustedHost->GetSecret()
[Parameters]
GetSecret メソッドは、パラメータを受け入れません。
戻り値
GetSecret メソッドは以下のいずれかの値を返します。
- trusted_host_shared_secret
- コールに失敗した場合は、undef
RolloverEnabled メソッドは、このトラステッド ホストに対して共有秘密キー ロールオーバーを有効にするかどうかを指定する共有秘密キー ロールオーバー フラグを設定または取得します。
構文
RolloverEnabled メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtTrustedHost->RolloverEnabled([rolloverEnabled])
[Parameters]
RolloverEnabled メソッドは以下のパラメータを受け入れます。
- rolloverEnabled(int)(オプション)共有秘密キー ロールオーバー フラグの新しい値を指定します。
- 値 = 1このトラステッド ホストに対して共有秘密キー ロールオーバーが有効であることを指定します。
- 値 = 0このトラステッドホストに対して共有秘密キー ロールオーバーが有効でないことを指定します。
戻り値
RolloverEnabled メソッドは、以下のように共有秘密キー ロールオーバー フラグの新規または既存の値を返します。
- 値 = 1このトラステッド ホストに対して共有秘密キー ロールオーバーが有効であることを指定します。
- 値 = 0このトラステッドホストに対して共有秘密キー ロールオーバーが有効でないことを指定します。
- undefコールが失敗したことを指定します。
注釈
このトラステッド ホストに対して共有秘密キー ロールオーバーが有効である場合、トラステッド ホストが登録されているポリシー ストア ドメインの PolicyMgtSharedSecretPolicy オブジェクト内でも共有秘密キー ロールオーバーが有効である必要があります。このオブジェクトで共有秘密キー ロールオーバーが有効でない場合は、PolicyMgtSharedSecretPolicy->Enabled メソッドをコールして有効にします。
SetSecret メソッドは、トラステッド ホストの共有秘密キーを設定します。
構文
SetSecret メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtTrustedHost->SetSecret([sharedSecret])
[Parameters]
SetSecret メソッドは以下のパラメータを受け入れます。
- sharedSecret(文字列)(オプション)トラステッド ホスト用に設定する共有秘密キーを指定します。注:共有秘密キーが指定されていない場合、CA Single Sign-onはトラステッド ホスト用のランダムな 128 バイト ASCII 共有秘密キーを生成します。
戻り値
SetSecret メソッドは以下のいずれかの値を返します。
- shared_secret(文字列)(オプション)トラステッド ホスト用の新しい共有秘密キーを指定します。
- ""(空の文字列)コールが失敗したことを指定します。
注釈
このメソッドを使用して共有秘密キーを設定するときは、ホスト設定ファイルで共有秘密キーを定義するために
CA Single Sign-on
ツール smreghost を実行する必要もあります (ホスト設定ファイルはデフォルトでは SmHost.conf と命名されます)。-sh オプションを指定して smreghost を実行します。詳細については、メソッド PolicyMgtSession>AddTrustedHost を参照してください。注
: 共有秘密キー ロールオーバーを自動的に発生するようにスケジュールできます。