Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр

Комментарии

access_token

строка

Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate.

enable_log

булево

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

Варианты:

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

member_path

строка

Путь к атрибуту члена для обработки.

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

Параметр, помеченный member_path, является допустимым для выполнения операции с членом.

member_state

строка

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

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

Варианты:

  • "present"
  • "absent"

state

строка / обязательно

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

Варианты:

  • "present"
  • "absent"

system_sso_admin

словарь

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

accprofile

строка

Профиль доступа пользователя SSO администратора. Имя системы.accprofile.

gui_dashboard

список / элементы=словарь

Графические панели.

columns

целое число

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

id

целое число / обязательно

ID панели. см. <a href=’#notes’>Примечания</a>.

layout_type

строка

Тип макета.

Варианты:

  • "responsive"
  • "fixed"

name

строка

Название панели.

permanent

строка

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

Варианты:

  • "disable"
  • "enable"

vdom

строка

Виртуальная область. Имя системы.vdom.

widget

список / элементы=словарь

Виджеты панели.

fabric_device

строка

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

fabric_device_widget_name

строка

Имя виджета устройства Fabric.

fabric_device_widget_visualization_type

строка

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

fortiview_device

строка

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

fortiview_filters

список / элементы=словарь

Фильтры FortiView.

id

целое число / обязательно

ID фильтра FortiView. см. <a href=’#notes’>Примечания</a>.

key

строка

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

value

строка

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

fortiview_sort_by

строка

Сортировка FortiView.

fortiview_timeframe

строка

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

fortiview_type

строка

Тип FortiView.

fortiview_visualization

строка

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

height

целое число

Высота.

id

целое число / обязательно

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

industry

строка

Отрасль рейтинга аудита безопасности.

Варианты:

  • "default"
  • "custom"

interface

строка

Интерфейс для мониторинга. Имя интерфейса целевой системы.

region

строка

Регион рейтинга аудита безопасности.

Варианты:

  • "default"
  • "custom"

title

строка

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

type

строка

Тип виджета.

Варианты:

  • "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

целое число

Ширина.

x_pos

целое число

Положение по оси X.

y_pos

целое число

Положение по оси Y.

gui_global_menu_favorites

список / элементы=словарь

Идентификаторы избранных меню глобального VDOM.

id

строка / обязательно

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

gui_ignore_release_overview_version

строка

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

gui_new_feature_acknowledge

список / элементы=словарь

Подтверждение новых функций.

id

строка / обязательно

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

gui_vdom_menu_favorites

список / элементы=словарь

Идентификаторы избранных меню GUI для VDOM.

id

строка / обязательно

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

name

строка / обязательно

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

vdom

список / элементы=словарь

Виртуальная(ые) область(и), к которой(ым) имеет доступ администратор.

name

string / required

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

vdom

string

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

Default: "root"

Примечания

Примечание

  • Устаревший fortiosapi был заменен, httpapi — предпочтительный способ запуска playbook'ов
  • Модуль поддерживает 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

Мастер-ключ (id), использованный в последнем вызове 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_sso_admin_module.html

Spec-Zone.ru

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