Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer — политика ротации журналов Network Analyzer.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

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

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer.

Добавлено в fortinet.fortimanager 2.0.0

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

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

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

Параметры

Параметр

Комментарии

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

Переопределённый метод для базового запроса Json RPC.

Варианты:

  • "update"
  • "set"
  • "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успешного выполнения.

system_log_settings_rollinganalyzer

dictionary

Параметры верхнего уровня.

days

list / elements=string

Расписание ротации файлов журнала

sun — воскресенье.

mon — понедельник.

tue — вторник.

wed — среда.

thu — четверг.

fri — пятница.

sat — суббота.

Варианты:

  • "sun"
  • "mon"
  • "tue"
  • "wed"
  • "thu"
  • "fri"
  • "sat"

del_files

псевдонимы: del-files

string

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

disable — отключить удаление файлов журнала.

enable — включить удаление файлов журнала.

Варианты:

  • "disable"
  • "enable"

directory

string

Каталог на сервере загрузки; для Unix-сервера укажите абсолютный путь

file_size

псевдонимы: file-size

integer

Выполнять ротацию файлов журнала при достижении этого размера

gzip_format

псевдонимы: gzip-format

string

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

disable — отключить сжатие.

enable — включить сжатие.

Варианты:

  • "disable"
  • "enable"

hour

integer

Расписание ротации файлов журнала

ip

string

IP-адрес сервера загрузки.

ip2

string

IP-адрес сервера загрузки 2.

ip3

string

IP-адрес сервера загрузки 3.

log_format

псевдонимы: log-format

string

Формат загружаемых файлов журнала.

native — исходный формат

text — текстовый формат

csv — CSV

Варианты:

  • "native"
  • "text"
  • "csv"

min

integer

Расписание ротации файлов журнала

password

any

(список) Пароль для входа на сервер загрузки.

password2

any

(список) Пароль 2 для входа на сервер загрузки.

password3

any

(список) Пароль 3 для входа на сервер загрузки.

port

integer

Номер порта IP1 сервера загрузки.

port2

integer

Номер порта IP2 сервера загрузки.

port3

integer

Номер порта IP3 сервера загрузки.

rolling_upgrade_status

псевдонимы: rolling-upgrade-status

integer

Состояние поэтапного обновления

server

string

FQDN/IP-адрес сервера загрузки.

server2

string

FQDN/IP-адрес сервера загрузки 2.

server3

string

FQDN/IP-адрес сервера загрузки 3.

server_type

псевдонимы: server-type

string

Тип сервера загрузки.

ftp — загрузка по FTP.

sftp — загрузка по SFTP.

scp — загрузка по SCP.

Варианты:

  • "ftp"
  • "sftp"
  • "scp"

upload

string

Включить или отключить загрузку файлов журнала.

disable — отключить загрузку файлов журнала.

enable — включить загрузку файлов журнала.

Варианты:

  • "disable"
  • "enable"

upload_hour

псевдонимы: upload-hour

integer

Расписание загрузки файлов журнала

upload_mode

псевдонимы: upload-mode

string

Режим загрузки при наличии нескольких серверов.

backup — серверы используются по очереди при невозможности подключения к предыдущему.

mirror — выполняется попытка подключения и использования всех настроенных серверов.

Варианты:

  • "backup"
  • "mirror"

upload_trigger

псевдонимы: upload-trigger

string

Событие, запускающее загрузку файлов журнала.

on-roll — загружать файлы журнала после их ротации.

on-schedule — загружать файлы журнала ежедневно.

Варианты:

  • "on-roll"
  • "on-schedule"

username

string

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

username2

string

Имя пользователя 2 для входа на сервер загрузки.

username3

string

Имя пользователя 3 для входа на сервер загрузки.

when

string

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

none — не выполнять периодическую ротацию файлов журнала.

daily — выполнять ротацию файлов журнала ежедневно.

weekly — выполнять ротацию файлов журнала в определённые дни недели.

Варианты:

  • "none"
  • "daily"
  • "weekly"

workspace_locking_adom

string

ADOM для блокировки в FortiManager, работающем в режиме workspace; в качестве значения можно указать global и другие значения, включая root.

workspace_locking_timeout

integer

Максимальное время в секундах ожидания снятия блокировки workspace другим пользователем.

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

Примечания

Примечание

  • Начиная с версии 2.4.0, для всех входных аргументов используются имена в формате snake_case с подчёркиваниями. Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но для них будут выводиться предупреждения об устаревании. Это предупреждение можно игнорировать, установив deprecation_warnings=False в ansible.cfg.
  • Этот модуль FortiManager поддерживает работу в режиме блокировки workspace; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Как правило, выполнение модуля завершается с ошибкой при возврате ненулевого кода rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Log rolling policy for Network Analyzer logs.
      fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer:
        # workspace_locking_adom: <global or your adom name>
        system_log_settings_rollinganalyzer:
          # days: ["sun", "mon", "tue", "wed", "thu", "fri", "sat"]
          # del_files: <value in [disable, enable]>
          # directory: <string>
          # file_size: <integer>
          # gzip_format: <value in [disable, enable]>
          # hour: <integer>
          # ip: <string>
          # ip2: <string>
          # ip3: <string>
          # log_format: <value in [native, text, csv]>
          # min: <integer>
          # password: <list or string>
          # password2: <list or string>
          # password3: <list or string>
          # server_type: <value in [ftp, sftp, scp]>
          # upload: <value in [disable, enable]>
          # upload_hour: <integer>
          # upload_mode: <value in [backup, mirror]>
          # upload_trigger: <value in [on-roll, on-schedule]>
          # username: <string>
          # username2: <string>
          # username3: <string>
          # when: <value in [none, daily, weekly]>
          # port: <integer>
          # port2: <integer>
          # port3: <integer>
          # rolling_upgrade_status: <integer>
          # server: <string>
          # server2: <string>
          # server3: <string>

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

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

Ключ

Описание

meta

dictionary

Результат запроса.

Возвращается: всегда

request_url

string

Полный URL запроса.

Возвращается: всегда

Пример: "/sys/login/user"

response_code

integer

Состояние запроса API.

Возвращается: всегда

Пример: 0

response_data

list / elements=string

Ответ API.

Возвращается: всегда

response_message

string

Описание ответа API.

Возвращается: всегда

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

Возвращается: всегда

rc

integer

Состояние запроса.

Возвращается: всегда

Пример: 0

version_check_warning

list / elements=string

Предупреждение, если используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: в сложных случаях

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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

  • Отслеживание ошибок
  • Главная страница
  • Репозиторий (исходный код)

© 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/fortinet/fortimanager/fmgr_system_log_settings_rollinganalyzer_module.html

Spec-Zone.ru

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