check_point.mgmt.cp_mgmt_simple_gateway модуль — Управляет объектами simple-gateway на Check Point через 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_gateway.
Новый в check_point.mgmt 1.0.0
Обзор
- Управляет объектами simple-gateway на устройствах Check Point, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
Параметры
Параметр | Комментарии |
|---|---|
anti_bot boolean | Включен модуль Anti-Bot. Варианты:
|
anti_virus boolean | Включен модуль Anti-Virus. Варианты:
|
application_control boolean | Включен модуль Application Control. Варианты:
|
auto_publish_session boolean | Опубликовать текущий сеанс, если изменения были выполнены после завершения задачи. Варианты:
|
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментариев. |
content_awareness boolean | Включен модуль Content Awareness. Варианты:
|
details_level string | Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
firewall boolean | Включен модуль Firewall. Варианты:
|
firewall_settings dictionary | N/A |
|
auto_calculate_connections_hash_table_size_and_memory_pool boolean |
N/A Варианты:
|
|
auto_maximum_limit_for_concurrent_connections boolean |
N/A Варианты:
|
|
connections_hash_size integer |
N/A |
|
maximum_limit_for_concurrent_connections integer |
N/A |
|
maximum_memory_pool_size integer |
N/A |
|
memory_pool_size integer |
N/A |
gateway_version string | Версия платформы шлюза. |
groups list / elements=string | Коллекция идентификаторов групп. |
ignore_errors boolean | Применить изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был пропущен, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings boolean | Применять изменения, игнорируя предупреждения. Варианты:
|
interfaces list / элементы=словарь | Сетевые интерфейсы. При обновлении шлюза с новыми интерфейсами, существующие интерфейсы удаляются. |
|
anti_spoofing boolean |
Н/Д Варианты:
|
|
anti_spoofing_settings словарь |
Н/Д |
|
action строка |
Если пакеты будут отклоняться (вариант «Предотвратить») или будут отслеживаться (вариант «Обнаружить»). Варианты:
|
|
color строка |
Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
|
comments строка |
Строка комментариев. |
|
details_level строка |
Уровень детализации для некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полного подробного представления объекта. Варианты:
|
|
ignore_errors boolean |
Применять изменения, игнорируя ошибки. Вы не сможете опубликовать такие изменения. Если флаг ignore-warnings был опущен, то предупреждения также будут проигнорированы. Варианты:
|
|
ignore_warnings boolean |
Применять изменения, игнорируя предупреждения. Варианты:
|
|
ip_address строка |
Адрес 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. |
|
name строка |
Имя объекта. |
|
network_mask строка |
Маска сети IPv4 или IPv6. Если обе маски необходимы, используйте поля ipv4-network-mask и ipv6-network-mask явно. Вместо самой маски можно указать длину маски IPv4 или IPv6 в поле mask-length. Если обе длины масок необходимы, используйте поля ipv4-mask-length и ipv6-mask-length явно. |
|
security_zone boolean |
N/A Варианты:
|
|
security_zone_settings dictionary |
N/A |
|
auto_calculated boolean |
Зона безопасности рассчитывается в зависимости от того, к чему ведет интерфейс. Варианты:
|
|
specific_zone string |
Зона безопасности, заданная вручную. |
|
tags list / элементы=string |
Коллекция идентификаторов тегов. |
|
topology string |
N/A Варианты:
|
|
topology_settings dictionary |
N/A |
|
interface_leads_to_dmz boolean |
Является ли этот интерфейс ведущим в демилитаризованную зону (периметр сети)? Варианты:
|
|
ip_address_behind_this_interface string |
N/A Варианты:
|
|
specific_network string |
Сеть за этим интерфейсом. |
ip_address string | Адрес IPv4 или IPv6. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно. |
ips boolean | Включен ли модуль предотвращения вторжений. Варианты:
|
ipv4_address string | Адрес IPv4. |
ipv6_address string | Адрес IPv6. |
logs_settings dictionary | N/A |
|
alert_when_free_disk_space_below boolean |
N/A Варианты:
|
|
alert_when_free_disk_space_below_threshold integer |
N/A |
|
alert_when_free_disk_space_below_type string |
N/A Варианты:
|
|
before_delete_keep_logs_from_the_last_days boolean |
N/A Варианты:
|
|
before_delete_keep_logs_from_the_last_days_threshold integer |
N/A |
|
before_delete_run_script boolean |
N/A Варианты:
|
|
before_delete_run_script_command string |
N/A |
|
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 |
Н/Д Choices:
|
|
stop_logging_when_free_disk_space_below_threshold integer |
Н/Д |
|
turn_on_qos_logging boolean |
N/A Варианты:
|
|
update_account_log_every целое число |
N/A |
name строка / обязательно | Имя объекта. |
one_time_password строка | N/A |
os_name строка | Операционная система платформы шлюза. |
save_logs_locally boolean | Сохранять журналы локально на шлюзе. Варианты:
|
send_alerts_to_server список / элементы=строка | Сервер(ы) для отправки уведомлений. |
send_logs_to_backup_server список / элементы=строка | Резервный сервер(ы) для отправки журналов. |
send_logs_to_server список / элементы=строка | Сервер(ы) для отправки журналов. |
state строка | Состояние правила доступа (есть или отсутствует). Варианты:
|
tags список / элементы=строка | Набор идентификаторов тегов. |
threat_emulation boolean | Включен модуль эмуляции угроз. Варианты:
|
threat_extraction boolean | Включен модуль извлечения угроз. Варианты:
|
url_filtering boolean | Включен модуль фильтрации URL. Варианты:
|
version строка | Версия Check Point. Если не указана, используется последняя. |
vpn boolean | Включен VPN-модуль. Варианты:
|
vpn_settings словарь | Настройки VPN шлюза. |
|
maximum_concurrent_ike_negotiations целое число |
N/A |
|
maximum_concurrent_tunnels целое число |
N/A |
wait_for_task boolean | Дождаться завершения задачи (например, публикации). Варианты:
|
wait_for_task_timeout целое число | Сколько минут ждать, прежде чем сгенерировать ошибку таймаута. По умолчанию: |
Примеры
- 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 словарь | Объект 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_gateway_module.html