check_point.mgmt.cp_mgmt_lsv_profile 模块 – 通过 Web 服务 API 在 Checkpoint 上管理 lsv-profile 对象

注意

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

check_point.mgmt 5.0.0 中的新增功能

概要

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

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

参数

参数

注释

allowed_ip_addresses

列表 / 元素=字符串

网络对象集合，通过名称或 UID 标识，表示在 profile 的 VPN 域中允许的 IP 地址。

auto_publish_session

布尔值

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

选项

  • false ←（默认）

  • true

certificate_authority

字符串

用于在 VPN 对等体之间建立信任的受信任证书颁发机构，通过名称或 UID 标识。

color

字符串

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

选项

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特 蓝色"

  • "浅黄褐色"

  • "青色"

  • "深 绿色"

  • "卡其色"

  • "兰花色"

  • "深 橙色"

  • "深 海 绿色"

  • "粉红色"

  • "绿松石色"

  • "深 蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林 绿色"

  • "金色"

  • "深 金色"

  • "灰色"

  • "深 灰色"

  • "浅 绿色"

  • "柠檬 薄纱"

  • "珊瑚色"

  • "海 绿色"

  • "天 蓝色"

  • "品红色"

  • "紫色"

  • "板岩 蓝色"

  • "紫罗兰 红色"

  • "海军 蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选项

  • "uid"

  • "标准"

  • "完整"

groups

列表 / 元素=字符串

组标识符的集合。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

restrict_allowed_addresses

布尔值

根据 allowed-ip-addresses 字段，指示是否限制 VPN 域中允许的 IP 地址。

选项

  • false

  • true

state

字符串

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

选项

  • "present" ←（默认）

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

version

字符串

Checkpoint 版本。如果未提供版本，则采用最新版本。

vpn_domain

字典

对等体的 VPN 域属性。

limit_peer_domain_size

布尔值

使用此参数根据 max-allowed-addresses 字段中的值限制每个对等体的 VPN 域中的 IP 地址数量。

选项

  • false

  • true

max_allowed_addresses

整数

每个对等体的 VPN 域中 IP 地址的最大数量。仅当 limit-peer-domain-size 字段设置为 true 时，此值才会强制执行。选择介于 1 和 256 之间的值。默认值为 256。

wait_for_task

布尔值

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

选项

  • false

  • true ←（默认）

wait_for_task_timeout

整数

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

默认： 30

示例

- name: add-lsv-profile
  cp_mgmt_lsv_profile:
    certificate_authority: dedicated_profile_certificate
    name: New lsv-profile
    state: present

- name: set-lsv-profile
  cp_mgmt_lsv_profile:
    certificate_authority: another CA
    name: existing lsv-profile
    restrict_allowed_addresses: 'false'
    state: present
    vpn_domain:
      limit_peer_domain_size: 'false'

- name: delete-lsv-profile
  cp_mgmt_lsv_profile:
    name: existing lsv-profile
    state: absent

返回值

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

键

描述

cp_mgmt_lsv_profile

字典

已创建或更新的 Checkpoint 对象。

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

作者

  • Eden Brillant (@chkp-edenbr)