fortinet.fortimanager.fmgr_voip_profile – Настройка профилей VoIP.

Примечание

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

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

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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

Существует только три параметра верхнего уровня, где ‘method’ всегда требуется, а два других ‘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 /PM/CONFIG/OBJ/VOIP/PROFILE
     fmgr_voip_profile:
        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:
                -
                    comment: <value of string>
                    name: <value of string>

   - name: REQUESTING /PM/CONFIG/OBJ/VOIP/PROFILE
     fmgr_voip_profile:
        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:
           -
              attr: <value of string>
              fields:
                -
                   - <value in [comment, name]>
              filter:
                - <value of string>
              get used: <value of integer>
              loadsub: <value of integer>
              option: <value in [count, object member, datasrc, ...]>
              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_voip_profile_module.html