check_point.mgmt.cp_mgmt_set_domain 模块 – 使用对象名称或 UID 编辑现有对象。

注意

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

check_point.mgmt 2.1.0 中的新增功能

概要

  • 使用对象名称或 UID 编辑现有对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选项

  • false ← (默认)

  • true

color

字符串

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

选项

  • "aquamarine"

  • "black"

  • "blue"

  • "crete blue"

  • "burlywood"

  • "cyan"

  • "dark green"

  • "khaki"

  • "orchid"

  • "dark orange"

  • "dark sea green"

  • "pink"

  • "turquoise"

  • "dark blue"

  • "firebrick"

  • "brown"

  • "forest green"

  • "gold"

  • "dark gold"

  • "gray"

  • "dark gray"

  • "light green"

  • "lemon chiffon"

  • "coral"

  • "sea green"

  • "sky blue"

  • "magenta"

  • "purple"

  • "slate blue"

  • "violet red"

  • "navy blue"

  • "olive"

  • "orange"

  • "red"

  • "sienna"

  • "yellow"

comments

字符串

注释字符串。

details_level

字符串

响应中某些字段的详细程度可以变化，从仅显示对象的 UID 值到对象的完整详细表示。

选项

  • "uid"

  • "standard"

  • "full"

ignore_errors

布尔值

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

选项

  • false

  • true

ignore_warnings

布尔值

忽略警告应用更改。

选项

  • false

  • true

name

字符串 / 必需

对象名称。

servers

字典

域服务器。提供此字段时，“set-domain”命令将异步执行。

add

列表 / 元素=字典

添加到值的集合

ip_address

字符串

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

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

multi_domain_server

字符串

多域服务器名称或 UID。

name

字符串

对象名称。在域中必须唯一。

skip_start_domain_server

布尔值

将此值设置为 true 以防止启动新创建的域。

选项

  • false

  • true

type

字符串

域服务器类型。

选项

  • "management server"

  • "log server"

  • "smc"

remove

列表 / 元素=字符串

从值的集合中移除

name

字符串

对象名称。在域中必须唯一。

tags

列表 / 元素=字符串

标签标识符的集合。注意，不能在一个命令中同时修改标签列表和域服务器。要修改标签，请使用单独的“set-domain”命令，而不提供域服务器列表。

version

字符串

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

wait_for_task

布尔值

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

选项

  • false

  • true ← (默认)

wait_for_task_timeout

整数

在抛出超时错误之前等待多少分钟。

默认： 30

示例

- name: set-domain
  cp_mgmt_set_domain:
    comments: This is domain1 comment
    name: domain1

返回值

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

键

描述

cp_mgmt_domain

字典

Checkpoint set-domain 输出。

返回： 始终。

作者

  • Or Soffer (@chkp-orso)