check_point.mgmt.cp_mgmt_set_login_message module – Edit Login message.

Note

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

New in check_point.mgmt 5.0.0

Synopsis

  • Edit Login message.

  • All operations are performed over Web Services API.

  • Available from R80 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

details_level

string

The level of detail for some of the fields in the response can vary from showing only the UID value of the object to a fully detailed representation of the object.

Choices:

  • "uid"

  • "standard"

  • "full"

header

string

Login message header.

login_message

string

Login message body.

show_message

boolean

Whether to show login message.

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

warning

boolean

Add warning sign.

Choices:

  • false

  • true

Examples

- name: set-login-message
  cp_mgmt_set_login_message:
    header: Warning
    login_message: Unauthorized access of this server is prohibited and punished by law
    show_message: 'true'
    warning: 'true'

Return Values

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

Key

Description

cp_mgmt_set_login_message

dictionary

The checkpoint set-login-message output.

Returned: always.

Authors

  • Eden Brillant (@chkp-edenbr)