Модуль fortinet.fortimanager.fmgr_system_locallog_disk_setting – Настройки для журнализации на локальный диск.

Примечание

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

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

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

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

Новая функция в 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_locallog_disk_setting словарь	Настройка параметров верхнего уровня.
diskfull строка	Политика, применяемая при заполнении диска. overwrite - Перезапись старейшего журнала при заполнении диска. nolog - Остановка ведения журнала при заполнении диска. Варианты: `"overwrite"` `"nolog"`
log_disk_full_percentage целое число	Устарело, пожалуйста, переименуйте на log_disk_full_percentage. Считает диск заполненным при данном проценте использования.
log_disk_quota целое число	Устарело, пожалуйста, переименуйте на log_disk_quota. Квота для управления размером локального журнала.
max_log_file_num целое число	Устарело, пожалуйста, переименуйте на max_log_file_num. Максимальное количество файлов журнала перед переходом к новой записи.
max_log_file_size целое число	Устарело, пожалуйста, переименуйте на max_log_file_size. Максимальный размер файла журнала перед переходом к новой записи.
roll_day список / элементы=строка	Устарело, пожалуйста, переименуйте на roll_day. Дни недели для перехода к новой записи в журналах. sunday - Воскресенье. monday - Понедельник. tuesday - Вторник. wednesday - Среда. thursday - Четверг. friday - Пятница. saturday - Суббота. Варианты: `"sunday"` `"monday"` `"tuesday"` `"wednesday"` `"thursday"` `"friday"` `"saturday"`
roll_schedule строка	Устарело, пожалуйста, переименуйте на roll_schedule. Частота проверки файла журнала для перехода к новой записи. none - Без расписания. daily - Ежедневно. weekly - Еженедельно. Варианты: `"none"` `"daily"` `"weekly"`
roll_time любое	(список или строка) Устарело, пожалуйста, переименуйте на roll_time. Время перехода к новой записи в журналах.
server_type строка	Устарело, пожалуйста, переименуйте на server_type. Тип сервера. FTP - Загрузка через FTP. SFTP - Загрузка через SFTP. SCP - Загрузка через SCP. Варианты: `"FTP"` `"SFTP"` `"SCP"`

severity string	Минимальный уровень серьезности для регистрации. emergency - Уровень аварийной ситуации. alert - Уровень оповещения. critical - Критический уровень. error - Уровень ошибки. warning - Уровень предупреждения. notification - Уровень уведомления. information - Информационный уровень. debug - Уровень отладки. Варианты: `"emergency"` `"alert"` `"critical"` `"error"` `"warning"` `"notification"` `"information"` `"debug"`
status string	Включить/выключить локальный лог на диск. disable - Не регистрировать на локальный диск. enable - Регистрировать на локальный диск. Варианты: `"disable"` `"enable"`
upload string	Загрузить файл лога при переполнении. disable - Отключить загрузку при переполнении файла лога. enable - Включить загрузку при переполнении файла лога. Варианты: `"disable"` `"enable"`
upload-delete-files string	Устарело, пожалуйста, переименуйте в upload_delete_files. Удалить файлы логов после загрузки disable - Не удалять файлы логов после загрузки. enable - Удалить файлы логов после загрузки. Варианты: `"disable"` `"enable"`
upload-time any	(list or str) Устарело, пожалуйста, переименуйте в upload_time. Время загрузки логов
uploaddir string	Удаленный каталог загрузки файлов логов.
uploadip string	IP-адрес сервера загрузки логов.
uploadpass any	(list) Пароль учетной записи пользователя на сервере загрузки.
uploadport integer	Порт сервера
uploadsched string	Плановая загрузка disable - Загрузка при переполнении. enable - Плановая загрузка. Варианты: `"disable"` `"enable"`
uploadtype list / elements=string	Типы файлов логов, которые необходимо загрузить. event - Загрузить лог событий. Варианты: `"event"`
uploaduser string	Учетная запись пользователя на сервере загрузки.
uploadzip string	Сжать загружаемые логи. disable - Загружать файлы логов как обычный текст. enable - Загружать файлы логов в сжатом виде. Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM для блокировки для FortiManager, работающего в режиме рабочей области; значение может быть global и другие, включая 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_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: Settings for local disk logging.
      fortinet.fortimanager.fmgr_system_locallog_disk_setting:
        # 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_locallog_disk_setting:
          diskfull: <value in [overwrite, nolog]>
          log_disk_full_percentage: <integer>
          max_log_file_size: <integer>
          roll_day:
            - sunday
            - monday
            - tuesday
            - wednesday
            - thursday
            - friday
            - saturday
          roll_schedule: <value in [none, daily, weekly]>
          roll_time: <list or string>
          server_type: <value in [FTP, SFTP, SCP]>
          severity: <value in [emergency, alert, critical, ...]>
          status: <value in [disable, enable]>
          upload: <value in [disable, enable]>
          upload_delete_files: <value in [disable, enable]>
          upload_time: <list or string>
          uploaddir: <string>
          uploadip: <string>
          uploadpass: <list or string>
          uploadport: <integer>
          uploadsched: <value in [disable, enable]>
          uploadtype:
            - event
          uploaduser: <string>
          uploadzip: <value in [disable, enable]>
          log_disk_quota: <integer>
          max_log_file_num: <integer>

Значения возврата

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

Ключ	Описание
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_locallog_disk_setting_module.html