Spec-Zone.ru › Ansible

Модуль check_point.mgmt.cp_mgmt_simple_gateway — управление объектами simple-gateway в 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_simple_gateway.

Добавлено в check_point.mgmt 1.0.0

  • Краткое описание
  • Параметры
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Управляет объектами simple-gateway на устройствах Check Point, включая создание, обновление и удаление объектов.
  • Все операции выполняются через API веб-служб.
  • Доступно начиная с версии R80 системы управления.

Параметры

Параметр

Комментарии

anti_bot

boolean

Модуль Anti-Bot включен.

Варианты:

  • false
  • true

anti_virus

boolean

Модуль Anti-Virus включен.

Варианты:

  • false
  • true

application_control

boolean

Модуль Application Control включен.

Варианты:

  • 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

Строка комментария.

content_awareness

boolean

Модуль Content Awareness включен.

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

Варианты:

  • false
  • true

details_level

string

Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до его полного подробного представления.

Варианты:

  • "uid"
  • "standard"
  • "full"

enable_https_inspection

boolean

Включить проверку HTTPS после настройки сертификата для проверки исходящего трафика. <br>Для настройки сертификата исходящего трафика используйте API сертификатов для проверки исходящего трафика.

Варианты:

  • false
  • true

firewall

boolean

Модуль Firewall включен.

Варианты:

  • false
  • true

firewall_settings

dictionary

Не применимо

auto_calculate_connections_hash_table_size_and_memory_pool

boolean

Не применимо

Варианты:

  • false
  • true

auto_maximum_limit_for_concurrent_connections

boolean

Не применимо

Варианты:

  • false
  • true

connections_hash_size

integer

Не применимо

maximum_limit_for_concurrent_connections

integer

Не применимо

maximum_memory_pool_size

integer

Не применимо

memory_pool_size

integer

Не применимо

gateway_version

string

Версия платформы шлюза.

groups

list / elements=string

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

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

interfaces

list / elements=dictionary

Сетевые интерфейсы. При обновлении шлюза с новым набором интерфейсов существующие интерфейсы удаляются.

anti_spoofing

boolean

Не применимо

Варианты:

  • false
  • true

anti_spoofing_settings

dictionary

Не применимо

action

string

Следует ли отклонять пакеты (параметр Prevent) или отслеживать их (параметр Detect).

Варианты:

  • "prevent"
  • "detect"

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"

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

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

Не применимо

Возможные значения:

  • false
  • true

security_zone_settings

dictionary

Не применимо

auto_calculated

boolean

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

Возможные значения:

  • false
  • true

specific_zone

string

Зона безопасности, заданная вручную.

tags

list / elements=string

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

topology

string

Не применимо

Возможные значения:

  • "automatic"
  • "external"
  • "internal"

topology_settings

dictionary

Не применимо

interface_leads_to_dmz

boolean

Указывает, ведёт ли этот интерфейс в демилитаризованную зону (периметровую сеть).

Возможные значения:

  • false
  • true

ip_address_behind_this_interface

string

Не применимо

Возможные значения:

  • "not defined"
  • "network defined by the interface ip and net mask"
  • "network defined by routing"
  • "specific"

specific_network

string

Сеть за этим интерфейсом.

ip_address

string

Адрес IPv4 или IPv6. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно.

ips

boolean

Модуль предотвращения вторжений включён.

Варианты:

  • false
  • true

ips_settings

dictionary

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

Настройки IPS шлюза.

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

activation_mode

string

Определяет, работает ли модуль IPS в режиме только обнаружения или применяет настроенную политику IPS.

Варианты:

  • "according-to-policy"
  • "detect-only"

bypass_all_under_load

boolean

Отключить/включить все средства защиты IPS до нормализации уровня загрузки ЦП и памяти.

Варианты:

  • false
  • true

bypass_track_method

string

Параметры отслеживания при отключении всех средств защиты IPS до нормализации уровня загрузки ЦП/памяти.

Варианты:

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

cpu_usage_high_threshold

integer

Верхний порог загрузки ЦП в процентах (1–99).

cpu_usage_low_threshold

integer

Нижний порог загрузки ЦП в процентах (1–99).

memory_usage_high_threshold

integer

Верхний порог использования памяти в процентах (1–99).

memory_usage_low_threshold

integer

Нижний порог использования памяти в процентах (1–99).

send_threat_cloud_info

boolean

Помогите улучшить продукт Check Point Threat Prevention, отправляя анонимную информацию.

Варианты:

  • false
  • true

