check_point.mgmt.cp_mgmt_network_probe 模块 – 通过 Web Services API 在 Checkpoint 上管理网络探测对象

注意

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

check_point.mgmt 6.0.0 中的新增功能

概要

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

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

参数

参数

注释

auto_publish_session

布尔值

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

选项

  • false ←（默认）

  • true

color

字符串

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

选项

  • "水绿色"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "黄褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿"

  • "粉色"

  • "绿松石色"

  • "深蓝色"

  • "火砖红"

  • "棕色"

  • "森林绿"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺色"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝色"

  • "紫红色"

  • "海军蓝"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选项

  • "uid"

  • "标准"

  • "完整"

domains_to_process

列表 / 元素=字符串

指示要在哪些域上处理命令。它不能与详细级别完整一起使用，必须仅从系统域运行，并且 ignore-warnings 为 true。有效值包括：CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

http_options

字典

当 [protocol] 设置为 “http” 时，其他选项。

destination

字符串

目标 URL。

icmp_options

字典

当 [protocol] 设置为 “icmp” 时，其他选项。

destination

字符串

以下之一：
- 具有单播 IPv4 地址的现有对象（主机、安全网关等）的名称或 UID。
- 单播 IPv4 地址字符串（如果您不想创建此类对象）。

source

字符串

以下之一：
- 字符串 “main-ip”（探测使用您在参数 [install-on] 中指定的安全网关对象的主 IPv4 地址）。
- 具有单播 IPv4 地址的 “主机” 类型现有对象的名称或 UID。
- 单播 IPv4 地址字符串（如果您不想创建此类对象）。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

install_on

列表 / 元素=字符串

生成探测的 Check Point 安全网关的集合，通过名称或 UID 标识。

interval

整数

每个探测请求之间的时间间隔，范围为 5-300（秒）。最佳实践 - interval 值应小于 timeout 值。

name

字符串 / 必填

对象名称。

protocol

字符串

要使用的探测协议。

选项

  • "http"

  • "icmp"

state

字符串

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

选项

  • "present" ←（默认）

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

timeout

整数

探测过期超时时间，范围为 5-300（秒）。如果在此时间内没有收到任何回复，则探测的状态将更改为 “Down”。

version

字符串

checkpoint 的版本。如果未给定版本，则采用最新版本。

wait_for_task

布尔值

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

选项

  • false

  • true ←（默认）

wait_for_task_timeout

整数

等待多少分钟，直到抛出超时错误。

默认： 30

示例

- name: add-network-probe
  cp_mgmt_network_probe:
    icmp_options:
      destination: HOST_20.20.20.20
      source: Host_10.10.10.10
    install_on: GW_1
    name: probe_GW1
    state: present

- name: set-network-probe
  cp_mgmt_network_probe:
    icmp_options:
      destination: 2.2.2.2
      source: 1.1.1.1
    name: probe_GW1
    state: present

- name: delete-network-probe
  cp_mgmt_network_probe:
    name: probe_GW1
    state: absent

返回值

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

键

描述

cp_mgmt_network_probe

字典

创建或更新的 checkpoint 对象。

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

作者

  • Eden Brillant (@chkp-edenbr)