fortinet.fortimanager.fmgr_dvm_cmd_del_device – Удаление устройства.

Примечание

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

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

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

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется свободно
method string / обязательно	Варианты: exec	Метод запроса
params list / элементы=string		Параметры для каждого метода Полный список параметров см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params dictionary		Параметры для каждого URL-адреса API-запроса Полный список URL-параметров также см. в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom string		Имя домена (adom), который следует заблокировать, если FortiManager работает в режиме рабочей области. Может быть глобальным или любым другим именем настраиваемого домена.
workspace_locking_timeout integer	По умолчанию: 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/DEL/DEVICE
     fmgr_dvm_cmd_del_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: <value of string>
                 flags:
                   - <value in [none, create_task, nonblocking, ...]>

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

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

Ключ	Возвращаемое значение	Описание
data dictionary	всегда	Полезная нагрузка, возвращенная в запросе
status dictionary	всегда	Статус запроса к API
url string	всегда	Полный запрашиваемый 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_del_device_module.html