ipv4_address

string

Адрес IPv4.

ipv6_address

string

Адрес IPv6.

logs_settings

dictionary

Н/Д

alert_when_free_disk_space_below

boolean

Н/Д

Варианты:

  • false
  • true

alert_when_free_disk_space_below_threshold

integer

Н/Д

alert_when_free_disk_space_below_type

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"

before_delete_keep_logs_from_the_last_days

boolean

Н/Д

Варианты:

  • false
  • true

before_delete_keep_logs_from_the_last_days_threshold

integer

Н/Д

before_delete_run_script

boolean

Н/Д

Варианты:

  • false
  • true

before_delete_run_script_command

string

Н/Д

delete_index_files_older_than_days

boolean

Н/Д

Варианты:

  • false
  • true

delete_index_files_older_than_days_threshold

integer

Н/Д

delete_index_files_when_index_size_above

boolean

Н/Д

Варианты:

  • false
  • true

delete_index_files_when_index_size_above_threshold

integer

Н/Д

delete_when_free_disk_space_below

boolean

Н/Д

Варианты:

  • false
  • true

delete_when_free_disk_space_below_threshold

integer

Н/Д

detect_new_citrix_ica_application_names

boolean

Не применимо

Варианты:

  • false
  • true

forward_logs_to_log_server

boolean

Не применимо

Варианты:

  • false
  • true

forward_logs_to_log_server_name

string

Не применимо

forward_logs_to_log_server_schedule_name

string

Не применимо

free_disk_space_metrics

string

Не применимо

Варианты:

  • "mbytes"
  • "percent"

perform_log_rotate_before_log_forwarding

boolean

Не применимо

Варианты:

  • false
  • true

reject_connections_when_free_disk_space_below_threshold

boolean

Не применимо

Варианты:

  • false
  • true

reserve_for_packet_capture_metrics

string

Не применимо

Варианты:

  • "percent"
  • "mbytes"

reserve_for_packet_capture_threshold

integer

Не применимо

rotate_log_by_file_size

boolean

Не применимо

Варианты:

  • false
  • true

rotate_log_file_size_threshold

integer

Не применимо

rotate_log_on_schedule

boolean

Не применимо

Варианты:

  • false
  • true

rotate_log_schedule_name

string

Не применимо

stop_logging_when_free_disk_space_below

boolean

Не применимо

Варианты:

  • false
  • true

stop_logging_when_free_disk_space_below_threshold

integer

Не применимо

turn_on_qos_logging

boolean

Не применимо

Варианты:

  • false
  • true

update_account_log_every

integer

Не применимо

name

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

Имя объекта.

one_time_password

string

Не применимо

os_name

string

Операционная система платформы шлюза.

save_logs_locally

boolean

Сохранять журналы локально на шлюзе.

Варианты:

  • false
  • true

send_alerts_to_server

list / elements=string

Серверы, на которые отправляются оповещения.

send_logs_to_backup_server

list / elements=string

Резервные серверы, на которые отправляются журналы.

send_logs_to_server

list / elements=string

Серверы, на которые отправляются журналы.

state

string

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

Варианты:

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

tags

list / elements=string

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

threat_emulation

boolean

Компонент Threat Emulation включен.

Варианты:

  • false
  • true

threat_extraction

boolean

Компонент Threat Extraction включен.

Доступно начиная с версии системы управления R80.20.M2.

Варианты:

  • false
  • true

url_filtering

boolean

Лезвие URL Filtering включено.

Варианты:

  • false
  • true

version

string

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

vpn

boolean

Лезвие VPN включено.

Варианты:

  • false
  • true

vpn_settings

dictionary

Настройки VPN шлюза.

maximum_concurrent_ike_negotiations

integer

Н/Д

maximum_concurrent_tunnels

integer

Н/Д

wait_for_task

boolean

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

Варианты:

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

wait_for_task_timeout

integer

Количество минут ожидания до возникновения ошибки тайм-аута.

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

Примеры

- name: add-simple-gateway
  cp_mgmt_simple_gateway:
    ip_address: 192.0.2.1
    name: gw1
    state: present

- name: set-simple-gateway
  cp_mgmt_simple_gateway:
    anti_bot: true
    anti_virus: true
    application_control: true
    ips: true
    name: test_gateway
    state: present
    threat_emulation: true
    url_filtering: true

- name: delete-simple-gateway
  cp_mgmt_simple_gateway:
    name: gw1
    state: absent

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

cp_mgmt_simple_gateway

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

Spec-Zone.ru

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