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

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation логическое значение	Устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое значение	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для отказа.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
user_device словарь	Установленные параметры верхнего уровня.
alias строка / обязательно	Псевдоним устройства.
avatar строка	Файл изображения для аватара
category строка	Категория устройства. Варианты: `"none"` `"android-device"` `"blackberry-device"` `"fortinet-device"` `"ios-device"` `"windows-device"` `"amazon-device"`
comment строка	Комментарий.
dynamic_mapping список / элементы=словарь	Динамическое отображение.
_scope список / элементы=словарь	Область.
name строка	Имя.
vdom строка	Vdom.
avatar строка	Аватар.
category строка	Категория. Варианты: `"none"` `"android-device"` `"blackberry-device"` `"fortinet-device"` `"ios-device"` `"windows-device"` `"amazon-device"`
comment строка	Комментарий.
family строка	Семейство.
hardware-vendor строка	Устарело, пожалуйста, переименуйте на hardware_vendor. Производитель оборудования.

hardware-version string	Устарело, пожалуйста, переименуйте на hardware_version. Версия оборудования.
mac string	MAC.
master-device string	Устарело, пожалуйста, переименуйте на master_device. Главное устройство.
os string	ОС.
software-version string	Устарело, пожалуйста, переименуйте на software_version. Версия ПО.
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 string	Устарело, пожалуйста, переименуйте на master_device. Главное устройство
tagging list / elements=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, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень.
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 на верхнем уровне помогают выполнить эту задачу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Как правило, выполнение одного модуля может завершиться ошибкой при возвращении ненулевого значения rc. Вы также можете переопределить условия для завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded

Примеры

- name: Example playbook
  hosts: fortimanagers
  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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание сообщения ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_user_device_module.html