Spec-Zone.ru › Ansible 2.11

fortinet.fortimanager.fmgr_switchcontroller_lldpprofile – Настройка профилей LLDP FortiSwitch.

Примечание

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

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

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

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

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

Обзор

  • Этот модуль может настроить устройство FortiManager.
  • Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
adom
строка / обязательно
параметр (adom) в запрошенном URL
bypass_validation
логический тип
    Варианты:
  • нет ←
  • да
устанавливать в значение True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров
rc_failed
список / элементы=строка
список кодов rc, при которых условия будут переопределены для завершения с ошибкой
rc_succeeded
список / элементы=строка
список кодов rc, при которых условия будут переопределены для успешного завершения
state
строка / обязательно
    Варианты:
  • present
  • absent
направление для создания, обновления или удаления объекта
switchcontroller_lldpprofile
словарь
параметры верхнего уровня
802.1-tlvs
список / элементы=строка
    Варианты:
  • port-vlan-id
без описания
802.3-tlvs
список / элементы=строка
    Варианты:
  • max-frame-size
без описания
auto-isl
строка
    Варианты:
  • disable
  • enable
Включить/выключить автоматическое создание LAG между коммутаторами.
auto-isl-hello-timer
целое число
Время ожидания hello для автоматического LAG между коммутаторами (1 - 30 сек, по умолчанию 3).
auto-isl-port-group
целое число
ID группы портов для автоматического LAG между коммутаторами (0 - 9).
auto-isl-receive-timeout
целое число
Таймаут приема для автоматического LAG между коммутаторами, если ответ не получен (3 - 90 сек, по умолчанию 9).
custom-tlvs
список / элементы=строка
без описания
information-string
строка
Строка информации, определенная организацией (0 - 507 шестнадцатеричных байт).
name
строка
Имя TLV (не отправляется).
oui
строка
Уникальный идентификатор организации (OUI), 3-байтовое шестнадцатеричное число для данного TLV.
subtype
целое число
Определенный организацией подтип (0 - 255).
med-network-policy
список / элементы=строка
без описания
dscp
целое число
Указанное значение Differentiated Services Code Point (DSCP), значение заголовка пакета, указывающее уровень сервиса, ...
name
строка
Название типа политики.
priority
целое число
Указанный приоритет уровня 2 (0 - 7; от низшего к высшему приоритету).
status
строка
    Варианты:
  • disable
  • enable
Включить или выключить данный TLV.
vlan
целое число
ID VLAN для рекламы, если он настроен на порту (0 - 4094, 0 = тег приоритета).
med-tlvs
список / элементы=строка
    Варианты:
  • inventory-management
  • network-policy
  • power-management
  • location-identification
без описания
name
строка
Имя профиля.
workspace_locking_adom
строка
adom для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая корневой.
workspace_locking_timeout
целое число
По умолчанию:
300
максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочую область.

Примечания

Примечание

  • Работа в режиме блокировки рабочей области поддерживается в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
  • Для создания или обновления объекта используйте директиву present.
  • Для удаления объекта используйте директиву absent.
  • Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.

Примеры

- 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: Configure FortiSwitch LLDP profiles.
     fmgr_switchcontroller_lldpprofile:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        switchcontroller_lldpprofile:
           802.1-tlvs:
             - port-vlan-id
           802.3-tlvs:
             - max-frame-size
           auto-isl: <value in [disable, enable]>
           auto-isl-hello-timer: <value of integer>
           auto-isl-port-group: <value of integer>
           auto-isl-receive-timeout: <value of integer>
           custom-tlvs:
             -
                 information-string: <value of string>
                 name: <value of string>
                 oui: <value of string>
                 subtype: <value of integer>
           med-network-policy:
             -
                 dscp: <value of integer>
                 name: <value of string>
                 priority: <value of integer>
                 status: <value in [disable, enable]>
                 vlan: <value of integer>
           med-tlvs:
             - inventory-management
             - network-policy
             - power-management
             - location-identification
           name: <value of string>

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

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

Ключ Возвращаемое значение Описание
request_url
строка
всегда
Полный запрошенный URL

Пример:
/sys/login/user
response_code
целое число
всегда
Статус запроса к API

response_message
строка
всегда
Дескриптивное сообщение ответа API

Пример:
OK.


Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_switchcontroller_lldpprofile_module.html

Spec-Zone.ru

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