Модуль fortinet.fortios.fortios_user_adgrp — настройка групп FSSO в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные зависимости; подробности см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: fortinet.fortios.fortios_user_adgrp.
Добавлено в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции user и категории adgrp. В примерах представлены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0
Требования
На хосте, который выполняет этот модуль, должны быть соблюдены следующие требования.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate. |
enable_log логическое значение | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту участника, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются косой чертой. Параметр member_path предназначен для выполнения операций с участниками. |
member_state строка | Добавить или удалить участника по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state строка / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
user_adgrp словарь | Настройка групп FSSO. |
|
connector_source строка |
Источник коннектора FSSO. |
|
id целое число |
Идентификатор группы. |
|
name строка / обязательный |
Имя. |
|
server_name строка |
Имя агента FSSO. Источник: user.fsso.name. |
vdom строка | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска сценариев — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Configure FSSO groups.
fortinet.fortios.fortios_user_adgrp:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_adgrp:
connector_source: "<your_own_value>"
id: "4"
name: "default_name_5"
server_name: "<your_own_value> (source user.fsso.name)"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method строка | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: |
name строка | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Результат операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_user_adgrp_module.html
