cisco.aci.aci_interface_policy_lldp – Управление политиками интерфейсов LLDP (lldp:IfPol)

Примечание

Этот плагин является частью коллекции cisco.aci (версия 1.1.1).

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

Для использования в книге задач укажите: cisco.aci.aci_interface_policy_lldp.

Обзор
Параметры
См. также
Примеры
Значения возврата

Обзор

Управление политиками интерфейсов LLDP на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
annotation строка		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, значение по умолчанию — это имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию — значение `username`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание имени политики интерфейса LLDP. псевдонимы: descr
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемое управляющим хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`. псевдонимы: hostname
lldp_policy строка		Имя политики интерфейса LLDP. псевдонимы: name
name_alias строка		Псевдоним текущего объекта. Связан с полем nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`.
output_path строка		Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI в формате JSON, сгенерированных модулем. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password строка		Пароль для аутентификации. Этот параметр взаимно исключает `private_key`. Если также указан `private_key`, он будет использован вместо него. Если значение не указано в задаче, будут использованы переменные окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PORT`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимно исключает `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
receive_state логическое значение	Варианты: no yes	Включить или выключить состояние Receive. APIC по умолчанию устанавливает значение `yes` при отсутствии указания при создании.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`.
transmit_state логическое значение	Варианты: no yes	Включить или выключить состояние Transmit. APIC по умолчанию устанавливает значение `yes` при отсутствии указания при создании.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, вместо стандартного подключения HTTPS будет использоваться HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы переменные окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить в `no` только при работе с сайтами, контролируемыми лично, и при использовании самозаверяемых сертификатов. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.

См. также

Справочник по модели информации управления APIC: Дополнительная информация о внутренней внутренней модели класса APIC lldp:IfPol.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a LLDP interface policy
  cisco.aci.aci_interface_policy_lldp:
    host: '{{ hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    lldp_policy: '{{ lldp_policy }}'
    description: '{{ description }}'
    receive_state: '{{ receive_state }}'
    transmit_state: '{{ transmit_state }}'
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
current список / элементы=строка	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	неудача	Информация об ошибке, возвращённая APIC Пример: {'code': '122', 'text': 'неизвестный тип управляемого объекта foo'}
filter_string строка	неудача или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	неудача или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список / элементы=строка	информация	Исходная конфигурация с APIC до начала модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'производство'}}}
raw строка	ошибка разбора	Необработанный результат, возвращённый REST API APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный тип управляемого объекта foo"/></imdata>
response строка	неудача или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список / элементы=строка	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	неудача или отладка	HTTP-статус от APIC Пример: 200
url строка	неудача или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Dag Wieers (@dagwieers)

© 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/cisco/aci/aci_interface_policy_lldp_module.html