check_point.mgmt.cp_mgmt_address_range 模块 – 通过 Web Services API 管理 Check Point 上的地址范围对象

注意

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

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

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

要在剧本中使用它，请指定：check_point.mgmt.cp_mgmt_address_range。

check_point.mgmt 1.0.0 中的新增功能

概要

  • 管理 Check Point 设备上的地址范围对象，包括创建、更新和删除对象。

  • 所有操作均通过 Web Services API 执行。

参数

参数

注释

auto_publish_session

布尔值

如果在任务完成后执行了更改，则发布当前会话。

选项

  • false ←（默认）

  • true

color

字符串

对象的颜色。应该是现有颜色之一。

选项

  • "aquamarine"

  • "black"

  • "blue"

  • "crete blue"

  • "burlywood"

  • "cyan"

  • "dark green"

  • "khaki"

  • "orchid"

  • "dark orange"

  • "dark sea green"

  • "pink"

  • "turquoise"

  • "dark blue"

  • "firebrick"

  • "brown"

  • "forest green"

  • "gold"

  • "dark gold"

  • "gray"

  • "dark gray"

  • "light green"

  • "lemon chiffon"

  • "coral"

  • "sea green"

  • "sky blue"

  • "magenta"

  • "purple"

  • "slate blue"

  • "violet red"

  • "navy blue"

  • "olive"

  • "orange"

  • "red"

  • "sienna"

  • "yellow"

comments

字符串

注释字符串。

details_level

字符串

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

选项

  • "uid"

  • "standard"

  • "full"

groups

列表 / 元素=字符串

组标识符的集合。

ignore_errors

布尔值

应用更改时忽略错误。您将无法发布此类更改。如果忽略了 ignore-warnings 标志，则警告也将被忽略。

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

ip_address_first

字符串

范围中的第一个 IP 地址。如果需要 IPv4 和 IPv6 地址范围，请改用 ipv4-address-first 和 ipv6-address-first 字段。

ip_address_last

字符串

范围中的最后一个 IP 地址。如果需要 IPv4 和 IPv6 地址范围，请改用 ipv4-address-first 和 ipv6-address-first 字段。

ipv4_address_first

字符串

范围中的第一个 IPv4 地址。

ipv4_address_last

字符串

范围中的最后一个 IPv4 地址。

ipv6_address_first

字符串

范围中的第一个 IPv6 地址。

ipv6_address_last

字符串

范围中的最后一个 IPv6 地址。

name

字符串 / 必需

对象名称。

nat_settings

字典

NAT 设置。

auto_rule

布尔值

是否添加自动地址转换规则。

选项

  • false

  • true

hide_behind

字符串

隐藏背后的方法。如果“method”参数为“static”，则不需要此参数。

选项

  • "gateway"

  • "ip-address"

install_on

字符串

哪个网关应应用 NAT 转换。

ip_address

字符串

IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。如果“method”参数为“hide”且“hide-behind”参数为“gateway”，则不需要此参数。

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

method

字符串

NAT 转换方法。

选项

  • "hide"

  • "static"

state

字符串

访问规则的状态（存在或不存在）。

选项

  • "present" ←（默认）

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

version

字符串

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

wait_for_task

布尔值

等待任务结束。例如发布任务。

选项

  • false

  • true ←（默认）

wait_for_task_timeout

整数

等待多少分钟才会抛出超时错误。

默认值： 30

示例

- name: add-address-range
  cp_mgmt_address_range:
    ip_address_first: 192.0.2.1
    ip_address_last: 192.0.2.10
    name: New Address Range 1
    state: present

- name: set-address-range
  cp_mgmt_address_range:
    color: green
    ip_address_first: 192.0.2.1
    ip_address_last: 192.0.2.1
    name: New Address Range 1
    new_name: New Address Range 2
    state: present

- name: delete-address-range
  cp_mgmt_address_range:
    name: New Address Range 2
    state: absent

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

cp_mgmt_address_range

字典

创建或更新的检查点对象。

返回值：始终返回，删除对象时除外。

作者

  • Or Soffer (@chkp-orso)