aci_aep - Управление объектами прикреплённых профилей доступа (AEP) (infra:AttEntityP, infra:ProvAcc)
Новая версия с 2.4.
Краткое описание
- Подключение к внешним виртуальным и физическим доменам с помощью прикрепляемых профилей доступа (AEP) на Cisco ACI-матрицах.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aep обязательно | Имя прикрепляемого профиля доступа. псевдонимы: aep_name, name | |
| certificate_name | По умолчанию: C(private_key) basename | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию равно private_key basename без расширения.псевдонимы: cert_name |
| description | Описание AEP. псевдонимы: descr | |
| host обязательно | IP-адрес или имя хоста APIC, разрешимые управляющим хостом Ansible. псевдонимы: hostname | |
| infra_vlan (добавлен в 2.5) |
| Включить инфраструктурную VLAN. Функции гипервизора AEP. no отключит инфраструктурную VLAN, если она включена.псевдонимы: infrastructure_vlan |
| output_level |
| Влияет на вывод этого модуля ACI. normal означает стандартный вывод, включая current dictinfo означает информационный вывод, включая previous, proposed и sent dictsdebug означает отладочный вывод, включая filter_string, method, response, status и url информацию |
| password обязательно | Пароль для аутентификации. | |
| port | По умолчанию: 443 (для https) и 80 (для http) | Номер порта для подключения REST. |
| private_key | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указано certificate_name. псевдонимы: cert_key | |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| timeout | По умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy |
| Если no, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. |
| use_ssl |
| Если no, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. |
| username обязательно | По умолчанию: admin | Имя пользователя для аутентификации. псевдонимы: user |
| validate_certs |
| Если no, сертификаты SSL не будут проверены.Это следует устанавливать только в no на сайтах с собственным контролем, использующих самоподписанные сертификаты. |
Примечания
Примечание
- Дополнительную информацию о внутренних классах APIC infra:AttEntityP и infra:ProvAcc можно найти в справочнике по модели информации управления APIC.
- По умолчанию, если на целевом хосте установлена переменная среды
<protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, задав переменную для этой задачи (см. настройка среды) или используя параметрuse_proxy. - HTTP-редиректы могут перенаправлять с HTTP на HTTPS, поэтому убедитесь, что ваша среда прокси для обоих протоколов корректна.
Примеры
- name: Add a new AEP
aci_aep:
host: apic
username: admin
password: SomeSecretPassword
aep: ACI-AEP
description: default
state: present
- name: Remove an existing AEP
aci_aep:
host: apic
username: admin
password: SomeSecretPassword
aep: ACI-AEP
state: absent
- name: Query all AEPs
aci_aep:
host: apic
username: admin
password: SomeSecretPassword
state: query
- name: Query a specific AEP
aci_aep:
host: apic
username: admin
password: SomeSecretPassword
aep: ACI-AEP
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 строка | ошибка разбора | Необработанный вывод, возвращенный 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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Автор
- 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_aep_module.html