Модуль fortinet.fortimanager.fmgr_switchcontroller_lldpprofile — настройка профилей LLDP FortiSwitch.

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_switchcontroller_lldpprofile.

Добавлено в fortinet.fortimanager 2.0.0

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

Краткое описание

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия сбоя.
rc_succeeded list / элементы=integer	Список кодов rc, с помощью которого переопределяются условия успешного выполнения.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Инструкция по созданию, обновлению или удалению объекта. Варианты: `"present"` `"absent"`
switchcontroller_lldpprofile dictionary	Набор параметров верхнего уровня.
802_1_tlvs псевдонимы: 802.1-tlvs list / элементы=string	Передаваемые IEEE 802. Варианты: `"port-vlan-id"`
802_3_tlvs псевдонимы: 802.3-tlvs list / элементы=string	Передаваемые IEEE 802. Варианты: `"max-frame-size"` `"power-negotiation"`
auto_isl псевдонимы: auto-isl string	Включить/отключить автоматическую агрегацию каналов между коммутаторами (LAG). Варианты: `"disable"` `"enable"`
auto_isl_auth псевдонимы: auto-isl-auth string	Режим аутентификации автоматической агрегации каналов между коммутаторами. Варианты: `"legacy"` `"strict"` `"relax"`
auto_isl_auth_encrypt псевдонимы: auto-isl-auth-encrypt string	Режим шифрования автоматической агрегации каналов между коммутаторами. Варианты: `"none"` `"mixed"` `"must"`
auto_isl_auth_identity псевдонимы: auto-isl-auth-identity string	Идентификатор аутентификации автоматической агрегации каналов между коммутаторами.
auto_isl_auth_macsec_profile псевдонимы: auto-isl-auth-macsec-profile string	Профиль MACsec для шифрования автоматической агрегации каналов между коммутаторами.
auto_isl_auth_reauth псевдонимы: auto-isl-auth-reauth integer	Период повторной аутентификации автоматической агрегации каналов между коммутаторами в секундах
auto_isl_auth_user псевдонимы: auto-isl-auth-user string	Сертификат пользователя для аутентификации автоматической агрегации каналов между коммутаторами.
auto_isl_hello_timer псевдонимы: auto-isl-hello-timer integer	Длительность таймера Hello автоматической агрегации каналов между коммутаторами
auto_isl_port_group псевдонимы: auto-isl-port-group integer	Идентификатор группы портов автоматической агрегации каналов между коммутаторами
auto_isl_receive_timeout псевдонимы: auto-isl-receive-timeout integer	Тайм-аут автоматической агрегации каналов между коммутаторами при отсутствии ответа
auto_mclag_icl псевдонимы: auto-mclag-icl string	Включить/отключить межузловой канал MCLAG. Варианты: `"disable"` `"enable"`
custom_tlvs псевдонимы: custom-tlvs list / элементы=dictionary	Пользовательские TLV.
information_string псевдонимы: information-string string	Строка сведений, определяемая организацией
name string	Имя TLV
oui string	Уникальный идентификатор организации
subtype integer	Подтип, определяемый организацией
med_location_service псевдонимы: med-location-service list / элементы=dictionary	Служба местоположения MED.
name string	Имя типа службы местоположения.
status string	Включить или отключить этот TLV. Варианты: `"disable"` `"enable"`
sys_location_id псевдонимы: sys-location-id string	Идентификатор службы местоположения.
med_network_policy псевдонимы: med-network-policy list / элементы=dictionary	Сетевая политика MED.
assign_vlan псевдонимы: assign-vlan string	Включить/отключить назначение VLAN при применении этого профиля к порту управляемого FortiSwitch. Варианты: `"disable"` `"enable"`
dscp integer	Объявляемая кодовая точка дифференцированного обслуживания
name string	Имя типа политики.
priority integer	Объявляемый приоритет уровня 2
status string	Включить или отключить этот TLV. Варианты: `"disable"` `"enable"`
vlan integer	Идентификатор объявляемой VLAN, если она настроена на порту
vlan_intf псевдонимы: vlan-intf string	Объявляемый интерфейс VLAN, если он настроен на порту.
med_tlvs псевдонимы: med-tlvs list / элементы=string	Передаваемые TLV LLDP-MED Варианты: `"inventory-management"` `"network-policy"` `"power-management"` `"location-identification"`
name string / обязательный	Имя профиля.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. Значением может быть global и другие области, включая root.
workspace_locking_timeout integer	Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, имена всех входных аргументов используют соглашение об именовании с подчёркиваниями (snake_case). Замените такие аргументы, как «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но для них будут выводиться предупреждения об устаревании. Чтобы игнорировать это предупреждение, установите deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области; для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение модуля может завершиться ошибкой, если возвращён ненулевой код rc. Условия ошибки или успешного выполнения также можно переопределить с помощью параметров rc_failed и rc_succeeded.
Чтобы создать или обновить объект, используйте директиву state present.
Чтобы удалить объект, используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure FortiSwitch LLDP profiles.
      fortinet.fortimanager.fmgr_switchcontroller_lldpprofile:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        switchcontroller_lldpprofile:
          name: "your value" # Required variable, string
          # 802_1_tlvs: ["port-vlan-id"]
          # 802_3_tlvs: ["max-frame-size", "power-negotiation"]
          # auto_isl: <value in [disable, enable]>
          # auto_isl_hello_timer: <integer>
          # auto_isl_port_group: <integer>
          # auto_isl_receive_timeout: <integer>
          # custom_tlvs:
          #   - information_string: <string>
          #     name: <string>
          #     oui: <string>
          #     subtype: <integer>
          # med_network_policy:
          #   - dscp: <integer>
          #     name: <string>
          #     priority: <integer>
          #     status: <value in [disable, enable]>
          #     vlan: <integer>
          #     vlan_intf: <string>
          #     assign_vlan: <value in [disable, enable]>
          # med_tlvs: ["inventory-management", "network-policy", "power-management",
          #            "location-identification"]
          # med_location_service:
          #   - name: <string>
          #     status: <value in [disable, enable]>
          #     sys_location_id: <string>
          # auto_mclag_icl: <value in [disable, enable]>
          # auto_isl_auth: <value in [legacy, strict, relax]>
          # auto_isl_auth_encrypt: <value in [none, mixed, must]>
          # auto_isl_auth_identity: <string>
          # auto_isl_auth_macsec_profile: <string>
          # auto_isl_auth_reauth: <integer>
          # auto_isl_auth_user: <string>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Текстовое описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager. Возвращается: в сложных случаях

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

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