check_point.mgmt.cp_mgmt_simple_gateway – Управляет объектами simple-gateway на Check Point через API веб-служб

Примечание

Этот плагин входит в коллекцию check_point.mgmt (версия 1.0.6).

Для его установки используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать его в плейбуке, укажите: check_point.mgmt.cp_mgmt_simple_gateway.

Введено в версии 2.9: модуля check_point.mgmt

Обзор
Параметры
Примеры
Возвращаемые значения

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
anti_bot boolean			Варианты: no yes	Включён модуль защиты от ботов.
anti_virus boolean			Варианты: no yes	Включён модуль антивируса.
application_control boolean			Варианты: no yes	Включён модуль управления приложениями.
auto_publish_session boolean			Варианты: no yes	Опубликовать текущую сессию, если после завершения задачи были внесены изменения.
color string			Варианты: аквамарин чёрный синий голубой крет коричневый голубой циан тёмно-зелёный хаки орхидея тёмно-оранжевый тёмно-морской зелёный розовый бирюзовый тёмно-синий кирпичный коричневый тёмно-зелёный золотой тёмно-золотой серый тёмно-серый светло-зелёный лимонно-жёлтый коралловый морской зелёный небесно-голубой пурпурный фиолетовый слабо-голубой фиолетово-красный тёмно-синий оливковый оранжевый красный сепия жёлтый	Цвет объекта. Должен быть одним из существующих цветов.
comments string				Строка комментариев.
content_awareness boolean			Варианты: no yes	Включён модуль осознания содержимого.
details_level string			Варианты: uid стандартный полный	Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта.
firewall boolean			Варианты: no yes	Включён модуль брандмауэра.
firewall_settings dictionary				Н/Д
	auto_calculate_connections_hash_table_size_and_memory_pool boolean		Варианты: no yes	Н/Д
	auto_maximum_limit_for_concurrent_connections boolean		Варианты: no yes	Н/Д
	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			Варианты: no yes	Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, то предупреждения также будут проигнорированы.
ignore_warnings boolean			Варианты: no yes	Применить изменения, игнорируя предупреждения.
interfaces list / elements=string				Сетевые интерфейсы. При обновлении шлюза с новыми интерфейсами, существующие интерфейсы удаляются.
	anti_spoofing boolean		Варианты: no yes	Н/Д
	anti_spoofing_settings dictionary			Н/Д
		action string	Варианты: prevent detect	Если пакеты будут отклонены (вариант Prevent) или будут отслеживаться (вариант Detect).
	color string		Варианты: аквамарин чёрный синий голубой крет коричневый голубой циан тёмно-зелёный хаки орхидея тёмно-оранжевый тёмно-морской зелёный розовый бирюзовый тёмно-синий кирпичный коричневый тёмно-зелёный золотой тёмно-золотой серый тёмно-серый светло-зелёный лимонно-жёлтый коралловый морской зелёный небесно-голубой пурпурный фиолетовый слабо-голубой фиолетово-красный тёмно-синий оливковый оранжевый красный сепия жёлтый	Цвет объекта. Должен быть одним из существующих цветов.
	comments string			Строка комментариев.
	details_level string		Варианты: uid стандартный полный	Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта.
	ignore_errors boolean		Варианты: no yes	Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, то предупреждения также будут проигнорированы.
	ignore_warnings boolean		Варианты: no yes	Применить изменения, игнорируя предупреждения.
	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		Варианты: no yes	Н/Д
	security_zone_settings dictionary			Н/Д
		auto_calculated boolean	Варианты: no yes	Зона безопасности рассчитывается в зависимости от того, куда ведёт интерфейс.
		specific_zone string		Зона безопасности, указанная вручную.
	tags list / elements=string			Коллекция идентификаторов тегов.
	topology string		Варианты: automatic external internal	Н/Д
	topology_settings dictionary			Н/Д
		interface_leads_to_dmz boolean	Варианты: no yes	Указывает, ведёт ли этот интерфейс в демилитаризованную зону (периметрическую сеть).

		ip_address_behind_this_interface string	Варианты: не определено сеть, определённая IP-адресом и маской сети интерфейса сеть, определённая маршрутизацией специфическая	Н/Д
		specific_network string		Сеть за этим интерфейсом.
