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

check_point.mgmt 3.0.0 中的新增功能

概要

  • 管理 Checkpoint 设备上的网络馈送对象，包括创建、更新和删除对象。

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

参数

参数

注释

auto_publish_session

布尔值

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

选择

  • false ← (默认)

  • true

certificate_id

字符串

用于访问馈送的证书 SHA-1 指纹。

color

字符串

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

选择

  • "海蓝色"

  • "黑色"

  • "蓝色"

  • "克里特 蓝色"

  • "浅黄褐色"

  • "青色"

  • "深 绿色"

  • "卡其色"

  • "兰花色"

  • "深 橙色"

  • "深 海 绿色"

  • "粉色"

  • "绿松石色"

  • "深 蓝色"

  • "火砖色"

  • "棕色"

  • "森林 绿色"

  • "金色"

  • "深 金色"

  • "灰色"

  • "深 灰色"

  • "浅 绿色"

  • "柠檬 雪纺色"

  • "珊瑚色"

  • "海 绿色"

  • "天 蓝色"

  • "洋红色"

  • "紫色"

  • "板岩 蓝色"

  • "紫罗兰 红色"

  • "海军 蓝色"

  • "橄榄色"

  • "橙色"

  • "红色"

  • "赭色"

  • "黄色"

comments

字符串

注释字符串。

custom_header

列表 / 元素=字典

允许使用 URL 使用不同身份验证方法的标头。

header_name

字符串

我们要添加的 HTTP 标头的名称。

header_value

字符串

我们要添加的 HTTP 值的名称。

data_column

整数

包含馈送数据的列的编号。

details_level

字符串

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

选择

  • "uid"

  • "standard"

  • "full"

domains_to_process

列表 / 元素=字符串

指示要在哪些域上处理命令。它不能与 details-level full 一起使用，必须仅从系统域运行且 ignore-warnings 为 true。有效值为：CURRENT_DOMAIN、ALL_DOMAINS_ON_THIS_SERVER。

feed_format

字符串

馈送文件格式。

选择

  • "平面 列表"

  • "JSON"

feed_type

字符串

要强制执行的馈送类型。

选择

  • "域"

  • "IP 地址"

  • "IP 地址/域"

feed_url

字符串

馈送的 URL。URL 应写为 http 或 https。

fields_delimiter

字符串

分隔馈送中列之间的分隔符。

ignore_errors

布尔值

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

选择

  • false

  • true

ignore_lines_that_start_with

字符串

确定要忽略哪些行的前缀。

ignore_warnings

布尔值

应用更改时忽略警告。

选择

  • false

  • true

json_query

字符串

要解析的 JQ 查询。

name

字符串 / 必需

对象名称。

password

字符串

用于通过 URL 进行身份验证的密码。

state

字符串

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

选择

  • "present" ← (默认)

  • "absent"

tags

列表 / 元素=字符串

标记标识符的集合。

update_interval

整数

在安全网关上更新馈送的分钟间隔。

use_gateway_proxy

布尔值

使用网关的代理来检索馈送。

选择

  • false

  • true

username

字符串

用于通过 URL 进行身份验证的用户名。

version

字符串

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

wait_for_task

布尔值

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

选择

  • false

  • true ← (默认)

wait_for_task_timeout

整数

等待多长时间（以分钟为单位）直到抛出超时错误。

默认： 30

示例

- name: add-network-feed
  cp_mgmt_network_feed:
    custom_header:
    - header_name: header1
      header_value: value1
    - header_name: header2
      header_value: value2
    data_column: 1
    feed_format: Flat List
    feed_type: IP Address
    feed_url: https://www.feedsresource.com/resource
    fields_delimiter: "     "
    ignore_lines_that_start_with: '!'
    name: network_feed
    password: feed_password
    state: present
    update_interval: 60
    use_gateway_proxy: false
    username: feed_username

- name: set-network-feed
  cp_mgmt_network_feed:
    custom_header:
    - header_name: new_header
      header_value: new_value
    data_column: 1
    feed_format: Flat List
    feed_type: IP Address
    feed_url: https://www.feedsresource.com/new_resource
    fields_delimiter: ','
    ignore_lines_that_start_with: '!'
    name: network_feed
    password: new_password
    state: present
    update_interval: 60
    use_gateway_proxy: false
    username: new_username

- name: delete-network-feed
  cp_mgmt_network_feed:
    name: network_feed
    state: absent

返回值

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

键

描述

cp_mgmt_network_feed

字典

已创建或更新的 Checkpoint 对象。

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

作者

  • Eden Brillant (@chkp-edenbr)