Модуль fortinet.fortios.fortios_system_sso_forticloud_admin – Настройка администраторов FortiCloud SSO в FortiOS и FortiGate Fortinet.

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: fortinet.fortios.fortios_system_sso_forticloud_admin.

Впервые в fortinet.fortios 2.0.0

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

Описание

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

Примечания

Примечание

Модуль fortiosapi устарел, рекомендуемым способом выполнения playbooks является httpapi.

Примеры

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

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
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_forticloud_admin_module.html