Модуль fortinet.fortimanager.fmgr_user_device — настройка устройств.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_user_device.

Добавлено в fortinet.fortimanager 2.0.0

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

Обзор

Этот модуль позволяет настроить устройство FortiManager.
В примерах указаны все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрашиваемом URL.
bypass_validation boolean	Установите значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_device dictionary	Параметры верхнего уровня.
alias string / обязательный	Псевдоним устройства.
avatar string	Файл изображения для аватара
category string	Категория устройства. Варианты: `"none"` `"android-device"` `"blackberry-device"` `"fortinet-device"` `"ios-device"` `"windows-device"` `"amazon-device"`
comment string	Комментарий.
dynamic_mapping list / элементы=dictionary	Динамическое сопоставление.
_scope list / элементы=dictionary	Область действия.
name string	Имя.
vdom string	Vdom.
avatar string	Аватар.
category string	Категория. Варианты: `"none"` `"android-device"` `"blackberry-device"` `"fortinet-device"` `"ios-device"` `"windows-device"` `"amazon-device"`
comment string	Комментарий.
family string	Семейство.
hardware_vendor псевдонимы: hardware-vendor string	Производитель оборудования.
hardware_version псевдонимы: hardware-version string	Версия оборудования.
mac string	MAC-адрес.
master_device псевдонимы: master-device string	Главное устройство.
os string	ОС.
software_version псевдонимы: software-version string	Версия программного обеспечения.
tags any	(список или строка) Теги.
type string	Тип. Варианты: `"ipad"` `"iphone"` `"gaming-console"` `"blackberry-phone"` `"blackberry-playbook"` `"linux-pc"` `"mac"` `"windows-pc"` `"android-phone"` `"android-tablet"` `"media-streaming"` `"windows-phone"` `"fortinet-device"` `"ip-phone"` `"router-nat-device"` `"other-network-device"` `"windows-tablet"` `"printer"` `"forticam"` `"fortifone"` `"unknown"`
user string	Пользователь.
mac string	MAC-адрес устройства
master_device псевдонимы: master-device string	Главное устройство
tagging list / элементы=dictionary	Назначение тегов.
category string	Категория тегов.
name string	Имя записи назначения тегов.
tags any	(список) Теги.
tags string	Применённые к объекту теги.
type string	Тип устройства. Варианты: `"ipad"` `"iphone"` `"gaming-console"` `"blackberry-phone"` `"blackberry-playbook"` `"linux-pc"` `"mac"` `"windows-pc"` `"android-phone"` `"android-tablet"` `"media-streaming"` `"windows-phone"` `"fortinet-device"` `"ip-phone"` `"router-nat-device"` `"other-network-device"` `"windows-tablet"` `"printer"` `"forticam"` `"fortifone"` `"unknown"`
user string	Имя пользователя.
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчёркиваниями (snake_case). Замените аргументы, например «var-name» на «var_name». Старые имена аргументов по-прежнему доступны, однако для них будут выдаваться предупреждения об устаревании. Это предупреждение можно отключить, установив deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться с ошибкой при возврате ненулевого значения rc. Условия сбоя или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure devices.
      fortinet.fortimanager.fmgr_user_device:
        bypass_validation: false
        adom: ansible
        state: present
        user_device:
          alias: ansible-test-device
          category: android-device # <value in [none, android-device, blackberry-device, ...]>
          comment: ansible-comment
          mac: "00:11:22:33:44:55"
          type: iphone # <value in [ipad, iphone, gaming-console, ...]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the devices
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "user_device"
          params:
            adom: "ansible"
            device: "your_value"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / элементы=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / элементы=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_user_device_module.html