check_point.mgmt.cp_mgmt_host 模块 – 通过 Web Services API 管理 Check Point 上的主机对象

注意

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

check_point.mgmt 1.0.0 中的新增功能

概要

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

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ←（默认）

  • true

color

字符串

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

选择

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "棕褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿"

  • "粉色"

  • "绿松石色"

  • "深蓝色"

  • "火砖色"

  • "棕色"

  • "森林绿"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝"

  • "紫红色"

  • "海军蓝"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选择

  • "uid"

  • "标准"

  • "完整"

groups

列表 / 元素=字符串

组标识符的集合。

host_servers

字典

服务器配置。

dns_server

布尔值

如果此服务器是 DNS 服务器，则为 True。

选择

  • false

  • true

mail_server

布尔值

如果此服务器是邮件服务器，则为 True。

选择

  • false

  • true

web_server

布尔值

如果此服务器是 Web 服务器，则为 True。

选择

  • false

  • true

web_server_config

字典

Web 服务器配置。

additional_ports

列表 / 元素=字符串

服务器的附加端口。

application_engines

列表 / 元素=字符串

此 Web 服务器的应用程序引擎。

listen_standard_port

布尔值

服务器是否侦听标准端口。

选择

  • false

  • true

operating_system

字符串

操作系统。

选择

  • "sparc linux"

  • "windows"

  • "other"

  • "x86 linux"

  • "sparc solaris"

protected_by

字符串

通过名称或 UID 标识的、保护此服务器的网络对象。

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

interfaces

列表 / 元素=字典

主机接口。

color

字符串

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

选择

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特蓝"

  • "棕褐色"

  • "青色"

  • "深绿色"

  • "卡其色"

  • "兰花色"

  • "深橙色"

  • "深海绿"

  • "粉色"

  • "绿松石色"

  • "深蓝色"

  • "火砖色"

  • "棕色"

  • "森林绿"

  • "金色"

  • "深金色"

  • "灰色"

  • "深灰色"

  • "浅绿色"

  • "柠檬雪纺"

  • "珊瑚色"

  • "海绿色"

  • "天蓝色"

  • "洋红色"

  • "紫色"

  • "板岩蓝"

  • "紫红色"

  • "海军蓝"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

details_level

字符串

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

选择

  • "uid"

  • "标准"

  • "完整"

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

mask_length

整数

IPv4 或 IPv6 网络掩码长度。如果需要两个掩码，请显式使用 mask-length4 和 mask-length6 字段。除了 IPv4 掩码长度之外，还可以在子网掩码字段中指定 IPv4 掩码本身。

mask_length4

整数

IPv4 网络掩码长度。

mask_length6

整数

IPv6 网络掩码长度。

name

字符串

接口名称。

subnet

字符串

IPv4 或 IPv6 网络地址。如果需要两个地址，请显式使用 subnet4 和 subnet6 字段。

subnet4

字符串

IPv4 网络地址。

subnet6

字符串

IPv6 网络地址。

subnet_mask

字符串

IPv4 网络掩码。

ip_address

字符串

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

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

name

字符串 / 必需

对象名称。

nat_settings

字典

NAT 设置。

auto_rule

布尔值

是否添加自动地址转换规则。

选择

  • false

  • true

hide_behind

字符串

隐藏在后面的方法。如果 “method” 参数为 “static”，则不需要此参数。

选择

  • "网关"

  • "IP 地址"

install_on

字符串

哪个网关应应用 NAT 转换。

ip_address

字符串

IPv4 或 IPv6 地址。如果需要两个地址，请显式使用 ipv4-address 和 ipv6-address 字段。如果 “method” 参数为 “hide” 且 “hide-behind” 参数为 “gateway”，则不需要此参数。

ipv4_address

字符串

IPv4 地址。

ipv6_address

字符串

IPv6 地址。

method

字符串

NAT 转换方法。

选择

  • "隐藏"

  • "静态"

state

字符串

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

选择

  • "present" ←（默认）

  • "absent"

tags

列表 / 元素=字符串

标签标识符的集合。

version

字符串

检查点的版本。如果未给出，则使用最新版本。

wait_for_task

布尔值

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

选择

  • false

  • true ←（默认）

wait_for_task_timeout

整数

等待超时错误抛出的分钟数。

默认： 30

示例

- name: add-host
  cp_mgmt_host:
    ip_address: 192.0.2.1
    name: New Host 1
    state: present

- name: set-host
  cp_mgmt_host:
    color: green
    ipv4_address: 192.0.2.2
    name: New Host 1
    state: present

- name: delete-host
  cp_mgmt_host:
    name: New Host 1
    state: absent

返回值

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

键

描述

cp_mgmt_host

字典

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

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

作者

  • Or Soffer (@chkp-orso)