Модуль check_point.mgmt.cp_mgmt_vpn_community_star – управление объектами vpn-community-star в Check Point через API веб-служб

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

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"

disable_nat

boolean

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

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

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

Варианты:

• false
• true

disable_nat_on

string

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

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

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

Варианты:

• "satellite gateways only"
• "both center and satellite gateways"

encrypted_traffic

dictionary

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

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

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

community_members

string

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

Варианты:

• "satellite gateways only"
• "both center and satellite gateways"

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.

granular_encryptions

list / elements=dictionary

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

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

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

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

Параметры IKE Phase 1. Применяется только при значении [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

Определяет интервал времени между повторными согласованиями фазы 1 IKE.

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

ike_p1_rekey_time_unit

string

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

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

Варианты:

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

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

ike_p2_rekey_time_unit

string

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

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

Варианты:

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

ike_p2_use_pfs

boolean

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

Варианты:

• false
• true

internal_gateway

string

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

ignore_errors

boolean

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

Варианты:

• false
• true

ignore_warnings

boolean

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

Варианты:

• false
• true

ike_phase_1

dictionary

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

Доступно начиная с версии управления 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_p1_rekey_time

integer

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

Определяет интервал времени между повторными согласованиями фазы 1 IKE.

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

ike_p1_rekey_time_unit

string

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

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

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

Варианты:

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

ike_phase_2

dictionary

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

Доступно начиная с версии управления 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"

ike_p2_pfs_dh_grp

string

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

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

Варианты:

• "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

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

Задает интервал времени между повторными согласованиями фазы 2 IKE.

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

ike_p2_rekey_time_unit

string

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

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

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

Варианты:

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

ike_p2_use_pfs

boolean

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

Указывает, используется ли совершенная прямая секретность (PFS) для фазы 2 IKE.

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

Варианты:

• false
• true

mep

dictionary

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

Свойства Multiple Entry Point.

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

default_priority_rule

dictionary

Правило приоритета для всех шлюзов-спутников. Применимо, только если для параметра ‘entry-point-selection-mechanism’ задано значение ‘manual’.

first_priority_center_gateways

list / elements=string

Список центральных шлюзов с наивысшим приоритетом, указанных по имени или UID.

second_priority_center_gateways

list / elements=string

Список центральных шлюзов со вторым по величине приоритетом, указанных по имени или UID.

third_priority_center_gateways

list / elements=string

Список центральных шлюзов с третьим по величине приоритетом, указанных по имени или UID.

enabled

boolean

Включить центральные шлюзы в качестве Multiple Entry Points.

Варианты:

• false
• true

entry_point_final_selection_mechanism

string

Метод выбора конечного шлюза точки входа, если выбранный механизм возвращает более одной возможной точки входа.

Варианты:

• "random selection"
• "first to respond"

entry_point_selection_mechanism

string

Метод выбора шлюза точки входа из числа шлюзов в центре.

Варианты:

• "closest gateway to source"
• "closest gateway to destination"
• "random selection"
• "manual"

exception_priority_rules

list / elements=dictionary

Исключения из правил приоритета для определенных шлюзов-спутников. Применимо, только если для параметра ‘entry-point-selection-mechanism’ задано значение ‘manual’.

first_priority_center_gateways

list / elements=string

Список центральных шлюзов с наивысшим приоритетом, указанных по имени или UID.

satellite_gateways

list / elements=string

Список шлюзов-спутников, к которым применяются правила приоритета, указанных по имени или UID.

second_priority_center_gateways

list / elements=string

Список центральных шлюзов со вторым по величине приоритетом, указанных по имени или UID.

third_priority_center_gateways

list / elements=string

Список центральных шлюзов с третьим по величине приоритетом, указанных по имени или UID.

tracking

string

Параметр отслеживания для MEP.

Варианты:

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

mesh_center_gateways

boolean

Указывает, находится ли ячеистое сообщество в центре.

Варианты:

• false
• true

name

string / обязательный

Имя объекта.

override_vpn_domains

list / elements=dictionary

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

Переопределение VPN-доменов участвующих шлюзов.

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

gateway

string

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

vpn_domain

string

Сеть VPN-домена, указанная по имени или UID.

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

Настройки механизма внедрения маршрутов.

enable_on_center_gateways

boolean

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

Варианты:

• false
• true

enable_on_satellite_gateways

boolean

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

Варианты:

• false
• true

enabled

boolean

Указывает, включен ли механизм внедрения маршрутов.

Варианты:

• 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"

satellite_gateways

list / elements=string

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

shared_secrets

list / elements=dictionary

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

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

external_gateway

string

Внешний шлюз, определяемый по имени или UID.

shared_secret

string

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

state

string

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

Варианты:

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

tags

list / elements=string

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

tunnel_granularity

string

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

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

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

Варианты:

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

use_shared_secret

boolean

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

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

Варианты:

• false
• true

version

string

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

vpn_routing

string

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

Включить маршрутизацию VPN к спутниковым шлюзам.

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

Варианты:

• "to center only"
• "to center and to other satellites"
• "to center other satellites and internet"

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

cp_mgmt_vpn_community_star

dictionary

Созданный или обновлённый объект Check Point.

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