fortinet.fortios.fortios_user_device – Настройка устройств в Fortinet FortiOS и FortiGate.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в книге задач укажите: fortinet.fortios.fortios_user_device.
Новое в версии 2.9: модуля fortinet.fortios
Обзор
- Этот модуль может настраивать устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять параметры функций пользователя и категорий устройств. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже приведены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| access_token строка | Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate. | ||||
| state строка / обязательно |
| Указывает, нужно ли создать или удалить объект. | |||
| user_device словарь | Настройка устройств. | ||||
| alias строка / обязательно | Псевдоним устройства. | ||||
| avatar строка | Изображение файла для аватара (максимум 4К в формате base64). | ||||
| category строка |
| Категория устройства. | |||
| comment строка | Комментарий. | ||||
| mac строка | MAC-адрес(а) устройства. | ||||
| master_device строка | Главное устройство (необязательно). Источник user.device.alias. | ||||
| tagging список / элементы=строка | Тегирование конфигурационного объекта. | ||||
| category строка | Категория тега. Источник system.object-tagging.category. | ||||
| name строка / обязательно | Имя записи тегирования. | ||||
| tags список / элементы=строка | Теги. | ||||
| name строка / обязательно | Имя тега. Источник system.object-tagging.tags.name. | ||||
| type строка |
| Тип устройства. | |||
| user строка | Имя пользователя. | ||||
| vdom строка | По умолчанию: "root" | Виртуальная область (vdom), определенная ранее. Vdom – это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. | |||
Примечания
Примечание
- Модуль fortiosapi устарел, предпочтительный способ запуска playbooks — httpapi
Примеры
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: Configure devices.
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 строка | всегда | Указание результата операции Пример: успех |
| 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/fortinet/fortios/fortios_user_device_module.html