Spec-Zone.ru › Ansible

check_point.mgmt.cp_mgmt_checkpoint_host модуль — Управляет объектами checkpoint-host на Checkpoint через веб-сервисы API

Примечание

Этот модуль входит в коллекцию check_point.mgmt (версия 5.2.3).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install check_point.mgmt.

Чтобы использовать её в playbook, укажите: check_point.mgmt.cp_mgmt_checkpoint_host.

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

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

Обзор

  • Управляет объектами checkpoint-host на устройствах Checkpoint, включая создание, обновление и удаление объектов.
  • Все операции выполняются через веб-сервисы API.

Параметры

Параметр

Комментарии

auto_publish_session

boolean

Опубликовать текущую сессию, если после выполнения задачи были внесены изменения.

Варианты:

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

check_point_host_version

string

Версия платформы хоста Check Point.

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"

groups

list / elements=string

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

hardware

string

Наименование оборудования.

ignore_errors

boolean

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

Варианты:

  • false
  • true

ignore_warnings

boolean

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

Варианты:

  • false
  • true

interfaces

list / elements=dictionary

Интерфейсы хоста Check Point.

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

mask_length

integer

Длина маски сети IPv4 или IPv6. Если требуются обе маски, используйте поля mask-length4 и mask-length6 явно. Вместо длины маски IPv4 можно указать саму маску IPv4 в поле subnet-mask.

mask_length4

целое число

Длина маски сети IPv4.

mask_length6

целое число

Длина маски сети IPv6.

name

строка

Имя интерфейса.

subnet

строка

Адрес сети IPv4 или IPv6. Если требуются оба адреса, используйте явным образом поля subnet4 и subnet6.

subnet4

строка

Адрес сети IPv4.

subnet6

строка

Адрес сети IPv6.

subnet_mask

строка

Маска сети IPv4.

ip_address

строка

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

ipv4_address

строка

Адрес IPv4.

ipv6_address

строка

Адрес IPv6.

logs_settings

словарь

Настройки логов.

accept_syslog_messages

логическое

Включить прием сообщений syslog.

Варианты:

  • false
  • true

alert_when_free_disk_space_below

логическое

Включить уведомление при свободном объеме диска ниже порога.

Варианты:

  • false
  • true

alert_when_free_disk_space_below_threshold

целое число

Уведомление при свободном объеме диска ниже порога.

alert_when_free_disk_space_below_type

строка

Уведомление при свободном объеме диска ниже порога типа.

Варианты:

  • "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

логическое

Включить сохранение логов за последние дни перед удалением.

Варианты:

  • false
  • true

before_delete_keep_logs_from_the_last_days_threshold

целое число

Порог для сохранения логов за последние дни перед удалением.

before_delete_run_script

логическое

Включить запуск скрипта перед удалением.

Варианты:

  • false
  • true

before_delete_run_script_command

строка

Команда для запуска скрипта перед удалением.

delete_index_files_older_than_days

логическое

Включить удаление индексных файлов, старше указанного количества дней.

Варианты:

  • false
  • true

delete_index_files_older_than_days_threshold

целое число

Порог для удаления индексных файлов, старше указанного количества дней.

delete_when_free_disk_space_below

логическое

Включить удаление при свободном объеме диска ниже порога.

Варианты:

  • false
  • true

delete_when_free_disk_space_below_threshold

integer

Удалять, если свободное место на диске ниже порогового значения.

detect_new_citrix_ica_application_names

boolean

Включить обнаружение новых имен приложений Citrix ICA.

Choices:

  • false
  • true

distribute_logs_between_all_active_servers

boolean

Распределять журналы между всеми активными серверами.

Choices:

  • false
  • true

enable_log_indexing

boolean

Включить индексацию журналов.

Choices:

  • false
  • true

forward_logs_to_log_server

boolean

Включить пересылку журналов на сервер журналов.

Choices:

  • false
  • true

forward_logs_to_log_server_name

string

Имя сервера журналов для пересылки.

forward_logs_to_log_server_schedule_name

string

Имя расписания пересылки журналов на сервер журналов.

free_disk_space_metrics

string

Метрики свободного места на диске.

Choices:

  • "mbytes"
  • "percent"

rotate_log_by_file_size

boolean

Включить вращение журналов по размеру файла.

Choices:

  • false
  • true

