Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer – Политика архивирования журналов анализатора сети.

Примечание

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

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

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

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

Новая функция в 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_rollinganalyzer

словарь

Настройка параметров верхнего уровня.

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-адрес сервера загрузки (IP2).

ip3

строка

IP-адрес сервера загрузки (IP3).

log-format

строка

Устаревшее, пожалуйста, переименуйте на log_format.

Формат загружаемых файлов журнала.

native - Нативный формат

text - Текстовый формат

csv - CSV

Варианты:

  • "native"
  • "text"
  • "csv"

min

целое число

График ротации файлов журналов
END_OF_DOCUMENT_MARKER

password

any

(list) Пароль для входа на сервер загрузки.

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, работающего в режиме рабочей области; значение может быть 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. Вы также можете переопределить условия для неудачи или успеха с помощью параметров 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 Network Analyzer logs.
      fortinet.fortimanager.fmgr_system_log_settings_rollinganalyzer:
        # 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_rollinganalyzer:
          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_rollinganalyzer_module.html

Spec-Zone.ru

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