check_point.mgmt.checkpoint_session – Manages session objects on Check Point over Web Services API
Note
This plugin is part of the check_point.mgmt collection (version 2.1.1).
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.checkpoint_session.
New in version 2.7: of check_point.mgmt
Synopsis
- Manages session objects on Check Point devices performing actions like publish and discard. All operations are performed over Web Services API.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| state
string
|
|
Action to perform on the session object. Valid choices are published and discarded.
|
| uid
string / required
|
UID of the session.
|
Examples
- name: Publish session
checkpoint_session:
uid: 7a13a360-9b24-40d7-acd3-5b50247be33e
state: published
- name: Discard session
checkpoint_session:
uid: 7a13a360-9b24-40d7-acd3-5b50247be33e
state: discarded
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| checkpoint_session
list / elements=string
|
always. |
The checkpoint session output per return from API. It will differ depending on action.
|
Authors
- Ansible by Red Hat (@rcarrillocruz)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/checkpoint_session_module.html