check_point.mgmt.cp_mgmt_interface 模块 – 通过 Web 服务 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_interface。

check_point.mgmt 6.2.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的接口对象，包括创建、更新和删除对象。

  • 适用于 R82 及更高版本的设备。

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

参数

参数

注释

anti_spoofing

布尔值

启用反欺骗。

选项

  • false

  • true

anti_spoofing_settings

字典

反欺骗设置。

action

字符串

如果数据包将被拒绝（阻止选项）或者数据包将被监控（检测选项）。

选项

  • "prevent"

  • "detect"

exclude_packets

布尔值

不要检查来自排除网络的数据包。

选项

  • false

  • true

excluded_network_name

字符串

排除的网络名称。

excluded_network_uid

字符串

排除的网络 UID。

spoof_tracking

字符串

欺骗跟踪。

选项

  • "none"

  • "log"

  • "alert"

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

cluster_members

列表 / 元素=字典

集群成员的网络接口设置。

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"

ignore_errors

布尔值

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

选项

  • 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 网络掩码长度。

member_name

字符串

集群成员对象名称。

name

字符串

集群成员网络接口名称。

network_mask

字符串

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

tags

列表 / 元素=字符串

标签标识符集合。

cluster_network_type

字符串

集群接口类型。

选项

  • "cluster"

  • "sync"

  • "cluster + sync"

  • "private"

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。

dynamic_ip

布尔值

启用动态接口。

选项

  • false

  • true

gateway_uid

字符串 / 必需

接口所属的网关或集群对象的UID。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

ipv4_address

字符串

IPv4 网络地址。

ipv4_mask_length

整数

IPv4掩码长度。

ipv4_network_mask

字符串

IPv4网络掩码。

ipv6_address

字符串

IPv6 地址。

ipv6_mask_length

整数

IPv6掩码长度。

ipv6_network_mask

字符串

IPv6网络掩码。

monitored_by_cluster

布尔值

当选择“私有”作为集群接口类型时，集群可以选择监控或不监控该接口。

选项

  • false

  • true

name

字符串 / 必需

网络接口名称。

network_interface_type

字符串

网络接口类型。

选项

  • “别名”

  • “bond”

  • “桥接”

  • “桥接成员”

  • “以太网”

  • “环回”

  • “6 in 4 隧道”

  • “pppoe”

  • “VPN隧道”

  • “VLAN”

security_zone_settings

字典

安全区域设置。

auto_calculated

布尔值

安全区域根据接口连接的位置自动计算。

选项

  • false

  • true

specific_zone

字符串

手动指定的安全区域。

state

字符串

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

选项

  • "present" ← (默认)

  • “absent”

tags

列表 / 元素=字符串

标签标识符集合。

topology

字符串

拓扑配置。

选项

  • “自动”

  • “外部”

  • “内部”

topology_settings

字典

拓扑设置。

interface_leads_to_dmz

布尔值

此接口是否连接到非军事区（周界网络）。

选项

  • false

  • true

ip_address_behind_this_interface

字符串

此接口后面的网络设置。

选项

  • “未定义”

  • “由接口IP和网络掩码定义的网络”

  • “由路由定义的网络”

  • “特定”

specific_network

字符串

此接口后面的网络。

specific_network_uid

字符串

N/A

version

字符串

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

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

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

默认： 30

示例

- name: add-interface
  cp_mgmt_interface:
    anti_spoofing: true
    anti_spoofing_settings:
      action: detect
      exclude_packets: false
      spoof_tracking: log
    cluster_members:
    - ipv4_address: 2.2.2.1
      ipv4_mask_length: 24
      ipv4_network_mask: 255.255.255.0
      member_name: member1
      name: eth4
    - ipv4_address: 2.2.2.2
      ipv4_mask_length: 24
      ipv4_network_mask: 255.255.255.0
      member_name: member2
      name: eth4
    cluster_network_type: cluster
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17
    ignore_warnings: false
    ipv4_address: 1.1.1.111
    ipv4_mask_length: 24
    name: eth0
    security_zone_settings:
      auto_calculated: false
      specific_zone: InternalZone
    state: present
    topology: internal
    topology_settings:
      interface_leads_to_dmz: false
      ip_address_behind_this_interface: network defined by routing

- name: set-interface
  cp_mgmt_interface:
    cluster_members:
    - ipv4_address: 4.4.4.1
      ipv4_mask_length: 22
      member_name: memberReal1
      uid: db4f8a63-5a94-46d8-b9e0-a63870bded3d
    - ipv4_address: 4.4.4.2
      ipv4_mask_length: 22
      member_name: memberReal2
      uid: baca571e-8ada-4be9-8966-145388f8e238
    cluster_network_type: cluster + sync
    ipv4_address: 4.4.4.111
    ipv4_mask_length: 22
    state: present
    topology: internal
    topology_settings:
      ip_address_behind_this_interface: network defined by routing
    name: eth0
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17

- name: delete-interface
  cp_mgmt_interface:
    state: absent
    name: eth0
    gateway_uid: 20ec49e8-8cd8-4ad4-b204-0de8ae4e0e17

返回值

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

键

描述

cp_mgmt_interface

字典

已创建或更新的Checkpoint对象。

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

作者

  • Eden Brillant (@chkp-edenbr)