Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_system_sso_admin — настройка пользователей SSO-администраторов в Fortinet FortiOS и FortiGate.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для работы с этим модулем также потребуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_sso_admin.

Добавлено в fortinet.fortios 2.0.0

  • Описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системной функции и категории sso_admin. Примеры включают все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием. Проверено с FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым нужно выполнить операцию.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр member_path можно использовать для выполнения операции с элементом.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

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

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

system_sso_admin

dictionary

Настройка пользователей SSO-администраторов.

accprofile

string

Профиль доступа пользователя SSO-администратора. Источник: system.accprofile.name.

gui_dashboard

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

Панели мониторинга графического интерфейса.

columns

integer

Количество столбцов.

id

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

Идентификатор панели мониторинга. См. <a href=’#notes’>примечания</a>.

layout_type

string

Тип макета.

Варианты:

  • "responsive"
  • "fixed"

name

string

Название панели мониторинга.

permanent

string

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

Варианты:

  • "disable"
  • "enable"

vdom

string

Виртуальный домен. Источник: system.vdom.name.

widget

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

Виджеты панели мониторинга.

fabric_device

string

Устройство Fabric для мониторинга.

fabric_device_widget_name

string

Название виджета устройства Fabric.

fabric_device_widget_visualization_type

string

Тип визуализации для виджета устройства Fabric.

fortiview_device

string

Устройство FortiView.

fortiview_filters

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

Фильтры FortiView.

id

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

Идентификатор фильтра FortiView. См. <a href=’#notes’>примечания</a>.

key

string

Ключ фильтра.

value

string

Значение фильтра.

fortiview_sort_by

string

Поле сортировки FortiView.

fortiview_timeframe

string

Временной интервал FortiView.

fortiview_type

string

Тип FortiView.

fortiview_visualization

string

Визуализация FortiView.

height

integer

Высота.

id

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

Идентификатор виджета. См. <a href=’#notes’>примечания</a>.

industry

string

Отрасль для оценки аудита безопасности.

Варианты:

  • "default"
  • "custom"

interface

string

Интерфейс для мониторинга. Источник: system.interface.name.

region

string

Регион для оценки аудита безопасности.

Варианты:

  • "default"
  • "custom"

title

string

Заголовок виджета.

type

string

Тип виджета.

Варианты:

  • "sysinfo"
  • "licinfo"
  • "forticloud"
  • "cpu-usage"
  • "memory-usage"
  • "disk-usage"
  • "log-rate"
  • "sessions"
  • "session-rate"
  • "tr-history"
  • "analytics"
  • "usb-modem"
  • "admins"
  • "security-fabric"
  • "security-fabric-ranking"
  • "sensor-info"
  • "ha-status"
  • "vulnerability-summary"
  • "host-scan-summary"
  • "fortiview"
  • "botnet-activity"
  • "fabric-device"

width

integer

Ширина.

x_pos

integer

Позиция по оси X.

y_pos

integer

Позиция по оси Y.

gui_global_menu_favorites

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

Идентификаторы избранных пунктов меню графического интерфейса для глобального VDOM.

id

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

Выберите идентификатор пункта меню.

gui_ignore_release_overview_version

string

Версия FortiOS, для которой следует игнорировать запрос с обзором выпуска.

gui_new_feature_acknowledge

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

Подтверждение ознакомления с новыми функциями.

id

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

Выберите идентификатор пункта меню.

gui_vdom_menu_favorites

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

Идентификаторы избранных пунктов меню графического интерфейса для VDOM.

id

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

Выберите идентификатор пункта меню.

name

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

Имя SSO-администратора.

vdom

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

Виртуальные домены, к которым администратор может получить доступ.

name

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

Имя виртуального домена. Источник: system.vdom.name.

vdom

string

Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure SSO admin users.
  fortinet.fortios.fortios_system_sso_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sso_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          gui_dashboard:
              -
                  columns: "10"
                  id: "6"
                  layout_type: "responsive"
                  name: "default_name_8"
                  permanent: "disable"
                  vdom: "<your_own_value> (source system.vdom.name)"
                  widget:
                      -
                          fabric_device: "<your_own_value>"
                          fabric_device_widget_name: "<your_own_value>"
                          fabric_device_widget_visualization_type: "<your_own_value>"
                          fortiview_device: "<your_own_value>"
                          fortiview_filters:
                              -
                                  id: "17"
                                  key: "<your_own_value>"
                                  value: "<your_own_value>"
                          fortiview_sort_by: "<your_own_value>"
                          fortiview_timeframe: "<your_own_value>"
                          fortiview_type: "<your_own_value>"
                          fortiview_visualization: "<your_own_value>"
                          height: "25"
                          id: "25"
                          industry: "default"
                          interface: "<your_own_value> (source system.interface.name)"
                          region: "default"
                          title: "<your_own_value>"
                          type: "sysinfo"
                          width: "25"
                          x_pos: "500"
                          y_pos: "500"
          gui_global_menu_favorites:
              -
                  id: "35"
          gui_ignore_release_overview_version: "<your_own_value>"
          gui_new_feature_acknowledge:
              -
                  id: "38"
          gui_vdom_menu_favorites:
              -
                  id: "40"
          name: "default_name_41"
          vdom:
              -
                  name: "default_name_43 (source system.vdom.name)"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

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

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

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

Пример: "PUT"

http_status

string

Последний результат, возвращенный FortiGate при выполнении последней операции

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

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

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

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

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

Пример: "webfilter"

revision

string

Внутренний номер ревизии

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

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

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

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

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

Пример: "success"

vdom

string

Используемый виртуальный домен

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

Пример: "root"

version

string

Версия FortiGate

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

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

© 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_system_sso_admin_module.html

Spec-Zone.ru

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