Модуль cisco.aci.aci_fabric_span_dst_group – Управление группами назначения SPAN Fabric (span:DestGrp)

Примечание

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

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

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

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

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

Описание

Управление группами назначения SPAN Fabric на Cisco ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменной окружения `ACI_ANNOTATION`, то будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, это значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` указано содержимое в формате PEM, это значение по умолчанию будет `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
description aliases: descr string	Описание группы назначений Fabric SPAN.
destination_epg dictionary	Группа конечных точек назначения.
ap aliases: ap_name, app_profile, app_profile_name string / required	Имя профиля приложения.
destination_ip string / required	IP-адрес назначения.
dscp string	Значение DSCP для отправки контролируемых пакетов с использованием ERSPAN. APIC использует значение по умолчанию `unspecified` при отсутствии задания во время создания. Choices: `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"unspecified"`
epg aliases: epg_name string / required	Имя группы конечных точек.
flow_id integer	Идентификатор потока пакета SPAN. APIC использует значение по умолчанию `1` при отсутствии задания во время создания.
mtu integer	Размер усечения MTU для пакетов. APIC использует значение по умолчанию `1518` при отсутствии задания во время создания.
source_ip string / required	Исходный IP-адрес или префикс.
span_version string	Версия SPAN. APIC использует значение по умолчанию `version_2` при отсутствии задания во время создания. Choices: `"version_1"` `"version_2"`
tenant aliases: tenant_name string / required	Имя арендатора.
ttl integer	Время жизни пакетов сеанса SPAN. APIC использует значение по умолчанию `64` при отсутствии задания во время создания.
version_enforced boolean	Применить версию SPAN. Choices: `false` `true`
destination_group aliases: name, dst_group string	Имя группы назначений Fabric SPAN.
host aliases: hostname string	IP-адрес или имя хоста APIC, распознаваемое узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.

name_alias string	Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
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 алиасы: cert_key string	Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение `certificate_name` по умолчанию, которое используется. Эта опция взаимоисключающая с `password`. Если `password` также предоставлен, он будет игнорироваться. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления одного или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous алиасы: no_previous, ignore_previous boolean	Если `true`, запрос GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification алиасы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, подтверждающий запрос GET не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение. Текущий объект, включая значения по умолчанию, не может быть проверен в одной задаче. Варианты: `false` `true`
timeout integer	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl boolean	Если `false`, будет использоваться HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию — true, когда соединение локальное. Варианты: `false` `true`

имя_пользователя

псевдонимы: пользователь

строка

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

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

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

validate_certs

булево

Если false, сертификаты SSL не будут проверены.

Это следует устанавливать в false только при работе с сайтами, контролируемыми лично, с использованием самозаверяющих сертификатов.

Если значение не указано в задании, вместо него используется значение переменной среды ACI_VALIDATE_CERTS.

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

Варианты:

false
true

См. также

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

Примеры

- name: Add a Fabric SPAN destination group
  cisco.aci.aci_fabric_span_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    destination_group: group1
    description: Test span
    destination_epg:
      tenant: Test1
      ap: ap1
      epg: ep1
      span_version: version_1
      version_enforced: false
      destination_ip: 10.0.0.1
      source_ip: 10.0.2.1
      ttl: 2
      mtu: 1500
      flow_id: 1
      dscp: CS1
    state: present
  delegate_to: localhost

- name: Remove a Fabric SPAN destination group
  cisco.aci.aci_fabric_span_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    destination_group: group1
    state: absent
  delegate_to: localhost

- name: Query a Fabric SPAN destination group
  cisco.aci.aci_fabric_span_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    destination_group: group1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all Fabric SPAN destination groups
  cisco.aci.aci_fabric_span_dst_group:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

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