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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
bypass_validation булево	Устанавливается в True только в случае расхождения схемы модуля со структурой API FortiManager, модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log булево	Включить/выключить логирование для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Авторизовать Ansible-клиент с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое	Список rc-кодов, по которым будут переопределены условия для отказа.
rc_succeeded список / элементы=целое	Список rc-кодов, по которым будут переопределены условия для успеха.
state строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
switchcontroller_lldpprofile словарь	Установленные параметры верхнего уровня.
802.1-tlvs список / элементы=строка	Устарело, пожалуйста, переименуйте на 802_1_tlvs. Передаваемые IEEE 802. Варианты: `"port-vlan-id"`
802.3-tlvs список / элементы=строка	Устарело, пожалуйста, переименуйте на 802_3_tlvs. Передаваемые IEEE 802. Варианты: `"max-frame-size"` `"power-negotiation"`
auto-isl строка	Устарело, пожалуйста, переименуйте на auto_isl. Включить/выключить автоматическое создание LAG между коммутаторами. Варианты: `"disable"` `"enable"`
auto-isl-auth строка	Устарело, пожалуйста, переименуйте на auto_isl_auth. Режим аутентификации автоматического LAG между коммутаторами. Варианты: `"legacy"` `"strict"` `"relax"`
auto-isl-auth-encrypt строка	Устарело, пожалуйста, переименуйте на auto_isl_auth_encrypt. Режим шифрования автоматического LAG между коммутаторами. Варианты: `"none"` `"mixed"` `"must"`
auto-isl-auth-identity строка	Устарело, пожалуйста, переименуйте на auto_isl_auth_identity. Идентификатор аутентификации автоматического LAG между коммутаторами.
auto-isl-auth-macsec-profile строка	Устарело, пожалуйста, переименуйте на auto_isl_auth_macsec_profile. Профиль MACsec для шифрования автоматического LAG между коммутаторами.
auto-isl-auth-reauth целое	Устарело, пожалуйста, переименуйте на auto_isl_auth_reauth. Период повторной аутентификации автоматического LAG между коммутаторами в секундах.
auto-isl-auth-user строка	Устарело, пожалуйста, переименуйте на auto_isl_auth_user. Сертификат пользователя для аутентификации автоматического LAG между коммутаторами.

END_OF_DOCUMENT_MARKER

auto-isl-hello-timer integer	Устарело, переименуйте в auto_isl_hello_timer. Продолжительность таймера авто-обнаружения LAG между коммутаторами
auto-isl-port-group integer	Устарело, переименуйте в auto_isl_port_group. ID группы портов авто-обнаружения LAG между коммутаторами
auto-isl-receive-timeout integer	Устарело, переименуйте в auto_isl_receive_timeout. Таймаут авто-обнаружения LAG между коммутаторами, если не получен ответ
auto-mclag-icl string	Устарело, переименуйте в auto_mclag_icl. Включить/выключить межшасси-канал MCLAG. Choices: `"disable"` `"enable"`
custom-tlvs list / elements=dictionary	Устарело, переименуйте в custom_tlvs. Пользовательские TLV.
information-string string	Устарело, переименуйте в information_string. Информационная строка, определенная организацией
name string	Имя TLV
oui string	Уникальный идентификатор организации
subtype integer	Подтип, определенный организацией
med-location-service list / elements=dictionary	Устарело, переименуйте в med_location_service. Сервис определения местоположения.
name string	Имя типа сервиса определения местоположения.
status string	Включить или выключить этот TLV. Choices: `"disable"` `"enable"`
sys-location-id string	Устарело, переименуйте в sys_location_id. ID сервиса определения местоположения.
med-network-policy list / elements=dictionary	Устарело, переименуйте в med_network_policy. Политика сети Med.
assign-vlan string	Устарело, переименуйте в assign_vlan. Включить/выключить назначение VLAN при применении этого профиля к управляемо… Choices: `"disable"` `"enable"`
dscp integer	Объявленная точка кода дифференцированных служб
name string	Имя типа политики.
priority integer	Объявленный приоритет уровня 2
status string	Включить или выключить этот TLV. Choices: `"disable"` `"enable"`
vlan integer	ID VLAN для объявления, если он настроен на порту
vlan-intf string	Устарело, переименуйте в vlan_intf. VLAN интерфейс для объявления; если он настроен на порту.

med-tlvs список / элементы=строка	Устаревшее, пожалуйста, переименуйте на med_tlvs. Передаваемые TLV LLDP-MED Варианты: `"inventory-management"` `"network-policy"` `"power-management"` `"location-identification"`
name строка / обязательно	Имя профиля.
workspace_locking_adom строка	ADOM для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным и другими, включая корень.
workspace_locking_timeout целое число	Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: `300`

Примечания

Примечание

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

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure FortiSwitch LLDP profiles.
      fortinet.fortimanager.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: present # <value in [present, absent]>
        switchcontroller_lldpprofile:
          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
          name: <string>
          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 словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный запрашиваемый URL. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус API-запроса. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание сообщения об ответе API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_switchcontroller_lldpprofile_module.html