cp_mgmt_set_login_message
Edit Login message through native controller HTTPAPI with owned sessions
Collection: check_point.mgmt
Full Name: check_point.mgmt.cp_mgmt_set_login_message
Controller module — runs on the local controller, not on remote hosts.
Synopsis
Edit Login message through native controller HTTPAPI with owned sessions
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| auto_publish_session | bool | false | Publish this owned session explicitly after the operation; default false. | |
| details_level | str | 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. | ||
| header | str | Login message header. | ||
| login_message | str | Login message body. | ||
| show_message | bool | Whether to show login message. | ||
| version | str | Management API version path; omitted uses the default API version. | ||
| wait_for_task | bool | true | Wait for returned asynchronous task identifiers; default true. | |
| wait_for_task_timeout | int | 30 | Polling deadline in minutes; default 30, negative values use 30, maximum 1440. | |
| warning | bool | Add warning sign. |
Example
yaml
- name: set-login-message
check_point.mgmt.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'