check_point.mgmt.cp_mgmt_lsm_cluster 模块 – 通过 Web 服务 API 管理 Checkpoint 上的 lsm-cluster 对象

注意

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

check_point.mgmt 2.3.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的 lsm-cluster 对象，包括创建、更新和删除对象。

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

参数

参数

注释

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"

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告并应用更改。

选项

  • false

  • true

interfaces

列表 / 元素=字典

接口。

ip_address_override

字符串

IP 地址覆盖。子网掩码由附加的 LSM 配置文件定义。

member_network_override

字符串

成员网络覆盖。子网掩码由附加的 LSM 配置文件定义。

name

字符串

接口名称。

main_ip_address

字符串

主 IP 地址。

members

列表 / 元素=字典

成员。

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

字符串

注释字符串。

name

字符串

对象名称。

provisioning_settings

字典

配置设置。此字段仅与 SMB 集群相关。

provisioning_profile

字符串

配置概要文件。

provisioning_state

字符串

配置状态。此字段仅与 SMB 集群相关。默认状态为“manual” - 启用配置但不会附加到配置文件。如果提供“using-profile”状态，则必须在 provisioning-settings 中提供配置概要文件。

选项

  • "off"

  • "manual"

  • "using-profile"

sic

字典

安全内部通信。

ip_address

字符串

IP 地址。提供 IP 地址时，立即使用此 IP 地址启动受信任的通信。

one_time_password

字符串

一次性密码。当在没有 ip-address 的情况下提供一次性密码时，网关首次连接到安全管理服务器时会自动启动受信任的通信。

tags

列表 / 元素=字符串

标签标识符集合。

name_prefix

字符串

添加到配置文件名称的 前缀，并创建 LSM 集群名称。

name_suffix

字符串

添加到配置文件名称的 后缀，并创建 LSM 集群名称。

security_profile

字符串 / 必需

LSM 配置文件。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

version

字符串

Checkpoint 版本。如果没有提供，则使用最新版本。

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

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

默认： 30

示例

- name: add-lsm-cluster
  cp_mgmt_lsm_cluster:
    interfaces:
    - ip_address_override: 192.168.8.197
      member_network_override: 192.168.8.0
      name: eth0
      new_name: WAN
    - ip_address_override: 10.8.197.1
      member_network_override: 10.8.197.0
      name: eth1
      new_name: LAN1
    - member_network_override: 10.10.10.0
      name: eth2
    main_ip_address: 192.168.8.197
    members:
    - name: Gaia_gw1
      sic:
        ip_address: 192.168.8.200
        one_time_password: aaaa
    - name: Gaia_gw2
      sic:
        ip_address: 192.168.8.202
        one_time_password: aaaa
    name_prefix: Gaia_
    security_profile: gaia_cluster
    state: present

- name: set-lsm-cluster
  cp_mgmt_lsm_cluster:
    interfaces:
    - ip_address_override: 192.168.8.197
      member_network_override: 192.168.8.0
      name: eth0
      new_name: WAN
    - ip_address_override: 10.8.197.1
      member_network_override: 10.8.197.0
      name: eth1
      new_name: LAN1
    - member_network_override: 10.10.10.0
      name: eth2
    members:
    - name: Gaia_gw1
      sic:
        ip_address: 192.168.8.200
        one_time_password: aaaa
    - name: Gaia_gw2
      sic:
        ip_address: 192.168.8.202
        one_time_password: aaaa
    name: Gaia_gaia_cluster
    state: present

- name: delete-lsm-cluster
  cp_mgmt_lsm_cluster:
    name: lsm_cluster
    state: absent

返回值

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

键

描述

cp_mgmt_lsm_cluster

字典

已创建或更新的 Checkpoint 对象。

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

作者

  • Shiran Golzar (@chkp-shirango)