Spec-Zone.ru › Ansible

Модуль 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.

Варианты:

  • false
  • true

use_aggressive_mode

boolean

Указывает, следует ли использовать агрессивный режим.

Варианты:

  • false
  • true

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"

disable_nat

boolean

добавлено в check_point.mgmt 6.5.0

Указывает, следует ли отключить NAT внутри VPN-сообщества.

Доступно начиная с версии управления R82 JHF.

Варианты:

  • false
  • true

encrypted_traffic

dictionary

добавлено в check_point.mgmt 6.5.0

Параметры шифрованного трафика.

Доступно начиная с версии управления R82 JHF.

enabled

boolean

Указывает, следует ли принимать весь зашифрованный трафик.

Варианты:

  • false
  • true

encryption_method

string

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

Доступно начиная с версии управления R80.10.

Варианты:

  • "prefer ikev2 but support ikev1"
  • "ikev2 only"
  • "ikev1 for ipv4 and ikev2 for ipv6 only"

encryption_suite

string

Используемый набор шифров.

Доступно начиная с версии управления R80.10.

Варианты:

  • "suite-b-gcm-256"
  • "custom"
  • "vpn b"
  • "vpn a"
  • "suite-b-gcm-128"

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 не указан, предупреждения также будут игнорироваться.

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

ike_phase_1

dictionary

Параметры IKE Phase 1. Применимо только при значении [custom] для encryption-suite.

Доступно начиная с версии управления R80.10.

data_integrity

string

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

Варианты:

  • "aes-xcbc"
  • "sha1"
  • "sha256"
  • "sha384"
  • "sha512"
  • "md5"

diffie_hellman_group

string

Используемая группа Диффи — Хеллмана.

Варианты:

  • "group-1"
  • "group-2"
  • "group-5"
  • "group-14"
  • "group-19"
  • "group-20"

encryption_algorithm

string

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

Варианты:

  • "cast"
  • "aes-256"
  • "des"
  • "aes-128"
  • "3des"

ike_phase_2

dictionary

Параметры IKE Phase 2. Применимо только при значении [custom] для encryption-suite.

Доступно начиная с версии управления R80.10.

data_integrity

string

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

Варианты:

  • "aes-xcbc"
  • "sha1"
  • "sha256"
  • "sha384"
  • "sha512"
  • "md5"

encryption_algorithm

string

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

Варианты:

  • "cast"
  • "aes-gcm-256"
  • "cast-40"
  • "aes-256"
  • "des"
  • "aes-128"
  • "3des"
  • "des-40cp"
  • "aes-gcm-128"
  • "none"

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».

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

override_tunnel_up_track

string

Параметр отслеживания состояния туннеля шлюза при его подключении. Применяется только если для track-options задано значение «override track options».

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

track_options

string

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

Варианты:

  • "according to community track options"
  • "override track options"

rim

dictionary

Параметры Route Injection Mechanism.

enable_on_gateways

boolean

Указывает, следует ли включить автоматический Route Injection Mechanism для шлюзов.

Варианты:

  • false
  • true

enabled

boolean

Указывает, включен ли Route Injection Mechanism.

Варианты:

  • false
  • true

route_injection_track

string

Метод отслеживания внедрения маршрутов.

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

set_permanent_tunnels

string

Указывает, какие туннели следует сделать постоянными.

Варианты:

  • "on all tunnels in the community"
  • "on all tunnels of specific gateways"
  • "on specific tunnels in the community"
  • "off"

tunnel_down_track

string

Параметр отслеживания состояния отключенных постоянных туннелей VPN-сообщества.

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

tunnel_up_track

string

Параметр отслеживания состояния подключенных постоянных туннелей.

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

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».

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

override_tunnel_up_track

string

Параметр отслеживания состояния туннеля шлюза при его подключении. Применяется только если для track-options задано значение «override track options».

Варианты:

  • "none"
  • "log"
  • "popup alert"
  • "mail alert"
  • "snmp trap alert"
  • "user defined alert no.1"
  • "user defined alert no.2"
  • "user defined alert no.3"

second_tunnel_endpoint

string

Вторая конечная точка туннеля (центральный шлюз для ячеистого VPN-сообщества и спутниковый шлюз для звездообразного VPN-сообщества). Указывается по имени или UID.

track_options

string

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

Варианты:

  • "according to community track options"
  • "override track options"

routing_mode

string

добавлено в check_point.mgmt 6.5.0

Режим маршрутизации VPN-сообщества.

Доступно начиная с версии управления R82 JHF.

Варианты:

  • "domain_based"
  • "route_based"

shared_secrets

list / elements=dictionary

Общие секреты для внешних шлюзов.

Доступно начиная с версии управления R80.10.

external_gateway

string

Внешний шлюз, указанный по имени или UID.

shared_secret

string

Общий секрет.

state

string

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

Варианты:

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

tags

list / elements=string

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

use_shared_secret

boolean

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

Доступно начиная с версии управления R80.10.

Варианты:

  • false
  • true

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

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

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

wire_mode

dictionary

добавлено в check_point.mgmt 6.5.0

Свойства режима Wire сообщества VPN.

Доступно начиная с версии управления R82 JHF.

allow_uninspected_encrypted_routing

boolean

Разрешить участникам маршрутизировать непроверенный зашифрованный трафик в конфигурациях маршрутизации VPN.

Варианты:

  • false
  • true

allow_uninspected_encrypted_traffic

boolean

Разрешить непроверенный зашифрованный трафик между интерфейсами режима Wire участников этого сообщества.

Варианты:

  • false
  • true

Примеры

- 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, созданный или обновлённый.

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

Авторы

  • 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_vpn_community_meshed_module.html

Spec-Zone.ru

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