check_point.mgmt.cp_mgmt_vsx_run_operation 模块 – 通过名称和参数运行 VSX 操作。

注意

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

check_point.mgmt 5.0.0 中的新功能

概要

  • 通过名称和参数运行 VSX 操作。

  • 自动会话发布是此 API 中所有操作的一部分。

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

参数

参数

注释

add_member_params

字典

用于添加 VSX 集群成员的操作的参数。

ipv4_address

字符串

VSX 集群成员的管理接口的 IPv4 地址。

ipv4_sync_address

字符串

VSX 集群成员的同步接口的 IPv4 地址。

member_name

字符串

新 VSX 集群成员对象的名称。

vsx_name

字符串

VSX 集群对象的名称。

vsx_uid

字符串

VSX 集群对象的 UID。

auto_publish_session

布尔值

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

选择

  • false ← (默认)

  • true

downgrade_params

字典

用于将 VSX 网关或 VSX 集群对象降级到较低版本的操作的参数。 <br>如果当前版本已经是目标版本,或低于目标版本,则不会进行任何更改。

target_version

字符串

目标版本。

vsx_name

字符串

VSX 网关或 VSX 集群对象的名称。

vsx_uid

字符串

VSX 网关或 VSX 集群对象的 UID。

operation

字符串

要运行的操作的名称。每个操作都有其特定的参数。 <br>可用的操作有,<ul><li><i>升级</i> - 将 VSX 网关或 VSX 集群对象升级到更高版本</li><li><i>降级</i> - 将 VSX 网关或 VSX 集群对象降级到较低版本</li><li><i>添加成员</i> - 添加新的 VSX 集群成员对象</li><li><i>删除成员</i> - 删除 VSX 集群成员对象</li><li><i>重新配置网关</i> - 在全新安装后重新配置 VSX 网关</li><li><i>重新配置成员</i> - 在全新安装后重新配置 VSX 集群成员</li></ul>。

选择

  • "upgrade"

  • "downgrade"

  • "add-member"

  • "remove-member"

  • "reconf-gw"

  • "reconf-member"

reconf_gw_params

字典

用于在全新安装后重新配置 VSX 网关的操作的参数。

ipv4_corexl_number

整数

目标 VSX 网关上的 IPv4 CoreXL 防火墙实例数。 <br>有效值, <br><ul><li>要配置 CoreXL 防火墙实例,请输入大于或等于 2 的整数。</li><li>要禁用 CoreXL,请输入 1。</li></ul>。

one_time_password

字符串

建立安全内部通信 (SIC) 所需的密码。输入您在目标 VSX 网关上首次配置向导期间使用的相同密码。

vsx_name

字符串

VSX 网关对象的名称。

vsx_uid

字符串

VSX 网关对象的 UID。

reconf_member_params

字典

用于在全新安装后重新配置 VSX 集群成员的操作的参数。

ipv4_corexl_number

整数

目标 VSX 集群成员上的 IPv4 CoreXL 防火墙实例数。 <br>有效值, <br><ul><li>要配置 CoreXL 防火墙实例,请输入大于或等于 2 的整数。</li><li>要禁用 CoreXL,请输入 1。</li></ul>重要提示 - CoreXL 配置在所有集群成员上必须相同。

member_name

字符串

VSX 集群成员对象的名称。

member_uid

字符串

VSX 集群成员对象的 UID。

one_time_password

字符串

建立安全内部通信 (SIC) 所需的密码。输入您在目标 VSX 集群成员上首次配置向导期间使用的相同密码。

remove_member_params

字典

用于删除 VSX 集群成员对象的操作的参数。

member_name

字符串

VSX 集群成员对象的名称。

member_uid

字符串

VSX 集群成员对象的 UID。

upgrade_params

字典

用于将 VSX 网关或 VSX 集群对象升级到更高版本的操作的参数。 <br>如果当前版本已经是目标版本,或高于目标版本,则不会进行任何更改。

target_version

字符串

目标版本。

vsx_name

字符串

VSX 网关或 VSX 集群对象的名称。

vsx_uid

字符串

VSX 网关或 VSX 集群对象的 UID。

version

字符串

检查点版本。如果未给定版本,则采用最新版本。

wait_for_task

布尔值

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

选择

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间(分钟)直到抛出超时错误。

默认: 30

示例

- name: vsx-run-operation
  cp_mgmt_vsx_run_operation:
    add_member_params:
      ipv4_address: 25.25.25.223
      ipv4_sync_address: 20.20.20.223
      member_name: Mem3
      vsx_name: VSX_CLUSTER
    operation: add-member

返回值

通用返回值记录在这里,以下是此模块特有的字段

描述

cp_mgmt_vsx_run_operation

字典

checkpoint vsx-run-operation 的输出。

返回: 总是。

作者

  • Eden Brillant (@chkp-edenbr)