Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › User Methods › DisableMaxLoginFail Method—Sets or Retrieves Disabled-by-Max-Login-Failure Flag

DisableMaxLoginFail Method—Sets or Retrieves Disabled-by-Max-Login-Failure Flag

The DisableMaxLoginFail method sets or retrieves the disabled-by-max-login-failure flag which specifies whether the user account is disabled because the number of login failures exceeded the maximum allowed.

Syntax

The DisableMaxLoginFail method has the following format:

Netegrity::PolicyMgtUser‑>DisableMaxLoginFail([disableFlag])

Parameters

The DisableMaxLoginFail method accepts the following parameter:

disableFlag (int)

(Optional) Specifies a new value for the disabled-by-max-login-failure flag.

• value = 1

  Specifies that the user account is disabled because the number of login failures exceeded the maximum allowed.

• value = 0

  Specifies that the user account is not disabled because the number of login failures exceeded the maximum allowed.

  Note: The user account can be disabled for other reasons. For more information, see Remarks.

Return Value

The DisableMaxLoginFail method returns the new or existing value for the disabled-by-max-login-failure flag:

• value = 1

  Specifies that the user account is disabled because the number of login failures exceeded the maximum allowed.

• value = 0

  Specifies that the user account is not disabled because the number of login failures exceeded the maximum allowed.

  Note: The user account can be disabled for other reasons. For more information, see Remarks.

• value = -1

  Specifies that the call is unsuccessful.

Remarks

User accounts can be disabled for one or more of the following reasons:

• The administrator disabled the user account.

  For more information, see the method PolicyMgtUser‑>DisableByAdmin.

• Account inactivity exceeded the time allowed.

  For more information, see the method PolicyMgtUser‑>DisableInactive.

• The number of login failures exceeded the maximum allowed.
• The password expired.

  For more information, see the method PolicyMgtUser‑>DisablePwdExpired.