check_point.mgmt.cp_mgmt_discard – All changes done by user are discarded and removed from database.

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.cp_mgmt_discard.

New in version 2.9: of check_point.mgmt

Synopsis

  • All changes done by user are discarded and removed from database.
  • All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
uid
string
Session unique identifier. Specify it to discard a different session than the one you currently use.
version
string
Version of checkpoint. If not given one, the latest version taken.
wait_for_task
boolean
    Choices:
  • no
  • yes
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: discard
  cp_mgmt_discard:

Return Values

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

Key Returned Description
cp_mgmt_discard
dictionary
always.
The checkpoint discard 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/latest/collections/check_point/mgmt/cp_mgmt_discard_module.html