Модуль fortinet.fortimanager.fmgr_system_log_settings_rollinglocal – Политика архивирования логов для локальных журналов.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к 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_rollinglocal словарь	Установленные параметры верхнего уровня.
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 строка	IP2-адрес сервера загрузки.
ip3 строка	IP3-адрес сервера загрузки.
log-format строка	Устаревшее, пожалуйста, переименуйте на log_format. Формат загружаемых лог-файлов. native - Нативный формат text - Текстовый формат csv - CSV Варианты: `"native"` `"text"` `"csv"`
min целое число	Расписание для архивации лог-файлов
password любой тип	(список) Пароль для входа на сервер загрузки.

END_OF_DOCUMENT_MARKER

password2 any	(список) Пароль входа на сервер загрузки2.
password3 any	(список) Пароль входа на сервер загрузки3.
port целое число	Номер порта IP1 сервера загрузки.
port2 целое число	Номер порта IP2 сервера загрузки.
port3 целое число	Номер порта IP3 сервера загрузки.
rolling-upgrade-status целое число	Устарело, пожалуйста, переименуйте на rolling_upgrade_status. Статус обновления с постепенной заменой.
server строка	FQDN/IP сервера загрузки.
server-type строка	Устарело, пожалуйста, переименуйте на server_type. Тип сервера загрузки. ftp - Загрузка через FTP. sftp - Загрузка через SFTP. scp - Загрузка через SCP. Выбор: `"ftp"` `"sftp"` `"scp"`
server2 строка	FQDN/IP сервера загрузки2.
server3 строка	FQDN/IP сервера загрузки3.
upload строка	Включить/выключить загрузку логов. disable - Выключить загрузку логов. enable - Включить загрузку логов. Выбор: `"disable"` `"enable"`
upload-hour целое число	Устарело, пожалуйста, переименуйте на upload_hour. Расписание загрузки логов.
upload-mode строка	Устарело, пожалуйста, переименуйте на upload_mode. Режим загрузки с несколькими серверами. backup - Серверы пробуются и используются по очереди при ошибках подключения. mirror - Все настроенные серверы пробуются и используются. Выбор: `"backup"` `"mirror"`
upload-trigger строка	Устарело, пожалуйста, переименуйте на upload_trigger. Событие, запускающее загрузку логов. on-roll - Загрузка логов после их сжатия. on-schedule - Загрузка логов ежедневно. Выбор: `"on-roll"` `"on-schedule"`
username строка	Имя пользователя входа на сервер загрузки.
username2 строка	Имя пользователя входа на сервер загрузки2.
username3 строка	Имя пользователя входа на сервер загрузки3.
when строка	Регулярное сжатие логов. none - Не сжимать лог файлы периодически. daily - Сжимать лог файлы ежедневно. weekly - Сжимать лог файлы в определённые дни недели. Выбор: `"none"` `"daily"` `"weekly"`
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `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 local logs.
      fortinet.fortimanager.fmgr_system_log_settings_rollinglocal:
        # 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_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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Дескриптивное сообщение ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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_rollinglocal_module.html