модуль cisco.aci.aci_l3out_bfd_interface_profile – управление профилями интерфейсов BFD L3Out (bfd:IfP)

Примечание

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

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

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

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

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

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

Управление конфигурацией профилей интерфейсов BFD L3Out на фабриках Cisco ACI
Доступно только в APIC версии 5.2 и выше и для облачных APIC

Параметры

Параметр	Комментарии
annotation строка	Строка, заданная пользователем для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
authentication_type строка	Тип аутентификации объекта профиля интерфейса BFD L3Out APIC задает значение по умолчанию none Варианты: `"none"` `"sha1"`
bfd_interface_policy псевдонимы: interface_policy, interface_policy_name строка	Имя политики интерфейса
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, привязанного к пользователю APIC AAA и используемого для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание объекта профиля интерфейса BFD L3Out
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_HOST`.
key строка	Ключ аутентификации объекта профиля интерфейса BFD L3Out Указание этого параметра всегда приводит к изменению, поскольку это защищенное свойство, которое невозможно получить из APIC.
key_id целое число	Идентификатор ключа аутентификации объекта профиля интерфейса BFD L3Out APIC задает значение по умолчанию 3 Допустимый диапазон: 1–255
l3out псевдонимы: l3out_name строка	Имя существующего L3Out
l3out_logical_interface_profile псевдонимы: logical_interface_profile, logical_interface_profile_name строка	Имя существующего логического профиля интерфейса L3Out
l3out_logical_node_profile псевдонимы: logical_node_profile, logical_node_profile_name строка	Имя существующего логического профиля узла L3Out
name псевдонимы: bfd_multihop_interface_profile строка	Имя объекта профиля интерфейса BFD L3Out
name_alias строка	Псевдоним имени объекта профиля интерфейса BFD L3Out
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`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, будет использовано его значение. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PORT`.
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`
tenant псевдонимы: tenant_name строка	Имя существующего арендатора
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`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должны существовать tenant, c(l3out), l3out_logical_node_profile и l3out_logical_interface_profile. Для этого можно использовать модули cisco.aci.aci_tenant

См. также

Справочник по информационной модели управления APIC: Дополнительная информация о внутреннем классе APIC bfd:IfP
cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_l3out: Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).
cisco.aci.aci_l3out_logical_node_profile: Управление логическими профилями узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).
cisco.aci.aci_l3out_logical_interface_profile: Управление логическими профилями интерфейсов Layer 3 Outside (L3Out) (l3ext:LIfP).
cisco.aci.aci_interface_policy_bfd: Управление политиками интерфейсов BFD (bfd:IfPol).
Руководство по Cisco ACI: Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add a new L3Out BFD Interface Profile
  cisco.aci.aci_l3out_bfd_interface_profile:
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    l3out_logical_node_profile: ansible_node_profile
    l3out_logical_interface_profile: ansible_interface_profile
    state: present
  delegate_to: localhost

- name: Query a new L3Out BFD Interface Profile
  cisco.aci.aci_l3out_bfd_interface_profile:
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    l3out_logical_node_profile: ansible_node_profile
    l3out_logical_interface_profile: ansible_interface_profile
    state: query
  delegate_to: localhost

- name: Query all L3Out BFD Interface Profile
  cisco.aci.aci_l3out_bfd_interface_profile:
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete L3Out BFD Interface Profile
  cisco.aci.aci_l3out_bfd_interface_profile:
    username: admin
    password: SomeSecretPassword
    tenant: ansible_tenant
    l3out: ansible_l3out
    l3out_logical_node_profile: ansible_node_profile
    l3out_logical_interface_profile: ansible_interface_profile
    state: absent
  delegate_to: localhost

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

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

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

Авторы

Anvitha Jain (@anvjain)

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

© 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_l3out_bfd_interface_profile_module.html