check_point.mgmt.cp_mgmt_trusted_client 模块 – 通过 Web Services API 管理 Checkpoint 上的受信任客户端对象

注意

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

check_point.mgmt 2.1.0 中的新功能

概要

  • 管理 Checkpoint 设备上的受信任客户端对象，包括创建、更新和删除对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ←（默认）

  • true

color

字符串

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

选择

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "浅黄褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿"

  • "粉色"

  • "绿松石色"

  • "深蓝色"

  • "火砖色"

  • "棕色"

  • "森林绿"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬薄纱"

  • "珊瑚色"

  • "海绿"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝"

  • "紫红色"

  • "海军蓝"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选择

  • "uid"

  • "标准"

  • "完整"

domains_assignment

列表 / 元素=字符串

要添加到此配置文件的域。仅使用域名。请参见下面的示例“添加受信任的客户端（使用域）”。

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

ip_address

字符串

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

ip_address_first

字符串

范围中的第一个 IP 地址。如果同时需要 IPv4 和 IPv6 地址范围，请改用 ipv4-address-first 和 ipv6-address-first 字段。

ip_address_last

字符串

范围中的最后一个 IP 地址。如果同时需要 IPv4 和 IPv6 地址范围，请改用 ipv4-address-first 和 ipv6-address-first 字段。

ipv4_address

字符串

IPv4 地址。

ipv4_address_first

字符串

范围中的第一个 IPv4 地址。

ipv4_address_last

字符串

范围中的最后一个 IPv4 地址。

ipv6_address

字符串

IPv6 地址。

ipv6_address_first

字符串

范围中的第一个 IPv6 地址。

ipv6_address_last

字符串

范围中的最后一个 IPv6 地址。

mask_length

整数

IPv4 或 IPv6 掩码长度。如果同时需要这两个掩码，请显式使用 mask-length4 和 mask-length6 字段。

mask_length4

整数

IPv4 掩码长度。

mask_length6

整数

IPv6 掩码长度。

multi_domain_server_trusted_client

布尔值

允许此受信任的客户端连接到部署中的所有多域服务器。

选择

  • false

  • true

name

字符串 / 必填

对象名称。

state

字符串

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

选择

  • "present" ←（默认）

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

type

字符串

受信任的客户端类型。

选择

  • "any"

  • "域"

  • "ipv4 地址"

  • "ipv4 地址范围"

  • "ipv4 网络掩码"

  • "ipv6 地址"

  • "ipv6 地址范围"

  • "ipv6 网络掩码"

  • "名称"

  • "通配符（仅限 IP）"

version

字符串

Checkpoint 的版本。如果未给出版本，则采用最新版本。

wait_for_task

布尔值

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

选择

  • false

  • true ←（默认）

wait_for_task_timeout

整数

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

默认值： 30

wild_card

字符串

IP 通配符（例如 192.0.2.*）。

示例

- name: add-trusted-client
  cp_mgmt_trusted_client:
    name: my client
    state: present
    type: ANY

- name: set-trusted-client
  cp_mgmt_trusted_client:
    ip_address: 192.0.2.1
    mask_length: '24'
    name: my client
    state: present
    type: NETMASK

- name: delete-trusted-client
  cp_mgmt_trusted_client:
    name: my client
    state: absent

返回值

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

键

描述

cp_mgmt_trusted_client

字典

创建或更新的 Checkpoint 对象。

返回：始终，删除对象时除外。

作者

  • Or Soffer (@chkp-orso)