check_point.mgmt.cp_mgmt_vpn_community_star 模块 – 通过 Web 服务 API 管理 Check Point 上的 vpn-community-star 对象

注意

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

check_point.mgmt 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ← （默认）

  • true

center_gateways

列表 / 元素=字符串

由名称或 UID 标识的中心 VPN 网关和 VPN 设备对象集合。

color

字符串

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

选择

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特 蓝色"

  • "浅褐色"

  • "青色"

  • "深 绿色"

  • "卡其色"

  • "兰花色"

  • "深 橙色"

  • "深 海 绿色"

  • "粉色"

  • "绿松石色"

  • "深 蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林 绿色"

  • "金色"

  • "深 金色"

  • "灰色"

  • "深 灰色"

  • "浅 绿色"

  • "柠檬 雪纺"

  • "珊瑚色"

  • "海 绿色"

  • "天 蓝色"

  • "洋红色"

  • "紫色"

  • "板岩 蓝色"

  • "紫罗兰 红色"

  • "海军 蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选择

  • "uid"

  • "standard"

  • "full"

encryption_method

字符串

要使用的加密方法。

选择

  • "首选 ikev2， 但 支持 ikev1"

  • "仅限 ikev2"

  • "ipv4 使用 ikev1， ipv6 仅使用 ikev2"

encryption_suite

字符串

要使用的加密套件。

选择

  • "suite-b-gcm-256"

  • "custom"

  • "vpn b"

  • "vpn a"

  • "suite-b-gcm-128"

granular_encryptions

列表 / 元素=字典

在 check_point.mgmt 5.1.0 中添加

VPN 细粒度加密设置。

encryption_method

字符串

要使用的加密方法。

选择

  • "首选 ikev2， 但 支持 ikev1"

  • "仅限 ikev2"

  • "ipv4 使用 ikev1， ipv6 仅使用 ikev2"

encryption_suite

字符串

要使用的加密套件。

选择

  • "suite-b-gcm-256"

  • "custom"

  • "vpn b"

  • "vpn a"

  • "suite-b-gcm-128"

external_gateway

字符串

由名称或 UID 标识的外部托管或第三方网关。

ike_phase_1

字典

Ike Phase 1 设置。仅当 encryption-suite 设置为 [custom] 时适用。

data_integrity

字符串

要使用的哈希算法。

选择

  • "aes-xcbc"

  • "sha1"

  • "sha256"

  • "sha384"

  • "sha512"

  • "md5"

diffie_hellman_group

字符串

要使用的 Diffie-Hellman 组。

选择

  • "group-1"

  • "group-2"

  • "group-5"

  • "group-14"

  • "group-15"

  • "group-16"

  • "group-17"

  • "group-18"

  • "group-19"

  • "group-20"

  • "group-24"

encryption_algorithm

字符串

要使用的加密算法。

选择

  • "cast"

  • "aes-256"

  • "des"

  • "aes-128"

  • "3des"

ike_p1_rekey_time

整数

指示 IKE 第 1 阶段重新协商的时间间隔。

ike_p1_rekey_time_unit

字符串

指示 [ike-p1-rekey-time-unit] 参数的时间单位，向上取整到分钟级别。

选择

  • "天"

  • "小时"

  • "分钟"

  • "秒"

ike_phase_2

字典

Ike Phase 2 设置。仅当 encryption-suite 设置为 [custom] 时适用。

data_integrity

字符串

要使用的哈希算法。

选择

  • "aes-xcbc"

  • "sha1"

  • "sha256"

  • "sha384"

  • "sha512"

  • "md5"

encryption_algorithm

字符串

要使用的加密算法。

选择

  • "cast"

  • "aes-gcm-256"

  • "cast-40"

  • "aes-256"

  • "des"

  • "aes-128"

  • "3des"

  • "des-40cp"

  • "aes-gcm-128"

  • "none"

ike_p2_pfs_dh_grp

字符串

要使用的 Diffie-Hellman 组。

选择

  • "group-1"

  • "group-2"

  • "group-5"

  • "group-14"

  • "group-15"

  • "group-16"

  • "group-17"

  • "group-18"

  • "group-19"

  • "group-20"

  • "group-24"

ike_p2_rekey_time

整数

指示 IKE 第 2 阶段重新协商的时间间隔。

ike_p2_rekey_time_unit

字符串

指示 [ike-p2-rekey-time-unit] 参数的时间单位。

选择

  • "天"

  • "小时"

  • "分钟"

  • "秒"

ike_p2_use_pfs

布尔值

指示 IKE 第 2 阶段是否正在使用完美前向保密 (PFS)。

选择

  • false

  • true

internal_gateway

字符串

由名称或 UID 标识的内部管理的 Check Point 网关，或“Any”表示此社区中所有内部网关参与者。

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

ike_phase_1

字典

Ike Phase 1 设置。仅当 encryption-suite 设置为 [custom] 时适用。

data_integrity

字符串

要使用的哈希算法。

