check_point.mgmt.cp_mgmt_checkpoint_host 模块 – 通过 Web Services API 管理 Checkpoint 上的 checkpoint-host 对象

注意

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

check_point.mgmt 5.0.0 中的新增功能

概要

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

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ←（默认）

  • true

check_point_host_version

字符串

Check Point 主机平台版本。

颜色

字符串

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

选择

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "棕褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿色"

  • "粉红色"

  • "绿松石色"

  • "深蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林绿色"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝色"

  • "紫红色"

  • "海军蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

评论

字符串

评论字符串。

details_level

字符串

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

选择

  • "uid"

  • "标准"

  • "完整"

组

列表 / 元素=字符串

组标识符的集合。

硬件

字符串

硬件名称。

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

接口

列表 / 元素=字典

Check Point 主机接口。

颜色

字符串

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

选择

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "棕褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿色"

  • "粉红色"

  • "绿松石色"

  • "深蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林绿色"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝色"

  • "紫红色"

  • "海军蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

评论

字符串

评论字符串。

details_level

字符串

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

选择

  • "uid"

  • "标准"

  • "完整"

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

mask_length

整数

IPv4 或 IPv6 网络掩码长度。如果同时需要两个掩码，请显式使用 mask-length4 和 mask-length6 字段。 除了 IPv4 掩码长度，还可以使用 subnet-mask 字段指定 IPv4 掩码本身。

mask_length4

整数

IPv4 网络掩码长度。

mask_length6

整数

IPv6 网络掩码长度。

名称

字符串

接口名称。

子网

字符串

IPv4 或 IPv6 网络地址。如果同时需要两个地址，请显式使用 subnet4 和 subnet6 字段。

subnet4

字符串

IPv4 网络地址。

subnet6

字符串

IPv6 网络地址。

subnet_mask

字符串

IPv4 网络掩码。

ip_address

字符串

IPv4 或 IPv6 地址。如果同时需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

logs_settings

字典

日志设置。

accept_syslog_messages

布尔值

启用接受 Syslog 消息。

选择

  • false

  • true

alert_when_free_disk_space_below

布尔值

当可用磁盘空间低于阈值时启用警报。

选择

  • false

  • true

alert_when_free_disk_space_below_threshold

整数

当可用磁盘空间低于阈值时发出警报。

alert_when_free_disk_space_below_type

字符串

当可用磁盘空间低于类型时发出警报。

选择

  • "无"

  • "日志"

  • "弹出警报"

  • "邮件警报"

  • "SNMP Trap 警报"

  • "用户定义警报 1"

  • "用户定义警报 2"

  • "用户定义警报 3"

before_delete_keep_logs_from_the_last_days

布尔值

启用“删除前保留最近几天的日志”。

选择

  • false

  • true

before_delete_keep_logs_from_the_last_days_threshold

整数

“删除前保留最近几天日志”的阈值。

before_delete_run_script

布尔值

启用“删除前运行脚本”。

选择

  • false

  • true

before_delete_run_script_command

字符串

“删除前运行脚本”命令。

delete_index_files_older_than_days

布尔值

启用“删除超过指定天数的索引文件”。

选择

  • false

  • true

delete_index_files_older_than_days_threshold

整数

“删除超过指定天数的索引文件”的阈值。

delete_when_free_disk_space_below

布尔值

启用“当可用磁盘空间低于阈值时删除”。

选择

  • false

  • true

delete_when_free_disk_space_below_threshold

整数

当可用磁盘空间低于阈值时删除。

detect_new_citrix_ica_application_names

布尔值

启用检测新的 Citrix ICA 应用程序名称。

选择

  • false

  • true

distribute_logs_between_all_active_servers

布尔值

在所有活动服务器之间分发日志。

选择

  • false

  • true

enable_log_indexing

布尔值

启用日志索引。

选择

  • false

  • true

forward_logs_to_log_server

布尔值

启用将日志转发到日志服务器。

选择

  • false

  • true

forward_logs_to_log_server_name

字符串

将日志转发到日志服务器名称。

forward_logs_to_log_server_schedule_name

字符串

将日志转发到日志服务器计划名称。

free_disk_space_metrics

字符串

可用磁盘空间指标。

选择

  • "mbytes"

  • "percent"

rotate_log_by_file_size

布尔值

