check_point.mgmt.cp_mgmt_delete_data_center_object module – Delete existing object using object name or uid.
Note
This module is part of the check_point.mgmt collection (version 2.3.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.cp_mgmt_delete_data_center_object
.
New in version 2.9: of check_point.mgmt
Synopsis
Delete existing object using object name or uid.
All operations are performed over Web Services API.
Parameters
Parameter |
Comments |
---|---|
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. Choices:
|
|
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. Choices:
|
|
Apply changes ignoring warnings. Choices:
|
|
Object name. |
|
Version of checkpoint. If not given one, the latest version taken. |
|
Wait for the task to end. Such as publish task. Choices:
|
|
How many minutes to wait until throwing a timeout error. Default: 30 |
Examples
- name: delete-data-center-object
cp_mgmt_delete_data_center_object:
name: VM1 mgmt name
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The checkpoint delete-data-center-object output. Returned: always. |
Authors
Or Soffer (@chkp-orso)