Spec-Zone.ru › Ansible 2.11

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

Примечание

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

Для его установки используйте: 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, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи.
Если был предоставлен файл с именем 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.
Выступает как вторичная encap при использовании 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 dict
info добавляет информативный вывод, включая previous, proposed и sent dicts
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 ←
Разрешить/Запретить прослушивание в виртуальном домене 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, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение.
Если значение не указано в задаче, будет использовано значение переменной окружения 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 можно использовать для этого.
  • Домены OpenStack VMM не должны создаваться с помощью этого модуля. Домен 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 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
список / элементы=строка
успех
Текущая конфигурация с 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
строка
ошибка разбора
Необработанный вывод, возвращённый APIC REST API (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
строка
ошибка или отладка
HTTP-адрес, используемый для запроса к APIC

Пример:
https://10.11.12.13/api/mo/uni/tn-production.json


Авторы

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

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

Spec-Zone.ru

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