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

Новая функция в fortinet.fortios 2.0.0

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

Обзор

Этот модуль может настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять параметры пользователей и категории устройств. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с 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"`
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"`

Примечания

Примечание

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