Модуль fortinet.fortios.fortios_log_disk_setting — настройки журналирования на локальный диск в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_log_disk_setting.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя функцию и категорию параметров log_disk. Перед использованием необходимо скорректировать все приведенные примеры параметров и значений в соответствии с источниками данных. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Описание |
|---|---|
access_token string | Аутентификация на основе токена. Токен создается в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
log_disk_setting dictionary | Настройки журналирования на локальный диск. |
|
diskfull string |
Действие при заполнении диска. Если диск заполнен, система может перезаписать самые старые сообщения журнала или остановить ведение журнала. Варианты:
|
|
dlp_archive_quota integer |
Квота архива DLP (МБ). |
|
full_final_warning_threshold integer |
Порог последнего предупреждения о заполнении журнала в процентах (3–100). |
|
full_first_warning_threshold integer |
Порог первого предупреждения о заполнении журнала в процентах (1–98). |
|
full_second_warning_threshold integer |
Порог второго предупреждения о заполнении журнала в процентах (2–99). |
|
interface string |
Укажите исходящий интерфейс для связи с сервером. Источник: system.interface.name. |
|
interface_select_method string |
Укажите способ выбора исходящего интерфейса для связи с сервером. Варианты:
|
|
ips_archive string |
Включить или отключить архивирование пакетов IPS на локальный диск. Варианты:
|
|
log_quota integer |
Квота журнала на диске (МБ). |
|
max_log_file_size integer |
Максимальный размер файла журнала перед ротацией (1–100 МБ). |
|
max_policy_packet_capture_size integer |
Максимальный размер файла захвата пакетов политики в МБ (0 означает отсутствие ограничений). |
|
maximum_log_age integer |
Удалять файлы журнала старше указанного числа дней. |
|
report_quota integer |
Квота базы данных отчетов (МБ). |
|
roll_day list / elements=string |
День недели, в который выполняется ротация файла журнала. Варианты:
|
|
roll_schedule string |
Периодичность проверки файла журнала для выполнения ротации. Варианты:
|
|
roll_time string |
Время суток для ротации файла журнала (чч:мм). |
|
source_ip string |
Исходный IP-адрес для загрузки файлов журнала с диска. |
|
status string |
Включить или отключить журналирование на локальный диск. Варианты:
|
|
upload string |
Включить или отключить загрузку файлов журнала после их ротации. Варианты:
|
|
upload_delete_files string |
Удалять файлы журнала после загрузки. Варианты:
|
|
upload_destination string |
Тип сервера для загрузки файлов журнала. В настоящее время поддерживается только FTP. Варианты:
|
|
upload_ssl_conn string |
Включить или отключить шифрование соединения FTPS для загрузки файлов журнала. Варианты:
|
|
uploaddir string |
Удаленный каталог на FTP-сервере, в который загружаются файлы журнала. |
|
uploadip string |
IP-адрес FTP-сервера, на который загружаются файлы журнала. |
|
uploadpass string |
Пароль для входа на FTP-сервер и загрузки файлов журнала с диска. |
|
uploadport integer |
Порт TCP для связи с FTP-сервером. |
|
uploadsched string |
Задайте расписание загрузки файлов журнала на FTP-сервер. Варианты:
|
|
uploadtime string |
Время суток, в которое загружаются файлы журнала, если включен uploadsched (чч:мм или чч). |
|
uploadtype list / elements=string |
Типы файлов журнала для загрузки. Разделяйте несколько значений пробелом. Варианты:
|
|
uploaduser string |
Имя пользователя для входа на FTP-сервер и загрузки файлов журнала с диска. |
|
vrf_select integer |
Идентификатор VRF для подключения к серверу. |
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, разделяйте их символом косой черты. Параметр с указанием member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути атрибута. Если указан member_state, параметр state игнорируется. Варианты:
|
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревшая библиотека fortiosapi объявлена устаревшей; предпочтительный способ запуска плейбуков — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Settings for local disk logging.
fortinet.fortios.fortios_log_disk_setting:
vdom: "{{ vdom }}"
log_disk_setting:
diskfull: "overwrite"
dlp_archive_quota: "0"
full_final_warning_threshold: "95"
full_first_warning_threshold: "75"
full_second_warning_threshold: "90"
interface: "<your_own_value> (source system.interface.name)"
interface_select_method: "auto"
ips_archive: "enable"
log_quota: "0"
max_log_file_size: "20"
max_policy_packet_capture_size: "100"
maximum_log_age: "7"
report_quota: "0"
roll_day: "sunday"
roll_schedule: "daily"
roll_time: "<your_own_value>"
source_ip: "84.230.14.43"
status: "enable"
upload: "enable"
upload_delete_files: "enable"
upload_destination: "ftp-server"
upload_ssl_conn: "default"
uploaddir: "<your_own_value>"
uploadip: "<your_own_value>"
uploadpass: "<your_own_value>"
uploadport: "21"
uploadsched: "disable"
uploadtime: "<your_own_value>"
uploadtype: "traffic"
uploaduser: "<your_own_value>"
vrf_select: "0"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращённый FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/fortios/fortios_log_disk_setting_module.html