Модуль fortinet.fortios.fortios_user_device — настройка устройств в 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_device.

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

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

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

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции над элементом.
member_state строка	Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
user_device словарь	Настройка устройств.
alias строка / обязательный	Псевдоним устройства.
avatar строка	Файл изображения для аватара (максимум 4 КБ в кодировке Base64).
category строка	Семейство. Варианты: `"none"` `"amazon-device"` `"android-device"` `"blackberry-device"` `"fortinet-device"` `"ios-device"` `"windows-device"`
comment строка	Комментарий.
mac строка	MAC-адрес устройства.
master_device строка	Главное устройство (необязательно). Источник: user.device.alias.
tagging список / элементы=словарь	Настройка тегов объекта конфигурации.
category строка	Категория тегов. Источник: system.object-tagging.category.
name строка / обязательный	Имя записи тегирования.
tags список / элементы=словарь	Теги.
name строка / обязательный	Имя тега. Источник: system.object-tagging.tags.name.
type строка	Тип. Варианты: `"unknown"` `"android-phone"` `"android-tablet"` `"blackberry-phone"` `"blackberry-playbook"` `"forticam"` `"fortifone"` `"fortinet-device"` `"gaming-console"` `"ip-phone"` `"ipad"` `"iphone"` `"linux-pc"` `"mac"` `"media-streaming"` `"printer"` `"router-nat-device"` `"windows-pc"` `"windows-phone"` `"windows-tablet"` `"other-network-device"`
user строка	Имя пользователя.
vdom строка	Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Configure devices.
  fortinet.fortios.fortios_user_device:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      user_device:
          alias: "<your_own_value>"
          avatar: "<your_own_value>"
          category: "none"
          comment: "Comment."
          mac: "<your_own_value>"
          master_device: "<your_own_value> (source user.device.alias)"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_11"
                  tags:
                      -
                          name: "default_name_13 (source system.object-tagging.tags.name)"
          type: "unknown"
          user: "<your_own_value>"

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

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

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращенный FortiGate для последней выполненной операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат операции Возвращается: всегда Пример: `"success"`
vdom строка	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия 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_user_device_module.html