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

boolean

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

选项

  • false ← (默认)

  • true

check_point_host_version

string

Check Point 主机平台版本。

color

string

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

选项

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "黄褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿"

  • "粉色"

  • "绿松石色"

  • "深蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林绿"

  • "金色"

  • "暗金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺色"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝色"

  • "紫红色"

  • "海军蓝"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

string

注释字符串。

details_level

string

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

选项

  • "uid"

  • "标准"

  • "完整"

groups

列表 / 元素=字符串

组标识符的集合。

hardware

string

硬件名称。

ignore_errors

boolean

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

选项

  • false

  • true

ignore_warnings

boolean

应用更改时忽略警告。

选项

  • false

  • true

interfaces

列表 / 元素=字典

Check Point 主机接口。

color

string

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

选项

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "黄褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿"

  • "粉色"

  • "绿松石色"

  • "深蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林绿"

  • "金色"

  • "暗金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺色"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝色"

  • "紫红色"

  • "海军蓝"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

string

注释字符串。

details_level

string

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

选项

  • "uid"

  • "标准"

  • "完整"

ignore_errors

boolean

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

选项

  • false

  • true

ignore_warnings

boolean

应用更改时忽略警告。

选项

  • false

  • true

mask_length

integer

IPv4 或 IPv6 网络掩码长度。如果需要两个掩码，请显式使用 mask-length4 和 mask-length6 字段。可以使用子网掩码字段指定 IPv4 掩码本身，而不是 IPv4 掩码长度。

mask_length4

integer

IPv4 网络掩码长度。

mask_length6

integer

IPv6 网络掩码长度。

name

string

接口名称。

subnet

string

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

subnet4

string

IPv4 网络地址。

subnet6

string

IPv6 网络地址。

subnet_mask

string

IPv4 网络掩码。

ip_address

string

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

ipv4_address

string

IPv4 地址。

ipv6_address

string

IPv6 地址。

logs_settings

字典

日志设置。

accept_syslog_messages

boolean

启用接受 syslog 消息。

选项

  • false

  • true

alert_when_free_disk_space_below

boolean

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

选项

  • false

  • true

alert_when_free_disk_space_below_threshold

integer

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

alert_when_free_disk_space_below_type

string

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

选项

  • "无"

  • "日志"

  • "弹出警报"

  • "邮件警报"

  • "snmp 陷阱警报"

  • "用户定义的警报 no.1"

  • "用户定义的警报 no.2"

  • "用户定义的警报 no.3"

before_delete_keep_logs_from_the_last_days

boolean

启用从最后几天保留删除前的日志。

选项

  • false

  • true

before_delete_keep_logs_from_the_last_days_threshold

integer

删除前保留最后几天日志的阈值。

before_delete_run_script

boolean

启用删除前运行脚本。

选项

  • false

  • true

before_delete_run_script_command

string

删除前运行脚本命令。

delete_index_files_older_than_days

boolean

启用删除早于指定天数的索引文件。

选项

  • false

  • true

delete_index_files_older_than_days_threshold

integer

删除早于指定天数的索引文件的阈值。

delete_when_free_disk_space_below

boolean

启用当可用磁盘空间低于指定值时删除。

选项

  • false

  • true

delete_when_free_disk_space_below_threshold

integer

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

detect_new_citrix_ica_application_names

boolean

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

选项

  • false

  • true

distribute_logs_between_all_active_servers

boolean

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

选项

  • false

  • true

enable_log_indexing

boolean

启用日志索引。

选项

  • false

  • true

forward_logs_to_log_server

boolean

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

选项

  • false

  • true

forward_logs_to_log_server_name

string

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

forward_logs_to_log_server_schedule_name

string

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

free_disk_space_metrics

string

可用磁盘空间指标。

选项

  • "兆字节"

  • "百分比"

rotate_log_by_file_size

boolean

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

选项

  • false

  • true

rotate_log_file_size_threshold

integer

日志文件大小阈值。

rotate_log_on_schedule

boolean

启用按计划轮换日志。

选项

  • false

  • true

rotate_log_schedule_name

string

轮换日志计划名称。

smart_event_intro_correletion_unit

boolean

启用 SmartEvent 引入关联单元。

选项

  • false

  • true

stop_logging_when_free_disk_space_below

boolean

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

选项

  • false

  • true

stop_logging_when_free_disk_space_below_threshold

integer

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

turn_on_qos_logging

boolean

启用 QoS 日志记录。

选项

  • false

  • true

update_account_log_every

integer

每隔一定秒数更新帐户日志。

management_blades

字典

管理 blades。

compliance

boolean

合规性 blade。当选择 ‘network-policy-management’ 为 True 时可以设置。

选项

  • false

  • true

endpoint_policy

boolean

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

选项

  • false

  • true

logging_and_status

boolean

启用日志记录 & 状态。

选项

  • false

  • true

network_policy_management

boolean

启用网络策略管理。

选项

  • false

  • true

smart_event_correlation

boolean

启用 SmartEvent 关联单元。

选项

  • false

  • true

smart_event_server

boolean

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

选项

  • false

  • true

user_directory

boolean

启用用户目录。当选择 ‘network-policy-management’ 为 True 时可以设置。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

nat_settings

字典

NAT 设置。

auto_rule

boolean

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

选项

  • false

  • true

hide_behind

string

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

选项

  • "gateway"

  • "ip-address"

install_on

string

哪个网关应应用 NAT 转换。

ip_address

string

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

ipv4_address

string

IPv4 地址。

ipv6_address

string

IPv6 地址。

method

string

NAT 转换方法。

选项

  • "hide"

  • "static"

one_time_password

string

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

os

string

操作系统名称。

save_logs_locally

boolean

启用本地保存日志。

选项

  • false

  • true

send_alerts_to_server

列表 / 元素=字符串

要将警报发送到的服务器集合，通过名称或 UID 标识。

send_logs_to_backup_server

列表 / 元素=字符串

要将日志发送到的备份服务器集合，通过名称或 UID 标识。

send_logs_to_server

列表 / 元素=字符串

要将日志发送到的服务器集合，通过名称或 UID 标识。

state

string

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

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

version

string

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

wait_for_task

boolean

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

integer

等待多长时间（以分钟为单位）直到抛出超时错误。

默认值: 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

字典

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

返回: 总是返回，除非删除对象。

作者

  • Eden Brillant (@chkp-edenbr)