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, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. псевдонимы: cert_name
description строка		Описание EPG. псевдонимы: descr
epg строка / обязательно		Имя группы конечных точек. псевдонимы: epg_name, name
fwd_control строка	Варианты: none proxy-arp	Контроль переадресации, используемый EPG. APIC по умолчанию использует `none`, если этот параметр не задан при создании.
host строка / обязательно		IP-адрес или имя хоста, разрешаемого хостом управления 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 логическое значение добавлено в 2.5	Варианты: нет да	Является ли EPG частью Предпочтительной группы и может ли он взаимодействовать без контрактов. Это очень удобно для сценариев миграции или когда ACI используется для автоматизации сети, но не для политики. APIC по умолчанию использует `no` при отсутствии настройки при создании.
priority строка	Варианты: level1 level2 level3 unspecified	Класс QoS. APIC по умолчанию использует `unspecified` при отсутствии настройки при создании.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр исключает `password`. Если также указан `password`, он будет проигнорирован. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
tenant строка		Имя существующего клиента. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy логическое значение	Варианты: нет да ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах.
use_ssl логическое значение	Варианты: нет да ←	Если `no`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs логическое значение	Варианты: нет да ←	Если `no`, сертификаты SSL не будут проверены. Это следует установить только в `no` случае использования на сайтах с собственным сертификатом.

Примечания

Примечание

Перед использованием этого модуля в вашем плейбуке должны существовать tenant и app_profile. Для этого можно использовать модули aci_tenant и aci_ap.

См. также

aci_tenant – Управление клиентами (fv:Tenant): Официальная документация по модулю aci_tenant.
aci_ap – Управление профилями приложений верхнего уровня (AP) (fv:Ap): Официальная документация по модулю aci_ap.
Ссылка на справочник модели информации управления APIC: Дополнительная информация о внутреннем классе APIC fv:AEPg.
Руководство Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей 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
    state: present
  delegate_to: localhost

- 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
  delegate_to: localhost
  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
  delegate_to: localhost

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

- name: Query all EPGs
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

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

- name: Query all EPGs of an App Profile
  aci_epg:
    host: apic
    username: admin
    password: SomeSecretPassword
    validate_certs: no
    ap: ticketing
    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 строка	ошибка или отладка	HTTP-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

Данный модуль не гарантирует обратной совместимости. [превью]
Данный модуль поддерживается партнером 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.8/modules/aci_epg_module.html