cisco.aci.aci_epg_to_domain – Привязка EPG к доменам (fv:RsDomAtt)

Примечание

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

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

Для использования в плейбуке укажите: cisco.aci.aci_epg_to_domain

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

Обзор

Привязка EPG к физическим и виртуальным доменам на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
allow_useg строка	Варианты: encap useg	Разрешает микросегментацию. APIC по умолчанию использует `encap`, если значение не задано при создании.
annotation строка		Пользовательская строка для аннотации объекта. Если значение не задано в задании, используется значение переменной окружения `ACI_ANNOTATION`.
ap строка		Имя существующего профиля сетевой инфраструктуры приложения, который будет содержать EPG. псевдонимы: app_profile, app_profile_name
certificate_name строка		Имя сертификата X.509, прикреплённого к пользователю AAA APIC, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не задано в задании, используется значение переменной окружения `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
deploy_immediacy строка	Варианты: immediate lazy	Определяет, когда политика отправляется на аппаратный CAM Политики. APIC по умолчанию использует `lazy`, если значение не задано при создании.
domain строка		Имя физического или виртуального домена, ассоциируемого с EPG. псевдонимы: domain_name, domain_profile
domain_type строка	Варианты: l2dom phys vmm	Указывает, является ли домен физическим (phys), виртуальным (vmm) или доменной ассоциацией внешнего L2 (l2dom). псевдонимы: type
encap целое число		Капсулирование VLAN для EPG при связывании виртуального домена с `encap_mode`. Действует как вторичное капсулирование при использовании useg. Допустимые значения в диапазоне от `1` до `4096`.
encap_mode строка	Варианты: auto vlan vxlan	Способ капсулирования, который будет использоваться. APIC по умолчанию использует `auto`, если значение не задано при создании. Если выбран vxlan, switching_mode должен быть «AVE».
epg строка		Имя группы конечных точек. псевдонимы: epg_name, name
host строка / обязательно		IP-адрес или имя хоста, разрешаемое хостом управления Ansible. Если значение не задано в задании, используется значение переменной окружения `ACI_HOST`. псевдонимы: hostname
netflow булево	Варианты: no yes	Определяет, нужно ли включить netflow. APIC по умолчанию использует `no`, если значение не задано при создании.
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`.
primary_encap целое число		Определяет основной идентификатор VLAN при использовании useg. Допустимые значения в диапазоне от `1` до `4096`.
private_key строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимно исключает `password`. Если `password` также указан, он будет проигнорирован. Если значение не задано в задании, используется значение переменной окружения `ACI_PRIVATE_KEY`. псевдонимы: cert_key
promiscuous строка	Варианты: accept reject ←	Разрешить/Запретить режим promiscuous в домене vmm
resolution_immediacy строка	Варианты: immediate lazy pre-provision	Определяет, когда политики должны быть разрешены и доступны. APIC по умолчанию использует `lazy`, если значение не задано при создании.
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
switching_mode строка	Варианты: AVE native ←	Режим коммутации, используемый коммутатором
tenant строка		Имя существующего арендатора. псевдонимы: tenant_name
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не задано в задании, используется значение переменной окружения `ACI_TIMEOUT`.
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Если значение не задано в задании, используется значение переменной окружения `ACI_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не задано в задании, используется значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не задано в задании, используется значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в значение `no` только при использовании на сайтах, контролируемых лично, с самозаверенными сертификатами. Если значение не задано в задании, используется значение переменной окружения `ACI_VALIDATE_CERTS`.
vm_provider строка	Варианты: cloudfoundry kubernetes microsoft openshift openstack redhat vmware	Платформа виртуальных машин для виртуальных доменов (VMM). Поддержка Kubernetes добавлена в ACI v3.0. Поддержка CloudFoundry, OpenShift и Red Hat добавлена в ACI v3.1.

Примечания

Примечание

Необходимо, чтобы tenant, ap, epg, и domain были созданы перед использованием этого модуля в вашем плане. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_ap, cisco.aci.aci_epg и cisco.aci.aci_domain.
Домены VMM OpenStack не должны создаваться с помощью этого модуля. Домен OpenStack VMM создаётся напрямую плагином Cisco APIC Neutron в ходе установки и настройки. Этот модуль можно использовать для запроса состояния домена OpenStack VMM.

См. также

cisco.aci.aci_ap: Официальная документация по модулю cisco.aci.aci_ap.
cisco.aci.aci_epg: Официальная документация по модулю cisco.aci.aci_epg.
cisco.aci.aci_domain: Официальная документация по модулю cisco.aci.aci_domain.
Справочник по модели управления информацией APIC: Дополнительная информация о внутренней APIC-классе fv:RsDomAtt.
Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new physical domain to EPG binding
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    domain: anstest
    domain_type: phys
    state: present
  delegate_to: localhost

- name: Remove an existing physical domain to EPG binding
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    domain: anstest
    domain_type: phys
    state: absent
  delegate_to: localhost

- name: Query a specific physical domain to EPG binding
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: anstest
    ap: anstest
    epg: anstest
    domain: anstest
    domain_type: phys
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all domain to EPG bindings
  cisco.aci.aci_epg_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Возвращённое значение	Описание
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 строка	ошибка или отладка	Используемый URL HTTP для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Jacob McGill (@jmcgill298)
Shreyas Srish (@shrsr)

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