fortinet.fortimanager.fmgr_dvm_cmd_add_devlist – Добавление нескольких устройств в базу данных Диспетчера устройств.

Примечание

Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).

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

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_dvm_cmd_add_devlist.

Новое в версии 2.10: коллекции fortinet.fortimanager

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

Обзор

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

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean			Варианты: нет ← да	устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без валидации параметров
dvm_cmd_add_devlist dictionary				параметры верхнего уровня
	add-dev-list list / elements=string			без описания
		adm_pass string		без описания
		adm_usr string		<i>добавить реальное и продвинуть устройство</i>.
		desc string		<i>доступно для всех операций</i>.
		device action string		Укажите операции по добавлению устройства или оставьте пустым для добавления реального устройства: "add_model" - добавить модель устройства. "promote_unreg" - продвинуть нерегистирированное устройство для управления FortiManager, используя информацию из базы данных.
		faz.quota integer		<i>доступно для всех операций</i>.
		ip string		<i>добавить только реальное устройство</i>. Добавление устройства будет проверяться с этим IP-адресом, используя учетные данные входа.
		meta fields string		<i>добавить реальное и модельное устройство</i>.
		mgmt_mode string	Варианты: unreg fmg faz fmgfaz	<i>добавить реальное и модельное устройство</i>.
		mr integer		<i>добавить только модельное устройство</i>.
		name string		<i>требуется для всех операций</i>. Уникальное имя устройства.
		os_type string	Варианты: unknown fos fsw foc fml faz fwb fch fct log fmg fsa fdd fac	<i>добавить только модельное устройство</i>.
		os_ver string	Варианты: unknown 0.0 1.0 2.0 3.0 4.0 5.0	<i>добавить только модельное устройство</i>.
		patch integer		<i>добавить только модельное устройство</i>.
		platform_str string		<i>добавить только модельное устройство</i>. Требуется для определения платформы для платформ виртуальных машин.
		sn string		<i>добавить только модельное устройство</i>. Этот атрибут будет использоваться для определения платформы устройства, за исключением платформ виртуальных машин, w...
	adom string			Имя или ID ADOM, на котором должен быть выполнен запрос.
	flags list / elements=string		Варианты: none create_task nonblocking log_dev	без описания
rc_failed list / elements=string				список кодов rc, с которыми будут переопределены условия сбоя
rc_succeeded list / elements=string				список кодов rc, с которыми будут переопределены условия успеха
workspace_locking_adom string				ADOM для блокировки FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая root
workspace_locking_timeout integer			По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

Поддерживается работа в режиме блокировки рабочего пространства в этом модуле FortiManager; параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают выполнить эту работу.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно запуск одного модуля может завершиться неудачей, если возвращается ненулевой код rc. Вы также можете переопределить условия сбоя или успеха с помощью параметров 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: Add multiple devices to the Device Manager database.
     fmgr_dvm_cmd_add_devlist:
        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, ...]
        dvm_cmd_add_devlist:
           add-dev-list:
             -
                 adm_pass: <value of string>
                 adm_usr: <value of string>
                 desc: <value of string>
                 device action: <value of string>
                 faz.quota: <value of integer>
                 ip: <value of string>
                 meta fields: <value of string>
                 mgmt_mode: <value in [unreg, fmg, faz, ...]>
                 mr: <value of integer>
                 name: <value of string>
                 os_type: <value in [unknown, fos, fsw, ...]>
                 os_ver: <value in [unknown, 0.0, 1.0, ...]>
                 patch: <value of integer>
                 platform_str: <value of string>
                 sn: <value of string>
           adom: <value of string>
           flags:
             - none
             - create_task
             - nonblocking
             - log_dev

Значения возврата

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа 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_dvm_cmd_add_devlist_module.html