cp_mgmt_nat_rule

Manages nat-rule objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Collection: check_point.mgmt

Full Name: check_point.mgmt.cp_mgmt_nat_rule

Controller module — runs on the local controller, not on remote hosts.

Synopsis

Manages nat-rule objects on Checkpoint over Web Services API through native controller HTTPAPI with owned sessions

Parameters

Name	Type	Required	Default	Description
auto_publish_session	bool		`false`	Publish this owned session explicitly after the operation; default false.
comments	str			Comments string.
details_level	str			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.
enabled	bool			Enable/Disable the rule.
ignore_errors	bool			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	bool			Apply changes ignoring warnings.
install_on	list			Which Gateways identified by the name or UID to install the policy on.
method	str			Nat method.
name	str	yes		Rule name. Available from R81 management version.
original_destination	str			Original destination.
original_service	str			Original service.
original_source	str			Original source.
package	str			Name of the package. Available from R80.10 management version.
position	str			Position in the rulebase. The use of values “top” and “bottom” may not be idempotent.
relative_position	dict			Position in the rulebase. Use of this field may not be idempotent.
search_entire_rulebase	bool		`false`	Whether to search the entire rulebase for a rule that’s been edited in its relative_position field to make sure there indeed has been a change in its position or the section it might be in.
state	str		`present`	Desired object presence.
translated_destination	str			Translated destination.
translated_service	str			Translated service.
translated_source	str			Translated source.
version	str			Management API version path; omitted uses the default API version.
wait_for_task	bool		`true`	Wait for returned asynchronous task identifiers; default true.
wait_for_task_timeout	int		`30`	Polling deadline in minutes; default 30, negative values use 30, maximum 1440.

Example

yaml

- name: add-nat-rule
  check_point.mgmt.cp_mgmt_nat_rule:
    name: nat_rule1
    comments: comment example1 nat999
    enabled: false
    install_on:
      - Policy Targets
    original_destination: All_Internet
    original_source: Any
    package: standard
    position: 1
    state: present

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

- name: delete-nat-rule
  check_point.mgmt.cp_mgmt_nat_rule:
    name: nat_rule1
    package: standard
    state: absent