fortios_user_device – Настройка устройств в Fortinet FortiOS и FortiGate

Новое в версии 2.9.

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

Обзор

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

Требования

Ниже приведены требования к хосту, на котором выполняется этот модуль.

fortiosapi>=0.9.8

Параметры

Параметр				Варианты/Значения по умолчанию	Комментарии
host строка					IP-адрес FortiOS или FortiGate.
https логический				Варианты: нет да ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password строка				Значение по умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify логический				Варианты: нет да ←	Обеспечивает проверку сертификата FortiGate надёжным центром сертификации.
state строка / обязательно				Варианты: present absent	Указывает, нужно ли создать или удалить объект.
user_device словарь				Значение по умолчанию: null	Настройка устройств.
	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 строка				Имя пользователя.
username строка					Имя пользователя FortiOS или FortiGate.
vdom строка				Значение по умолчанию: "root"	Виртуальный домен, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Выполняется как local_action в вашем playbook

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure devices.
    fortios_user_device:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      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 строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Данный модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_user_device_module.html