fortinet.fortimanager.fmgr_system_interface_obj – Конфигурация интерфейса.

Примечание

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

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

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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
loose_validation boolean	Варианты: no yes	Проверка параметров в свободном режиме
method string / обязательно	Варианты: delete 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). Может быть глобальным или любым другим именем настраиваемого домена.
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/{INTERFACE}
     fmgr_system_interface_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [set, update]>
        url_params:
           interface: <value of string>
        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]>

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

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

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