модуль cisco.aci.aci_bd_to_l3out — привязка домена моста к L3 Out (fv:RsBDToOut)

Примечание

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

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

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

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

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

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

Привязка домена моста к L3 Out в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него используется значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
bd псевдонимы: bd_name, bridge_domain строка	Имя домена моста.
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, связанного с пользователем APIC AAA, который используется для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него используется значение переменной среды `ACI_CERTIFICATE_NAME`.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, которое может разрешить управляющий узел Ansible. Если значение не указано в задаче, вместо него используется значение переменной среды `ACI_HOST`.
l3out строка	Имя 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`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверено, а запрос POST на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, после отправки обновления POST в APIC проверочный запрос GET не выполняется. Если значение не указано в задаче, вместо него используется значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение current будет установлено в предложенное значение. Текущее состояние объекта, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `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`

Примечания

Примечание

Перед использованием этого модуля должны существовать параметры bd и l3out. Для их создания можно использовать cisco.aci.aci_bd и aci_l3out.

См. также

cisco.aci.aci_bd: Управление объектами доменов моста (BD) (fv:BD).
cisco.aci.aci_l3out: Управление объектами внешнего уровня 3 (L3Out) (l3ext:Out).
Справочник по информационной модели управления APIC: Дополнительная информация о внутреннем классе APIC fv:RsBDToOut.
Руководство по Cisco ACI: Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Bind Bridge Domain to L3 Out
  cisco.aci.aci_bd_to_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    bd: web_servers
    l3out: prod_l3out
    tenant: prod
    state: present
  delegate_to: localhost

- name: Unbind Bridge Domain from L3 Out
  cisco.aci.aci_bd_to_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    bd: web_servers
    l3out: prod_l3out
    tenant: prod
    state: absent
  delegate_to: localhost

- name: Query all Bridge Domains bound to L3 Outs
  cisco.aci.aci_bd_to_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query specific Bridge Domain(s) bound to an L3 Out
  cisco.aci.aci_bd_to_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    bd: web_servers
    l3out: prod_l3out
    tenant: prod
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
current список / элементы=строка	Текущая конфигурация из APIC после выполнения модуля Возвращается: при успешном выполнении Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Сведения об ошибке, возвращенные APIC Возвращается: при сбое Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Строка фильтра, использованная в запросе Возвращается: при сбое или отладке Пример: `"?rsp-prop-include=config-only"`
method строка	Метод HTTP, использованный для запроса к APIC Возвращается: при сбое или отладке Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация из APIC до запуска модуля Возвращается: при выводе сведений Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собранная конфигурация на основе параметров, предоставленных пользователем Возвращается: при выводе сведений Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод, возвращенный 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 строка	Ответ HTTP от APIC Возвращается: при сбое или отладке Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: при выводе сведений Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	Статус HTTP от APIC Возвращается: при сбое или отладке Пример: `200`
url строка	URL HTTP, использованный для запроса к APIC Возвращается: при сбое или отладке Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Jacob McGill (@jmcgill298)

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

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