Модуль fortinet.fortimanager.fmgr_system_log_settings_rollinglocal — политика ротации локальных журналов.

Примечание

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

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

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

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

Добавлено в 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_rollinglocal 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	Номер порта IP-адреса 1 сервера отправки файлов.
port2 integer	Номер порта IP-адреса 2 сервера отправки файлов.
port3 integer	Номер порта IP-адреса 3 сервера отправки файлов.
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 в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выводиться предупреждения об устаревании. Это предупреждение можно отключить, задав deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; параметры верхнего уровня 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 local logs.
      fortinet.fortimanager.fmgr_system_log_settings_rollinglocal:
        # workspace_locking_adom: <global or your adom name>
        system_log_settings_rollinglocal:
          # 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_rollinglocal_module.html