fortinet.fortimanager.fmgr_user_device – Настройка устройств.
Примечание
Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_user_device.
В версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль может настраивать устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | ||||
| bypass_validation логическое значение |
| устанавливается только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров | |||
| rc_failed список / элементы=строка | список кодов rc, при которых условия для отказа будут переопределены | ||||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия для успеха будут переопределены | ||||
| state строка / обязательно |
| директива для создания, обновления или удаления объекта | |||
| user_device словарь | установленные параметры верхнего уровня | ||||
| alias строка | Псевдоним устройства. | ||||
| avatar строка | Файл изображения для аватара (максимум 4К в формате base64). | ||||
| category строка |
| Категория устройства. | |||
| comment строка | Комментарий. | ||||
| dynamic_mapping список / элементы=строка | нет описания | ||||
| _scope список / элементы=строка | нет описания | ||||
| name строка | нет описания | ||||
| vdom строка | нет описания | ||||
| avatar строка | нет описания | ||||
| category строка |
| нет описания | |||
| comment строка | нет описания | ||||
| mac строка | нет описания | ||||
| master-device строка | нет описания | ||||
| tags строка | нет описания | ||||
| type строка |
| нет описания | |||
| user строка | нет описания | ||||
| mac строка | MAC-адрес(ы) устройства. | ||||
| master-device строка | Главное устройство (необязательно). | ||||
| Тегирование список / элементы=строка | без описания | ||||
| Категория строка | Категория тега. | ||||
| Имя строка | Имя записи тегирования. | ||||
| Теги строка | без описания | ||||
| Тип строка |
| Тип устройства. | |||
| Пользователь строка | Имя пользователя. | ||||
| заблокированная_область_рабочей_среды строка | область, которую необходимо заблокировать для FortiManager, работающего в режиме рабочей среды. Значение может быть глобальным и другими, включая корень | ||||
| таймаут_блокировки_рабочей_среды целое число | По умолчанию: 300 | максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую среду | |||
Примечания
Примечание
- Режим блокировки рабочей среды поддерживается в данном модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в работе.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно модуль может завершиться неудачей, если возвращён ненулевой код. Вы также можете переопределить условия для завершения успехом или неудачей с помощью параметров rc_failed и rc_succeeded
Примеры
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure devices.
fmgr_user_device:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
state: <value in [present, absent]>
user_device:
alias: <value of string>
avatar: <value of string>
category: <value in [none, android-device, blackberry-device, ...]>
comment: <value of string>
dynamic_mapping:
-
_scope:
-
name: <value of string>
vdom: <value of string>
avatar: <value of string>
category: <value in [none, android-device, blackberry-device, ...]>
comment: <value of string>
mac: <value of string>
master-device: <value of string>
tags: <value of string>
type: <value in [ipad, iphone, gaming-console, ...]>
user: <value of string>
mac: <value of string>
master-device: <value of string>
tagging:
-
category: <value of string>
name: <value of string>
tags: <value of string>
type: <value in [ipad, iphone, gaming-console, ...]>
user: <value of string>
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| request_url строка | всегда | Полный запрашиваемый URL Пример: /sys/login/user |
| response_code целое число | всегда | Статус запроса API |
| response_message строка | всегда | Описание ответа API Пример: OK. |
Авторы
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_user_device_module.html
