Модуль check_point.mgmt.cp_mgmt_syslog_server – управление объектами серверов syslog на 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_syslog_server.

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

Краткое описание
Параметры
Примеры
Возвращаемые значения

Краткое описание

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

Параметры

Параметр	Комментарии
auto_publish_session boolean	Опубликовать текущий сеанс после выполнения задачи, если в него вносились изменения. Варианты: `false` ← (по умолчанию) `true`
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"`
domains_to_process list / elements=string	Указывает, в каких доменах выполнять команды. Нельзя использовать вместе с уровнем детализации full; запускать следует только из системного домена и с параметром ignore-warnings, равным true. Допустимые значения: CURRENT_DOMAIN, ALL_DOMAINS_ON_THIS_SERVER.
host string	Объект сервера, определяемый по имени или UID.
ignore_errors boolean	Применить изменения, игнорируя ошибки. Опубликовать такие изменения не получится. Если параметр ignore-warnings не указан, предупреждения также будут игнорироваться. Варианты: `false` `true`
ignore_warnings boolean	Применить изменения, игнорируя предупреждения. Варианты: `false` `true`
name string / обязательный	Имя объекта.
port integer	Номер порта.
server_version string	Версия RFC. Варианты: `"bsd"` `"syslog"`
state string	Состояние правила доступа (present или absent). Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / elements=string	Список идентификаторов тегов.
version string	Версия Checkpoint. Если версия не указана, используется последняя.
wait_for_task boolean	Ожидать завершения задачи, например задачи публикации. Варианты: `false` `true` ← (по умолчанию)
wait_for_task_timeout integer	Сколько минут ждать до возникновения ошибки по тайм-ауту. По умолчанию: `30`

Примеры

- name: add-syslog-server
  cp_mgmt_syslog_server:
    host: syslogServerHost
    name: newSyslogServer
    port: 18889
    state: present

- name: set-syslog-server
  cp_mgmt_syslog_server:
    name: newSyslogServer
    port: '10101'
    state: present

- name: delete-syslog-server
  cp_mgmt_syslog_server:
    name: newSyslogServer
    state: absent

Возвращаемые значения

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

Ключ	Описание
cp_mgmt_syslog_server dictionary	Созданный или обновлённый объект Checkpoint. Возвращается: всегда, кроме случаев удаления объекта.

Авторы

Dor Berenstein (@chkp-dorbe)

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

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