Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_system_log_settings_rollingregular – Политика ротации логов устройств.

Примечание

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

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_system_log_settings_rollingregular.

Добавлен в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
bypass_validation
boolean
    Варианты:
  • нет ←
  • да
устанавливается в True только при различиях в схеме модуля и структуре API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed
list / elements=string
список rc-кодов, при которых будут игнорироваться условия сбоя
rc_succeeded
list / elements=string
список rc-кодов, при которых будут игнорироваться условия успеха
state
string / обязательный
    Варианты:
  • present
  • absent
директива для создания, обновления или удаления объекта
system_log_settings_rollingregular
dictionary
устанавливаемые параметры верхнего уровня
days
list / elements=string
    Варианты:
  • sun
  • mon
  • tue
  • wed
  • thu
  • fri
  • sat
нет описания
del-files
string
    Варианты:
  • отключено ←
  • включено
Включить/выключить удаление лог-файлов после загрузки.
отключено - Отключить удаление лог-файлов.
включено - Включить удаление лог-файлов.
directory
string
Директория сервера загрузки, для Unix-серверов используйте абсолютный путь
file-size
integer
Значение по умолчанию:
200
Произвести ротацию лог-файлов, когда они достигнут этого размера (МБ).
gzip-format
string
    Варианты:
  • отключено ←
  • включено
Включить/выключить сжатие загружаемых лог-файлов.
отключено - Отключить сжатие.
включено - Включить сжатие.
hour
integer
Значение по умолчанию:
0
График ротации лог-файлов (час).
ip
string
Значение по умолчанию:
"0.0.0.0"
IP-адрес сервера загрузки.
ip2
string
Значение по умолчанию:
"0.0.0.0"
IP-адрес сервера загрузки 2.
ip3
string
Значение по умолчанию:
"0.0.0.0"
IP-адрес сервера загрузки 3.
log-format
string
    Варианты:
  • native ←
  • text
  • csv
Формат загружаемых лог-файлов.
native - Нативный формат (текст или компактный).
text - Текстовый формат (преобразуйте при необходимости).
csv - CSV (comma-separated value) формат.
min
integer
Значение по умолчанию:
0
График ротации лог-файлов (минуты).
password
string
нет описания
password2
string
нет описания
password3
string
нет описания
server-type
string
    Варианты:
  • ftp ←
  • sftp
  • scp
Тип сервера загрузки.
ftp - Загрузка через FTP.
sftp - Загрузка через SFTP.
scp - Загрузка через SCP.
upload
string
    Варианты:
  • отключено ←
  • включено
Включить/выключить загрузку лог-файлов.
отключено - Отключить загрузку лог-файлов.
включено - Включить загрузку лог-файлов.
upload-hour
integer
Значение по умолчанию:
0
График загрузки лог-файлов (час).
upload-mode
string
    Варианты:
  • резервное копирование ←
  • зеркало
Режим загрузки с несколькими серверами.
резервное копирование - Серверы пытаются подключиться по очереди при ошибке соединения.
зеркало - Все настроенные серверы пытаются подключиться и используются.
upload-trigger
string
    Варианты:
  • при ротации ←
  • по расписанию
Событие, вызывающее загрузку лог-файлов.
при ротации - Загрузить лог-файлы после их ротации.
по расписанию - Ежедневно загружать лог-файлы.
username
string
Имя пользователя для входа на сервер загрузки.
username2
string
Имя пользователя для входа на сервер загрузки 2.
username3
string
Имя пользователя для входа на сервер загрузки 3.
when
string
    Варианты:
  • никогда ←
  • ежедневно
  • еженедельно
Периодическая ротация лог-файлов.
никогда - Не производить периодическую ротацию лог-файлов.
ежедневно - Ротировать лог-файлы ежедневно.
еженедельно - Ротировать лог-файлы по определенным дням недели.
workspace_locking_adom
string
ADOM для блокировки в режиме работы с рабочим пространством FortiManager, значение может быть глобальным и другими, включая root
workspace_locking_timeout
integer
Значение по умолчанию:
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: Log rolling policy for device logs.
     fmgr_system_log_settings_rollingregular:
        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, ...]
        system_log_settings_rollingregular:
           days:
             - sun
             - mon
             - tue
             - wed
             - thu
             - fri
             - sat
           del-files: <value in [disable, enable]>
           directory: <value of string>
           file-size: <value of integer>
           gzip-format: <value in [disable, enable]>
           hour: <value of integer>
           ip: <value of string>
           ip2: <value of string>
           ip3: <value of string>
           log-format: <value in [native, text, csv]>
           min: <value of integer>
           password: <value of string>
           password2: <value of string>
           password3: <value of string>
           server-type: <value in [ftp, sftp, scp]>
           upload: <value in [disable, enable]>
           upload-hour: <value of integer>
           upload-mode: <value in [backup, mirror]>
           upload-trigger: <value in [on-roll, on-schedule]>
           username: <value of string>
           username2: <value of string>
           username3: <value of string>
           when: <value in [none, daily, weekly]>

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

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

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

Пример:
/sys/login/user
response_code
integer
всегда
Статус запроса API
response_message
string
всегда
Дескриптивное сообщение ответа 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_system_log_settings_rollingregular_module.html

Spec-Zone.ru

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