check_point.mgmt.cp_mgmt_set_login_restrictions module – Set login restrictions.

Note

This module is part of the check_point.mgmt collection (version 6.8.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install check_point.mgmt.

To use it in a playbook, specify: check_point.mgmt.cp_mgmt_set_login_restrictions.

New in check_point.mgmt 6.7.0

Synopsis

  • Set login restrictions.

  • This command is available only after logging in to the System Data domain.

  • All operations are performed over Web Services API.

  • Available from R82.10 management version.

Parameters

Parameter

Comments

auto_publish_session

boolean

Publish the current session if changes have been performed after task completes.

Choices:

  • false ← (default)

  • true

display_access_denied_message

boolean

Indicates whether to display informative message upon denying access. <font color=”red”>Required only when</font> lockout-admin-account is set to true.

Choices:

  • false

  • true

failed_authentication_attempts

integer

Number of failed authentication attempts before lockout administrator account. <font color=”red”>Required only when</font> lockout-admin-account is set to true.

Valid values are between 1 and 120.

lockout_admin_account

boolean

Indicates whether to lockout administrator’s account after specified number of failed authentication attempts.

Choices:

  • false

  • true

lockout_duration

integer

Number of minutes of administrator account lockout. <font color=”red”>Required only when</font> lockout-admin-account is set to true.

Valid values are between 1 and 120.

unlock_admin_account

boolean

Indicates whether to unlock administrator account after specified number of minutes. <font color=”red”>Required only when</font> lockout-admin-account is set to true.

Choices:

  • false

  • true

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

Wait for the task to end. Such as publish task.

Choices:

  • false

  • true ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: set-login-restrictions
  cp_mgmt_set_login_restrictions:
    display_access_denied_message: false
    failed_authentication_attempts: 10
    lockout_admin_account: true
    lockout_duration: 30
    unlock_admin_account: false

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

cp_mgmt_set_login_restrictions

dictionary

The checkpoint set-login-restrictions output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)