cisco.aci.aci_interface_policy_port_channel – Управление политиками интерфейсов канала портов (lacp:LagPol)

Примечание

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

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

Чтобы использовать его в книге задач, укажите: cisco.aci.aci_interface_policy_port_channel.

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

Обзор

Управление политиками интерфейсов каналов портов на тканях 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 строка		Описание канала портов. Псевдонимы: descr
fast_select логическое значение	Варианты: нет да	Определяет, включен ли Fast Select для портов Hot Standby. Это определяет политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределенными или установленные в значение false, будут удалены после выполнения задачи. APIC по умолчанию использует значение `yes`, если оно не задано при создании.
graceful_convergence логическое значение	Варианты: нет да	Определяет, включена ли Graceful Convergence. Это определяет политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределенными или установленные в значение false, будут удалены после выполнения задачи. APIC по умолчанию использует значение `yes`, если оно не задано при создании.
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_HOST`. Псевдонимы: hostname
load_defer логическое значение	Варианты: нет да	Определяет, включена ли отсрочка загрузки. Это определяет политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределенными или установленные в значение false, будут удалены после выполнения задачи. APIC по умолчанию использует значение `no`, если оно не задано при создании.
max_links целое число		Максимальное количество ссылок. Допустимые значения находятся в диапазоне от 1 до 16. APIC по умолчанию использует значение `16`, если оно не задано при создании.
min_links целое число		Минимальное количество ссылок. Допустимые значения находятся в диапазоне от 1 до 16. APIC по умолчанию использует значение `1`, если оно не задано при создании.
mode строка	Варианты: активный mac-pin mac-pin-nicload выключен пассивный	Режим политики интерфейса канала портов. Определяет метод LACP для формирования каналов портов. APIC по умолчанию использует значение `off`, если оно не задано при создании.
name_alias строка		Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.
output_level строка	Варианты: отладка информация обычный ←	Влияет на вывод этого модуля 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`.
port_channel строка		Имя канала портов. Псевдонимы: name
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр несовместим с `password`. Если задано также `password`, оно будет проигнорировано. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. Псевдонимы: cert_key
state строка	Варианты: отсутствует есть ← запрос	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
suspend_individual логическое значение	Варианты: нет да	Определяет, включена ли Suspend Individual. Это определяет политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределенными или установленные в значение false, будут удалены после выполнения задачи. APIC по умолчанию использует значение `yes`, если оно не задано при создании.
symmetric_hash логическое значение	Варианты: нет да	Определяет, включено ли симметричное хеширование. Это определяет политику управления LACP; если задано одно значение, все другие свойства управления, оставленные неопределенными или установленные в значение false, будут удалены после выполнения задачи. APIC по умолчанию использует значение `no`, если оно не задано при создании.
timeout целое число	Значение по умолчанию: 30	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy логическое значение	Варианты: нет да ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl логическое значение	Варианты: нет да ←	Если `no`, вместо стандартного HTTPS соединения будет использоваться HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Псевдонимы: user
validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при работе с сайтами, управляемыми лично, и использованием самозаверенных сертификатов. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.

См. также

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

Примеры

- name: Add a port channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: '{{ inventory_hostname }}'
    username: '{{ username }}'
    password: '{{ password }}'
    port_channel: '{{ port_channel }}'
    description: '{{ description }}'
    min_links: '{{ min_links }}'
    max_links: '{{ max_links }}'
    mode: '{{ mode }}'
  delegate_to: localhost

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

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

Ключ	Возвращаемое значение	Описание
current список / элементы=строка	успех	Текущая конфигурация из APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', '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': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Сборка конфигурации из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный вывод, возвращенный API REST 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_port_channel_module.html