启用按文件大小轮换日志。

选择

  • false

  • true

rotate_log_file_size_threshold

整数

日志文件大小阈值。

rotate_log_on_schedule

布尔值

启用按计划轮换日志。

选择

  • false

  • true

rotate_log_schedule_name

字符串

轮换日志计划名称。

smart_event_intro_correletion_unit

布尔值

启用 SmartEvent 介绍关联单元。

选择

  • false

  • true

stop_logging_when_free_disk_space_below

布尔值

启用当可用磁盘空间低于时停止记录日志。

选择

  • false

  • true

stop_logging_when_free_disk_space_below_threshold

整数

当可用磁盘空间低于阈值时停止记录日志。

turn_on_qos_logging

布尔值

启用打开 QoS 日志记录。

选择

  • false

  • true

update_account_log_every

整数

每隔若干秒更新一次帐户日志。

management_blades

字典

管理刀片。

compliance

布尔值

合规性刀片。当选择将“网络策略管理”设置为 True 时，可以设置。

选择

  • false

  • true

endpoint_policy

布尔值

启用端点策略。</br>要完成端点安全管理配置，请在您的端点管理服务器上执行安装数据库。 </br>多域服务器环境不支持此字段。

选择

  • false

  • true

logging_and_status

布尔值

启用日志记录和状态。

选择

  • false

  • true

network_policy_management

布尔值

启用网络策略管理。

选择

  • false

  • true

smart_event_correlation

布尔值

启用 SmartEvent 关联单元。

选择

  • false

  • true

smart_event_server

布尔值

启用 SmartEvent 服务器。</br>激活 SmartEvent 服务器时，应将“logging-and-status”和“smart-event-correlation”刀片设置为 True。 </br>要完成 SmartEvent 配置，请在您的安全管理服务器和日志服务器上执行安装数据库或安装策略。</br>不建议在管理高可用性环境中激活 SmartEvent 服务器。有关更多信息，请参阅 sk25164。

选择

  • false

  • true

user_directory

布尔值

启用用户目录。当选择将“网络策略管理”设置为 True 时，可以设置。

选择

  • false

  • true

名称

string / required

对象名称。

nat_settings

字典

NAT 设置。

auto_rule

布尔值

是否添加自动地址转换规则。

选择

  • false

  • true

hide_behind

字符串

隐藏背后的方法。如果“method”参数为“static”，则禁止使用此参数。

选择

  • "gateway"

  • "ip-address"

install_on

字符串

哪个网关应应用 NAT 转换。

ip_address

字符串

IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。如果“method”参数为“hide”且“hide-behind”参数为“gateway”，则此参数不是必需的。

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

method

字符串

NAT 转换方法。

选择

  • "hide"

  • "static"

one_time_password

字符串

安全内部连接一次性密码。

os

字符串

操作系统名称。

save_logs_locally

布尔值

启用本地保存日志。

选择

  • false

  • true

send_alerts_to_server

列表 / 元素=字符串

按名称或 UID 标识的要向其发送警报的服务器集合。

send_logs_to_backup_server

列表 / 元素=字符串

按名称或 UID 标识的要向其发送日志的备份服务器集合。

send_logs_to_server

列表 / 元素=字符串

按名称或 UID 标识的要向其发送日志的服务器集合。

state

字符串

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

选择

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

version

字符串

Checkpoint 版本。如果没有给定版本，则采用最新版本。

wait_for_task

布尔值

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

选择

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多少分钟后抛出超时错误。

默认值： 30

示例

- name: add-checkpoint-host
  cp_mgmt_checkpoint_host:
    ipv4_address: 5.5.5.5
    management_blades:
      logging_and_status: true
      network_policy_management: true
    name: secondarylogserver
    state: present

- name: set-checkpoint-host
  cp_mgmt_checkpoint_host:
    hardware: Smart-1
    management_blades:
      compliance: true
      network_policy_management: true
      user_directory: true
    name: secondarylogserver
    os: Linux
    state: present

- name: delete-checkpoint-host
  cp_mgmt_checkpoint_host:
    name: secondarylogserver
    state: absent

返回值

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

键

描述

cp_mgmt_checkpoint_host

字典

已创建或更新的 Checkpoint 对象。

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

作者

  • Eden Brillant (@chkp-edenbr)