cp_mgmt_simple_gateway – Управление объектами simple-gateway на Check Point через веб-сервисы API

Новое в версии 2.9.

Описание
Параметры
Примеры
Значения возврата
Статус

Описание

Управление объектами 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			Не применимо
groups list				Коллекция идентификаторов групп.
ignore_errors boolean			Варианты: no yes	Применять изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings не указан, будут игнорироваться и предупреждения.
ignore_warnings boolean			Варианты: no yes	Применять изменения, игнорируя предупреждения.
interfaces list				Сетевые интерфейсы. При обновлении шлюза с новыми интерфейсами, существующие интерфейсы удаляются.
	anti_spoofing boolean		Варианты: no yes	Не применимо
	anti_spoofing_settings dictionary			Не применимо
		action string	Варианты: блокировать обнаруживать	Если пакеты будут отклоняться (вариант Блокировать) или будут отслеживаться (вариант Обнаруживать).
	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		Choices: нет да	Н/Д
	security_zone_settings dictionary			Н/Д
		auto_calculated boolean	Choices: нет да	Зона безопасности рассчитывается в зависимости от того, куда ведет интерфейс.
		specific_zone string		Зона безопасности, указанная вручную.
	tags list			Коллекция идентификаторов тегов.
	topology string		Choices: автоматическая внешняя внутренняя	Н/Д
	topology_settings dictionary			Н/Д
		interface_leads_to_dmz boolean	Choices: нет да	Указывает, ведет ли этот интерфейс в демилитаризованную зону (периметр сети).
		ip_address_behind_this_interface string	Choices: не определено сеть, определенная IP-адресом и маской интерфейса сеть, определенная маршрутизацией указанная	Н/Д
		specific_network string		Сеть за этим интерфейсом.
ip_address string				IPv4 или IPv6 адрес. Если оба адреса необходимы, используйте явным образом поля ipv4-address и ipv6-address.
ips boolean			Choices: нет да	Включен модуль системы предотвращения вторжений (Intrusion Prevention System).
ipv4_address string				IPv4-адрес.
ipv6_address string				IPv6-адрес.
logs_settings dictionary				Н/Д
	alert_when_free_disk_space_below boolean		Choices: нет да	Н/Д
	alert_when_free_disk_space_below_threshold integer			Н/Д
	alert_when_free_disk_space_below_type string		Choices: нет лог всплывающее уведомление уведомление по почте уведомление SNMP trap пользовательское уведомление №1 пользовательское уведомление №2 пользовательское уведомление №3	Н/Д
	before_delete_keep_logs_from_the_last_days boolean		Choices: нет да	Н/Д
	before_delete_keep_logs_from_the_last_days_threshold integer			Н/Д
	before_delete_run_script boolean		Choices: нет да	Н/Д
	before_delete_run_script_command string			Н/Д
	delete_index_files_older_than_days boolean		Choices: нет да	Н/Д
	delete_index_files_older_than_days_threshold integer			Н/Д
	delete_index_files_when_index_size_above boolean		Choices: нет да	Н/Д
	delete_index_files_when_index_size_above_threshold integer			Н/Д
	delete_when_free_disk_space_below boolean		Choices: нет да	Н/Д
	delete_when_free_disk_space_below_threshold integer			Н/Д
	detect_new_citrix_ica_application_names boolean		Choices: нет да	Н/Д
	forward_logs_to_log_server boolean		Choices: нет да	Н/Д
	forward_logs_to_log_server_name string			Н/Д
	forward_logs_to_log_server_schedule_name string			Н/Д
	free_disk_space_metrics string		Choices: МБ процент	Н/Д
	perform_log_rotate_before_log_forwarding boolean		Choices: нет да	Н/Д
	reject_connections_when_free_disk_space_below_threshold boolean		Choices: нет да	Н/Д
	reserve_for_packet_capture_metrics string		Choices: процент МБ	Н/Д
	reserve_for_packet_capture_threshold integer			Н/Д
	rotate_log_by_file_size boolean		Choices: нет да	Н/Д
	rotate_log_file_size_threshold integer			Н/Д
	rotate_log_on_schedule boolean		Choices: нет да	Н/Д

	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 list			Сервер(ы) для отправки оповещений.
send_logs_to_backup_server list			Запасной сервер(ы) для отправки логов.
send_logs_to_server list			Сервер(ы) для отправки логов.
state string		Варианты: присутствует ← отсутствует	Состояние правила доступа (присутствует или отсутствует). По умолчанию — присутствует.
tags list			Коллекция идентификаторов тегов.
threat_emulation boolean		Варианты: нет да	Включён модуль имитации угроз.
threat_extraction boolean		Варианты: нет да	Включён модуль извлечения угроз.
url_filtering boolean		Варианты: нет да	Включён модуль фильтрации URL.
version string			Версия платформы шлюза.
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 dictionary	всегда, за исключением удаления объекта.	Созданный или обновлённый объект контрольной точки.

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

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.9/modules/cp_mgmt_simple_gateway_module.html