fortinet.fortimanager.fmgr_system_log_interfacestats module – Настройки статистики интерфейсов.

Примечание

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

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

Чтобы установить ее, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать ее в плейбуке, укажите: fortinet.fortimanager.fmgr_system_log_interfacestats.

Добавлено в fortinet.fortimanager 2.1.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 / elements=integer	Список кодов rc, переопределяющий условия возникновения ошибки.
rc_succeeded list / elements=integer	Список кодов rc, переопределяющий условия успешного выполнения.
system_log_interfacestats dictionary	Параметры верхнего уровня.
billing_report псевдонимы: billing-report string	Отключение или включение функции отчетов по выставлению счетов. disable — отключить отчеты по выставлению счетов. enable — включить отчеты по выставлению счетов. Возможные значения: `"disable"` `"enable"`
retention_days псевдонимы: retention-days integer	Количество дней хранения данных интерфейсов.
sampling_interval псевдонимы: sampling-interval integer	Интервал получения данных об интерфейсах от FortiGate, в секундах.
status 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: Interface statistics settings.
      fortinet.fortimanager.fmgr_system_log_interfacestats:
        # workspace_locking_adom: <global or your adom name>
        system_log_interfacestats:
          # retention_days: <integer>
          # sampling_interval: <integer>
          # status: <value in [disable, enable]>
          # billing_report: <value in [disable, enable]>

Возвращаемые значения

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Состояние запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Состояние запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=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_log_interfacestats_module.html