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

Примечание

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

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

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

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

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

Обзор

Этот модуль может настроить устройство FortiManager, позволяя пользователю [ удалить получить установить обновить добавить ] следующие API.
/dvmdb/adom/{adom}/group/{group}
/dvmdb/group/{group}
Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется в свободном режиме
method строка / обязательно	Варианты: delete get set update add	Метод запроса
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 строка		имя домена для блокировки в случае работы FortiManager в режиме рабочей области может быть глобальным или любым другим настраиваемым именем домена
workspace_locking_timeout целое число	Значение по умолчанию: 300	максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

Существует только три параметра верхнего уровня, где «метод» всегда обязателен, а другие два «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 /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [delete]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              option: <value in [object member, chksum]>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              data:
                 desc: <value of string>
                 meta fields: <value of string>
                 name: <value of string>
                 os_type: <value in [unknown, fos, fsw, ...]>
                 type: <value in [normal, default, auto]>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              data:
                -
                    name: <value of string>
                    vdom: <value of string>

   - name: REQUESTING /DVMDB/GROUP/{GROUP}
     fmgr_dvmdb_group_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add]>
        url_params:
           adom: <value in [none, global, custom dom]>
           group: <value of string>
        params:
           -
              data:
                -
                    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_dvmdb_group_obj_module.html