check_point.mgmt.cp_mgmt_set_default_administrator_settings module – Set default administrator settings.

Note

This module is part of the check_point.mgmt collection (version 6.7.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_default_administrator_settings.

New in check_point.mgmt 6.7.0

Synopsis

  • Set default administrator settings.

  • 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

authentication_method

string

Authentication method for new administrator.

Choices:

  • "undefined"

  • "check point password"

  • "os password"

  • "securid"

  • "radius"

  • "tacacs"

  • "ad authentication"

  • "api key"

  • "identity provider"

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

days_to_indicate_expiration_in_admin_view

integer

Number of days in advanced to show ‘about to expire’ indication in administrator view.

Valid values are between 1 and 99.

days_to_notify_expiration_to_admin

integer

Number of days in advanced to notify administrator about expiration.

Valid values are between 1 and 99.

expiration_date

string

Expiration date for new administrator in YYYY-MM-DD format. <font color=”red”>Required only when</font> ‘expiration-type’ is set to ‘expiration date’.

expiration_period

integer

Expiration period for new administrator. <font color=”red”>Required only when</font> ‘expiration-type’ is set to ‘expiration period’.

Valid values are between 1 and 99.

expiration_period_time_units

string

Expiration period time units for new administrator. <font color=”red”>Required only when</font> ‘expiration-type’ is set to ‘expiration period’.

Choices:

  • "days"

  • "months"

  • "years"

expiration_type

string

Expiration type for new administrator.

Choices:

  • "never"

  • "expiration date"

  • "expiration period"

indicate_expiration_in_admin_view

boolean

Indicates whether to notify administrator about expiration.

Choices:

  • false

  • true

notify_expiration_to_admin

boolean

Indicates whether to show ‘about to expire’ indication in administrator view.

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-default-administrator-settings
  cp_mgmt_set_default_administrator_settings:
    days_to_notify_expiration_to_admin: 5
    expiration_date: '2025-06-23'
    expiration_type: expiration date
    indicate_expiration_in_admin_view: false
    notify_expiration_to_admin: true

Return Values

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

Key

Description

cp_mgmt_set_default_administrator_settings

dictionary

The checkpoint set-default-administrator-settings output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)