Модуль fortinet.fortios.fortios_system_sso_forticloud_admin — настройка пользователей-администраторов FortiCloud 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_forticloud_admin.

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

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

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системных функций и категории sso_forticloud_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_forticloud_admin dictionary	Настройка пользователей-администраторов FortiCloud SSO.
accprofile string	Профиль доступа пользователя-администратора FortiCloud SSO. Без лицензии FortiGate Cloud Central Management разрешение устанавливается только для чтения. Источник: system.accprofile.name.
name string / обязательный	Имя администратора FortiCloud SSO.
vdom list / элементы=dictionary	Виртуальные домены, к которым администратор может получить доступ.
name string / обязательный	Имя виртуального домена. Источник: system.vdom.name.
vdom string	Виртуальный домен из числа определённых ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure FortiCloud SSO admin users.
  fortinet.fortios.fortios_system_sso_forticloud_admin:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sso_forticloud_admin:
          accprofile: "<your_own_value> (source system.accprofile.name)"
          name: "default_name_4"
          vdom:
              -
                  name: "default_name_6 (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_forticloud_admin_module.html