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

字符串

对象的颜色。应该是现有颜色之一。

选项

  • "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"

encryption_method

字符串

要使用的加密方法。

选项

  • "prefer ikev2 but support ikev1"

  • "ikev2 only"

  • "ikev1 for ipv4 and ikev2 for ipv6 only"

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

字符串

要使用的加密方法。

选项

  • "prefer ikev2 but support ikev1"

  • "ikev2 only"

  • "ikev1 for ipv4 and ikev2 for ipv6 only"

encryption_suite

字符串

要使用的加密套件。

选项

  • "suite-b-gcm-256"

  • "custom"

  • "vpn b"

  • "vpn a"

  • "suite-b-gcm-128"

external_gateway

字符串

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

ike_phase_1

字典

IKE 第 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] 参数的时间单位，四舍五入到分钟。

选项

  • "days"

  • "hours"

  • "minutes"

  • "seconds"

ike_phase_2

字典

IKE 第 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] 参数的时间单位。

选项

  • "days"

  • "hours"

  • "minutes"

  • "seconds"

ike_p2_use_pfs

布尔值

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

选项

  • false

  • true

internal_gateway

字符串

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

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

ike_phase_1

字典

IKE 第 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] 参数的时间单位，四舍五入到分钟。

选项

  • "days"

  • "hours"

  • "minutes"

  • "seconds"

ike_phase_2

字典

IKE 第 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] 参数的时间单位。

选项

  • "days"

  • "hours"

  • "minutes"

  • "seconds"

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 中新增

参与者 GW 的覆盖 VPN 域。

gateway

字符串

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

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

字符串

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

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

字典

已创建或更新的 Checkpoint 对象。

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

作者

  • Or Soffer (@chkp-orso)