Модуль check_point.mgmt.cp_mgmt_vpn_community_meshed — управление объектами vpn-community-meshed на 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_vpn_community_meshed.
Добавлено в check_point.mgmt 1.0.0
Краткое описание
- Управляет объектами vpn-community-meshed на устройствах Check Point, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
- Доступно начиная с версии управления R80.
Параметры
Параметр | Комментарии |
|---|---|
advanced_properties dictionary добавлено в check_point.mgmt 6.5.0 | Дополнительные свойства. Доступно начиная с версии управления R82 JHF. |
|
support_ip_compression boolean |
Указывает, следует ли поддерживать сжатие IP. Варианты:
|
|
use_aggressive_mode boolean |
Указывает, следует ли использовать агрессивный режим. Варианты:
|
auto_publish_session boolean | Опубликовать текущий сеанс после завершения задачи, если в него были внесены изменения. Варианты:
|
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментария. |
details_level string | Уровень детализации некоторых полей ответа может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты:
|
disable_nat boolean добавлено в check_point.mgmt 6.5.0 | Указывает, следует ли отключить NAT внутри VPN-сообщества. Доступно начиная с версии управления R82 JHF. Варианты:
|
encrypted_traffic dictionary добавлено в check_point.mgmt 6.5.0 | Параметры шифрованного трафика. Доступно начиная с версии управления R82 JHF. |
|
enabled boolean |
Указывает, следует ли принимать весь зашифрованный трафик. Варианты:
|
encryption_method string | Используемый метод шифрования. Доступно начиная с версии управления R80.10. Варианты:
|
encryption_suite string | Используемый набор шифров. Доступно начиная с версии управления R80.10. Варианты:
|
excluded_services list / elements=string добавлено в check_point.mgmt 6.5.0 | Список служб, исключенных из сообщества, указанных по имени или UID.<br> Подключения с использованием этих служб не будут зашифрованы и не будут соответствовать правилам, в которых указано это VPN-сообщество. Доступно начиная с версии управления R82 JHF. |
gateways list / elements=string | Список объектов Gateway, указанных по имени или UID. |
ignore_errors boolean | Применить изменения, игнорируя ошибки. Опубликовать такие изменения будет невозможно. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings boolean | Применить изменения, игнорируя предупреждения. Варианты:
|
ike_phase_1 dictionary | Параметры IKE Phase 1. Применимо только при значении [custom] для encryption-suite. Доступно начиная с версии управления R80.10. |
|
data_integrity string |
Используемый алгоритм хеширования. Варианты:
|
|
diffie_hellman_group string |
Используемая группа Диффи — Хеллмана. Варианты:
|
|
encryption_algorithm string |
Используемый алгоритм шифрования. Варианты:
|
ike_phase_2 dictionary | Параметры IKE Phase 2. Применимо только при значении [custom] для encryption-suite. Доступно начиная с версии управления R80.10. |
|
data_integrity string |
Используемый алгоритм хеширования. Варианты:
|
|
encryption_algorithm string |
Используемый алгоритм шифрования. Варианты:
|
name string / обязательный | Имя объекта. |
permanent_tunnels dictionary добавлено в check_point.mgmt 6.5.0 | Свойства постоянных туннелей. Доступно начиная с версии управления R82 JHF. |
|
gateways list / elements=dictionary |
Список шлюзов, для которых все туннели будут настроены как постоянные с указанными параметрами отслеживания. Вступает в силу только если set-permanent-tunnels-on имеет значение all-tunnels-of-specific-gateways. |
|
gateway string |
Шлюз, для которого все его туннели будут настроены как постоянные с указанными параметрами отслеживания.<br> Указывается по имени или UID. |
|
override_tunnel_down_track string |
Параметр отслеживания состояния туннеля шлюза при его отключении. Применяется только если для track-options задано значение «override track options». Варианты:
|
|
override_tunnel_up_track string |
Параметр отслеживания состояния туннеля шлюза при его подключении. Применяется только если для track-options задано значение «override track options». Варианты:
|
|
track_options string |
Указывает, следует ли использовать параметры отслеживания сообщества или переопределить параметры отслеживания постоянных туннелей. Варианты:
|
|
rim dictionary |
Параметры Route Injection Mechanism. |
|
enable_on_gateways boolean |
Указывает, следует ли включить автоматический Route Injection Mechanism для шлюзов. Варианты:
|
|
enabled boolean |
Указывает, включен ли Route Injection Mechanism. Варианты:
|
|
route_injection_track string |
Метод отслеживания внедрения маршрутов. Варианты:
|
|
set_permanent_tunnels string |
Указывает, какие туннели следует сделать постоянными. Варианты:
|
|
tunnel_down_track string |
Параметр отслеживания состояния отключенных постоянных туннелей VPN-сообщества. Варианты:
|
|
tunnel_up_track string |
Параметр отслеживания состояния подключенных постоянных туннелей. Варианты:
|
|
tunnels list / elements=dictionary |
Список туннелей, которые нужно сделать постоянными с указанными параметрами отслеживания. Вступает в силу только если set-permanent-tunnels-on имеет значение specific-tunnels-in-the-community. |
|
first_tunnel_endpoint string |
Первая конечная точка туннеля (центральный шлюз). Указывается по имени или UID. |
|
override_tunnel_down_track string |
Параметр отслеживания состояния туннеля шлюза при его отключении. Применяется только если для track-options задано значение «override track options». Варианты:
|
|
override_tunnel_up_track string |
Параметр отслеживания состояния туннеля шлюза при его подключении. Применяется только если для track-options задано значение «override track options». Варианты:
|
|
second_tunnel_endpoint string |
Вторая конечная точка туннеля (центральный шлюз для ячеистого VPN-сообщества и спутниковый шлюз для звездообразного VPN-сообщества). Указывается по имени или UID. |
|
track_options string |
Указывает, следует ли использовать параметры отслеживания сообщества или переопределить параметры отслеживания постоянных туннелей. Варианты:
|
routing_mode string добавлено в check_point.mgmt 6.5.0 | Режим маршрутизации VPN-сообщества. Доступно начиная с версии управления R82 JHF. Варианты:
|
list / elements=dictionary | Общие секреты для внешних шлюзов. Доступно начиная с версии управления R80.10. |
|
string |
Внешний шлюз, указанный по имени или UID. |
|
string |
Общий секрет. |
state string | Состояние правила доступа (present или absent). Варианты:
|
tags list / elements=string | Коллекция идентификаторов тегов. |
boolean | Указывает, следует ли использовать общий секрет для всех внешних шлюзов. Доступно начиная с версии управления R80.10. Варианты:
|
version string | Версия Check Point. Если она не указана, используется последняя версия. |
wait_for_task boolean | Ожидать завершения задачи, например задачи публикации. Варианты:
|
wait_for_task_timeout integer | Время ожидания в минутах до возникновения ошибки тайм-аута. По умолчанию: |
wire_mode dictionary добавлено в check_point.mgmt 6.5.0 | Свойства режима Wire сообщества VPN. Доступно начиная с версии управления R82 JHF. |
|
allow_uninspected_encrypted_routing boolean |
Разрешить участникам маршрутизировать непроверенный зашифрованный трафик в конфигурациях маршрутизации VPN. Варианты:
|
|
allow_uninspected_encrypted_traffic boolean |
Разрешить непроверенный зашифрованный трафик между интерфейсами режима Wire участников этого сообщества. Варианты:
|
Примеры
- name: add-vpn-community-meshed
cp_mgmt_vpn_community_meshed:
encryption_method: prefer ikev2 but support ikev1
encryption_suite: custom
ike_phase_1:
data_integrity: sha1
diffie_hellman_group: group 19
encryption_algorithm: aes-128
ike_phase_2:
data_integrity: aes-xcbc
encryption_algorithm: aes-gcm-128
name: New_VPN_Community_Meshed_1
state: present
- name: set-vpn-community-meshed
cp_mgmt_vpn_community_meshed:
encryption_method: ikev2 only
encryption_suite: custom
ike_phase_1:
data_integrity: sha1
diffie_hellman_group: group 19
encryption_algorithm: aes-128
ike_phase_2:
data_integrity: aes-xcbc
encryption_algorithm: aes-gcm-128
name: New_VPN_Community_Meshed_1
state: present
- name: delete-vpn-community-meshed
cp_mgmt_vpn_community_meshed:
name: New_VPN_Community_Meshed_1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_vpn_community_meshed dictionary | Объект Check Point, созданный или обновлённый. Возвращается: всегда, кроме случаев удаления объекта. |
Ссылки на коллекцию
© 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_vpn_community_meshed_module.html