Spec-Zone.ru › Ansible 2.10

fortinet.fortimanager.fmgr_firewall_address6_obj – Настройка адресов IPv6 брандмауэра.

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
loose_validation
булево
    Варианты:
  • no
  • yes
Проверка параметров с менее строгими условиями
method
строка / обязательный
    Варианты:
  • clone
  • 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
строка
имя домена для блокировки в случае работы 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/FIREWALL/ADDRESS6/{ADDRESS6}
     fmgr_firewall_address6_obj:
        loose_validation: False
        workspace_locking_adom: <value in [global, custom adom]>
        workspace_locking_timeout: 300
        method: <value in [clone, set, update]>
        url_params:
           adom: <value in [none, global, custom dom]>
           address6: <value of string>
        params:
           -
              data:
                 cache-ttl: <value of integer>
                 color: <value of integer>
                 comment: <value of string>
                 dynamic_mapping:
                   -
                       _scope:
                         -
                             name: <value of string>
                             vdom: <value of string>
                       cache-ttl: <value of integer>
                       color: <value of integer>
                       comment: <value of string>
                       end-ip: <value of string>
                       fqdn: <value of string>
                       host: <value of string>
                       host-type: <value in [any, specific]>
                       ip6: <value of string>
                       obj-id: <value of string>
                       sdn: <value in [nsx]>
                       start-ip: <value of string>
                       tags: <value of string>
                       template: <value of string>
                       type: <value in [ipprefix, iprange, nsx, ...]>
                       uuid: <value of string>
                       visibility: <value in [disable, enable]>
                 end-ip: <value of string>
                 fqdn: <value of string>
                 host: <value of string>
                 host-type: <value in [any, specific]>
                 ip6: <value of string>
                 list:
                   -
                       ip: <value of string>
                 name: <value of string>
                 obj-id: <value of string>
                 sdn: <value in [nsx]>
                 start-ip: <value of string>
                 subnet-segment:
                   -
                       name: <value of string>
                       type: <value in [any, specific]>
                       value: <value of string>
                 tagging:
                   -
                       category: <value of string>
                       name: <value of string>
                       tags:
                         - <value of string>
                 template: <value of string>
                 type: <value in [ipprefix, iprange, nsx, ...]>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/ADDRESS6/{ADDRESS6}
     fmgr_firewall_address6_obj:
        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]>
           address6: <value of string>
        params:
           -
              option: <value in [object member, chksum, datasrc]>

Значения возврата

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

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

Spec-Zone.ru

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