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。

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

check_point.mgmt 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ← (默认)

  • true

color

字符串

对象的颜色。应为现有颜色之一。

选择

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特 蓝色"

  • "浅棕褐色"

  • "青色"

  • "深 绿色"

  • "卡其色"

  • "兰花紫"

  • "深 橙色"

  • "深 海 绿"

  • "粉红色"

  • "绿松石色"

  • "深 蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林 绿色"

  • "金色"

  • "深 金色"

  • "灰色"

  • "深 灰色"

  • "浅 绿色"

  • "柠檬 雪纺"

  • "珊瑚色"

  • "海 绿色"

  • "天 蓝色"

  • "洋红色"

  • "紫色"

  • "板岩 蓝色"

  • "紫罗兰 红色"

  • "海军 蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

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”，则此参数不是必需的。

选择

  • "网关"

  • "ip-地址"

install_on

字符串

哪个网关应应用 NAT 转换。

ip_address

字符串

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

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

method

字符串

NAT 转换方法。

选择

  • "隐藏"

  • "静态"

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)