aci_epg - Управление объектами групп конечных точек (EPG) (fv:AEPg)

Новое в версии 2.4.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Управление группами конечных точек (EPG) на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
ap обязательно		Имя существующего профиля прикладной сети, который будет содержать EPG. псевдонимы: app_profile, app_profile_name
bd обязательно		Имя домена моста, ассоциируемого с EPG. псевдонимы: bd_name, bridge_domain
certificate_name		Имя сертификата X.509, прикрепленного к пользователю AAA APIC, используемому для аутентификации на основе подписи. По умолчанию используется `private_key` имя без расширения. псевдонимы: cert_name
description		Описание EPG. псевдонимы: descr
epg обязательно		Имя группы конечных точек. псевдонимы: epg_name, name
fwd_control	Варианты: none proxy-arp	Управление передачей, используемое EPG. APIC по умолчанию устанавливает значение `none`, если оно не задано при создании.
host обязательно		IP-адрес или имя хоста APIC, разрешаемого хостом управления Ansible. псевдонимы: hostname
intra_epg_isolation	Варианты: enforced unenforced	Изоляция внутри EPG. APIC по умолчанию устанавливает значение `unenforced`, если оно не задано при создании.
output_level	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password обязательно		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если также указан `private_key`, он будет использован вместо него.
port		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
preferred_group bool (добавлен в 2.5)	Варианты: no yes	Указывает, является ли EPG частью предпочтительной группы и может ли он общаться без контрактов. Это очень удобно для сценариев миграции или когда ACI используется для автоматизации сети, но не для политики. APIC по умолчанию устанавливает значение `no`, если оно не задано при создании.
priority	Варианты: level1 level2 level3 unspecified	Класс QoS. APIC по умолчанию устанавливает значение `unspecified`, если оно не задано при создании.
private_key обязательно		Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указано `certificate_name`. Этот параметр взаимоисключает `password`. Если также указан `password`, он будет проигнорирован. псевдонимы: cert_key
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant		Имя существующего арендатора. псевдонимы: tenant_name
timeout int	По умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS соединения будет использовано HTTP соединение.
username	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить на `no` только при использовании на контролируемых сайтах с самозаверяющими сертификатами.

Примечания

Примечание

Обеспечьте существование tenant и app_profile перед использованием этого модуля в вашем плейбуке. Для этого можно использовать модули aci_tenant и aci_ap.
Дополнительную информацию о внутреннем классе APIC fv:AEPg можно найти в справочнике по модели информации управления APIC.
Более подробную информацию о том, как управлять инфраструктурой ACI с помощью Ansible, можно найти в Руководстве Cisco ACI.

Примеры

- name: Add a new EPG
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: intranet
    epg: web_epg
    description: Web Intranet EPG
    bd: prod_bd
    preferred_group: yes

- aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    epg: "{{ item.epg }}"
    description: Ticketing EPG
    bd: "{{ item.bd }}"
    priority: unspecified
    intra_epg_isolation: unenforced
    state: present
  with_items:
    - epg: web
      bd: web_bd
    - epg: database
      bd: database_bd

- name: Remove an EPG
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    tenant: production
    app_profile: intranet
    epg: web_epg
    state: absent

- name: Query an EPG
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: ticketing
    epg: web_epg
    state: query

- name: Query all EPGs
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query

- name: Query all EPGs with a Specific Name
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    epg: web_epg
    state: query

- name: Query all EPGs of an App Profile
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    ap: ticketing
    state: query

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

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

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

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.

Техническое обслуживание

Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Смотрите Поддержка и обслуживание модулей для получения дополнительной информации.

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

Автор

Swetha Chunduri (@schunduri)

Подсказка

Если вы обнаружите какие-либо проблемы в этом руководстве, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aci_epg_module.html