Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_network_feed – Управление объектами сетевых каналов на Checkpoint через API веб-служб

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 6.9.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_network_feed.

Добавлено в check_point.mgmt 3.0.0

  • Краткое описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управляет объектами сетевых каналов на устройствах Checkpoint, в том числе создаёт, обновляет и удаляет объекты.
  • Все операции выполняются через API веб-служб.
  • Доступно начиная с версии управления R81.20.

Параметры

Параметр

Комментарии

auto_publish_session

boolean

Опубликовать текущий сеанс после завершения задачи, если в нём были внесены изменения.

Варианты:

  • false ← (по умолчанию)
  • true

certificate_id

string

Отпечаток SHA-1 сертификата для доступа к каналу.

color

string

Цвет объекта. Должен быть одним из существующих цветов.

Варианты:

  • "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

string

Строка комментария.

custom_header

list / elements=dictionary

Заголовки для использования различных методов аутентификации с URL.

header_name

string

Имя добавляемого HTTP-заголовка.

header_value

string

Значение HTTP-заголовка, которое требуется добавить.

data_column

integer

Номер столбца, содержащего данные канала.

details_level

string

Уровень детализации некоторых полей ответа может варьироваться от отображения только значения UID объекта до полного представления объекта.

Варианты:

  • "uid"
  • "standard"
  • "full"

domains_to_process

list / elements=string

Указывает, в каких доменах выполнять команды. Нельзя использовать со значением details-level full; запускать следует только из системного домена и при значении ignore-warnings true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.

feed_format

string

Формат файла канала.

Варианты:

  • "Flat List"
  • "JSON"

feed_type

string

Тип канала, который требуется применить.

Варианты:

  • "Domain"
  • "IP Address"
  • "IP Address/Domain"

feed_url

string

URL канала. URL должен начинаться с http или https.

fields_delimiter

string

Разделитель столбцов в канале.

ignore_errors

boolean

Применять изменения, игнорируя ошибки. Такие изменения нельзя будет опубликовать. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться.

Варианты:

  • false
  • true

ignore_lines_that_start_with

string

Префикс, определяющий строки, которые нужно игнорировать.

ignore_warnings

boolean

Применять изменения, игнорируя предупреждения.

Варианты:

  • false
  • true

json_query

string

Запрос JQ для разбора.

name

string / обязательный

Имя объекта.

password

string

Пароль для аутентификации при обращении к URL.

state

string

Состояние правила доступа (present или absent).

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

list / elements=string

Набор идентификаторов тегов.

update_interval

integer

Интервал обновления канала на шлюзе безопасности в минутах.

use_gateway_proxy

boolean

Использовать прокси-сервер шлюза для получения канала.

Варианты:

  • false
  • true

username

string

Имя пользователя для аутентификации при обращении к URL.

version

string

Версия Checkpoint. Если она не указана, используется последняя версия.

wait_for_task

boolean

Ожидать завершения задачи, например публикации.

Варианты:

  • false
  • true ← (по умолчанию)

wait_for_task_timeout

integer

Время ожидания в минутах до возникновения ошибки тайм-аута.

По умолчанию: 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

dictionary

Созданный или обновлённый объект Checkpoint.

Возвращается: всегда, кроме случаев удаления объекта.

Авторы

  • Eden Brillant (@chkp-edenbr)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/check_point/mgmt/cp_mgmt_network_feed_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API