check_point.mgmt.cp_mgmt_set_nat_rule module – Edit 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_set_nat_rule.

New in version 2.9: of check_point.mgmt

Synopsis

  • Edit existing object using object name or uid.

  • All operations are performed over Web Services API.

Parameters

Parameter

Comments

comments

string

Comments string.

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.

Choices:

  • uid

  • standard

  • full

enabled

boolean

Enable/Disable the rule.

Choices:

  • no

  • yes

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.

Choices:

  • no

  • yes

ignore_warnings

boolean

Apply changes ignoring warnings.

Choices:

  • no

  • yes

install_on

list / elements=string

Which Gateways identified by the name or UID to install the policy on.

method

string

Nat method.

Choices:

  • static

  • hide

  • nat64

  • nat46

new_position

string

New position in the rulebase.

original_destination

string

Original destination.

original_service

string

Original service.

original_source

string

Original source.

package

string

Name of the package.

rule_number

string

Rule number.

translated_destination

string

Translated destination.

translated_service

string

Translated service.

translated_source

string

Translated source.

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.

Choices:

  • no

  • yes ← (default)

wait_for_task_timeout

integer

How many minutes to wait until throwing a timeout error.

Default: 30

Examples

- name: set-nat-rule
  cp_mgmt_set_nat_rule:
    comments: rule for RND members  RNDNetwork-> RND to Internal Network
    enabled: false
    original_service: ssh_version_2
    original_source: Any
    package: standard
    state: present

Return Values

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

Key

Description

cp_mgmt_set_nat_rule

dictionary

The checkpoint set-nat-rule output.

Returned: always.

Authors

  • Or Soffer (@chkp-orso)