check_point.mgmt.cp_mgmt_simple_gateway 模块 – 通过 Web 服务 API 管理 Check Point 上的 simple-gateway 对象

注意

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

check_point.mgmt 1.0.0 中的新增功能

概要

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

  • 所有操作均通过 Web 服务 API 执行。

参数

参数

注释

anti_bot

布尔值

启用反机器人刀片。

选项

  • false

  • true

anti_virus

布尔值

启用反病毒刀片。

选项

  • false

  • true

application_control

布尔值

启用应用程序控制刀片。

选项

  • false

  • true

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

字符串

注释字符串。

content_awareness

布尔值

启用内容感知刀片。

选项

  • false

  • true

details_level

字符串

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

选项

  • "uid"

  • "standard"

  • "full"

firewall

布尔值

启用防火墙刀片。

选项

  • false

  • true

firewall_settings

字典

N/A

auto_calculate_connections_hash_table_size_and_memory_pool

布尔值

N/A

选项

  • false

  • true

auto_maximum_limit_for_concurrent_connections

布尔值

N/A

选项

  • false

  • true

connections_hash_size

整数

N/A

maximum_limit_for_concurrent_connections

整数

N/A

maximum_memory_pool_size

整数

N/A

memory_pool_size

整数

N/A

gateway_version

字符串

网关平台版本。

groups

列表 / 元素=字符串

组标识符集合。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

interfaces

列表 / 元素=字典

网络接口。当网关使用新的接口更新时，现有的接口将被移除。

anti_spoofing

布尔值

N/A

选项

  • false

  • true

anti_spoofing_settings

字典

N/A

操作

字符串

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

选项

  • "prevent"

  • "detect"

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

name

字符串

对象名称。

network_mask

字符串

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

security_zone

布尔值

N/A

选项

  • false

  • true

security_zone_settings

字典

N/A

auto_calculated

布尔值

安全区域根据接口的指向位置计算。

选项

  • false

  • true

specific_zone

字符串

手动指定的安全区域。

tags

列表 / 元素=字符串

标签标识符集合。

topology

字符串

N/A

选项

  • "automatic"

  • "external"

  • "internal"

topology_settings

字典

N/A

interface_leads_to_dmz

布尔值

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

选项

  • false

  • true

ip_address_behind_this_interface

字符串

N/A

选项

  • "not defined"

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

  • "network defined by routing"

  • "specific"

specific_network

字符串

此接口后面的网络。

ip_address

字符串

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

ips

布尔值

启用入侵防护系统刀片。

选项

  • false

  • true

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

logs_settings

字典

N/A

alert_when_free_disk_space_below

布尔值

N/A

选项

  • false

  • true

alert_when_free_disk_space_below_threshold

整数

N/A

alert_when_free_disk_space_below_type

字符串

N/A

选项

  • "none"

  • "log"

  • "popup alert"

  • "mail alert"

  • "snmp trap alert"

  • "user defined alert no.1"

  • "user defined alert no.2"

  • "user defined alert no.3"

before_delete_keep_logs_from_the_last_days

布尔值

N/A

选项

  • false

  • true

before_delete_keep_logs_from_the_last_days_threshold

整数

N/A

before_delete_run_script

布尔值

N/A

选项

  • false

  • true

before_delete_run_script_command

字符串

N/A

delete_index_files_older_than_days

布尔值

N/A

选项

  • false

  • true

delete_index_files_older_than_days_threshold

整数

N/A

delete_index_files_when_index_size_above

布尔值

N/A

选项

  • false

  • true

delete_index_files_when_index_size_above_threshold

整数

N/A

低于可用磁盘空间时删除

布尔值

N/A

选项

  • false

  • true

低于可用磁盘空间阈值时删除

整数

N/A

检测新的Citrix ICA应用程序名称

布尔值

N/A

选项

  • false

  • true

将日志转发到日志服务器

布尔值

N/A

选项

  • false

  • true

日志服务器名称

字符串

N/A

日志服务器转发计划名称

字符串

N/A

可用磁盘空间指标

字符串

N/A

选项

  • 兆字节(MB)

  • 百分比

在日志转发之前执行日志轮转

布尔值

N/A

选项

  • false

  • true

低于可用磁盘空间阈值时拒绝连接

布尔值

N/A

选项

  • false

  • true

为数据包捕获保留的指标

字符串

N/A

选项

  • 百分比

  • 兆字节(MB)

为数据包捕获保留的阈值

整数

N/A

按文件大小轮转日志

布尔值

N/A

选项

  • false

  • true

日志文件大小阈值

整数

N/A

按计划轮转日志

布尔值

N/A

选项

  • false

  • true

日志轮转计划名称

字符串

N/A

低于可用磁盘空间时停止日志记录

布尔值

N/A

选项

  • false

  • true

低于可用磁盘空间阈值时停止日志记录

整数

N/A

启用QoS日志记录

布尔值

N/A

选项

  • false

  • true

每隔多久更新帐户日志

整数

N/A

name

字符串 / 必填

对象名称。

一次性密码

字符串

N/A

操作系统名称

字符串

网关平台操作系统。

本地保存日志

布尔值

在网关上本地保存日志。

选项

  • false

  • true

将警报发送到服务器

列表 / 元素=字符串

发送警报的目标服务器。

将日志发送到备份服务器

列表 / 元素=字符串

发送日志的目标备份服务器。

将日志发送到服务器

列表 / 元素=字符串

发送日志的目标服务器。

状态

字符串

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

选项

  • "present" ← (默认)

  • "不存在"

tags

列表 / 元素=字符串

标签标识符集合。

威胁仿真

布尔值

启用威胁仿真刀片。

选项

  • false

  • true

威胁提取

布尔值

启用威胁提取刀片。

选项

  • false

  • true

URL过滤

布尔值

启用URL过滤刀片。

选项

  • false

  • true

版本

字符串

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

VPN

布尔值

启用VPN刀片。

选项

  • false

  • true

VPN设置

字典

网关VPN设置。

最大并发IKE协商

整数

N/A

最大并发隧道

整数

N/A

等待任务完成

布尔值

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

选项

  • false

  • true ← (默认)

等待任务超时

整数

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

默认： 30

示例

- name: add-simple-gateway
  cp_mgmt_simple_gateway:
    ip_address: 192.0.2.1
    name: gw1
    state: present

- name: set-simple-gateway
  cp_mgmt_simple_gateway:
    anti_bot: true
    anti_virus: true
    application_control: true
    ips: true
    name: test_gateway
    state: present
    threat_emulation: true
    url_filtering: true

- name: delete-simple-gateway
  cp_mgmt_simple_gateway:
    name: gw1
    state: absent

返回值

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

键

描述

cp_mgmt_simple_gateway

字典

已创建或更新的Checkpoint对象。

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

作者

  • Or Soffer (@chkp-orso)