fortinet.fortimanager.fmgr_dvmdb_group – Таблица групп устройств.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation логическое значение		Варианты: нет ← да	устанавливается в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
dvmdb_group словарь			параметры верхнего уровня
	desc строка		нет описания
	meta fields словарь		нет описания
	name строка		нет описания
	os_type строка	Варианты: неизвестно ← fos fsw foc fml faz fwb fch fct log fmg fsa fdd fac fpx	нет описания
	type строка	Варианты: обычный ← по умолчанию автоматический	нет описания
rc_failed список / элементы=строка			список кодов rc, при которых выполнение будет прервано
rc_succeeded список / элементы=строка			список кодов rc, при которых выполнение будет завершено успешно
state строка / обязательно		Варианты: наличие отсутствие	направление на создание, обновление или удаление объекта
workspace_locking_adom строка			область, блокируемая для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корень
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочего пространства другим пользователем

Примечания

Примечание

Поддержка работы в режиме блокировки рабочего пространства в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте состояние наличия.
Для удаления объекта используйте состояние отсутствия.
Обычно выполнение модуля может завершиться неудачей при возврате ненулевого кода 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: Device group table.
     fmgr_dvmdb_group:
        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, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        dvmdb_group:
           desc: <value of string>
           meta fields: <value of dict>
           name: <value of string>
           os_type: <value in [unknown, fos, fsw, ...]>
           type: <value in [normal, default, auto]>

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

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

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