fortinet.fortios.fortios_user_device_group – Настройка групп устройств в FortiOS и FortiGate Fortinet.
Примечание
Этот плагин входит в коллекцию fortinet.fortios (версия 1.1.8).
Для его установки используйте: ansible-galaxy collection install fortinet.fortios.
Для использования в книге задач укажите: fortinet.fortios.fortios_user_device_group.
Новое в версии 2.9: плагина fortinet.fortios
Обзор
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять категорию функций пользователя и группы устройств. Примеры включают в себя все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0.
Требования
Ниже перечислены требования, необходимые на хосте, на котором выполняется этот модуль.
- ansible>=2.9.0
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| access_token строка | Аутентификация на основе токенов. Сгенерировано из графического интерфейса Fortigate. | ||||
| state строка / обязательный |
| Указывает, нужно ли создать или удалить объект. | |||
| user_device_group словарь | Настройка групп устройств. | ||||
| comment строка | Комментарий. | ||||
| member список / элементы=строка | Член группы устройств. | ||||
| name строка / обязательный | Имя устройства. Имя пользователя из поля user.device.alias или user.device-category.name. | ||||
| name строка / обязательный | Имя группы устройств. | ||||
| tagging список / элементы=строка | Тегирование конфигурационного объекта. | ||||
| category строка | Категория тега. Источник system.object-tagging.category. | ||||
| name строка / обязательный | Имя записи тегирования. | ||||
| tags список / элементы=строка | Теги. | ||||
| name строка / обязательный | Имя тега. Источник system.object-tagging.tags.name. | ||||
| vdom строка | По умолчанию: "root" | Виртуальная область, среди тех, что определены ранее. VDOM — это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. | |||
Примечания
Примечание
- Устаревший fortiosapi был устаревшим, 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 device groups.
fortios_user_device_group:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
user_device_group:
comment: "Comment."
member:
-
name: "default_name_5 (source user.device.alias user.device-category.name)"
name: "default_name_6"
tagging:
-
category: "<your_own_value> (source system.object-tagging.category)"
name: "default_name_9"
tags:
-
name: "default_name_11 (source system.object-tagging.tags.name)"
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_group_module.html