Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_interface_policy_port_channel.

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

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

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

Параметры

Параметр

Комментарии

annotation

строка

Определяемая пользователем строка для аннотирования объекта.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_ANNOTATION.

Если значение не указано в задаче, а переменная среды ACI_ANNOTATION, будет использоваться значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

строка

Имя сертификата X.509, привязанного к пользователю APIC AAA, который используется для аутентификации на основе подписи.

Если указано имя файла private_key, по умолчанию используется базовое имя private_key без расширения.

Если для private_key было указано содержимое в формате PEM, по умолчанию используется значение username.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_CERTIFICATE_NAME.

description

псевдонимы: descr

строка

Описание порт-канала.

fast_select

логическое значение

Определяет, включён ли режим Fast Select для портов горячего резерва.

Этот параметр формирует политику управления LACP; если задана одна настройка, все остальные свойства управления, оставленные неопределёнными или установленными в false, перестанут существовать после выполнения задачи.

Если при создании значение не задано, APIC использует значение true по умолчанию.

Варианты:

  • false
  • true

graceful_convergence

логическое значение

Определяет, включена ли плавная сходимость (Graceful Convergence).

Этот параметр формирует политику управления LACP; если задана одна настройка, все остальные свойства управления, оставленные неопределёнными или установленными в false, перестанут существовать после выполнения задачи.

Если при создании значение не задано, APIC использует значение true по умолчанию.

Варианты:

  • false
  • true

host

псевдонимы: hostname

строка

IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_HOST.

load_defer

логическое значение

Определяет, включена ли отсрочка загрузки (Load Defer).

Этот параметр формирует политику управления LACP; если задана одна настройка, все остальные свойства управления, оставленные неопределёнными или установленными в false, перестанут существовать после выполнения задачи.

Если при создании значение не задано, APIC использует значение false по умолчанию.

Варианты:

  • false
  • true

max_links

целое число

Максимальное количество каналов.

Допустимый диапазон значений — от 1 до 16.

Если при создании значение не задано, APIC использует значение 16 по умолчанию.

min_links

целое число

Минимальное количество каналов.

Допустимый диапазон значений — от 1 до 16.

Если при создании значение не задано, APIC использует значение 1 по умолчанию.

mode

строка

Режим политики интерфейса порт-канала.

Определяет метод LACP, используемый для формирования порт-каналов.

Если при создании значение не задано, APIC использует значение off по умолчанию.

Варианты:

  • "active"
  • "mac-pin"
  • "mac-pin-nicload"
  • "off"
  • "passive"

name_alias

строка

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

output_level

строка

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая previous, proposed и словари sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_OUTPUT_LEVEL.

Варианты:

  • "debug"
  • "info"
  • "normal" ← (по умолчанию)

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

псевдонимы: cert_key

строка

Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр взаимоисключающий с password. Если также задан password, он будет проигнорирован.

Если значение не указано в задаче, вместо него будут использоваться значения переменных среды ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

state

строка

Для добавления или удаления используйте present или absent.

Для просмотра одного или нескольких объектов используйте query.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

логическое значение

Если задано true, перед отправкой POST-запроса на обновление в APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым.

Предыдущее состояние объекта проверяться не будет, а POST-запрос на обновление будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

логическое значение

Если задано true, после отправки POST-запроса на обновление в APIC проверочный GET-запрос отправляться не будет.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате текущее возвращаемое значение будет установлено равным предлагаемому значению.

Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи.

Варианты:

  • false
  • true

suspend_individual

логическое значение

Определяет, включён ли режим приостановки отдельных каналов (Suspend Individual).

Этот параметр формирует политику управления LACP; если задана одна настройка, все остальные свойства управления, оставленные неопределёнными или установленными в false, перестанут существовать после выполнения задачи.

Если при создании значение не задано, APIC использует значение true по умолчанию.

Варианты:

  • false
  • true

symmetric_hash

логическое значение

Определяет, включено ли симметричное хеширование.

Этот параметр формирует политику управления LACP; если задана одна настройка, все остальные свойства управления, оставленные неопределёнными или установленными в false, перестанут существовать после выполнения задачи.

Если при создании значение не задано, APIC использует значение false по умолчанию.

Варианты:

  • false
  • true

timeout

целое число

Тайм-аут на уровне сокета в секундах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_TIMEOUT.

Значение по умолчанию: 30.

use_proxy

логическое значение

Если задано false, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_USE_PROXY.

Значение по умолчанию: true.

Варианты:

  • false
  • true

use_ssl

логическое значение

Если задано false, вместо HTTPS-подключения, используемого по умолчанию, будет установлено HTTP-подключение.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_USE_SSL.

Значение по умолчанию — true, если подключение локальное.

Варианты:

  • false
  • true

username

псевдонимы: user

строка

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будут использоваться значения переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию: admin.

validate_certs

логическое значение

Если задано false, SSL-сертификаты проверяться не будут.

Устанавливайте значение false только при использовании на контролируемых вами сайтах с самоподписанными сертификатами.

Если значение не указано в задаче, вместо него будет использоваться значение переменной среды ACI_VALIDATE_CERTS.

Значение по умолчанию: true.

Варианты:

  • false
  • true

См. также

См. также

Справочник по информационной модели управления APIC

Дополнительная информация о внутреннем классе APIC lacp:LagPol.

Руководство по Cisco ACI

Подробная информация об управлении инфраструктурой ACI с помощью Ansible.

Разработка модулей Cisco ACI

Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Create a Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    mode: active
    min_links: 1
    max_links: 16
    state: present
  delegate_to: localhost

- name: Delete a Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    state: absent
  delegate_to: localhost

- name: Query all Port Channel interface policies
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Port Channel interface policy
  cisco.aci.aci_interface_policy_port_channel:
    host: apic
    username: admin
    password: SomeSecretPassword
    port_channel: LACP_ACTIVE
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ

Описание

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: при успешном выполнении

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Информация об ошибке, возвращённая APIC

Возвращается: при сбое

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: при сбое или в режиме отладки

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до запуска модуля

Возвращается: при выводе информации

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Сформированная конфигурация на основе параметров, заданных пользователем

Возвращается: при выводе информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращённый REST API APIC (xml или json)

Возвращается: при ошибке разбора

Пример: "<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"

response

string

Ответ HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: при выводе информации

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: при сбое или в режиме отладки

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Dag Wieers (@dagwieers)

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

  • Отслеживание проблем
  • Репозиторий (исходный код)

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

Spec-Zone.ru

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