aci_tenant_span_dst_group – Управление группами назначения SPAN (span:DestGrp)
Новая версия с версии 2.4.
Описание
- Управление группами назначения SPAN на Cisco ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| certificate_name строка | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла private_key, по умолчанию используется имя файла private_key, без расширения.Если для private_key предоставлено содержимое в формате PEM, по умолчанию используется значение username. алиасы: cert_name | |
| description строка | Описание группы назначения SPAN. алиасы: descr | |
| dst_group строка / обязательно | Имя группы назначения SPAN. алиасы: name | |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешаемое управляющим хостом Ansible. алиасы: hostname | |
| 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. | |
| 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. Для этого можно использовать модуль aci_tenant.
См. также
См. также
- aci_tenant – Управление клиентами (fv:Tenant)
- Официальная документация по модулю aci_tenant.
- Справочник по модели информации управления APIC
- Дополнительная информация о внутреннем классе APIC span:DestGrp.
- Руководство по Cisco ACI
- Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
- Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.
Примеры
- aci_tenant_span_dst_group:
host: apic
username: admin
password: SomeSecretPassword
dst_group: '{{ dst_group }}'
description: '{{ descr }}'
tenant: '{{ tenant }}'
delegate_to: localhost
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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 строка | ошибка разбора | Необработанный результат, возвращенный 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 |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается партнером Ansible. [сертифицированный]
Авторы
- Dag Wieers (@dagwieers)
Подсказка
Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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_tenant_span_dst_group_module.html