check_point.mgmt.cp_mgmt_set_smart_console_idle_timeout module – Set SmartConsole idle timeout 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_smart_console_idle_timeout.

New in check_point.mgmt 6.7.0

Synopsis

  • Set SmartConsole idle timeout 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

auto_publish_session

boolean

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

Choices:

  • false ← (default)

  • true

enabled

boolean

Indicates whether to perform logout after being idle.

Choices:

  • false

  • true

timeout_duration

integer

Number of minutes that the SmartConsole will automatically logout after being idle.

Updating the interval will take effect only on the next login.

Valid values are between 1 and 120.

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-smart-console-idle-timeout
  cp_mgmt_set_smart_console_idle_timeout:
    enabled: true
    timeout_duration: 30

Return Values

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

Key

Description

cp_mgmt_set_smart_console_idle_timeout

dictionary

The checkpoint set-smart-console-idle-timeout output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)