Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, привязанного к пользователю AAA APIC и используемого для аутентификации на основе подписи.

Если указан файл 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) или внешним доменом L2 (l2dom).

Варианты:

  • "l2dom"
  • "phys"
  • "vmm"

encap

integer

Инкапсуляция VLAN для EPG при привязке домена VMM в режиме статического VLAN.

В пользовательском интерфейсе режим VLAN устанавливается в статический, если encap не задан.

При использовании useg этот параметр служит вторичной инкапсуляцией.

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

encap_mode

string

Используемый метод инкапсуляции.

При создании APIC по умолчанию устанавливает значение auto, если параметр не задан.

Если выбрано vxlan, параметр switching_mode должен иметь значение «AVE».

Варианты:

  • "auto"
  • "vlan"
  • "vxlan"

enhanced_lag_policy

aliases: lag_policy

string

Имя расширенной политики LAG домена VMM.

epg

aliases: epg_name, name

string

Имя группы конечных точек.

epg_cos

string

Класс обслуживания (CoS).

При создании APIC по умолчанию устанавливает значение cos_0, если параметр не задан.

Варианты:

  • "cos_0"
  • "cos_1"
  • "cos_2"
  • "cos_3"
  • "cos_4"
  • "cos_5"
  • "cos_6"
  • "cos_7"

epg_cos_preference

string

Приоритет CoS.

При создании APIC по умолчанию устанавливает значение disabled, если параметр не задан.

Варианты:

  • "enabled"
  • "disabled"

forged_transmits

string

Разрешить передачу поддельных кадров. Поддельный кадр передаётся, когда сетевой адаптер начинает отправлять трафик, выдавая себя за другое устройство.

Варианты:

  • "accept"
  • "reject" ← (по умолчанию)

host

aliases: hostname

string

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

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

ipam_dhcp_override

string

Переопределение протокола динамической настройки узлов (DHCP) в системе управления IP-адресами (IPAM).

Применимо только для доменов Nutanix.

ipam_enabled

boolean

Состояние IPAM (включена или отключена).

Применимо только для доменов Nutanix.

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

Варианты:

  • false
  • true

ipam_gateway

string

Шлюз IPAM.

Применимо только для доменов Nutanix.

lag_policy_name

string

Имя политики группы агрегации каналов (LAG).

mac_changes

string

Разрешает задавать новые MAC-адреса для сетевого адаптера виртуальной машины (VM).

Варианты:

  • "accept"
  • "reject" ← (по умолчанию)

netflow

boolean

Определяет, следует ли включить NetFlow.

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

Варианты:

  • false
  • true

netflow_direction

string

Направление мониторинга NetFlow.

При создании APIC по умолчанию устанавливает значение both, если параметр не задан.

Варианты:

  • "both"
  • "ingress"
  • "egress"

number_of_ports

integer

Количество портов.

output_level

string

Управляет выводом этого модуля ACI.

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

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

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.

primary_encap_inner

integer

Основная внутренняя инкапсуляция.

Используется для группы портов на распределённом виртуальном коммутаторе VMWare (DVS).

Эта VLAN является внутренней для DVS и используется для связи между другими VM и VM AVE на узле.

Трафик не передаётся через эту VLAN в фабрику.

Применимо только для доменов Cisco ACI Virtual Edge (AVE).

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

private_key

aliases: cert_key

string

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

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

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

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

promiscuous

string

Разрешить или запретить неразборчивый режим в домене VMM.

Варианты:

  • "accept"
  • "reject" ← (по умолчанию)

resolution_immediacy

string

Определяет, когда политики должны быть разрешены и стать доступными.

При создании APIC по умолчанию устанавливает значение lazy, если параметр не задан.

Варианты:

  • "immediate"
  • "lazy"
  • "pre-provision"

secondary_encap_inner

integer

Вторичная внутренняя инкапсуляция.

Используется для группы портов на DVS VMWare.

Эта VLAN является внутренней для DVS и используется для связи между другими VM и VM AVE на узле.

Трафик не передаётся через эту VLAN в фабрику.

Применимо только для доменов AVE.

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

state

string

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

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

Варианты:

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

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Варианты:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

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

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

Варианты:

  • false
  • true

switching_mode

string

Режим коммутации, используемый коммутатором.

Варианты:

  • "AVE"
  • "native" ← (по умолчанию)

tenant

aliases: 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"
  • "nutanix"

vmm_uplink_active

list / elements=string

Список идентификаторов активных восходящих каналов.

Порядок определяет, в какой последовательности активные восходящие каналы будут заменять отказавший канал.

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

vmm_uplink_standby

list / elements=string

Список идентификаторов резервных восходящих каналов.

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

Примечания

Примечание

  • Объекты 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

Дополнительные сведения о внутреннем классе 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 после завершения работы модуля

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

Пример: [{"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"

Авторы

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

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

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

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

Spec-Zone.ru

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