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

Примечание

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

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

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

Добавлено в версии 2.10: плагин fortinet.fortimanager

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

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров выполняется нестрого
method строка / обязательно	Варианты: add get set update	Метод запроса
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
     fmgr_dvmdb_group:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
        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
     fmgr_dvmdb_group:
        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]>
        params:
           -
              expand member: <value of string>
              fields:
                -
                   - <value in [desc, name, os_type, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              meta fields:
                - <value of string>
              option: <value in [count, object member, syntax]>
              range:
                - <value of integer>
              sortings:
                -
                    varidic.attr_name: <value in [1, -1]>

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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_module.html