check_point.mgmt.cp_mgmt_access_point_name 模块 – 通过 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_access_point_name。

check_point.mgmt 5.0.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的访问点名称对象，包括创建、更新和删除对象。

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

参数

参数

注释

apn

字符串

APN 名称。

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

block_traffic_other_end_user_domains

布尔值

阻止此 APN 与其他 APN 最终用户域之间的 MS 到 MS 流量。

选项

  • false

  • true

block_traffic_this_end_user_domain

布尔值

阻止此最终用户域内的 MS 到 MS 流量。

选项

  • false

  • true

color

字符串

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

选项

  • "海蓝宝石"

  • "黑色"

  • "蓝色"

  • "克里特 蓝色"

  • "黄褐色"

  • "青色"

  • "深 绿色"

  • "卡其色"

  • "兰花色"

  • "深 橙色"

  • "深 海 绿色"

  • "粉色"

  • "绿松石色"

  • "深 蓝色"

  • "耐火砖色"

  • "棕色"

  • "森林 绿色"

  • "金色"

  • "深 金色"

  • "灰色"

  • "深 灰色"

  • "浅 绿色"

  • "柠檬 雪纺"

  • "珊瑚色"

  • "海 绿色"

  • "天 蓝色"

  • "洋红色"

  • "紫色"

  • "板岩 蓝色"

  • "紫罗兰 红色"

  • "海军 蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选项

  • "uid"

  • "标准"

  • "完整"

end_user_domain

字符串

最终用户域名或 UID。

enforce_end_user_domain

布尔值

启用强制执行最终用户域。

选项

  • false

  • true

groups

列表 / 元素=字符串

组标识符集合。

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

state

字符串

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

选项

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标签标识符集合。

version

字符串

检查点的版本。如果未指定，则采用最新版本。

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

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

默认值： 30

示例

- name: add-access-point-name
  cp_mgmt_access_point_name:
    name: myaccesspointname
    apn: apnname
    end_user_domain: All_Internet
    enforce_end_user_domain: 'True'
    state: present

- name: set-access-point-name
  cp_mgmt_access_point_name:
    name: myaccesspointname
    block_traffic_other_end_user_domains: 'False'
    block_traffic_this_end_user_domain: 'False'
    enforce_end_user_domain: 'True'
    state: present

- name: delete-access-point-name
  cp_mgmt_access_point_name:
    name: myaccesspointname
    state: absent

返回值

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

键

描述

cp_mgmt_access_point_name

字典

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

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

作者

  • Eden Brillant (@chkp-edenbr)