check_point.mgmt.cp_mgmt_https_section – Manages https-section objects on Checkpoint 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.cp_mgmt_https_section.

New in version 2.9: of check_point.mgmt

Synopsis

  • Manages https-section objects on Checkpoint devices including creating, updating and removing objects.

  • All operations are performed over Web Services API.

Parameters

Parameter Choices/Defaults Comments
auto_publish_session
boolean
    Choices:
  • no
  • yes
Publish the current session if changes have been performed after task completes.
details_level
string
    Choices:
  • 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
    Choices:
  • 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
    Choices:
  • no
  • yes
Apply changes ignoring warnings.
layer
string
Layer that holds the Object. Identified by the Name or UID.
name
string / required
Object name.
position
string
Position in the rulebase.
state
string
    Choices:
  • present ←
  • absent
State of the access rule (present or absent). Defaults to present.
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: add-https-section
  cp_mgmt_https_section:
    layer: Default Layer
    name: New Section 1
    position: 1
    state: present

- name: set-https-section
  cp_mgmt_https_section:
    layer: Default Layer
    name: New Section 1
    state: present

- name: delete-https-section
  cp_mgmt_https_section:
    layer: Default Layer
    name: New Section 2
    state: absent

Return Values

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

Key Returned Description
cp_mgmt_https_section
dictionary
always, except when deleting the object.
The checkpoint object created or updated.



Authors

  • Or Soffer (@chkp-orso)