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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
allow_useg string	Разрешает микросегментацию. APIC по умолчанию использует `encap` при создании, если значение не задано. Варианты: `"encap"` `"useg"`
annotation string	Определяемая пользователем строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменной среды `ACI_ANNOTATION`, будет использовано значение по умолчанию. Значение по умолчанию: `"orchestrator:ansible"`
ap aliases: app_profile, app_profile_name string	Имя существующего профиля прикладной сети, который будет содержать EPG.
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, значение по умолчанию — это базовое имя `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, значение по умолчанию — `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
custom_epg_name string	Настраиваемое имя epg в ассоциации домена VMM.
delimiter string	Разделитель. Варианты: `"\|"` `"~"` `"!"` `"@"` `"^"` `"+"` `"="` `"_"`
deploy_immediacy string	Определяет, когда политика передается в аппаратную память CAM политик. APIC по умолчанию использует `lazy` при создании, если значение не задано. Варианты: `"immediate"` `"lazy"`
domain aliases: domain_name, domain_profile string	Имя физического или виртуального домена, ассоциируемого с EPG.
domain_type aliases: type string	Указывает, является ли домен физическим (phys), виртуальным (vmm) или ассоциацией внешнего домена уровня 2 (l2dom). Варианты: `"l2dom"` `"phys"` `"vmm"`
encap integer	VLAN-инкапсуляция для EPG при привязке домена VMM со статическим `encap_mode`. Действует как вторичная инкапсуляция при использовании useg. Допустимые значения находятся в диапазоне от `1` до `4096`.
encap_mode string	Метод инкапсуляции, который будет использоваться. APIC по умолчанию использует `auto` при создании, если значение не задано. Если выбран vxlan, switching_mode должен быть «AVE». Варианты: `"auto"` `"vlan"` `"vxlan"`
enhanced_lag_policy aliases: lag_policy string	Имя политики расширенного агрегирования каналов домена VMM.
epg aliases: epg_name, name string	Имя группы конечных точек.
forged_transmits string	Разрешить поддельные передачи. Поддельная передача происходит, когда сетевой адаптер начинает отправлять трафик, идентифицируя себя как что-то другое. Варианты: `"accept"` `"reject"` ← (по умолчанию)
host aliases: hostname string	IP-адрес или имя хоста APIC, разрешаемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_HOST`.
mac_changes string	Разрешает определение новых MAC-адресов для сетевого адаптера внутри виртуальной машины (VM). Варианты: `"accept"` `"reject"` ← (по умолчанию)

netflow boolean	Определяет, следует ли включать netflow. APIC по умолчанию использует `false` при отсутствии значения во время создания. Варианты: `false` `true`
number_of_ports integer	Количество портов.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI JSON, созданных модулем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
password string	Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если также указан `private_key`, он будет использован вместо него. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта, который будет использоваться для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PORT`.
port_allocation string	Метод распределения портов. Варианты: `"elastic"` `"fixed"`
port_binding string	Метод привязки портов. Варианты: `"dynamic"` `"ephemeral"` `"static"`
primary_encap integer	Определяет основной идентификатор VLAN при использовании useg. Допустимые значения находятся в диапазоне от `1` до `4096`.
private_key алиасы: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Этот параметр взаимоисключает `password`. Если также указан `password`, он будет игнорироваться. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
promiscuous string	Разрешить/Запретить promiscuous mode в домене vmm Варианты: `"accept"` `"reject"` ← (по умолчанию)
resolution_immediacy string	Определяет, когда политики должны быть разрешены и доступны. APIC по умолчанию использует `lazy` при отсутствии значения во время создания. Варианты: `"immediate"` `"lazy"` `"pre-provision"`
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous алиасы: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification алиасы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, подтверждающий запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет непроверяемым в одной задаче. Варианты: `false` `true`

switching_mode string	Режим коммутации, используемый коммутатором Варианты: `"AVE"` `"native"` ← (по умолчанию)
tenant псевдонимы: tenant_name string	Имя существующего арендатора.
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
untagged_vlan boolean	VLAN доступа не маркируется. Варианты: `false` `true`
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS соединения будет использоваться HTTP соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию true, когда подключение локальное. Варианты: `false` `true`
username псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это должно быть установлено в `false` только при работе с сайтами, контролируемыми лично, с использованием самозаверяющих сертификатов. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Варианты: `false` `true`
vm_provider string	Платформа виртуальной машины для VMM доменов. Поддержка Kubernetes была добавлена в ACI v3.0. Поддержка CloudFoundry, OpenShift и Red Hat была добавлена в ACI v3.1. Варианты: `"cloudfoundry"` `"kubernetes"` `"microsoft"` `"openshift"` `"openstack"` `"redhat"` `"vmware"`
vmm_uplink_active список / элементы=строка	Список активных идентификаторов каналов связи. Порядок определяет порядок, в котором активные каналы связи перенимают функции при выходе из строя канала связи. При конфигурировании активного канала связи в списке должен оставаться хотя бы один активный канал.
vmm_uplink_standby список / элементы=строка	Список резервных идентификаторов каналов связи. При отсутствии активных каналов связи в списке должен оставаться хотя бы один резервный канал связи.

Примечания

Примечание

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

См. также

cisco.aci.aci_ap: Управление объектами профилей приложений верхнего уровня (AP) (fv:Ap).
cisco.aci.aci_epg: Управление объектами групп конечных точек (EPG) (fv:AEPg).
cisco.aci.aci_domain: Управление физическими, виртуальными, мостовыми, маршрутизированными или FC профилями доменов (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP).
APIC Management Information Model reference: Дополнительная информация о внутренней 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 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 или debug Пример: `"?rsp-prop-include=config-only"`
method string	HTTP-метод, используемый для запроса к APIC Возвращается: failure или 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 foo\"/></imdata>"`
response string	HTTP-ответ от APIC Возвращается: failure или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	HTTP-статус от APIC Возвращается: failure или debug Пример: `200`
url string	HTTP-URL, используемый для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

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

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/aci/aci_epg_to_domain_module.html