check_point.mgmt.cp_mgmt_delete_data_center_object – Delete existing object using object name or uid.

From Get docs
Ansible/docs/2.11/collections/check point/mgmt/cp mgmt delete data center object module


check_point.mgmt.cp_mgmt_delete_data_center_object – Delete existing object using object name or uid.

Note

This plugin is part of the check_point.mgmt collection (version 2.0.0).

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 Choices/Defaults Comments

details_level

string

  • uid
  • standard
  • full

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.

ignore_errors

boolean

  • no
  • yes

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.

ignore_warnings

boolean

  • no
  • yes

Apply changes ignoring warnings.

name

string

Object name.

version

string

Version of checkpoint. If not given one, the latest version taken.

wait_for_task

boolean

  • 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: 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 Returned Description

cp_mgmt_delete_data_center_object

dictionary

always.

The checkpoint delete-data-center-object 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/2.11/collections/check_point/mgmt/cp_mgmt_delete_data_center_object_module.html