Spec-Zone.ru › Ansible 2.10

fortinet.fortimanager.fmgr_system_interface – Настройка интерфейса.

Примечание

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

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

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

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

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

Обзор

  • Этот модуль позволяет настроить устройство FortiManager, позволяя пользователю [ добавить получить установить обновить ] следующие API.
  • /cli/global/system/interface
  • В примерах все параметры и значения должны быть скорректированы в источниках данных перед использованием.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
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
строка
Имя домена (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 /CLI/SYSTEM/INTERFACE
     fmgr_system_interface:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [add, set, update]>
        params:
           -
              data:
                -
                    alias: <value of string>
                    allowaccess:
                      - <value in [ping, https, ssh, ...]>
                    description: <value of string>
                    ip: <value of string>
                    ipv6:
                       ip6-address: <value of string>
                       ip6-allowaccess:
                         - <value in [ping, https, ssh, ...]>
                       ip6-autoconf: <value in [disable, enable]>
                    mtu: <value of integer>
                    name: <value of string>
                    serviceaccess:
                      - <value in [fgtupdates, fclupdates, webfilter-antispam]>
                    speed: <value in [auto, 10full, 10half, ...]>
                    status: <value in [down, up]>

   - name: REQUESTING /CLI/SYSTEM/INTERFACE
     fmgr_system_interface:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [get]>
        params:
           -
              fields:
                -
                   - <value in [alias, allowaccess, description, ...]>
              filter:
                - <value of string>
              loadsub: <value of integer>
              option: <value in [count, syntax]>

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

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

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

Spec-Zone.ru

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