Модуль check_point.mgmt.cp_mgmt_checkpoint_host — управление объектами checkpoint-host в Checkpoint через 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_checkpoint_host.
Добавлено в check_point.mgmt 5.0.0
Краткое описание
- Управляет объектами checkpoint-host на устройствах Checkpoint, включая создание, обновление и удаление объектов.
- Все операции выполняются через API веб-служб.
- Доступен начиная с версии управления R80.40 JHF.
Параметры
Параметр | Комментарии |
|---|---|
auto_publish_session boolean | Опубликовать текущий сеанс, если после завершения задачи были внесены изменения. Варианты:
|
check_point_host_version string | Версия платформы узла Check Point. |
color string | Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
comments string | Строка комментариев. |
details_level string | Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
groups list / elements=string | Коллекция идентификаторов групп. |
hardware string | Название оборудования. |
ignore_errors boolean | Применить изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
ignore_warnings boolean | Применить изменения, игнорируя предупреждения. Варианты:
|
interfaces list / elements=dictionary | Интерфейсы узла Check Point. |
|
color string |
Цвет объекта. Должен быть одним из существующих цветов. Варианты:
|
|
comments string |
Строка комментариев. |
|
details_level string |
Уровень детализации некоторых полей в ответе может варьироваться от отображения только значения UID объекта до полностью подробного представления объекта. Варианты:
|
|
ignore_errors boolean |
Применить изменения, игнорируя ошибки. Опубликовать такие изменения не удастся. Если флаг ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты:
|
|
ignore_warnings boolean |
Применить изменения, игнорируя предупреждения. Варианты:
|
|
mask_length integer |
Длина маски сети IPv4 или IPv6. Если требуются обе маски, явно укажите поля mask-length4 и mask-length6. Вместо длины маски IPv4 можно указать саму маску IPv4 в поле subnet-mask. |
|
mask_length4 integer |
Длина маски сети IPv4. |
|
mask_length6 integer |
Длина маски сети IPv6. |
|
name string |
Имя интерфейса. |
|
subnet string |
Сетевой адрес IPv4 или IPv6. Если требуются оба адреса, явно укажите поля subnet4 и subnet6. |
|
subnet4 string |
Сетевой адрес IPv4. |
|
subnet6 string |
Сетевой адрес IPv6. |
|
subnet_mask string |
Сетевая маска IPv4. |
ip_address string | Адрес IPv4 или IPv6. Если требуются оба адреса, явно укажите поля ipv4-address и ipv6-address. |
ipv4_address string | Адрес IPv4. |
ipv6_address string | Адрес IPv6. |
logs_settings dictionary | Настройки журналов. |
|
accept_syslog_messages boolean |
Включить прием сообщений syslog. Варианты:
|
|
alert_when_free_disk_space_below boolean |
Включить оповещение, когда свободное место на диске опускается ниже порогового значения. Варианты:
|
|
alert_when_free_disk_space_below_threshold integer |
Пороговое значение свободного места на диске для оповещения. |
|
alert_when_free_disk_space_below_type string |
Тип порогового значения свободного места на диске для оповещения. Варианты:
|
|
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_when_free_disk_space_below boolean |
Включить удаление при снижении свободного места на диске ниже порогового значения. Варианты:
|
|
delete_when_free_disk_space_below_threshold integer |
Пороговое значение свободного места на диске для удаления. |
|
detect_new_citrix_ica_application_names boolean |
Включить обнаружение новых имен приложений Citrix ICA. Варианты:
|
|
distribute_logs_between_all_active_servers boolean |
Распределять журналы между всеми активными серверами. Доступно начиная с версии управления R81.20. Варианты:
|
|
enable_log_indexing 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 |
Метрики свободного места на диске. Варианты:
|
|
rotate_log_by_file_size boolean |
Включить ротацию журналов по размеру файла. Варианты:
|
|
rotate_log_file_size_threshold integer |
Пороговый размер файла журнала. |
|
rotate_log_on_schedule boolean |
Включить ротацию журналов по расписанию. Варианты:
|
|
rotate_log_schedule_name string |
Имя расписания ротации журналов. |
|
smart_event_intro_correletion_unit boolean |
Включить вводный модуль корреляции SmartEvent. Варианты:
|
|
stop_logging_when_free_disk_space_below boolean |
Включить остановку ведения журналов при недостатке свободного места на диске. Варианты:
|
|
stop_logging_when_free_disk_space_below_threshold integer |
Останавливать ведение журналов при снижении объёма свободного места на диске ниже порогового значения. |
|
turn_on_qos_logging boolean |
Включить ведение журналов QoS. Варианты:
|
|
update_account_log_every integer |
Обновлять журнал учётной записи через заданное количество секунд. |
management_blades dictionary | Компоненты управления. |
|
compliance boolean |
Компонент Compliance. Можно задать, если для ‘network-policy-management’ выбрано значение True. Варианты:
|
|
endpoint_policy boolean |
Включить Endpoint Policy. </br>Чтобы завершить настройку Endpoint Security Management, выполните установку базы данных на сервере Endpoint Management. </br>Поле не поддерживается в среде Multi Domain Server. Варианты:
|
|
logging_and_status boolean |
Включить ведение журналов и мониторинг состояния. Варианты:
|
|
network_policy_management boolean |
Включить Network Policy Management. Варианты:
|
|
smart_event_correlation boolean |
Включить модуль корреляции SmartEvent. Варианты:
|
|
smart_event_server boolean |
Включить сервер SmartEvent. </br>При активации сервера SmartEvent для компонентов ‘logging-and-status’ и ‘smart-event-correlation’ необходимо задать значение True. </br>Чтобы завершить настройку SmartEvent, выполните установку базы данных или установку политики на серверах Security Management и серверах журналов. </br>Не рекомендуется активировать SmartEvent Server в среде Management High Availability. Дополнительные сведения см. в sk25164. Варианты:
|
|
user_directory boolean |
Включить User Directory. Можно задать, если для ‘network-policy-management’ выбрано значение True. Варианты:
|
name string / обязательный | Имя объекта. |
nat_settings dictionary | Параметры NAT. |
|
auto_rule boolean |
Следует ли добавлять правила автоматической трансляции адресов. Варианты:
|
|
hide_behind string |
Метод сокрытия за адресом. Этот параметр запрещено задавать, если параметр “method” имеет значение “static”. Варианты:
|
|
install_on string |
Шлюз, который должен выполнять трансляцию NAT. |
|
ip_address string |
Адрес IPv4 или IPv6. Если требуются оба адреса, явно используйте поля ipv4-address и ipv6-address. Этот параметр не требуется, если параметр “method” имеет значение “hide”, а параметр “hide-behind” — значение “gateway”. |
|
ipv4_address string |
Адрес IPv4. |
|
ipv6_address string |
Адрес IPv6. |
|
method string |
Метод трансляции NAT. Варианты:
|
one_time_password string | Одноразовый пароль для защищённого внутреннего соединения. |
os string | Название операционной системы. |
save_logs_locally boolean | Включить локальное сохранение журналов. Варианты:
|
send_alerts_to_server list / элементы=string | Список серверов, на которые отправляются оповещения; серверы указываются по имени или UID. |
send_logs_to_backup_server list / элементы=string | Список серверов резервного копирования, на которые отправляются журналы; серверы указываются по имени или UID. |
send_logs_to_server list / элементы=string | Список серверов, на которые отправляются журналы; серверы указываются по имени или UID. |
state string | Состояние правила доступа (present или absent). Варианты:
|
tags list / elements=string | Коллекция идентификаторов тегов. |
version string | Версия контрольной точки. Если версия не указана, используется последняя. |
wait_for_task boolean | Ожидать завершения задачи, например публикации. Варианты:
|
wait_for_task_timeout integer | Сколько минут ждать до возникновения ошибки тайм-аута. По умолчанию: |
Примеры
- name: add-checkpoint-host
cp_mgmt_checkpoint_host:
ipv4_address: 5.5.5.5
management_blades:
logging_and_status: true
network_policy_management: true
name: secondarylogserver
state: present
- name: set-checkpoint-host
cp_mgmt_checkpoint_host:
hardware: Smart-1
management_blades:
compliance: true
network_policy_management: true
user_directory: true
name: secondarylogserver
os: Linux
state: present
- name: delete-checkpoint-host
cp_mgmt_checkpoint_host:
name: secondarylogserver
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
cp_mgmt_checkpoint_host dictionary | Созданный или обновлённый объект контрольной точки. Возвращается: всегда, кроме случаев удаления объекта. |
Ссылки на коллекцию
© 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_checkpoint_host_module.html