check_point.mgmt.cp_mgmt_set_session – Edit user’s current session.
check_point.mgmt.cp_mgmt_set_session – Edit user’s current session.
Note
This plugin is part of the check_point.mgmt collection (version 2.0.0).
To install it use: ansible-galaxy collection install check_point.mgmt.
To use it in a playbook, specify: check_point.mgmt.cp_mgmt_set_session.
New in version 2.9: of check_point.mgmt
Synopsis
- Edit user’s current session.
- All operations are performed over Web Services API.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
|
color string |
|
Color of the object. Should be one of existing colors. |
|
comments string |
Comments string. | |
|
description string |
Session description. | |
|
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. |
|
ignore_errors boolean |
|
Apply changes ignoring errors. You won't be able to publish such a changes. If ignore-warnings flag was omitted - warnings will also be ignored. |
|
ignore_warnings boolean |
|
Apply changes ignoring warnings. |
|
new_name string |
New name of the object. | |
|
tags list / elements=string |
Collection of tag identifiers. | |
|
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. |
|
wait_for_task_timeout integer |
Default: 30 |
How many minutes to wait until throwing a timeout error. |
Examples
- name: set-session
cp_mgmt_set_session:
description: Session to work on ticket number CR00323665
state: present
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
|
cp_mgmt_set_session dictionary |
always. |
The checkpoint set-session output.
|
Authors
- Or Soffer (@chkp-orso)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/check_point/mgmt/cp_mgmt_set_session_module.html