Модуль check_point.mgmt.cp_mgmt_access_rule — управление объектами правил доступа Check Point через 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_access_rule.

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

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

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

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

Параметры

Параметр	Комментарии
action string	«Accept», «Drop», «Ask», «Inform», «Reject», «User Auth», «Client Auth», «Apply Layer».
action_settings dictionary	Параметры действия.
enable_identity_captive_portal boolean	Н/Д Возможные значения: `false` `true`
limit string	Н/Д
auto_publish_session boolean	Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Возможные значения: `false` ← (по умолчанию) `true`
comments string	Строка комментария.
content list / elements=dictionary	Список обрабатываемых типов файлов, к которым применяется это правило. Доступно начиная с версии управления R80.10.
content_direction string	Направление, в котором применяется обработка типов файлов. Доступно начиная с версии управления R80.10. Возможные значения: `"any"` `"up"` `"down"`
content_negate boolean	Значение True, если для данных задано отрицание. Доступно начиная с версии управления R80.10. Возможные значения: `false` `true`
custom_fields dictionary	Пользовательские поля.
field_1 string	Первое пользовательское поле.
field_2 string	Второе пользовательское поле.
field_3 string	Третье пользовательское поле.
destination list / elements=string	Коллекция сетевых объектов, определяемых по имени или UID.
destination_negate boolean	Значение True, если для назначения задано отрицание. Возможные значения: `false` `true`
details_level string	Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до его полного подробного представления. Возможные значения: `"uid"` `"standard"` `"full"`
enabled boolean	Включить или отключить правило. Возможные значения: `false` `true`
ignore_errors boolean	Применить изменения, игнорируя ошибки. Опубликовать такие изменения будет невозможно. Если флаг ignore-warnings не указан, предупреждения также будут проигнорированы. Возможные значения: `false` `true`
ignore_warnings boolean	Применить изменения, игнорируя предупреждения. Возможные значения: `false` `true`
inline_layer string	Встроенный слой, определяемый по имени или UID. Применимо только в том случае, если для «Action» задано значение «Apply Layer».
install_on list / elements=string	Шлюзы, определяемые по имени или UID, на которые следует установить политику.
layer string	Слой, к которому относится правило, определяемый по имени или UID.
name string / обязательный	Имя объекта.
position string	Позиция в базе правил. Использование значений «top» и «bottom» может нарушить идемпотентность.
relative_position dictionary	Позиция в базе правил. Использование этого поля может нарушить идемпотентность.
above string	Добавить правило над указанным правилом или разделом, определяемым по имени (поиск ограничен 50 правилами, если search_entire_rulebase имеет значение False).
below string	Добавить правило под указанным правилом или разделом, определяемым по имени (поиск ограничен 50 правилами, если search_entire_rulebase имеет значение False).
bottom string	Добавить правило в конец указанного раздела, определяемого по имени (поиск ограничен 50 правилами, если search_entire_rulebase имеет значение False).
top string	Добавить правило в начало указанного раздела, определяемого по имени (поиск ограничен 50 правилами, если search_entire_rulebase имеет значение False).
search_entire_rulebase boolean	Определяет, следует ли искать правило по всей базе правил, если оно изменено в поле relative_position, чтобы убедиться, что его позиция или раздел действительно изменились. Возможные значения: `false` ← (по умолчанию) `true`
service list / elements=string	Коллекция сетевых объектов, определяемых по имени или UID.
service_negate boolean	Значение True, если для службы задано отрицание. Возможные значения: `false` `true`
source list / elements=string	Коллекция сетевых объектов, определяемых по имени или UID.
source_negate boolean	Значение True, если для источника задано отрицание. Возможные значения: `false` `true`
state string	Состояние правила доступа (present или absent). Возможные значения: `"present"` ← (по умолчанию) `"absent"`
time list / elements=string	Список временных объектов. Например, «Weekend», «Off-Work», «Every-Day».
track dictionary	Параметры отслеживания. Доступно начиная с версии управления R80.10.
accounting boolean	Включает и отключает сбор данных учета для отслеживания. Возможные значения: `false` `true`
alert string	Тип оповещения для отслеживания. Возможные значения: `"none"` `"alert"` `"snmp"` `"mail"` `"user alert 1"` `"user alert 2"` `"user alert 3"`
enable_firewall_session boolean	Определяет, следует ли создавать журналы сеансов только для подключений брандмауэра. Доступно начиная с версии управления R80.20. Возможные значения: `false` `true`
per_connection boolean	Определяет, следует ли создавать запись журнала для каждого подключения. Возможные значения: `false` `true`
per_session boolean	Определяет, следует ли создавать запись журнала для каждого сеанса. Возможные значения: `false` `true`
type string	«Log», «Extended Log», «Detailed Log», «None».
user_check dictionary	Параметры проверки пользователя.
confirm string	Н/Д Возможные значения: `"per rule"` `"per category"` `"per application/site"` `"per data type"`
custom_frequency dictionary	Н/Д
every integer	Н/Д
unit string	Н/Д Возможные значения: `"hours"` `"days"` `"weeks"` `"months"`
frequency string	Н/Д Возможные значения: `"once a day"` `"once a week"` `"once a month"` `"custom frequency..."`
interaction string	Н/Д
version string	Версия Check Point. Если не указана, используется последняя версия.
vpn string	Any или All_GwToGw. Возможные значения: `"Any"` `"All_GwToGw"`
vpn_list list / elements=dictionary	Сообщества или направленные условия.
community list / elements=string	Список имен сообществ или их UID.
directional list / elements=dictionary	Направленное условие соответствия сообществ.
from string	Имя или UID исходного сообщества.
to string	Имя или UID целевого сообщества.
wait_for_task boolean	Ожидать завершения задачи, например задачи публикации. Возможные значения: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Количество минут ожидания до возникновения ошибки тайм-аута. По умолчанию: `30`

Примеры

- name: add-access-rule
  cp_mgmt_access_rule:
    layer: Network
    name: Rule 1
    position: 1
    service:
      - SMTP
      - AOL
    vpn: All_GwToGw
    state: present

- name: set-access-rule
  cp_mgmt_access_rule:
    action: Ask
    action_settings:
      enable_identity_captive_portal: true
      limit: Upload_1Gbps
    layer: Network
    name: Rule 1
    state: present

- name: delete-access-rule
  cp_mgmt_access_rule:
    layer: Network
    name: Rule 2
    state: absent

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

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

Ключ	Описание
cp_mgmt_access_rule dictionary	Объект Check Point, созданный или обновлённый. Возвращается: всегда, кроме случаев удаления объекта.

Авторы

Or Soffer (@chkp-orso)

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

© 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_access_rule_module.html