Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › CLI Shared Secret Rollover Methods

CLI Shared Secret Rollover Methods

Enabled Method—Sets or Retrieves Rollover Enabled Flag for Policy

The Enabled method sets or retrieves the flag that specifies whether the shared secret rollover policy is enabled.

Syntax

The Enabled method has the following format:

Netegrity::PolicyMgtSharedSecretPolicy‑>Enabled([enableFlag])

Parameters

The Enabled method accepts the following parameter:

enableFlag (int)

(Optional) Specifies a new value for the enabled flag.

• value = 1

  Specifies enabling the shared secret rollover policy.

• value = 0

  Specifies disabling the shared secret rollover policy.

Return Value

The Enabled method returns the new or existing value for the enabled flag:

• value = 1

  Specifies that the shared secret rollover policy is enabled.

• value = 0

  Specifies that the shared secret rollover policy is disabled.

Remarks

If the shared secret rollover policy is enabled, rollover must also be enabled for any trusted host whose shared secret needs to be synchronized with the rollover policy's shared secret. To enable rollover for a trusted host object, call the method PolicyMgtTrustedHost‑>RolloverEnabled.

RolloverFrequency Method—Sets or Retrieves Rollover Frequency for Policy

The RolloverFrequency method sets or retrieves the rollover frequency for the rollover policy. This value determines how often the shared secret is automatically updated in the time period specified by the method PolicyMgtSharedSecretPolicy‑>RolloverPeriod.

Syntax

The RolloverFrequency method has the following format:

Netegrity::PolicyMgtSharedSecretPolicy‑>RolloverFrequency([rollFreq])

Parameters

The RolloverFrequency method accepts the following parameter:

rollFreq (int)

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

Range: rollFreq >= 1

Return Value

The RolloverFrequency method returns the following value:

• rollover_frequency (int)

  Specifies the new or existing value for the rollover frequency.

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.

Save Method—Saves Shared Secret Policy Object

The Save method saves the shared secret policy object to the policy store. Call this method once after making all changes to the shared secret policy object. You must call this method for the changes to take effect.

Syntax

The Save method has the following format:

Netegrity::PolicyMgtSharedSecretPolicy‑>Save()

Parameters

The Save method accepts no parameters.

Return Value

The Save method returns one of the following values:

• value = 0

  Specifies that the call is successful.

• value = -1

  Specifies that the call is unsuccessful.