Модуль fortinet.fortimanager.fmgr_system_log_settings_rollingregular – Политика ротации журналов устройств.

Примечание

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

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

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

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

Впервые в fortinet.fortimanager 2.0.0

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

Обзор

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

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation булево	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включение/выключение ведения журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список кодов rc, с помощью которых будут переопределены условия завершения задачи с ошибкой.
rc_succeeded список / элементы=целое	Список кодов rc, с помощью которых будут переопределены условия успешного завершения задачи.
system_log_settings_rollingregular словарь	Параметры верхнего уровня.
days список / элементы=строка	График ротации логов sun - Воскресенье. mon - Понедельник. tue - Вторник. wed - Среда. thu - Четверг. fri - Пятница. sat - Суббота. Варианты: `"sun"` `"mon"` `"tue"` `"wed"` `"thu"` `"fri"` `"sat"`
del-files строка	Устарело, пожалуйста, переименуйте на del_files. Включение/выключение удаления файлов логов после загрузки. disable - Отключить удаление файлов логов. enable - Включить удаление файлов логов. Варианты: `"disable"` `"enable"`
directory строка	Директория сервера загрузки, для Unix-серверов использовать абсолютный путь.
file-size целое	Устарело, пожалуйста, переименуйте на file_size. Ротация логов, когда они достигают этого размера.
gzip-format строка	Устарело, пожалуйста, переименуйте на gzip_format. Включение/выключение сжатия загружаемых файлов логов. disable - Отключить сжатие. enable - Включить сжатие. Варианты: `"disable"` `"enable"`
hour целое	График ротации логов
ip строка	IP-адрес сервера загрузки.
ip2 строка	IP-адрес сервера загрузки (второй).
ip3 строка	IP-адрес сервера загрузки (третий).
log-format строка	Устарело, пожалуйста, переименуйте на log_format. Формат загружаемых файлов логов. native - Нативный формат text - Текстовый формат csv - CSV Варианты: `"native"` `"text"` `"csv"`
min целое	График ротации логов
password любой	(список) Пароль для входа на сервер загрузки.

END_OF_DOCUMENT_MARKER ```

password2 any	(list) Пароль входа на сервер загрузки 2.
password3 any	(list) Пароль входа на сервер загрузки 3.
port integer	Номер порта IP1 сервера загрузки.
port2 integer	Номер порта IP2 сервера загрузки.
port3 integer	Номер порта IP3 сервера загрузки.
rolling-upgrade-status integer	Устарело, пожалуйста, переименуйте на rolling_upgrade_status. Статус обновления с постепенным повышением.
server string	FQDN/IP сервера загрузки.
server-type string	Устарело, пожалуйста, переименуйте на server_type. Тип сервера загрузки. ftp - Загрузка по FTP. sftp - Загрузка по SFTP. scp - Загрузка по SCP. Варианты: `"ftp"` `"sftp"` `"scp"`
server2 string	FQDN/IP сервера загрузки 2.
server3 string	FQDN/IP сервера загрузки 3.
upload string	Включить/выключить загрузку логов. disable - Выключить загрузку логов. enable - Включить загрузку логов. Варианты: `"disable"` `"enable"`
upload-hour integer	Устарело, пожалуйста, переименуйте на upload_hour. Расписание загрузки логов.
upload-mode string	Устарело, пожалуйста, переименуйте на upload_mode. Режим загрузки с несколькими серверами. backup - Сервера пытаются подключиться один за другим при неудаче. mirror - Все настроенные сервера пытаются подключиться. Варианты: `"backup"` `"mirror"`
upload-trigger string	Устарело, пожалуйста, переименуйте на upload_trigger. Событие, вызывающее загрузку логов. 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_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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Log rolling policy for device logs.
      fortinet.fortimanager.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: <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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в playbook, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_system_log_settings_rollingregular_module.html