check_point.mgmt.cp_mgmt_network 模块 – 通过 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_network。

check_point.mgmt 1.0.0 中的新增功能

概要

  • 管理 Check Point 设备上的网络对象，包括创建、更新和删除对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

broadcast

字符串

允许包含广播地址。

选项

  • "disallow"

  • "allow"

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

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

mask_length

整数

IPv4 或 IPv6 网络掩码长度。如果需要两个掩码，请显式使用 mask-length4 和 mask-length6 字段。除了 IPv4 掩码长度外，还可以在 subnet-mask 字段中指定 IPv4 掩码本身。

mask_length4

整数

IPv4 网络掩码长度。

mask_length6

整数

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"

subnet

字符串

IPv4 或 IPv6 网络地址。如果需要两个地址，请显式使用 subnet4 和 subnet6 字段。

subnet4

字符串

IPv4 网络地址。

subnet6

字符串

IPv6 网络地址。

subnet_mask

字符串

IPv4 网络掩码。

tags

列表 / 元素=字符串

标签标识符的集合。

version

字符串

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

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

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

默认： 30

示例

- name: add-network
  cp_mgmt_network:
    name: New Network 1
    state: present
    subnet: 192.0.2.0
    subnet_mask: 255.255.255.0

- name: set-network
  cp_mgmt_network:
    color: green
    mask_length: 16
    name: New Network 1
    new_name: New Network 2
    state: present
    subnet: 192.0.0.0

- name: delete-network
  cp_mgmt_network:
    name: New Network 2
    state: absent

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

cp_mgmt_network

字典

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

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

作者

  • Or Soffer (@chkp-orso)