check_point.mgmt.cp_mgmt_dns_domain 模块 – 通过 Web 服务 API 在 Check Point 上管理 dns-domain 对象

注意

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

check_point.mgmt 1.0.0 中的新功能

概要

  • 管理 Check Point 设备上的 dns-domain 对象，包括创建、更新和删除对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ← (默认)

  • true

颜色

字符串

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

选择

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特蓝色"

  • "实木色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花紫"

  • "深橙色"

  • "深海绿色"

  • "粉红色"

  • "绿松石色"

  • "深蓝色"

  • "火砖红"

  • "棕色"

  • "森林绿色"

  • "金色"

  • "暗金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "石板蓝色"

  • "紫红色"

  • "海军蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

评论

字符串

评论字符串。

details_level

字符串

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

选择

  • "uid"

  • "标准"

  • "完整"

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改，忽略警告。

选择

  • false

  • true

is_sub_domain

布尔值

是否除了域本身之外还匹配子域。

选择

  • false

  • true

名称

字符串 / 必需

对象名称。

状态

字符串

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

选择

  • "present" ← (默认)

  • "absent"

标签

列表 / 元素=字符串

标签标识符的集合。

版本

字符串

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

wait_for_task

布尔值

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

选择

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多少分钟，直到抛出超时错误。

默认： 30

示例

- name: add-dns-domain
  cp_mgmt_dns_domain:
    is_sub_domain: false
    name: .www.example.com
    state: present

- name: set-dns-domain
  cp_mgmt_dns_domain:
    is_sub_domain: true
    name: .www.example.com
    state: present

- name: delete-dns-domain
  cp_mgmt_dns_domain:
    name: .example.com
    state: absent

返回值

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

键

描述

cp_mgmt_dns_domain

字典

创建或更新的 Checkpoint 对象。

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

作者

  • Or Soffer (@chkp-orso)