check_point.mgmt.cp_mgmt_vpn_community_star модуль — Управляет объектами vpn-community-star на Check Point через API веб-служб
Примечание
Этот модуль входит в коллекцию check_point.mgmt (версия 5.2.3).
Вы, возможно, уже установили эту коллекцию, если используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install check_point.mgmt.
Чтобы использовать её в плейбуке, укажите: check_point.mgmt.cp_mgmt_vpn_community_star.
Добавлен в check_point.mgmt 1.0.0
Описание
- Управляет объектами vpn-community-star на устройствах Check Point, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
Параметры
Параметр | Комментарии |
|---|---|
auto_publish_session boolean | Опубликовать текущий сеанс, если изменения были выполнены после завершения задачи. Варианты:
|
center_gateways list / elements=string | Коллекция объектов центрального VPN-шлюза и VPN-устройства, идентифицированных по имени или UID. |
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментариев. |
details_level string | Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
encryption_method string | Используемый метод шифрования. Варианты:
|
encryption_suite string | Используемый набор шифрования. Варианты:
|
granular_encryptions list / elements=dictionary added in check_point.mgmt 5.1.0 | Параметры гранулярного шифрования VPN. |
|
encryption_method string |
Используемый метод шифрования. Варианты:
|
|
encryption_suite string |
Используемый набор шифрования. Варианты:
|
|
external_gateway string |
Внешний управляемый или сторонний шлюз, идентифицированный по имени или UID. |
|
ike_phase_1 dictionary |
Параметры фазы 1 IKE. Применимо только когда encryption-suite установлен в [custom]. |
|
data_integrity string |
Используемый алгоритм хеширования. Варианты:
|
|
diffie_hellman_group string |
Используемая группа Диффи-Хеллмана. Варианты:
|
|
encryption_algorithm string |
Используемый алгоритм шифрования. Варианты:
|
|
ike_p1_rekey_time integer |
Указывает временной интервал для переговорного процесса IKE фазы 1. |
|
ike_p1_rekey_time_unit string |
Указывает единицу времени для параметра [ike-p1-rekey-time-unit], округленную до минут. Варианты:
|
|
ike_phase_2 dictionary |
Параметры фазы 2 IKE. Применимо только тогда, когда encryption-suite установлен в [custom]. |
|
data_integrity string |
Используемый алгоритм хеширования. Варианты:
|
|
encryption_algorithm string |
Используемый алгоритм шифрования. Варианты:
|
|
ike_p2_pfs_dh_grp string |
Используемая группа Диффи-Хеллмана. Варианты:
|
|
ike_p2_rekey_time integer |
Указывает временной интервал для повторного согласования фазы 2 IKE. |
|
ike_p2_rekey_time_unit string |
Указывает единицу времени для параметра [ike-p2-rekey-time-unit]. Варианты:
|
|
ike_p2_use_pfs boolean |
Указывает, используется ли Perfect Forward Secrecy (PFS) для фазы 2 IKE. Варианты:
|
|
internal_gateway string |
Внутренний шлюз Check Point, идентифицированный по имени или UID, или «Any» для всех участников внутреннего шлюза в этом сообществе. |
ignore_errors boolean | Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings boolean | Применить изменения, игнорируя предупреждения. Варианты:
|
ike_phase_1 dictionary | Параметры фазы 1 IKE. Применимо только тогда, когда encryption-suite установлен в [custom]. |
|
data_integrity string |
Используемый алгоритм хеширования. Варианты:
|
|
diffie_hellman_group string |
Используемая группа Диффи-Хеллмана. Варианты:
|
|
encryption_algorithm string |
Используемый алгоритм шифрования. Варианты:
|
|
ike_p1_rekey_time integer added in check_point.mgmt 5.1.0 |
Указывает временной интервал для повторного согласования фазы 1 IKE. |
|
ike_p1_rekey_time_unit строка добавлено в check_point.mgmt 5.1.0 |
Указывает единицу измерения времени для параметра [ike-p1-rekey-time-unit], округлённую до минут. Варианты:
|
ike_phase_2 словарь | Настройки IKE Phase 2. Применимо только при [custom] для параметра encryption-suite. |
|
data_integrity строка |
Алгоритм хэширования. Варианты:
|
|
encryption_algorithm строка |
Используемый алгоритм шифрования. Варианты:
|
|
ike_p2_pfs_dh_grp строка добавлено в check_point.mgmt 5.1.0 |
Используемая группа Diffie-Hellman. Варианты:
|
|
ike_p2_rekey_time целое число добавлено в check_point.mgmt 5.1.0 |
Интервал времени для повторного согласования IKE phase 2. |
|
ike_p2_rekey_time_unit строка добавлено в check_point.mgmt 5.1.0 |
Указывает единицу измерения времени для параметра [ike-p2-rekey-time-unit]. Варианты:
|
|
ike_p2_use_pfs логическое добавлено в check_point.mgmt 5.1.0 |
Указывает, используется ли Perfect Forward Secrecy (PFS) для IKE phase 2. Варианты:
|
mesh_center_gateways логическое | Указывает, находится ли объединённая группа в центре. Варианты:
|
name строка / обязательно | Имя объекта. |
override_vpn_domains список / элементы=словарь добавлено в check_point.mgmt 5.1.0 | Настройки переопределения VPN-доменов для шлюзов участников. |
|
gateway строка |
Шлюз участника в переопределённом VPN-домене, определённый по имени или идентификатору. |
|
vpn_domain строка |
VPN-домен сети, определённый по имени или идентификатору. |
satellite_gateways список / элементы=строка | Список объектов шлюзов, представляющих спутниковые шлюзы, определённые по имени или идентификатору. |
список / элементы=словарь | Общие секреты для внешних шлюзов. |
|
строка |
Внешний шлюз, определённый по имени или идентификатору. |
|
строка |
Общий секрет. |
state строка | Состояние правила доступа (существующее или отсутствующее). Варианты:
|
tags список / элементы=строка | Список идентификаторов тегов. |
tunnel_granularity string added in check_point.mgmt 5.1.0 | Вариант совместного использования VPN-туннеля. Варианты:
|
boolean | Указывает, следует ли использовать общий секрет для всех внешних шлюзов. Варианты:
|
version string | Версия Checkpoint. Если не указана, используется последняя версия. |
wait_for_task boolean | Ожидать завершения задачи, например, задачи публикации. Варианты:
|
wait_for_task_timeout integer | Количество минут ожидания, после чего произойдёт ошибка таймаута. По умолчанию: |
Примеры
- name: add-vpn-community-star
cp_mgmt_vpn_community_star:
center_gateways: Second_Security_Gateway
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_Star_1
state: present
- name: set-vpn-community-star
cp_mgmt_vpn_community_star:
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_Star_1
state: present
- name: delete-vpn-community-star
cp_mgmt_vpn_community_star:
name: New_VPN_Community_Star_1
state: absent
Значения возврата
Общие значения возврата описаны в этом разделе, а следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
cp_mgmt_vpn_community_star словарь | Созданный или обновлённый объект Checkpoint. Возвращается: всегда, кроме случая удаления объекта. |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/check_point/mgmt/cp_mgmt_vpn_community_star_module.html