check_point.mgmt.cp_mgmt_interoperable_device 模块 – 通过 Web Services API 管理 Checkpoint 上的可互操作设备对象

注意

此模块是 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_interoperable_device。

check_point.mgmt 3.0.0 中的新增功能

摘要

  • 管理 Checkpoint 设备上的可互操作设备对象，包括创建、更新和删除对象。

  • 所有操作均通过 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"

domains_to_process

列表 / 元素=字符串

指示在哪些域上处理命令。它不能与 details-level full 一起使用，必须仅从系统域运行并使用 ignore-warnings true。有效值为 CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

groups

列表 / 元素=字符串

组标识符集合。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

interfaces

列表 / 元素=字典

网络接口。

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"

domains_to_process

列表 / 元素=字符串

指示在哪些域上处理命令。它不能与 details-level full 一起使用，必须仅从系统域运行并使用 ignore-warnings true。有效值为 CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

ip_address

字符串

IPv4 或 IPv6 地址。如果需要两个地址，请明确使用 ipv4-address 和 ipv6-address 字段。

ipv4_address

字符串

IPv4 地址。

ipv4_mask_length

字符串

IPv4 网络掩码长度。

ipv4_network_mask

字符串

IPv4 网络地址。

ipv6_address

字符串

IPv6 地址。

ipv6_mask_length

字符串

IPv6 网络掩码长度。

ipv6_network_mask

字符串

IPv6 网络地址。

mask_length

字符串

IPv4 或 IPv6 网络掩码长度。

name

字符串

对象名称。在域中必须唯一。

network_mask

字符串

IPv4 或 IPv6 网络掩码。如果需要两个掩码，请明确使用 ipv4-network-mask 和 ipv6-network-mask 字段。无需提供掩码本身，可以在 mask-length 字段中指定 IPv4 或 IPv6 掩码长度。如果需要两个掩码长度，请明确使用 ipv4-mask-length 和 ipv6-mask-length 字段。

tags

列表 / 元素=字符串

标签标识符集合。

topology

字符串

拓扑配置。

选项

  • "external"

  • "internal"

topology_settings

字典

内部拓扑设置。

interface_leads_to_dmz

布尔值

此接口是否通向非军事区 (周界网络)。

选项

  • false

  • true

ip_address_behind_this_interface

字符串

此接口后面的网络设置。

选项

  • "not defined"

  • "network defined by the interface ip and net mask"

  • "network defined by routing"

  • "specific"

specific_network

字符串

此接口后面的网络。

ip_address

字符串

IPv4 或 IPv6 地址。

ipv4_address

字符串

可互操作设备的 IPv4 地址。

ipv6_address

字符串

可互操作设备的 IPv6 地址。

name

字符串 / 必需

对象名称。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符集合。

version

字符串

Checkpoint 版本。如果未指定，则采用最新版本。

vpn_settings

字典

可互操作设备的 VPN 域属性。

vpn_domain

字符串

表示自定义加密域的网络组。当 vpn-domain-type 设置为“manual”选项时，必须设置此项。

vpn_domain_exclude_external_ip_addresses

布尔值

从此可互操作设备的 VPN 域中排除外部 IP 地址。

选项

  • false

  • true

vpn_domain_type

字符串

指示加密域。

选项

  • "manual"

  • "addresses_behind_gw"

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

在抛出超时错误之前等待多少分钟。

默认： 30

示例

- name: add-interoperable-device
  cp_mgmt_interoperable_device:
    ip_address: 192.168.1.6
    name: NewInteroperableDevice
    state: present

- name: set-interoperable-device
  cp_mgmt_interoperable_device:
    ip_address: 192.168.1.6
    name: NewInteroperableDevice
    state: present

- name: delete-interoperable-device
  cp_mgmt_interoperable_device:
    name: NewInteroperableDevice
    state: absent

返回值

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

键

描述

cp_mgmt_interoperable_device

字典

已创建或更新的 Checkpoint 对象。

返回： 始终返回，除非删除对象。

作者

  • Eden Brillant (@chkp-edenbr)