ip_address string				IPv4 или IPv6 адрес. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно.
ips boolean			Варианты: нет да	Включён ли модуль Intrusion Prevention System.
ipv4_address string				IPv4 адрес.
ipv6_address string				IPv6 адрес.
logs_settings dictionary				Н/Д
	alert_when_free_disk_space_below boolean		Варианты: нет да	Н/Д
	alert_when_free_disk_space_below_threshold integer			Н/Д
	alert_when_free_disk_space_below_type string		Варианты: нет лог сообщение уведомление по почте уведомление SNMP пользовательское уведомление №1 пользовательское уведомление №2 пользовательское уведомление №3	Н/Д
	before_delete_keep_logs_from_the_last_days boolean		Варианты: нет да	Н/Д
	before_delete_keep_logs_from_the_last_days_threshold integer			Н/Д
	before_delete_run_script boolean		Варианты: нет да	Н/Д
	before_delete_run_script_command string			Н/Д
	delete_index_files_older_than_days boolean		Варианты: нет да	Н/Д
	delete_index_files_older_than_days_threshold integer			Н/Д
	delete_index_files_when_index_size_above boolean		Варианты: нет да	Н/Д
	delete_index_files_when_index_size_above_threshold integer			Н/Д
	delete_when_free_disk_space_below boolean		Варианты: нет да	Н/Д
	delete_when_free_disk_space_below_threshold integer			Н/Д
	detect_new_citrix_ica_application_names boolean		Варианты: нет да	Н/Д
	forward_logs_to_log_server boolean		Варианты: нет да	Н/Д
	forward_logs_to_log_server_name string			Н/Д
	forward_logs_to_log_server_schedule_name string			Н/Д
	free_disk_space_metrics string		Варианты: МБ процент	Н/Д
	perform_log_rotate_before_log_forwarding boolean		Варианты: нет да	Н/Д
	reject_connections_when_free_disk_space_below_threshold boolean		Варианты: нет да	Н/Д
	reserve_for_packet_capture_metrics string		Варианты: процент МБ	Н/Д
	reserve_for_packet_capture_threshold integer			Н/Д
	rotate_log_by_file_size boolean		Варианты: нет да	Н/Д
	rotate_log_file_size_threshold integer			Н/Д
	rotate_log_on_schedule boolean		Варианты: нет да	Н/Д
	rotate_log_schedule_name string			Н/Д
	stop_logging_when_free_disk_space_below boolean		Варианты: нет да	Н/Д
	stop_logging_when_free_disk_space_below_threshold integer			Н/Д
	turn_on_qos_logging boolean		Варианты: нет да	Н/Д
	update_account_log_every integer			Н/Д
name string / обязательно				Имя объекта.
one_time_password string				Н/Д
os_name string				Операционная система шлюза.
save_logs_locally boolean			Варианты: нет да	Сохранять логи локально на шлюзе.
send_alerts_to_server список / элементы=строка				Сервер(ы) для отправки сообщений об ошибках.
send_logs_to_backup_server список / элементы=строка				Резервный сервер(ы) для отправки логов.
send_logs_to_server список / элементы=строка				Сервер(ы) для отправки логов.
state string			Варианты: настоящее ← отсутствует	Состояние правила доступа (настоящее или отсутствует). По умолчанию - настоящее.
tags список / элементы=строка				Коллекция идентификаторов тегов.
threat_emulation boolean			Варианты: нет да	Включён ли модуль Threat Emulation.
threat_extraction boolean			Варианты: нет да	Включён ли модуль Threat Extraction.
url_filtering boolean			Варианты: нет да	Включён ли модуль URL Filtering.
version string				Версия Checkpoint. Если не указана, используется последняя.
vpn boolean			Варианты: нет да	Включён ли модуль VPN.
vpn_settings dictionary				Настройки VPN шлюза.
	maximum_concurrent_ike_negotiations integer			Н/Д
	maximum_concurrent_tunnels integer			Н/Д
wait_for_task boolean			Варианты: нет да ←	Ожидать завершения задачи. Например, задачи публикации.

Примеры

- 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 словарь	всегда, кроме случая удаления объекта.	Объект контрольной точки, созданный или обновлённый.

Авторы

Or Soffer (@chkp-orso)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/check_point/mgmt/cp_mgmt_simple_gateway_module.html