Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Shared Secret Rollover Methods › RolloverPeriod Method—Sets or Retrieves Rollover Period for Policy

RolloverPeriod Method—Sets or Retrieves Rollover Period for Policy

The RolloverPeriod method sets or retrieves the rollover period for the rollover policy. The rollover period can have one of four values: hourly, daily, weekly, or monthly. The rollover period is used with the rollover frequency to specify how often the shared secret is automatically changed. For example, if the rollover frequency is two and the rollover period is weekly, then the shared secret is automatically changed every two weeks. To set the rollover frequency, call the PolicyMgtSharedSecretPolicy‑>RolloverFrequency method.

Syntax

The RolloverPeriod method has the following format:

Netegrity::PolicyMgtSharedSecretPolicy‑>RolloverPeriod([rollPeriod])

Parameters

The RolloverPeriod method accepts the following parameter:

rollPeriod (int)

(Optional) Specifies a new value for the rollover period.

• value = 0

  Specifies that the rollover period is hourly.

• value = 1

  Specifies that the rollover period is daily.

• value = 2

  Specifies that the rollover period is weekly.

• value = 3

  Specifies that the rollover period is monthly.

Return Value

The RolloverPeriod method returns one of the following values:

• rollover_period (int)

  Specifies the new or existing value for the rollover period.

  Range: 0-3

• value = -1

  Specifies that the return value is not in the 0-3 range.