aci_tenant_span_src_group — Управление группами источников SPAN (span:SrcGrp)

Новая версия с 2.4.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
Техническое обслуживание
- Автор

Обзор

Управление группами источников SPAN на Cisco ACI сетях.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state	Варианты: enabled disabled	Включить или отключить источники SPAN. APIC использует значение по умолчанию `enabled`, если оно не установлено при создании.
certificate_name		Имя X.509 сертификата, привязанного к пользователю APIC AAA, используемому для аутентификации на основе сертификатов. По умолчанию используется `private_key` без расширения. Псевдонимы: cert_name
description		Описание группы источников SPAN. Псевдонимы: descr
dst_group		Группа назначения SPAN для ассоциации с группой источников.
host обязательно		IP-адрес или имя хоста APIC, разрешимый управляющим хостом Ansible. Псевдонимы: hostname
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`.
private_key обязательно		Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе сертификатов. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указан `certificate_name`. Этот параметр исключает `password`. Если `password` также указан, он будет проигнорирован. Псевдонимы: cert_key
src_group		Имя группы источников SPAN. Псевдонимы: name
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для получения списка объекта или нескольких объектов.
tenant		Имя арендатора. Псевдонимы: tenant_name
timeout int	По умолчанию: 30	Таймаут соединения на уровне сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS.
username	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самозаверенными сертификатами.

Примечания

Примечание

Требуемый tenant должен существовать перед использованием данного модуля в вашей книге задач. Для этого можно использовать модуль aci_tenant.
Дополнительная информация о внутреннем классе APIC span:SrcGrp из справочника по модели управления информацией APIC.
Для более подробной информации о том, как управлять вашей инфраструктурой ACI с помощью Ansible, прочитайте Руководство Cisco ACI.

Примеры

- aci_tenant_span_src_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    src_group: "{{ src_group }}"
    dst_group: "{{ dst_group }}"
    admin_state: "{{ admin_state }}"
    description: "{{ description }}"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращаемое значение	Описание
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. Подробнее см. Обслуживание и поддержка модулей.

Список других модулей, поддерживаемых сообществом Ansible, см. здесь.

Автор

Яков Макгилл (@jmcgill298)

Подсказка

Если вы заметили какие-либо проблемы в этом документе, вы можете отредактировать его, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aci_tenant_span_src_group_module.html