CLI 共有秘密キーのロールオーバー メソッド

目次
casso127jpjp
目次
Enabled メソッド - ポリシーのロールオーバー有効化フラグを設定または取得
Enabled メソッドは、共有秘密キー ロールオーバー ポリシーを有効にするかどうかを指定するフラグを設定または取得します。
構文
Enabled メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSharedSecretPolicy->Enabled([enableFlag])
[Parameters]
Enabled メソッドは以下のパラメータを受け入れます。
  1. enableFlag
    (int)
    (オプション)有効化フラグの新しい値を指定します。
    • 値 = 1
      共有秘密キー ロールオーバー ポリシーを有効にすることを指定します。
    • 値 = 0
      共有秘密キー ロールオーバー ポリシーを無効にすることを指定します。
戻り値
Enabled メソッドは、有効化フラグの新規または既存の値を返します。
  • 値 = 1
    共有秘密キーのロールオーバー ポリシーが有効であることを指定します。
  • 値 = 0
    共有秘密キーのロールオーバー ポリシーが無効であることを指定します。
注釈
共有秘密キーのロールオーバー ポリシーが有効な場合は、その共有秘密キーをロールオーバー ポリシーの共有秘密キーと同期する必要があるトラステッド ホストに対しても、ロールオーバーを有効にする必要があります。トラステッド ホスト オブジェクトに対するロールオーバーを有効にするには、メソッド PolicyMgtTrustedHost->RolloverEnabled をコールします。
RolloverFrequency メソッド - ポリシーのロールオーバー頻度を設定または取得
RolloverFrequency メソッドは、ポリシーのロールオーバー頻度を設定または取得します。この値は、メソッド PolicyMgtSharedSecretPolicy->RolloverPeriod によって指定された期間に共有秘密キーが自動的に更新される頻度を決定します。
構文
RolloverFrequency メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSharedSecretPolicy->RolloverFrequency([rollFreq])
[Parameters]
RolloverFrequency メソッドは以下のパラメータを受け入れます。
  1. rollFreq
    (int)
    (オプション)ロールオーバー頻度の新しい値を指定します。
    範囲:
    rollFreq
    >= 1
戻り値
RolloverFrequency メソッドは、以下の値を返します。
  • rollover_frequency(int)
    ロールオーバー頻度の新規または既存の値を指定します。
RolloverPeriod メソッド - ポリシーのロールオーバー期間を設定または取得
RolloverPeriod メソッドは、ロールオーバー ポリシーのロールオーバー期間を設定または取得します。ロールオーバー期間には次の 4 つの値が有効です。1 時間ごと、日単位、週単位、または月単位。共有秘密キーが自動的に変更される頻度を指定するには、ロールオーバー期間をロールオーバー頻度とともに使用します。たとえば、ロールオーバー頻度が 2 で、ロールオーバー期間が毎週の場合、共有秘密キーは 2 週間ごとに自動的に変更されます。ロールオーバー頻度を設定するには、PolicyMgtSharedSecretPolicy->RolloverFrequency メソッドをコールします。
構文
RolloverPeriod メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSharedSecretPolicy->RolloverPeriod([rollPeriod])
[Parameters]
RolloverPeriod メソッドは以下のパラメータを受け入れます。
  1. rollPeriod
    (int)
    (オプション)ロールオーバー期間の新しい値を指定します。
    • 値 = 0
      ロールオーバー期間が 1 時間ごとであることを指定します。
    • 値 = 1
      ロールオーバー期間が日単位であることを指定します。
    • 値 = 2
      ロールオーバー期間が週単位であることを指定します。
    • 値 = -3
      ロールオーバー期間が月単位であることを指定します。
戻り値
RolloverPeriod メソッドは以下のいずれかの値を返します。
  • rollover_period(int)
    ロールオーバー期間の新規または既存の値を指定します。
    範囲
    : 0-3
  • 値 = -1
    戻り値が 0-3 の範囲にないことを指定します。
Save メソッド - 共有秘密キー ポリシー オブジェクトを保存
Save メソッドは、共有秘密キー ポリシー オブジェクトをポリシー ストアに保存します。共有秘密キー ポリシー オブジェクトに変更をすべて加えた後、このメソッドを 1 回コールします。変更を有効にするには、必ずこのメソッドをコールします。
構文
Save メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtSharedSecretPolicy->Save()
[Parameters]
Save メソッドは、パラメータを受け入れません。
戻り値
Save メソッドは以下のいずれかの値を返します。
  • 値 = 0
    コールが成功したことを指定します。
  • 値 = -1
    コールが失敗したことを指定します。