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.2.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.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 |
Comments |
---|---|
Action to perform on the session object. Valid choices are published and discarded. Choices:
|
|
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 |
Description |
---|---|
The checkpoint session output per return from API. It will differ depending on action. Returned: always. |
Authors
Ansible by Red Hat (@rcarrillocruz)