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

New in version 2.9.

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.

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.



Status

Authors

  • Or Soffer (@chkp-orso)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.