check_point.mgmt.cp_mgmt_service_sctp 模块 – 通过 Web 服务 API 管理 Check Point 上的 service-sctp 对象

注意

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

check_point.mgmt 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

aggressive_aging

字典

为空闲连接设置较短（积极）的超时时间。

default_timeout

整数

默认积极老化超时时间（秒）。

enable

布尔值

N/A

选项

  • false

  • true

timeout

整数

积极老化超时时间（秒）。

use_default_timeout

布尔值

N/A

选项

  • 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

字符串

注释字符串。

details_level

字符串

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

选项

  • "uid"

  • "standard"

  • "full"

groups

列表 / 元素=字符串

组标识符集合。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

keep_connections_open_after_policy_installation

布尔值

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

选项

  • false

  • true

match_for_any

布尔值

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

选项

  • false

  • true

name

字符串 / 必需

对象名称。

port

字符串

端口号。要指定端口范围，请在最低和最高端口号之间添加一个连字符，例如 44-45。

session_timeout

整数

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

source_port

字符串

源端口号。要指定端口范围，请在最低和最高端口号之间添加一个连字符，例如 44-45。

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-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      enable: true
      timeout: 360
      use_default_timeout: false
    keep_connections_open_after_policy_installation: false
    match_for_any: true
    name: New_SCTP_Service_1
    port: 5669
    session_timeout: 0
    state: present
    sync_connections_on_cluster: true

- name: set-service-sctp
  cp_mgmt_service_sctp:
    aggressive_aging:
      default_timeout: 3600
    color: green
    name: New_SCTP_Service_1
    port: 5656
    state: present

- name: delete-service-sctp
  cp_mgmt_service_sctp:
    name: New_SCTP_Service_2
    state: absent

返回值

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

键

描述

cp_mgmt_service_sctp

字典

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

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

作者

  • Or Soffer (@chkp-orso)