Spec-Zone.ru › Ansible 2.10

fortinet.fortimanager.fmgr_firewall_addrgrp6_obj – Настройка групп адресов IPv6.

Примечание

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

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

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

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

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

Обзор

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

Параметры

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

Примечания

Примечание

  • Существуют только три параметра верхнего уровня, где «метод» всегда обязателен, а два других «параметры» и «url_параметры» могут быть необязательными.
  • Из-за сложности схемы 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/ADDRGRP6/{ADDRGRP6}
     fmgr_firewall_addrgrp6_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]>
           addrgrp6: <value of string>
        params:
           -
              data:
                 color: <value of integer>
                 comment: <value of string>
                 dynamic_mapping:
                   -
                       _scope:
                         -
                             name: <value of string>
                             vdom: <value of string>
                       color: <value of integer>
                       comment: <value of string>
                       member: <value of string>
                       tags: <value of string>
                       uuid: <value of string>
                       visibility: <value in [disable, enable]>
                 member: <value of string>
                 name: <value of string>
                 tagging:
                   -
                       category: <value of string>
                       name: <value of string>
                       tags:
                         - <value of string>
                 uuid: <value of string>
                 visibility: <value in [disable, enable]>

   - name: REQUESTING /PM/CONFIG/OBJ/FIREWALL/ADDRGRP6/{ADDRGRP6}
     fmgr_firewall_addrgrp6_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]>
           addrgrp6: <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_addrgrp6_obj_module.html

Spec-Zone.ru

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