rotate_log_file_size_threshold

integer

Пороговое значение размера файла журнала.

rotate_log_on_schedule

boolean

Включить вращение журналов по расписанию.

Choices:

  • false
  • true

rotate_log_schedule_name

string

Имя расписания вращения журналов.

smart_event_intro_correletion_unit

boolean

Включить блок корреляции SmartEvent intro.

Choices:

  • false
  • true

stop_logging_when_free_disk_space_below

boolean

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

Choices:

  • false
  • true

stop_logging_when_free_disk_space_below_threshold

integer

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

turn_on_qos_logging

boolean

Включить ведение журнала QoS.

Choices:

  • false
  • true

update_account_log_every

integer

Обновлять журнал учетных записей каждые несколько секунд.

management_blades

dictionary

Модули управления.

compliance

boolean

Модуль соответствия. Может быть установлен, если «network-policy-management» установлено как True.

Choices:

  • false
  • true

endpoint_policy

boolean

Включить политику конечной точки. </br>Для завершения настройки управления безопасностью конечных точек выполните установку базы данных на сервере управления конечными точками. </br>Поле не поддерживается в среде многодоменного сервера.

Choices:

  • false
  • true

logging_and_status

boolean

Включить протоколирование и статус.

Варианты:

  • false
  • true

network_policy_management

boolean

Включить управление политикой сети.

Варианты:

  • false
  • true

smart_event_correlation

boolean

Включить блок SmartEvent Correlation.

Варианты:

  • false
  • true

smart_event_server

boolean

Включить сервер SmartEvent. </br>При активации сервера SmartEvent, параметры ‘logging-and-status’ и ‘smart-event-correlation’ должны быть установлены в значение True. </br>Для завершения настройки SmartEvent, выполните Установку базы данных или Установку политики на ваших серверах управления безопасностью и серверах протоколирования. </br>Активация сервера SmartEvent не рекомендуется в среде высокой доступности управления. Для получения дополнительной информации см. sk25164.

Варианты:

  • false
  • true

user_directory

boolean

Включить Каталог пользователей. Может быть установлен, когда ‘network-policy-management’ был выбран как True.

Варианты:

  • false
  • true

name

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

Имя объекта.

nat_settings

словарь

Настройки NAT.

auto_rule

boolean

Добавлять ли автоматические правила трансляции адресов?

Варианты:

  • false
  • true

hide_behind

строка

Метод скрытия. Этот параметр запрещён в случае, если параметр «method» равен «static».

Варианты:

  • "gateway"
  • "ip-address"

install_on

строка

Какой шлюз должен применить трансляцию NAT?

ip_address

строка

Адрес IPv4 или IPv6. Если требуются оба адреса, используйте поля ipv4-address и ipv6-address явно. Этот параметр не требуется в случае, если параметр «method» равен «hide» и параметр «hide-behind» равен «gateway».

ipv4_address

строка

Адрес IPv4.

ipv6_address

строка

Адрес IPv6.

method

строка

Метод трансляции NAT.

Варианты:

  • "hide"
  • "static"

one_time_password

строка

Одноразовый пароль для защищенного внутреннего подключения.

os

строка

Имя операционной системы.

save_logs_locally

boolean

Включить сохранение журналов локально.

Варианты:

  • false
  • true

send_alerts_to_server

список / элементы=строка

Коллекция серверов, на которые отправлять оповещения, по имени или идентификатору.

send_logs_to_backup_server

список / элементы=строка

Коллекция резервных серверов, на которые отправлять логи, по имени или идентификатору.

send_logs_to_server

список / элементы=строка

Коллекция серверов, на которые отправлять логи, по имени или идентификатору.

состояние

строка

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

Варианты:

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

метки

список / элементы=строка

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

версия

строка

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

ждать_задачи

булево

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

Варианты:

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

ждать_задачи_таймаут

целое число

Сколько минут ждать, прежде чем выбросить ошибку таймаута.

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

Примеры

- 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

словарь

Объект контрольной точки, созданный или обновлённый.

Возвращается: всегда, кроме случаев удаления объекта.

Авторы

  • Eden Brillant (@chkp-edenbr)

Ссылки на коллекцию

  • Система отслеживания ошибок
  • Репозиторий (источники)

© 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_checkpoint_host_module.html

Spec-Zone.ru

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