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

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install cisco.aci.

Для использования в книге задач укажите: cisco.aci.aci_tenant_span_src_group.

Обзор
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
admin_state boolean	Варианты: no yes	Включение или отключение источников span. APIC по умолчанию устанавливает значение `yes` при отсутствии задания при создании.
annotation string		Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_ANNOTATION`.
certificate_name string		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла в формате `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description string		Описание группы источников Span. псевдонимы: descr
dst_group string		Группа назначения Span для ассоциации с группой источников.
host string / required		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`. псевдонимы: hostname
name_alias string		Псевдоним текущего объекта. Относится к полю nameAlias в ACI.
output_level string	Варианты: debug info normal ←	Влияние на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`.
output_path string		Путь к файлу, который будет использоваться для вывода объектов конфигурации ACI в формате JSON, сгенерированных модулем. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OUTPUT_PATH`.
owner_key string		Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OWNER_KEY`.
owner_tag string		Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять свои собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_OWNER_TAG`.
password string		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также указан `private_key`, он будет использован вместо него. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer		Порт, который будет использоваться для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PORT`.
private_key string		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_PRIVATE_KEY`. псевдонимы: cert_key
src_group string		Имя группы источников Span. псевдонимы: name
state string	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода списка объектов или нескольких объектов.
tenant string		Имя клиента. псевдонимы: tenant_name
timeout integer	По умолчанию: 30	Таймаут сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_TIMEOUT`.
use_proxy boolean	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_PROXY`.
use_ssl boolean	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS подключения будет использовано HTTP подключение. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_USE_SSL`.
username string	По умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы переменные среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs boolean	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это должно быть установлено в `no` только при работе с сайтами, контролируемыми пользователем, использующими самозаверяющие сертификаты. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_VALIDATE_CERTS`.

Примечания

Примечание

Необходимый tenant должен существовать перед использованием этого модуля в вашей книге задач. Для этого можно использовать модуль cisco.aci.aci_tenant.

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
Справочник по модели управления информацией APIC: Дополнительная информация о внутреннем классе APIC span:SrcGrp.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- 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 }}"
  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 строка	ошибка разбора	Необработанный вывод, возвращённый 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 url для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Jacob McGill (@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.10/collections/cisco/aci/aci_tenant_span_src_group_module.html