check_point.mgmt.cp_mgmt_nat_rule_facts 模块 – 通过 Web 服务 API 在 Checkpoint 上获取 nat-rule 对象的事实

注意

此模块是 check_point.mgmt 集合（版本 6.2.1）的一部分。

如果您正在使用 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install check_point.mgmt。

要在 playbook 中使用它，请指定：check_point.mgmt.cp_mgmt_nat_rule_facts。

check_point.mgmt 2.0.0 中的新增功能

概要

  • 在 Checkpoint 设备上获取 nat-rule 对象的事实。

  • 所有操作都通过 Web 服务 API 执行。

  • 此模块处理两种操作，获取特定对象和获取多个对象。要获取特定对象，请使用参数“name”。

参数

参数

注释

dereference_group_members

布尔值

指示是否在回复中为每个对象按详细级别取消引用“members”字段。

选项

  • false

  • true

details_level

字符串

响应中某些字段的详细程度可能从仅显示对象的 UID 值到对象的完整详细表示不等。

选项

  • "uid"

  • "standard"

  • "full"

filter

字符串

用于筛选规则库的搜索表达式。提供的文本应与在 Smart Console 中给出的文本完全相同。表达式中的逻辑运算符（“AND”、“OR”）应以大写字母提供。如果不使用运算符，则默认应用 OR 运算符。

filter_settings

字典

设置筛选首选项。

packet_search_settings

字典

当“search-mode”设置为“packet”时，此对象允许设置数据包搜索首选项。

expand_group_members

布尔值

如果为 true，则如果搜索表达式包含组对象的 UID 或名称，则结果将包括至少匹配组的一个成员的规则。

选项

  • false

  • true

expand_group_with_exclusion_members

布尔值

如果为 true，则如果搜索表达式包含带有排除项的组对象的 UID 或名称，则结果将包括至少匹配“include”部分的一个成员且不是“except”部分的成员的规则。

选项

  • false

  • true

match_on_any

布尔值

是否匹配“Any”对象。

选项

  • false

  • true

match_on_group_with_exclusion

布尔值

是否匹配带有排除项的组。

选项

  • false

  • true

match_on_negate

布尔值

是否匹配否定的单元格。

选项

  • false

  • true

search_mode

字符串

当设置为“general”时，启用全文搜索和数据包搜索。在此模式下，数据包搜索将不匹配“Any”对象、否定的单元格或带有排除项的组。当 search-mode 设置为“packet”时，默认情况下，启用匹配“Any”对象、否定的单元格或带有排除项的组。可以提供 packet-search-settings 来更改默认行为。

选项

  • "general"

  • "packet"

limit

整数

返回结果的最大数量。此参数仅与获取少量对象相关。

name

字符串

规则名称。此参数仅与获取特定对象相关。所需的最低版本为 1.7.1。

offset

整数

最初跳过的结果数量。此参数仅与获取少量对象相关。

order

列表 / 元素=字典

按搜索条件对结果进行排序。自动按名称升序对结果进行排序。此参数仅与获取少量对象相关。

ASC

字符串

按给定字段升序对结果进行排序。

选项

  • "name"

DESC

字符串

按给定字段降序对结果进行排序。

选项

  • "name"

package

字符串

包的名称。

rule_number

字符串

规则编号。

show_membership

布尔值

指示是否计算并显示回复中每个对象的“groups”字段。

选项

  • false

  • true

use_object_dictionary

布尔值

不适用

选项

  • false

  • true

version

字符串

检查点的版本。如果未给出版本，则采用最新版本。

示例

- name: show-nat-rule
  cp_mgmt_nat_rule_facts:
    package: standard
    name: nat_rule1

- name: show-nat-rulebase
  cp_mgmt_nat_rule_facts:
    details_level: standard
    limit: 2
    offset: 1
    package: standard
    use_object_dictionary: true

作者

  • Or Soffer (@chkp-orso)