check_point.mgmt.cp_mgmt_simple_cluster модуль – Управляет объектами simple-cluster на Checkpoint через 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_simple_cluster.
Добавлен в check_point.mgmt 3.0.0
Описание
- Управляет объектами simple-cluster на устройствах Checkpoint, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
Параметры
Параметр | Комментарии |
|---|---|
anti_bot boolean | Включен модуль защиты от ботов. Варианты:
|
anti_virus boolean | Включен модуль антивируса. Варианты:
|
application_control boolean | Включён модуль управления приложениями. Варианты:
|
auto_publish_session boolean | Опубликовать текущую сессию, если после выполнения задачи были внесены изменения. Варианты:
|
cluster_mode string | Режим кластера. Варианты:
|
cluster_version string | Версия платформы кластера. |
color string | Цвет объекта. Должен совпадать с одним из существующих цветов. Варианты:
|
comments string | Строка комментариев. |
content_awareness boolean | Включен модуль осознания содержимого. Варианты:
|
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты:
|
firewall boolean | Включён брандмауэр. Варианты:
|
firewall_settings dictionary | Не применимо. |
|
auto_calculate_connections_hash_table_size_and_memory_pool boolean |
Не применимо. Варианты:
|
|
auto_maximum_limit_for_concurrent_connections boolean |
Не применимо. Варианты:
|
|
connections_hash_size integer |
Не применимо. |
|
maximum_limit_for_concurrent_connections integer |
Не применимо. |
|
maximum_memory_pool_size integer |
Не применимо. |
|
memory_pool_size integer |
Не применимо. |
groups list / elements=string | Коллекция идентификаторов групп. |
hardware string | Аппаратная платформа кластера. |
ignore_errors boolean | Применить изменения, игнорируя ошибки. Такие изменения нельзя опубликовать. Если флаг ignore-warnings не был указан, то предупреждения также будут проигнорированы. Варианты:
|
ignore_warnings boolean | Применить изменения, игнорируя предупреждения. Варианты:
|
interfaces list / elements=dictionary | Н/Д |
|
anti_spoofing boolean |
Н/Д Варианты:
|
|
anti_spoofing_settings dictionary |
Н/Д |
|
action string |
Если пакеты будут отклоняться (опция Prevent) или будут отслеживаться (опция Detect). Варианты:
|
|
exclude_packets boolean |
Не проверять пакеты из исключённой сети. Варианты:
|
|
excluded_network_name string |
Название исключённой сети. |
|
excluded_network_uid string |
UID исключённой сети. |
|
spoof_tracking string |
Отслеживание подмены. Варианты:
|
|
color string |
Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
|
comments string |
Строка комментариев. |
|
details_level string |
Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью детализированного представления объекта. Варианты:
|
|
ignore_errors boolean |
Применить изменения, игнорируя ошибки. Такие изменения нельзя опубликовать. Если флаг ignore-warnings не был указан, то предупреждения также будут проигнорированы. Варианты:
|
|
ignore_warnings boolean |
Применить изменения, игнорируя предупреждения. Варианты:
|
|
interface_type string |
Тип интерфейса кластера. Варианты:
|
|
ip_address string |
Адрес IPv4 или IPv6. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно. |
|
ipv4_address строка |
IPv4 адрес. |
|
ipv4_mask_length строка |
Длина маски подсети IPv4. |
|
ipv4_network_mask строка |
Адрес сети IPv4. |
|
ipv6_address строка |
IPv6 адрес. |
|
ipv6_mask_length строка |
Длина маски подсети IPv6. |
|
ipv6_network_mask строка |
Адрес сети IPv6. |
|
mask_length строка |
Длина маски подсети IPv4 или IPv6. |
|
multicast_address строка |
Мультиадресной IP-адрес. |
|
multicast_address_type строка |
Тип адреса мультиадресации. Варианты:
|
|
name строка |
Имя объекта. |
|
network_mask строка |
Маска подсети IPv4 или IPv6. Если требуются обе маски, используйте явным образом поля ipv4-network-mask и ipv6-network-mask. Вместо указания самой маски можно указать длину маски IPv4 или IPv6 в поле mask-length. Если требуются обе длины масок, используйте явным образом поля ipv4-mask-length и ipv6-mask-length. |
|
security_zone логическое |
Не применимо Варианты:
|
|
security_zone_settings словарь |
Не применимо |
|
auto_calculated логическое |
Безопасная зона рассчитывается в зависимости от того, куда ведет интерфейс. Варианты:
|
|
specific_zone строка |
Безопасная зона указана вручную. |
|
tags список / элементы=строка |
Коллекция идентификаторов тегов. |
|
topology строка |
Не применимо Варианты:
|
|
topology_settings словарь |
Не применимо |
|
interface_leads_to_dmz логическое |
Является ли этот интерфейс выходом в зону демилитаризованной зоны (периметральной сети). Варианты:
|
|
ip_address_behind_this_interface строка |
Настройки сети за этим интерфейсом. Варианты:
|
|
specific_network строка |
Сеть за этим интерфейсом. |
ip_address строка | IPv4 или IPv6 адрес. Если требуются оба адреса, используйте явным образом поля ipv4-address и ipv6-address. |
ips логическое | Включен ли модуль Intrusion Prevention System. Варианты:
|
ipv4_address string | IPv4 адрес. |
ipv6_address string | IPv6 адрес. |
members list / elements=dictionary | Список членов кластера. Можно добавить только новых членов кластера. Добавление существующего шлюза не поддерживается. |
|
color string |
Цвет объекта. Должен быть одним из существующих цветов. Выбооры:
|
|
comments string |
Строка комментариев. |
|
details_level string |
Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью детализированного представления объекта. Выбооры:
|
|
ignore_errors boolean |
Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, будут также игнорироваться предупреждения. Выбооры:
|
|
ignore_warnings boolean |
Применить изменения, игнорируя предупреждения. Выбооры:
|
|
interfaces list / elements=dictionary |
Сетевые интерфейсы члена кластера. |
|
anti_spoofing boolean |
Н/Д Выбооры:
|
|
anti_spoofing_settings dictionary |
Н/Д |
|
action string |
Если пакеты будут отклоняться (вариант Prevent) или будут отслеживаться (вариант Detect). Выбооры:
|
|
exclude_packets boolean |
Не проверять пакеты из исключённой сети. Выбооры:
|
|
excluded_network_name string |
Имя исключённой сети. |
|
excluded_network_uid string |
UID исключённой сети. |
|
spoof_tracking string |
Отслеживание подмены. Выбооры:
|
|
color string |
Цвет объекта. Должен быть одним из существующих цветов. Choices:
|
|
comments string |
Строка комментариев. |
|
details_level string |
Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного детального представления объекта. Choices:
|
|
ignore_errors boolean |
Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, предупреждения также будут игнорироваться. Choices:
|
|
ignore_warnings boolean |
Применить изменения, игнорируя предупреждения. Choices:
|
|
ip_address string |
IPv4 или IPv6 адрес. Если необходимы оба адреса, используйте поля ipv4-address и ipv6-address. |
|
ipv4_address string |
IPv4 адрес. |
|
ipv4_mask_length string |
Длина маски IPv4 сети. |
|
ipv4_network_mask string |
Адрес IPv4 сети. |
|
ipv6_address string |
IPv6 адрес. |
|
ipv6_mask_length string |
Длина маски IPv6 сети. |
|
ipv6_network_mask string |
Адрес IPv6 сети. |
|
mask_length string |
Длина маски IPv4 или IPv6 сети. |
|
name string |
Имя объекта. |
|
network_mask string |
Маска IPv4 или IPv6 сети. Если необходимы обе маски, используйте поля ipv4-network-mask и ipv6-network-mask. Вместо предоставления самой маски можно указать длину маски IPv4 или IPv6 в поле mask-length. Если необходимы обе длины масок, используйте поля ipv4-mask-length и ipv6-mask-length. |
|
security_zone boolean |
N/A Choices:
|
|
security_zone_settings dictionary |
N/A |
|
auto_calculated boolean |
Зона безопасности рассчитывается в зависимости от того, куда ведет интерфейс. Choices:
|
|
specific_zone string |
Зона безопасности, указанная вручную. |
|
tags list / elements=string |
Коллекция идентификаторов тегов. |
|
topology string |
N/A Варианты:
|
|
topology_settings dictionary |
N/A |
|
interface_leads_to_dmz boolean |
Указывает, ведёт ли этот интерфейс в демилитаризованную зону (периметр сети). Варианты:
|
|
ip_address_behind_this_interface string |
Настройки сети за этим интерфейсом. Варианты:
|
|
specific_network string |
Сеть за этим интерфейсом. |
|
ip_address string |
Адрес IPv4 или IPv6. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно. |
|
ipv4_address string |
Адрес IPv4. |
|
ipv6_address string |
Адрес IPv6. |
|
name string |
Имя объекта. |
|
one_time_password string |
N/A |
|
tags list / elements=string |
Коллекция идентификаторов тегов. |
name string / обязательно | Имя объекта. |
os_name string | Операционная система платформы кластера. |
platform_portal_settings dictionary | Настройки портала платформы. |
|
accessibility dictionary |
Настройка параметров доступа к порталу. |
|
allow_access_from string |
Разрешённый доступ к веб-порталу (на основе интерфейсов или политики безопасности). Варианты:
|
|
internal_access_settings dictionary |
Настройка дополнительных параметров доступа к порталу только для внутренних интерфейсов. |
|
dmz boolean |
Управляет настройками доступа к порталу для внутренних интерфейсов, топология которых установлена как «DMZ». Варианты:
|
|
undefined boolean |
Управляет настройками доступа к порталу для внутренних интерфейсов, топология которых установлена как «Неопределено». Варианты:
|
|
vpn boolean |
Управляет настройками доступа к порталу для интерфейсов, которые являются частью домена шифрования VPN. Варианты:
|
|
certificate_settings dictionary |
Настройка параметров сертификата портала. |
|
base64_certificate string |
Файл сертификата, закодированный в Base64 с добавкой. Этот файл должен быть в формате *.p12. |
|
base64_password string |
Пароль (закодированный в Base64 с заполнением) для файла сертификата. |
|
portal_web_settings dictionary |
Настройка параметров веб-портала. |
|
aliases list / elements=string |
Список псевдонимов URL, которые перенаправляются на основной URL портала. |
|
ip_address string |
Необязательный IP-адрес для веб-портала, если ваш DNS-сервер не может разрешить основной URL-адрес портала. Примечание: если ваш DNS-сервер разрешает основной URL-адрес портала, этот IP-адрес игнорируется. |
|
main_url string |
Основной URL веб-портала. |
send_alerts_to_server list / elements=string | Сервер(ы) для отправки оповещений. |
send_logs_to_backup_server list / elements=string | Запасной(ие) сервер(ы) для отправки журналов. |
send_logs_to_server list / elements=string | Сервер(ы) для отправки журналов. |
show_portals_certificate boolean | Указывает, нужно ли отображать значение сертификата портала в ответе. Варианты:
|
state string | Состояние правила доступа (присутствует или отсутствует). Варианты:
|
tags list / elements=string | Коллекция идентификаторов тегов. |
threat_emulation boolean | Включен ли модуль эмуляции угроз. Варианты:
|
threat_extraction boolean | Включен ли модуль извлечения угроз. Варианты:
|
threat_prevention_mode string | Режим использования защиты от угроз. При использовании автономной защиты от угроз отключение модулей защиты от угроз недопустимо. Варианты:
|
url_filtering boolean | Включен ли модуль фильтрации URL. Варианты:
|
usercheck_portal_settings dictionary | Настройки портала UserCheck. |
|
accessibility dictionary |
Настройка параметров доступа к порталу. |
|
allow_access_from string |
Разрешенный доступ к веб-порталу (на основе интерфейсов или политики безопасности). Варианты:
|
|
internal_access_settings dictionary |
Настройка дополнительных параметров доступа к порталу только для внутренних интерфейсов. |
|
dmz boolean |
Управляет настройками доступа к порталу для внутренних интерфейсов, топология которых установлена в «DMZ». Варианты:
|
|
undefined boolean |
Управляет настройками доступа к порталу для внутренних интерфейсов, топология которых установлена как «Undefined». Choices:
|
|
vpn boolean |
Управляет настройками доступа к порталу для интерфейсов, которые являются частью домена шифрования VPN. Choices:
|
|
certificate_settings dictionary |
Конфигурация настроек сертификата портала. |
|
base64_certificate string |
Сертификат, закодированный в Base64 с заполнением. Этот файл должен быть в формате *.p12. |
|
base64_password string |
Пароль (закодированный в Base64 с заполнением) для файла сертификата. |
|
enabled boolean |
Состояние веб-портала (включен или выключен). Поддерживаемые модули: {‘Application Control’, ‘URL Filtering’, ‘Data Loss Prevention’, ‘Anti Virus’, ‘Anti Bot’, ‘Threat Emulation’, ‘Threat Extraction’, ‘Data Awareness’}. Choices:
|
|
portal_web_settings dictionary |
Конфигурация веб-параметров портала. |
|
aliases list / elements=string |
Список псевдонимов URL, которые перенаправляются на основной URL-адрес портала. |
|
ip_address string |
Необязательно, IP-адрес для веб-портала, который будет использоваться, если ваш DNS-сервер не сможет разрешить основной URL-адрес портала. Примечание. Если ваш DNS-сервер разрешает основной URL-адрес портала, этот IP-адрес игнорируется. |
|
main_url string |
Основной URL-адрес для веб-портала. |
version string | Версия Checkpoint. Если не указана, используется последняя версия. |
vpn boolean | Включен модуль VPN. Choices:
|
vpn_settings dictionary | Настройки VPN-шлюза. |
|
authentication dictionary |
Аутентификация. |
|
authentication_clients list / elements=string |
Набор клиентов аутентификации VPN, идентифицируемых по имени или UID. |
|
link_selection dictionary |
Выбор соединения. |
|
dns_resolving_hostname string |
Имя хоста для разрешения DNS. Должно быть установлено, если «ip-selection» выбрано как «dns-resolving-from-hostname». |
|
ip_address string |
IP-адрес. Должен быть установлен, если «ip-selection» выбрано как «use-selected-address-from-topology» или «use-statically-nated-ip». |
|
ip_selection string |
N/A Choices:
|
|
maximum_concurrent_ike_negotiations integer |
N/A |
|
maximum_concurrent_tunnels integer |
N/A |
|
office_mode dictionary |
Режим офиса. Заметка о широком воздействии - Режим офиса применяется к клиентам программного обеспечения IPSec VPN и к клиентам программного обеспечения Mobile Access. |
|
allocate_ip_address_from dictionary |
Метод выделения IP-адреса. Выделение IP-адреса путём последовательной попытки указанных методов до успеха. |
|
allocate_method string |
Использование либо Ручного (IP-пул), либо Автоматического (DHCP). Должно быть установлено, когда “use-allocate-method” истинно. Варианты:
|
|
dhcp_mac_address string |
Вычисленный MAC-адрес для DHCP-выделения. Должен быть установлен, когда “allocate-method” выбран как “automatic”. Варианты:
|
|
dhcp_server string |
DHCP-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “allocate-method” выбран как “automatic”. |
|
manual_network string |
Ручная сеть. Идентифицируется по имени или UID. Должна быть установлена, когда “allocate-method” выбран как “manual”. |
|
optional_parameters dictionary |
Эта конфигурация применяется ко всем методам режима офиса, за исключением автоматического (использование DHCP) и записей ipassignment.conf, которые содержат эти данные. |
|
dns_suffixes string |
Суффиксы DNS. |
|
first_backup_dns_server string |
Первый резервный DNS-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “use-first-backup-dns-server” истинно и не может быть установлен, когда “use-first-backup-dns-server” ложно. |
|
first_backup_wins_server string |
Первый резервный WINS-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “use-first-backup-wins-server” истинно и не может быть установлен, когда “use-first-backup-wins-server” ложно. |
|
ip_lease_duration integer |
Срок аренды IP в минутах. Значение должно быть в диапазоне от 2 до 32767. |
|
primary_dns_server string |
Основной DNS-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “use-primary-dns-server” истинно и не может быть установлен, когда “use-primary-dns-server” ложно. |
|
primary_wins_server string |
Основной WINS-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “use-primary-wins-server” истинно и не может быть установлен, когда “use-primary-wins-server” ложно. |
|
second_backup_dns_server string |
Второй резервный DNS-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “use-second-backup-dns-server” истинно и не может быть установлен, когда “use-second-backup-dns-server” ложно. |
|
second_backup_wins_server string |
Второй резервный WINS-сервер. Идентифицируется по имени или UID. Должен быть установлен, когда “use-second-backup-wins-server” истинно и не может быть установлен, когда “use-second-backup-wins-server” ложно. |
|
use_first_backup_dns_server boolean |
Использовать первый резервный DNS-сервер. Варианты:
|
|
use_first_backup_wins_server boolean |
Использовать первый резервный WINS-сервер. Варианты:
|
|
use_primary_dns_server boolean |
Использовать основной DNS-сервер. Варианты:
|
|
use_primary_wins_server boolean |
Использовать основной WINS-сервер. Варианты:
|
|
use_second_backup_dns_server boolean |
Использовать второй резервный DNS-сервер. Варианты:
|
|
use_second_backup_wins_server boolean |
Использовать второй резервный WINS-сервер. Варианты:
|
|
radius_server boolean |
RADIUS-сервер, используемый для аутентификации пользователя. Варианты:
|
|
use_allocate_method boolean |
Использовать метод выделения. Варианты:
|
|
virtual_ip_address string |
Виртуальный IPV4-адрес для ответов DHCP-сервера. Должен быть установлен, если «allocate-method» выбран как «automatic». |
|
anti_spoofing_additional_addresses string |
Дополнительные IP-адреса для защиты от подмены адреса. Идентифицируются по имени или UID. Должны быть установлены, если «perform-anti-spoofings» имеет значение true. |
|
group string |
Группа. Идентифицируется по имени или UID. Должна быть установлена, если «office-mode-permissions» выбрано как «group». |
|
mode string |
Разрешения режима Office. Если выбрано «off», все другие определения не имеют значения. Варианты:
|
|
perform_anti_spoofing boolean |
Выполнять защиту от подмены адреса для адресов режима Office. Варианты:
|
|
support_multiple_interfaces boolean |
Поддержка расширенных возможностей подключения для шлюзов с несколькими внешними интерфейсами. Варианты:
|
|
remote_access dictionary |
Удаленный доступ. |
|
allow_vpn_clients_to_route_traffic boolean |
Разрешить VPN-клиентам маршрутизацию трафика. Варианты:
|
|
l2tp_auth_method string |
Метод аутентификации L2TP. Должен быть установлен, если «support-l2tp» имеет значение true. Варианты:
|
|
l2tp_certificate string |
Сертификат L2TP. Должен быть установлен, если «l2tp-auth-method» выбран как «certificate». Вставьте «defaultCert», если вы хотите использовать сертификат по умолчанию. |
|
nat_traversal_service string |
Выделенная служба UDP для прохождения NAT. Идентифицируется по имени или UID. Должна быть установлена, если «support-nat-traversal-mechanism» имеет значение true. |
|
support_l2tp boolean |
Поддержка L2TP (актуально только при активном режиме Office). Варианты:
|
|
support_nat_traversal_mechanism boolean |
Поддержка механизма прохождения NAT (инкапсуляция UDP). Варианты:
|
|
support_visitor_mode boolean |
Поддержка гостевого режима. Варианты:
|
|
visitor_mode_interface string |
Интерфейс для гостевого режима. Должен быть установлен, если «support-visitor-mode» имеет значение true. Вставьте IPV4-адрес существующего интерфейса или «All IPs», если вы хотите использовать все интерфейсы. |
|
visitor_mode_service string |
TCP-сервис для режима посетителя. Идентифицируется по имени или идентификатору. Должен быть установлен, когда «support-visitor-mode» имеет значение true. |
|
vpn_domain string |
Домен VPN шлюза, идентифицируемый по имени или идентификатору. |
|
vpn_domain_type string |
Тип домена VPN шлюза. Варианты:
|
wait_for_task boolean | Дождаться завершения задачи. Например, задачи публикации. Варианты:
|
wait_for_task_timeout integer | Количество минут ожидания до выброса ошибки таймаута. По умолчанию: |
Примеры
- name: add-simple-cluster
cp_mgmt_simple_cluster:
cluster_mode: cluster-xl-ha
color: yellow
firewall: true
interfaces:
- anti_spoofing: true
interface_type: cluster
ip_address: 17.23.5.1
name: eth0
network_mask: 255.255.255.0
topology: EXTERNAL
- interface_type: sync
name: eth1
topology: INTERNAL
topology_settings:
interface_leads_to_dmz: false
ip_address_behind_this_interface: network defined by the interface ip and net
mask
- anti_spoofing: true
interface_type: cluster
ip_address: 192.168.1.1
name: eth2
network_mask: 255.255.255.0
topology: INTERNAL
topology_settings:
interface_leads_to_dmz: false
ip_address_behind_this_interface: network defined by the interface ip and net
mask
ip_address: 17.23.5.1
members:
- interfaces:
- ip_address: 17.23.5.2
name: eth0
network_mask: 255.255.255.0
- ip_address: 1.1.2.4
name: eth1
network_mask: 255.255.255.0
- ip_address: 192.168.1.2
name: eth2
network_mask: 255.255.255.0
ip_address: 17.23.5.2
name: member1
one_time_password: abcd
- interfaces:
- ip_address: 17.23.5.3
name: eth0
network_mask: 255.255.255.0
- ip_address: 1.1.2.5
name: eth1
network_mask: 255.255.255.0
- ip_address: 192.168.1.3
name: eth2
network_mask: 255.255.255.0
ip_address: 17.23.5.3
name: member2
one_time_password: abcd
name: cluster1
os_name: Gaia
state: present
cluster_version: R80.30
- name: set-simple-cluster
cp_mgmt_simple_cluster:
name: cluster1
state: present
- name: delete-simple-cluster
cp_mgmt_simple_cluster:
name: cluster1
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
cp_mgmt_simple_cluster словарь | Созданный или обновленный объект 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_simple_cluster_module.html