Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_devprof_log_syslogd_setting – Глобальные настройки удалённого сервера syslog.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_devprof_log_syslogd_setting.

В версии 2.10: модуля fortinet.fortimanager

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

Обзор

  • Этот модуль позволяет настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо скорректировать для источников данных перед использованием.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
логическое
    Варианты:
  • нет ←
  • да
устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
devprof
строка / обязательно
параметр (devprof) в запрошенном URL
devprof_log_syslogd_setting
словарь
параметры верхнего уровня
certificate
строка
Сертификат, используемый для связи с сервером Syslog.
enc-algorithm
строка
    Варианты:
  • high
  • low
  • disable
  • high-medium
Включение/выключение надёжного syslogging с шифрованием TLS.
facility
строка
    Варианты:
  • kernel
  • user
  • mail
  • daemon
  • auth
  • syslog
  • lpr
  • news
  • uucp
  • cron
  • authpriv
  • ftp
  • ntp
  • audit
  • alert
  • clock
  • local0
  • local1
  • local2
  • local3
  • local4
  • local5
  • local6
  • local7
Удобство удалённого syslog.
mode
строка
    Варианты:
  • udp
  • legacy-reliable
  • reliable
Удалённый syslog logging через UDP/надёжный TCP.
port
целое число
Порт прослушивания сервера.
server
строка
Адрес удалённого сервера syslog.
ssl-min-proto-version
строка
    Варианты:
  • default
  • TLSv1-1
  • TLSv1-2
  • SSLv3
  • TLSv1
Минимальная поддерживаемая версия протокола для соединений SSL/TLS (по умолчанию используется глобальное системное значение).
status
строка
    Варианты:
  • disable
  • enable
Включение/выключение удалённого syslog logging.
rc_failed
список / элементы=строка
список кодов rc, при которых условия будут нарушены
rc_succeeded
список / элементы=строка
список кодов rc, при которых условия будут выполнены
state
строка / обязательно
    Варианты:
  • present
  • absent
инструкции по созданию, обновлению или удалению объекта
workspace_locking_adom
строка
adom для блокировки FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным или другим, включая root
workspace_locking_timeout
целое число
По умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства

Примечания

Примечание

  • В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.
  • Обычно выполнение одного модуля может завершиться сбоем при возврате ненулевого rc. Вы также можете переопределить условия отказа или успеха с помощью параметров rc_failed и rc_succeeded

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Global settings for remote syslog server.
     fmgr_devprof_log_syslogd_setting:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        devprof: <your own value>
        devprof_log_syslogd_setting:
           certificate: <value of string>
           enc-algorithm: <value in [high, low, disable, ...]>
           facility: <value in [kernel, user, mail, ...]>
           mode: <value in [udp, legacy-reliable, reliable]>
           port: <value of integer>
           server: <value of string>
           ssl-min-proto-version: <value in [default, TLSv1-1, TLSv1-2, ...]>
           status: <value in [disable, enable]>

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

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

Ключ Возвращаемое значение Описание
request_url
строка
всегда
Полный запрошенный URL

Пример:
/sys/login/user
response_code
целое число
всегда
Статус запроса API

response_message
строка
всегда
Дескриптивное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_devprof_log_syslogd_setting_module.html

Spec-Zone.ru

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