fortinet.fortimanager.fmgr_dvm_cmd_add_device – Добавить устройство в базу данных Устройства.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версии 1.0.5).

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

Для использования в книге задач укажите: fortinet.fortimanager.fmgr_dvm_cmd_add_device.

Новое в версии 2.10: от fortinet.fortimanager

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется в свободном режиме.
method строка / обязательный	Варианты: exec	Метод в запросе.
params список / элементы=строка		Параметры для каждого метода. Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params словарь		Параметры для каждого URL-адреса API-запроса. Полный список параметров URL см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom строка		Имя домена ADOM для блокировки в случае работы FortiManager в режиме рабочей области. Может быть глобальным или любым другим настраиваемым именем домена ADOM.
workspace_locking_timeout целое число	Значение по умолчанию: 300	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область.

Примечания

Примечание

Есть только три параметра верхнего уровня, где «method» всегда обязателен, а два других «params» и «url_params» могут быть необязательными.
Из-за сложности схемы API fortimanager проверка выполняется вне процедуры проверки параметров Ansible.
Синтаксис OPTIONS не соответствует стандартному спецификации аргументов Ansible, но со структурой схемы API fortimanager нам необходимо тривиальное преобразование при заполнении книги задач ansible.

Примеры

- 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: REQUESTING /DVM/CMD/ADD/DEVICE
     fmgr_dvm_cmd_add_device:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [exec]>
        params:
           -
              data:
                 adom: <value of string>
                 device:
                    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>
                 flags:
                   - <value in [none, create_task, nonblocking, ...]>
                 groups:
                   -
                       name: <value of string>
                       vdom: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
data словарь	всегда	Загрузка, возвращённая в запросе.
status словарь	всегда	Статус API-запроса.
url строка	всегда	Полный запрашиваемый URL. Пример: /sys/login/user

Авторы

Frank Shen (@fshen01)
Link Zheng (@zhengl)

© 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/fortimanager/fmgr_dvm_cmd_add_device_module.html