Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_locallog_disk_setting – настройки локального журналирования на диск.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.14.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

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 / элементы=integer

Список кодов rc, которыми переопределяются условия возникновения ошибки.

rc_succeeded

list / элементы=integer

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

system_locallog_disk_setting

dictionary

Набор параметров верхнего уровня.

diskfull

string

Политика, применяемая при заполнении диска.

overwrite — перезаписывать старейшую запись журнала при заполнении диска.

nolog — прекращать ведение журнала при заполнении диска.

Варианты:

  • "overwrite"
  • "nolog"

log_disk_full_percentage

псевдонимы: log-disk-full-percentage

integer

Считать диск для журналов заполненным при достижении этого процента использования.

log_disk_quota

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

integer

Квота для ограничения размера локального журнала.

max_log_file_num

псевдонимы: max-log-file-num

integer

Максимальное количество файлов журнала до их ротации.

max_log_file_size

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

integer

Максимальный размер файла журнала до его ротации.

roll_day

псевдонимы: roll-day

list / элементы=string

Дни недели для ротации журналов.

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

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

tuesday — вторник.

wednesday — среда.

thursday — четверг.

friday — пятница.

saturday — суббота.

Варианты:

  • "sunday"
  • "monday"
  • "tuesday"
  • "wednesday"
  • "thursday"
  • "friday"
  • "saturday"

roll_schedule

псевдонимы: roll-schedule

string

Частота проверки файла журнала для ротации.

none — без расписания.

daily — ежедневно.

weekly — еженедельно.

Варианты:

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

roll_time

псевдонимы: roll-time

any

(список или строка) Время ротации журналов

server_type

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

string

Тип сервера.

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

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

string

Удалять файлы журналов после загрузки.

disable — не удалять файлы журналов после загрузки.

enable — удалять файлы журналов после загрузки.

Варианты:

  • "disable"
  • "enable"

upload_time

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

any

(список или строка) Время загрузки журналов

uploaddir

string

Удалённый каталог для загрузки файлов журнала.

uploadip

string

IP-адрес сервера для загрузки журналов.

uploadpass

any

(список) Пароль учётной записи пользователя на сервере загрузки.

uploadport

integer

Порт сервера

uploadsched

string

Запланированная загрузка

disable — загружать при ротации.

enable — запланированная загрузка.

Варианты:

  • "disable"
  • "enable"

uploadtype

list / элементы=string

Типы файлов журналов, которые необходимо загрузить.

event — загрузить журнал событий.

Варианты:

  • "event"

uploaduser

string

Учётная запись пользователя на сервере загрузки.

uploadzip

string

Сжимать загружаемые журналы.

disable — загружать файлы журналов в виде обычного текста.

enable — загружать сжатые файлы журналов.

Варианты:

  • "disable"
  • "enable"

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: Settings for local disk logging.
      fortinet.fortimanager.fmgr_system_locallog_disk_setting:
        # workspace_locking_adom: <global or your adom name>
        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

dictionary

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

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

request_url

string

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

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

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

response_code

integer

Статус запроса к API.

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

Пример: 0

response_data

list / элементы=string

Ответ API.

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

response_message

string

Текстовое описание ответа API.

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

Пример: "OK."

system_information

dictionary

Сведения о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / элементы=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_locallog_disk_setting_module.html

Spec-Zone.ru

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