On this page
check_point.mgmt.cp_mgmt_nat_section – Manages nat-section objects on Checkpoint over Web Services API
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_nat_section
.
New in version 2.9: of check_point.mgmt
Synopsis
- Manages nat-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
|
|
Publish the current session if changes have been performed after task completes.
|
details_level
string
|
|
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
|
|
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
|
|
Apply changes ignoring warnings.
|
name
string / required
|
Object name.
|
|
package
string
|
Name of the package.
|
|
position
string
|
Position in the rulebase.
|
|
state
string
|
|
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
|
|
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-nat-section
cp_mgmt_nat_section:
name: New Section 1
package: standard
position: 1
state: present
- name: set-nat-section
cp_mgmt_nat_section:
name: New Section 1
package: standard
state: present
- name: delete-nat-section
cp_mgmt_nat_section:
name: New Section 1
package: standard
state: absent
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
cp_mgmt_nat_section
dictionary
|
always, except when deleting the object. |
The checkpoint object created or updated.
|
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_nat_section_module.html