Spec-Zone.ru › Ansible 2.10

fortinet.fortimanager.fmgr_wanopt_profile – Настройка профилей оптимизации WAN.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
loose_validation
boolean
    Варианты:
  • no
  • yes
Проверка параметров выполняется с нестрогими условиями
method
string / обязательный
    Варианты:
  • add
  • get
  • set
  • update
Метод запроса
params
list / элементы=string
Параметры для каждого метода
См. полный список параметров в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
url_params
dictionary
Параметры для каждого URL запроса API
Также см. полный список параметров URL в https://ansible-galaxy-fortimanager-docs.readthedocs.io/en/latest
workspace_locking_adom
string
Имя домена (adom), который необходимо заблокировать, если FortiManager работает в режиме рабочей области
Он может быть глобальным или любым другим именем настраиваемого домена
workspace_locking_timeout
integer
Значение по умолчанию:
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/WANOPT/PROFILE
     fmgr_wanopt_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:
                -
                    auth-group: <value of string>
                    comments: <value of string>
                    name: <value of string>
                    transparent: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/WANOPT/PROFILE
     fmgr_wanopt_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 [auth-group, comments, 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
dictionary
всегда
Полезная нагрузка, возвращаемая в запросе

status
dictionary
всегда
Статус запроса API

url
string
всегда
Полный запрошенный 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_wanopt_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API