Spec-Zone.ru › Ansible

Модуль fortinet.fortimanager.fmgr_system_admin_user_dashboard — пользовательские виджеты панели мониторинга.

Примечание

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

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

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

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

Добавлено в 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 / elements=integer

Список кодов rc, с помощью которого переопределяются условия завершения с ошибкой.

rc_succeeded

list / elements=integer

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

state

string / обязательный

Инструкция для создания, обновления или удаления объекта.

Варианты:

  • "present"
  • "absent"

system_admin_user_dashboard

dictionary

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

column

integer

Идентификатор столбца виджетов.

diskio_content_type

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

string

Тип диаграммы виджета мониторинга ввода-вывода диска.

util — использование пропускной способности.

iops — количество запросов ввода-вывода.

blks — объем данных запросов ввода-вывода.

Варианты:

  • "util"
  • "iops"
  • "blks"

diskio_period

псевдонимы: diskio-period

string

Период данных виджета мониторинга ввода-вывода диска.

1hour — 1 час.

8hour — 8 часов.

24hour — 24 часа.

Варианты:

  • "1hour"
  • "8hour"
  • "24hour"

log_rate_period

псевдонимы: log-rate-period

string

Период данных виджетов мониторинга приема журналов.

2min — 2 минуты.

1hour — 1 час.

6hours — 6 часов.

Варианты:

  • "2min"
  • "1hour"
  • "6hours"

log_rate_topn

псевдонимы: log-rate-topn

string

Количество элементов, отображаемых в виджетах мониторинга приема журналов.

1 — первые 1.

2 — первые 2.

3 — первые 3.

4 — первые 4.

5 — первые 5.

Варианты:

  • "1"
  • "2"
  • "3"
  • "4"
  • "5"

log_rate_type

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

string

Варианты разбивки статистики в виджетах мониторинга приема журналов.

log — отображать скорость приема журналов для каждого типа журнала.

device — отображать скорость приема журналов для каждого устройства.

Варианты:

  • "log"
  • "device"

moduleid

integer / обязательный

Идентификатор виджета.

name

string

Название виджета.

num_entries

псевдонимы: num-entries

integer

Количество записей.

refresh_interval

псевдонимы: refresh-interval

integer

Интервал обновления виджетов.

res_cpu_display

псевдонимы: res-cpu-display

string

Тип отображения ЦП в виджетах.

average — среднее использование ЦП.

each — использование каждого ядра ЦП.

Варианты:

  • "average"
  • "each"

res_period

псевдонимы: res-period

string

Период данных виджетов.

10min — последние 10 минут.

hour — последний час.

day — последний день.

Варианты:

  • "10min"
  • "hour"
  • "day"

res_view_type

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

string

Тип представления данных виджетов.

real-time — представление в реальном времени.

history — представление истории.

Варианты:

  • "real-time"
  • "history"

status

string

Состояние виджета: открыт или закрыт.

close — виджет закрыт.

open — виджет открыт.

Варианты:

  • "close"
  • "open"

tabid

integer

Идентификатор вкладки, на которой отображается виджет.

time_period

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

string

Период данных виджетов мониторинга базы данных журналов.

1hour — 1 час.

8hour — 8 часов.

24hour — 24 часа.

Варианты:

  • "1hour"
  • "8hour"
  • "24hour"

widget_type

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

string

Тип виджета.

top-lograte — монитор приема журналов.

sysres — системные ресурсы.

sysinfo — сведения о системе.

licinfo — сведения о лицензии.

jsconsole — консоль CLI.

sysop — работа устройства.

alert — консоль сообщений оповещений.

statistics — статистика.

rpteng — механизм отчетов.

raid — монитор дисков.

logrecv — полученные журналы/данные.

devsummary — сводка по устройству.

logdb-perf — монитор производительности базы данных журналов.

logdb-lag — задержка базы данных журналов.

disk-io — ввод-вывод диска.

log-rcvd-fwd — монитор приема и пересылки журналов.

Варианты:

  • "top-lograte"
  • "sysres"
  • "sysinfo"
  • "licinfo"
  • "jsconsole"
  • "sysop"
  • "alert"
  • "statistics"
  • "rpteng"
  • "raid"
  • "logrecv"
  • "devsummary"
  • "logdb-perf"
  • "logdb-lag"
  • "disk-io"
  • "log-rcvd-fwd"

user

string / обязательный

Параметр (user) в запрашиваемом URL.

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.
  • Для создания или обновления объекта используйте директиву state present.
  • Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Custom dashboard widgets.
      fortinet.fortimanager.fmgr_system_admin_user_dashboard:
        bypass_validation: false
        user: ansible-test
        state: present
        system_admin_user_dashboard:
          column: 1
          diskio_content_type: util # <value in [util, iops, blks]>
          diskio_period: 1hour # <value in [1hour, 8hour, 24hour]>
          log_rate_period: 1hour # <value in [2min , 1hour, 6hours]>
          log_rate_topn: 5 # <value in [1, 2, 3, ...]>
          log_rate_type: device # <value in [log, device]>
          moduleid: 10
          name: ansible-test-dashboard
          num_entries: 10
          refresh_interval: 0
          res_cpu_display: "each" # <value in [average , each]>
          res_period: 10min # <value in [10min , hour, day]>
          res_view_type: history # <value in [real-time , history]>
          status: open # <value in [close, open]>
          tabid: 1
          time_period: 1hour # <value in [1hour, 8hour, 24hour]>
          widget_type: sysres # <value in [top-lograte, sysres, sysinfo, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the dashboard widgets
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "system_admin_user_dashboard"
          params:
            user: "ansible-test"
            dashboard: "your_value"

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

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

Ключ

Описание

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_admin_user_dashboard_module.html

Spec-Zone.ru

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