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

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
bypass_validation boolean		Варианты: нет ← да	устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполняться без проверки параметров
dvm_cmd_del_device dictionary			параметры верхнего уровня
	adom string		Имя или идентификатор ADOM, на котором будет выполнена команда.
	device string		Имя или идентификатор целевого устройства.
	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 в режиме рабочей области; значение может быть глобальным или другим, включая корень.
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: Delete a device.
     fmgr_dvm_cmd_del_device:
        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_del_device:
           adom: <value of string>
           device: <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_del_device_module.html