aci_l3out_extepg – Управление профилями экземпляров внешней сети (ExtEpg) (l3extInstP:instP)
Новая в версии 2.9.
Обзор
- Управление объектами профилей экземпляров внешней сети (ExtEpg) (l3extInstP:instP)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name строка | Имя X.509 сертификата, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла private_key, по умолчанию используется имя файла private_key, без расширения.Если для private_key предоставлено содержимое в формате PEM, по умолчанию используется значение username. Псевдонимы: cert_name | |
| description строка | Описание для ExtEpg. Псевдонимы: descr | |
| dscp строка |
| Целевое значение DSCP (Differentiated Service). APIC по умолчанию устанавливает значение unspecified, если параметр не задан при создании.Псевдонимы: target |
| extepg строка / обязательно | Имя создаваемого ExtEpg. Псевдонимы: extepg_name, name | |
| host строка / обязательно | IP-адрес или имя хоста, разрешаемого контрольным хостом Ansible. Псевдонимы: hostname | |
| l3out строка / обязательно | Имя существующего L3Out. Псевдонимы: l3out_name | |
| output_level строка |
| Влияние на вывод этого модуля 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 булево |
| Принадлежность EPG к группе Preferred Group, позволяющая общаться без контрактов. Это очень удобно для сценариев миграции или когда ACI используется для автоматизации сети, но не для политики. APIC по умолчанию устанавливает значение no, если параметр не задан при создании. |
| private_key строка / обязательно | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию certificate_name, которое используется.Этот параметр взаимоисключающий с password. Если предоставлен и password, он будет проигнорирован.Псевдонимы: cert_key | |
| state строка |
| Используйте 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,domainиvrfдолжны существовать перед использованием этого модуля в вашем плейбуке. Для этого можно использовать модули aci_tenant, aci_domain и aci_vrf.
См. также
См. также
- aci_tenant – Управление арендаторами (fv:Tenant)
- Официальная документация по модулю aci_tenant.
- aci_domain – Управление физическими, виртуальными, мостовыми, маршрутизированными или FC профилями доменов (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP)
- Официальная документация по модулю aci_domain.
- aci_vrf – Управление контекстами или VRF (fv:Ctx)
- Официальная документация по модулю aci_vrf.
- Ссылка на модель управления информацией APIC
- Дополнительная информация о внутреннем классе APIC l3ext:Out.
- Руководство по Cisco ACI
- Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
- Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Add a new ExtEpg
aci_l3out_extepg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
name: prod_extepg
description: ExtEpg for Production L3Out
state: present
delegate_to: localhost
- name: Delete ExtEpg
extepg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
name: prod_extepg
state: absent
delegate_to: localhost
- name: Query ExtEpg information
aci_l3out_extepg:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
name: prod_extepg
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 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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Статус
- Этот модуль не гарантирует обратную совместимость. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицировано]
Авторы
- Ростислав Давыденко (@rost-d)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aci_l3out_extepg_module.html