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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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 строка / обязательно	Имя арендатора источника SPAN.
filter_group строка	Имя группы фильтров Access SPAN для ассоциации с источником.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемые хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`.
name_alias строка	Псевдоним для текущего объекта. Он относится к полю nameAlias в ACI.
output_level строка	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` information Если значение не указано в задаче, используется значение переменной среды `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`.

пароль строка	Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если `private_key` также предоставлен, он будет использован вместо него. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
порт целое число	Номер порта для подключения 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 строка	Имя источника SPAN L3Out.
tenant псевдонимы: tenant_name строка	Имя Tenant источника SPAN.
источник псевдонимы: имя, источник строка	Имя источника Access SPAN.
source_group псевдонимы: src_group строка	Имя группы источников Access SPAN.
состояние строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логический	Если `true`, GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к пустому предыдущему значению возврата. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логический	Если `true`, GET-запрос для проверки не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, будет недоступен для проверки в одной задаче. Варианты: `false` `true`
таймаут целое число	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию 30.
использовать_прокси логический	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых узлах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`
использовать_ssl логический	Если `false`, вместо стандартного HTTPS-соединения будет использовано HTTP-соединение. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию true при локальном соединении. Варианты: `false` `true`

username

aliases: user

string

Имя пользователя для аутентификации.

Если значение не указано в задаче, будет использовано значение переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.

Значение по умолчанию — admin.

validate_certs

boolean

Если 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: Управление профилями приложений верхнего уровня (AP) (fv:Ap).
cisco.aci.aci_epg: Управление группами конечных точек (EPG) (fv:AEPg).
cisco.aci.aci_l3out: Управление объектами внешнего уровня 3 (L3Out) (l3ext:Out).
APIC Management Information Model reference: Дополнительная информация об внутренней классе APIC span:Src.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco 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 список / элементы=строка	Текущая конфигурация с APIC после завершения модуля Возвращается при: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Информация об ошибке, возвращаемая APIC Возвращается при: ошибка Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Используемая строка фильтрации для запроса Возвращается при: ошибка или отладка Пример: `"?rsp-prop-include=config-only"`
method строка	Используемый HTTP-метод для запроса к APIC Возвращается при: ошибка или отладка Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация с APIC до запуска модуля Возвращается при: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Скомпонованная конфигурация из предоставленных пользователем параметров Возвращается при: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод, возвращенный API REST APIC (xml или json) Возвращается при: ошибка разбора Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	HTTP-ответ от APIC Возвращается при: ошибка или отладка Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается при: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	HTTP-статус от APIC Возвращается при: ошибка или отладка Пример: `200`
url строка	Используемый HTTP-URL для запроса к APIC Возвращается при: ошибка или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Akini Ross (@akinross)

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

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