check_point.mgmt.cp_mgmt_service_tcp 模块 – 通过 Web Services API 管理 Check Point 上的 service-tcp 对象

注意

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

check_point.mgmt 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

aggressive_aging

字典

为空闲连接设置短（激进）超时。

default_timeout

整数

默认的激进老化超时时间（秒）。

enable

布尔值

N/A

选项

  • false

  • true

timeout

整数

激进老化超时时间（秒）。

use_default_timeout

布尔值

N/A

选项

  • false

  • true

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

color

字符串

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

选项

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特 蓝色"

  • "黄褐色"

  • "青色"

  • "深 绿色"

  • "卡其色"

  • "兰花色"

  • "深 橙色"

  • "深 海 绿色"

  • "粉色"

  • "绿松石色"

  • "深 蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林 绿色"

  • "金色"

  • "深 金色"

  • "灰色"

  • "深 灰色"

  • "浅 绿色"

  • "柠檬 薄纱色"

  • "珊瑚色"

  • "海 绿色"

  • "天 蓝色"

  • "洋红色"

  • "紫色"

  • "板岩 蓝色"

  • "紫罗兰 红色"

  • "海军 蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选项

  • "uid"

  • "标准"

  • "完整"

groups

列表 / 元素=字符串

组标识符的集合。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

keep_connections_open_after_policy_installation

布尔值

即使新策略不允许连接，在安装策略后仍保持连接打开。这将覆盖“连接持久性”页面中的设置。如果更改此属性，则更改将不会影响打开的连接，而只会影响未来的连接。

选项

  • false

  • true

match_by_protocol_signature

布尔值

值为 true 时，启用通过所选协议的签名进行匹配 - 签名将协议标识为真实协议。选择此选项可将端口限制为指定的协议。如果所选协议不支持通过签名进行匹配，则此字段不能设置为 true。

选项

  • false

  • true

match_for_any

布尔值

指示当“任何”设置为规则的服务并且有多个具有相同源端口和协议的服务对象时，是否使用此服务。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

override_default_settings

布尔值

指示此服务是否是已被覆盖的数据域服务。

选项

  • false

  • true

port

字符串

用于提供此服务的端口号。要指定端口范围，请在最低端口号和最高端口号之间放置一个连字符，例如 44-55。

protocol

字符串

选择与服务关联的协议类型，并且隐含地选择为服务强制执行内容安全和身份验证的管理服务器（如果有）。选择协议类型会调用每个协议类型的特定协议处理程序，从而通过解析协议来启用更高级别的安全性，并通过跟踪动态操作（例如打开端口）来启用更高级别的连接性。

session_timeout

整数

会话超时之前的时间（以秒为单位）。

source_port

字符串

客户端服务的端口号。如果指定，则仅在数据包检查期间接受、丢弃或拒绝那些源端口号。否则，不检查源端口。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

sync_connections_on_cluster

布尔值

在 ClusterXL 或 OPSEC 认证的群集上启用状态同步高可用性或负载共享。

选项

  • false

  • true

tags

列表 / 元素=字符串

标记标识符的集合。

use_default_session_timeout

布尔值

使用默认的虚拟会话超时。

选项

  • false

  • true

version

字符串

Check Point 的版本。如果未指定版本，则采用最新版本。

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多少分钟直到引发超时错误。

默认值： 30

示例

- name: add-service-tcp
  cp_mgmt_service_tcp:
    aggressive_aging:
      enable: true
      timeout: 360
      use_default_timeout: false
    keep_connections_open_after_policy_installation: false
    match_for_any: true
    name: New_TCP_Service_1
    port: 5669
    session_timeout: 0
    state: present
    sync_connections_on_cluster: true

- name: set-service-tcp
  cp_mgmt_service_tcp:
    aggressive_aging:
      default_timeout: 3600
    color: green
    name: New_TCP_Service_1
    port: 5656
    state: present

- name: delete-service-tcp
  cp_mgmt_service_tcp:
    name: New_TCP_Service_1
    state: absent

返回值

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

键

描述

cp_mgmt_service_tcp

字典

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

返回： 总是返回，除非删除该对象。

作者

  • Or Soffer (@chkp-orso)