fortinet.fortimanager.fmgr_dvmdb_device – Таблица устройств, большинство атрибутов — только для чтения и могут быть изменены только внутренне. Обратитесь к модулю команд Device Manager для API добавления, d…

Примечание

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

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

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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

Существует только три параметра верхнего уровня, где «метод» всегда обязателен, а «параметры» и «url_параметры» могут быть необязательными.
Из-за сложности схемы 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/DEVICE
     fmgr_dvmdb_device:
        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 [adm_pass, adm_usr, app_ver, ...]>
              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]>

   - name: REQUESTING /DVMDB/DEVICE
     fmgr_dvmdb_device:
        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]>
        params:
           -
              data:
                -
                    adm_pass:
                      - <value of string>
                    adm_usr: <value of string>
                    app_ver: <value of string>
                    av_ver: <value of string>
                    beta: <value of integer>
                    branch_pt: <value of integer>
                    build: <value of integer>
                    checksum: <value of string>
                    conf_status: <value in [unknown, insync, outofsync]>
                    conn_mode: <value in [active, passive]>
                    conn_status: <value in [UNKNOWN, up, down]>
                    db_status: <value in [unknown, nomod, mod]>
                    desc: <value of string>
                    dev_status: <value in [none, unknown, checkedin, ...]>
                    fap_cnt: <value of integer>
                    faz.full_act: <value of integer>
                    faz.perm: <value of integer>
                    faz.quota: <value of integer>
                    faz.used: <value of integer>
                    fex_cnt: <value of integer>
                    flags:
                      - <value in [has_hdd, vdom_enabled, discover, ...]>
                    foslic_cpu: <value of integer>
                    foslic_dr_site: <value in [disable, enable]>
                    foslic_inst_time: <value of integer>
                    foslic_last_sync: <value of integer>
                    foslic_ram: <value of integer>
                    foslic_type: <value in [temporary, trial, regular, ...]>
                    foslic_utm:
                      - <value in [fw, av, ips, ...]>
                    fsw_cnt: <value of integer>
                    ha_group_id: <value of integer>
                    ha_group_name: <value of string>
                    ha_mode: <value in [standalone, AP, AA, ...]>
                    hdisk_size: <value of integer>
                    hostname: <value of string>
                    hw_rev_major: <value of integer>
                    hw_rev_minor: <value of integer>
                    ip: <value of string>
                    ips_ext: <value of integer>
                    ips_ver: <value of string>
                    last_checked: <value of integer>
                    last_resync: <value of integer>
                    latitude: <value of string>
                    lic_flags: <value of integer>
                    lic_region: <value of string>
                    location_from: <value of string>
                    logdisk_size: <value of integer>
                    longitude: <value of string>
                    maxvdom: <value of integer>
                    meta fields: <value of string>
                    mgmt_id: <value of integer>
                    mgmt_if: <value of string>
                    mgmt_mode: <value in [unreg, fmg, faz, ...]>
                    mgt_vdom: <value of string>
                    mr: <value of integer>
                    name: <value of string>
                    os_type: <value in [unknown, fos, fsw, ...]>
                    os_ver: <value in [unknown, 0.0, 1.0, ...]>
                    patch: <value of integer>
                    platform_str: <value of string>
                    psk: <value of string>
                    sn: <value of string>
                    vdom:
                      -
                          comments: <value of string>
                          name: <value of string>
                          opmode: <value in [nat, transparent]>
                          rtm_prof_id: <value of integer>
                          status: <value of string>
                    version: <value of integer>
                    vm_cpu: <value of integer>
                    vm_cpu_limit: <value of integer>
                    vm_lic_expire: <value of integer>
                    vm_mem: <value of integer>
                    vm_mem_limit: <value of integer>
                    vm_status: <value of integer>

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

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

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