модуль cisco.aci.aci_access_span_src_group_src — управление источниками Access SPAN (span:Src)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_access_span_src_group_src.

Краткое описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление источниками Access SPAN в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменная окружения `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикреплённого к пользователю APIC AAA, который используется для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание источника Access SPAN.
direction строка	Направление источника SPAN. Если при создании значение не указано, APIC использует `both` по умолчанию. Варианты: `"incoming"` `"outgoing"` `"both"`
drop_packets логический	Включить SPAN только для отброшенных пакетов. Если при создании значение не указано, APIC использует `false` по умолчанию. Варианты: `false` `true`
epg словарь	Сведения об EPG — источнике SPAN. Параметры epg и routed_outside нельзя настроить одновременно.
ap псевдонимы: ap_name, app_profile, app_profile_name строка / обязательный	Имя AP — источника SPAN.
epg псевдонимы: epg_name строка / обязательный	Имя EPG — источника SPAN.
tenant псевдонимы: tenant_name строка / обязательный	Имя Tenant — источника SPAN.
filter_group строка	Имя группы фильтров Access SPAN, связываемой с источником.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level строка	Управляет выводом этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записываться созданные модулем объекты конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, который позволяет клиентам владеть своими данными для сопоставления сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять собственные данные. Например, чтобы указать, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, будет использован он. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
routed_outside словарь	Сведения о Routed Outside. Параметры epg и routed_outside нельзя настроить одновременно.
encap псевдонимы: vlan, vlan_id, encap_id целое число	VLAN, связанный с этим Routed Outside.
l3out псевдонимы: l3out_name строка	Имя L3Out — источника SPAN.
tenant псевдонимы: tenant_name строка	Имя Tenant — источника SPAN.
source псевдонимы: name, src строка	Имя источника Access SPAN.
source_group псевдонимы: src_group строка	Имя группы источников Access SPAN.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для просмотра одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логический	Если `true`, перед POST-обновлением APIC не будет отправлен GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — возвращаемое предыдущее значение будет пустым. Предыдущее состояние объекта не будет проверено, а POST-обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, после POST-обновления APIC не будет отправлен проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — в качестве текущего возвращаемого значения будет установлено предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию: 30.
use_proxy логический	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию: true. Варианты: `false` `true`
use_ssl логический	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет применяться HTTP-подключение. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию: admin.
validate_certs логический	Если `false`, SSL-сертификаты не будут проверяться. Значение `false` следует задавать только на подконтрольных вам сайтах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию: true. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должны существовать filter_group и source_group. Для этого можно использовать модули cisco.aci.aci_access_span_filter_group и cisco.aci.aci_access_span_src_group.

См. также

cisco.aci.aci_access_span_filter_group: Управление группами фильтров Access SPAN (span:FilterGrp).
cisco.aci.aci_access_span_src_group: Управление группами источников Access SPAN (span:SrcGrp).
cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_ap: Управление объектами верхнего уровня Application Profile (AP) (fv:Ap).
cisco.aci.aci_epg: Управление объектами групп конечных точек (EPG) (fv:AEPg).
cisco.aci.aci_l3out: Управление объектами внешних сетей уровня 3 (L3Out) (l3ext:Out).
Справочник модели управления информацией APIC: Дополнительные сведения о внутреннем классе APIC span:Src.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Create a Access SPAN source
  cisco.aci.aci_access_span_src_group_src:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    state: present
  delegate_to: localhost

- name: Delete a Access SPAN source
  cisco.aci.aci_access_span_src_group_src:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    state: absent
  delegate_to: localhost

- name: Query all Access SPAN sources
  cisco.aci.aci_access_span_src_group_src:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific Access SPAN source
  cisco.aci.aci_access_span_src_group_src:
    host: apic
    username: admin
    password: SomeSecretPassword
    source_group: my_span_source_group
    source: my_source
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
current list / elements=string	Текущая конфигурация APIC после выполнения модуля Возвращается: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Информация об ошибке, возвращенная APIC Возвращается: ошибка Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, использованная для запроса Возвращается: ошибка или отладка Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: ошибка или отладка Пример: `"POST"`
previous list / elements=string	Исходная конфигурация APIC до запуска модуля Возвращается: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Сформированная конфигурация на основе параметров, предоставленных пользователем Возвращается: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод, возвращенный REST API APIC (xml или json) Возвращается: ошибка разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response string	Ответ HTTP от APIC Возвращается: ошибка или отладка Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: ошибка или отладка Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: ошибка или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Akini Ross (@akinross)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_access_span_src_group_src_module.html