Spec-Zone.ru › Ansible

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

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

Варианты:

  • false ← (default)
  • true

center_gateways

list / elements=string

Коллекция объектов центрального VPN-шлюза и VPN-устройства, идентифицированных по имени или UID.

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"

encryption_method

string

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

Варианты:

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

encryption_suite

string

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

Варианты:

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

granular_encryptions

list / elements=dictionary

added in check_point.mgmt 5.1.0

Параметры гранулярного шифрования VPN.

encryption_method

string

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

Варианты:

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

encryption_suite

string

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

Варианты:

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

external_gateway

string

Внешний управляемый или сторонний шлюз, идентифицированный по имени или UID.

ike_phase_1

dictionary

Параметры фазы 1 IKE. Применимо только когда encryption-suite установлен в [custom].

data_integrity

string

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

Варианты:

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

diffie_hellman_group

string

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

Варианты:

  • "group-1"
  • "group-2"
  • "group-5"
  • "group-14"
  • "group-15"
  • "group-16"
  • "group-17"
  • "group-18"
  • "group-19"
  • "group-20"
  • "group-24"

encryption_algorithm

string

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

Варианты:

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

ike_p1_rekey_time

integer

Указывает временной интервал для переговорного процесса IKE фазы 1.

ike_p1_rekey_time_unit

string

Указывает единицу времени для параметра [ike-p1-rekey-time-unit], округленную до минут.

Варианты:

  • "days"
  • "hours"
  • "minutes"
  • "seconds"

ike_phase_2

dictionary

Параметры фазы 2 IKE. Применимо только тогда, когда encryption-suite установлен в [custom].

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"

ike_p2_pfs_dh_grp

string

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

Варианты:

  • "group-1"
  • "group-2"
  • "group-5"
  • "group-14"
  • "group-15"
  • "group-16"
  • "group-17"
  • "group-18"
  • "group-19"
  • "group-20"
  • "group-24"

ike_p2_rekey_time

integer

Указывает временной интервал для повторного согласования фазы 2 IKE.

ike_p2_rekey_time_unit

string

Указывает единицу времени для параметра [ike-p2-rekey-time-unit].

Варианты:

  • "days"
  • "hours"
  • "minutes"
  • "seconds"

ike_p2_use_pfs

boolean

Указывает, используется ли Perfect Forward Secrecy (PFS) для фазы 2 IKE.

Варианты:

  • false
  • true

internal_gateway

string

Внутренний шлюз Check Point, идентифицированный по имени или UID, или «Any» для всех участников внутреннего шлюза в этом сообществе.

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

ike_phase_1

dictionary

Параметры фазы 1 IKE. Применимо только тогда, когда encryption-suite установлен в [custom].

data_integrity

string

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

Варианты:

  • "aes-xcbc"
  • "sha1"
  • "sha256"
  • "sha384"
  • "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_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], округлённую до минут.

Варианты:

  • "days"
  • "hours"
  • "minutes"
  • "seconds"

ike_phase_2

словарь

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

data_integrity

строка

Алгоритм хэширования.

Варианты:

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

encryption_algorithm

строка

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

Варианты:

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

ike_p2_pfs_dh_grp

строка

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

Используемая группа Diffie-Hellman.

Варианты:

  • "group-1"
  • "group-2"
  • "group-5"
  • "group-14"
  • "group-15"
  • "group-16"
  • "group-17"
  • "group-18"
  • "group-19"
  • "group-20"
  • "group-24"

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

Варианты:

  • "days"
  • "hours"
  • "minutes"
  • "seconds"

ike_p2_use_pfs

логическое

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

Указывает, используется ли Perfect Forward Secrecy (PFS) для IKE phase 2.

Варианты:

  • false
  • true

mesh_center_gateways

логическое

Указывает, находится ли объединённая группа в центре.

Варианты:

  • false
  • true

name

строка / обязательно

Имя объекта.

override_vpn_domains

список / элементы=словарь

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

Настройки переопределения VPN-доменов для шлюзов участников.

gateway

строка

Шлюз участника в переопределённом VPN-домене, определённый по имени или идентификатору.

vpn_domain

строка

VPN-домен сети, определённый по имени или идентификатору.

satellite_gateways

список / элементы=строка

Список объектов шлюзов, представляющих спутниковые шлюзы, определённые по имени или идентификатору.

shared_secrets

список / элементы=словарь

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

external_gateway

строка

Внешний шлюз, определённый по имени или идентификатору.

shared_secret

строка

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

state

строка

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

Варианты:

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

tags

список / элементы=строка

Список идентификаторов тегов.

END_OF_DOCUMENT_MARKER

tunnel_granularity

string

added in check_point.mgmt 5.1.0

Вариант совместного использования VPN-туннеля.

Варианты:

  • "per_host"
  • "per_subnet"
  • "universal"

use_shared_secret

boolean

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

Варианты:

  • false
  • true

version

string

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

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

Количество минут ожидания, после чего произойдёт ошибка таймаута.

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

Примеры

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

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

Авторы

  • Or Soffer (@chkp-orso)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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

Spec-Zone.ru

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