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 | По умолчанию: C(private_key) basename | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию равно private_key basename без расширения.псевдонимы: cert_name |
| description | Описание EPG. псевдонимы: descr | |
| epg обязательно | Имя группы конечных точек. псевдонимы: epg_name, name | |
| fwd_control |
| Управление пересылкой, используемое EPG. APIC по умолчанию устанавливает новые EPG в значение none. |
| host обязательно | IP-адрес или имя хоста APIC, разрешимые хостом управления Ansible. псевдонимы: hostname | |
| intra_epg_isolation |
| Изоляция внутри EPG. |
| output_level |
| Влияет на вывод этого модуля ACI. normal означает стандартный вывод, включая current dictinfo означает информационный вывод, включая previous, proposed и sent dictsdebug означает вывод отладки, включая filter_string, method, response, status и url информацию |
| password обязательно | Пароль для аутентификации. | |
| port | По умолчанию: 443 (для https) и 80 (для http) | Номер порта для подключения REST. |
| preferred_group (добавлен в 2.5) |
| Является ли EPG частью предпочтительной группы и может ли он взаимодействовать без контрактов. Это очень удобно для сценариев миграции или когда ACI используется для автоматизации сети, но не для политики. |
| priority |
| Класс QoS. |
| private_key | Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указано certificate_name.псевдонимы: cert_key | |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| tenant | Имя существующего арендатора. псевдонимы: tenant_name | |
| timeout | По умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy |
| Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. |
| use_ssl |
| Если no, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. |
| username обязательно | По умолчанию: admin | Имя пользователя для аутентификации. псевдонимы: user |
| validate_certs |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать только для no на сайтах, контролируемых лично, использующих самозаверенные сертификаты. |
Примечания
Примечание
- Необходимо, чтобы
tenantиapp_profileсуществовали перед использованием этого модуля в вашей книге задач. Для этого можно использовать модули aci_tenant и aci_ap. - Дополнительная информация о внутреннем классе APIC fv:AEPg доступна в справочнике по модели управления информацией APIC.
- По умолчанию, если на целевом хосте установлена переменная среды
<protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. установку среды) или используя параметрuse_proxy. - Перенаправления HTTP могут перенаправлять с HTTP на HTTPS, поэтому вы должны убедиться, что ваша среда прокси для обоих протоколов правильна.
Примеры
- 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': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}] |
| error словарь | ошибка | Информация об ошибке, возвращённая с APIC Пример: {'text': 'неизвестный класс управляемого объекта foo', 'code': '122'} |
| filter_string строка | ошибка или отладка | Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only |
| method строка | ошибка или отладка | HTTP-метод, используемый для запроса к APIC Пример: POST |
| previous список | информация | Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производство', 'nameAlias': '', 'ownerTag': ''}}}] |
| proposed словарь | информация | Собраная конфигурация из параметров, заданных пользователем Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}} |
| 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-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- 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.5/modules/aci_epg_module.html