Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_network_probe — управление объектами сетевых проб на 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_probe.

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

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

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

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

Параметры

Параметр

Комментарии

auto_publish_session

boolean

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

Варианты:

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

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

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

details_level

string

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

Варианты:

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

domains_to_process

list / elements=string

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

http_options

dictionary

Дополнительные параметры, если для [protocol] задано значение «http».

destination

string

URL назначения.

icmp_options

dictionary

Дополнительные параметры, если для [protocol] задано значение «icmp».

destination

string

Одно из следующих значений:<br>- Имя или UID существующего объекта с одноадресным IPv4-адресом (Host, Security Gateway и т. д.).<br>- Строка с одноадресным IPv4-адресом (если вы не хотите создавать такой объект).

source

string

Одно из следующих значений:<br>- Строка «main-ip» (проба использует основной IPv4-адрес объектов Security Gateway, указанных в параметре [install-on]).<br>- Имя или UID существующего объекта типа ‘Host’ с одноадресным IPv4-адресом.<br>- Строка с одноадресным IPv4-адресом (если вы не хотите создавать такой объект).

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

install_on

list / elements=string

Коллекция шлюзов безопасности Check Point, создающих пробу; шлюзы указываются по имени или UID.

interval

integer

Интервал времени в диапазоне 5–300 (секунд) между запросами пробы. Рекомендация: значение интервала должно быть меньше значения тайм-аута.

name

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

Имя объекта.

protocol

string

Используемый протокол пробирования.

Варианты:

  • "http"
  • "icmp"

state

string

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

Варианты:

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

tags

list / elements=string

Коллекция идентификаторов тегов.

timeout

integer

Тайм-аут истечения срока действия пробы в диапазоне 5–300 (секунд). Если за это время не поступит ни одного ответа, состояние пробы изменится на «Down».

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

Сколько минут ожидать до возникновения ошибки тайм-аута.

По умолчанию: 30

Примеры

- name: add-network-probe
  cp_mgmt_network_probe:
    icmp_options:
      destination: HOST_20.20.20.20
      source: Host_10.10.10.10
    install_on: GW_1
    name: probe_GW1
    state: present

- name: set-network-probe
  cp_mgmt_network_probe:
    icmp_options:
      destination: 2.2.2.2
      source: 1.1.1.1
    name: probe_GW1
    state: present

- name: delete-network-probe
  cp_mgmt_network_probe:
    name: probe_GW1
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

cp_mgmt_network_probe

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_probe_module.html

Spec-Zone.ru

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