选择

  • "aes-xcbc"

  • "sha1"

  • "sha256"

  • "sha384"

  • "sha512"

  • "md5"

diffie_hellman_group

字符串

要使用的 Diffie-Hellman 组。

选择

  • "group-1"

  • "group-2"

  • "group-5"

  • "group-14"

  • "group-19"

  • "group-20"

encryption_algorithm

字符串

要使用的加密算法。

选择

  • "cast"

  • "aes-256"

  • "des"

  • "aes-128"

  • "3des"

ike_p1_rekey_time

整数

在 check_point.mgmt 5.1.0 中添加

指示 IKE 第 1 阶段重新协商的时间间隔。

ike_p1_rekey_time_unit

字符串

在 check_point.mgmt 5.1.0 中添加

指示 [ike-p1-rekey-time-unit] 参数的时间单位，向上取整到分钟级别。

选择

  • "天"

  • "小时"

  • "分钟"

  • "秒"

ike_phase_2

字典

Ike Phase 2 设置。仅当 encryption-suite 设置为 [custom] 时适用。

data_integrity

字符串

要使用的哈希算法。

选择

  • "aes-xcbc"

  • "sha1"

  • "sha256"

  • "sha384"

  • "sha512"

  • "md5"

encryption_algorithm

字符串

要使用的加密算法。

选择

  • "cast"

  • "aes-gcm-256"

  • "cast-40"

  • "aes-256"

  • "des"

  • "aes-128"

  • "3des"

  • "des-40cp"

  • "aes-gcm-128"

  • "none"

ike_p2_pfs_dh_grp

字符串

在 check_point.mgmt 5.1.0 中添加

要使用的 Diffie-Hellman 组。

选择

  • "group-1"

  • "group-2"

  • "group-5"

  • "group-14"

  • "group-15"

  • "group-16"

  • "group-17"

  • "group-18"

  • "group-19"

  • "group-20"

  • "group-24"

ike_p2_rekey_time

整数

在 check_point.mgmt 5.1.0 中添加

指示 IKE 第 2 阶段重新协商的时间间隔。

ike_p2_rekey_time_unit

字符串

在 check_point.mgmt 5.1.0 中添加

指示 [ike-p2-rekey-time-unit] 参数的时间单位。

选择

  • "天"

  • "小时"

  • "分钟"

  • "秒"

ike_p2_use_pfs

布尔值

在 check_point.mgmt 5.1.0 中添加

指示 IKE 第 2 阶段是否正在使用完美前向保密 (PFS)。

选择

  • false

  • true

mesh_center_gateways

布尔值

指示网格社区是否位于中心。

选择

  • false

  • true

name

字符串 / 必需

对象名称。

override_vpn_domains

列表 / 元素=字典

在 check_point.mgmt 5.1.0 中添加

参与者网关的覆盖 VPN 域。

gateway

字符串

由名称或 UID 标识的覆盖 VPN 域中的参与者网关。

vpn_domain

字符串

由名称或 UID 标识的 VPN 域网络。

satellite_gateways

列表 / 元素=字符串

由名称或 UID 标识的表示卫星网关的网关对象集合。

shared_secrets

列表 / 元素=字典

外部网关的共享密钥。

external_gateway

字符串

由名称或 UID 标识的外部网关。

shared_secret

字符串

共享密钥。

state

字符串

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

选择

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

tunnel_granularity

字符串

在 check_point.mgmt 5.1.0 中添加

要使用的 VPN 隧道共享选项。

选择

  • "per_host"

  • "per_subnet"

  • "universal"

use_shared_secret

布尔值

指示是否应该对所有外部网关使用共享密钥。

选择

  • false

  • true

version

字符串

检查点版本。如果未给出版本，则采用最新版本。

wait_for_task

布尔值

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

选择

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间（分钟）后抛出超时错误。

默认值: 30

示例

- name: add-vpn-community-star
  cp_mgmt_vpn_community_star:
    center_gateways: Second_Security_Gateway
    encryption_method: prefer ikev2 but support ikev1
    encryption_suite: custom
    ike_phase_1:
      data_integrity: sha1
      diffie_hellman_group: group 19
      encryption_algorithm: aes-128
    ike_phase_2:
      data_integrity: aes-xcbc
      encryption_algorithm: aes-gcm-128
    name: New_VPN_Community_Star_1
    state: present

- name: set-vpn-community-star
  cp_mgmt_vpn_community_star:
    encryption_method: ikev2 only
    encryption_suite: custom
    ike_phase_1:
      data_integrity: sha1
      diffie_hellman_group: group 19
      encryption_algorithm: aes-128
    ike_phase_2:
      data_integrity: aes-xcbc
      encryption_algorithm: aes-gcm-128
    name: New_VPN_Community_Star_1
    state: present

- name: delete-vpn-community-star
  cp_mgmt_vpn_community_star:
    name: New_VPN_Community_Star_1
    state: absent

返回值

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

键

描述

cp_mgmt_vpn_community_star

字典

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

返回: 总是返回，删除对象时除外。

作者

  • Or Soffer (@chkp-orso)