модуль cisco.aci.aci_fabric_span_src_group — управление группами источников Fabric SPAN (span:SrcGrp)

admin_state

boolean

Включить true или отключить false источники SPAN.

Если при создании значение не задано, APIC по умолчанию использует true.

Варианты:

• false
• true

annotation

string

Задаваемая пользователем строка для добавления аннотации к объекту.

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

Если значение не указано в задаче и переменная среды ACI_ANNOTATION, будет использовано значение по умолчанию.

По умолчанию: "orchestrator:ansible"

certificate_name

псевдонимы: cert_name

string

Имя сертификата X.509, связанного с пользователем AAA APIC и используемого для аутентификации на основе подписи.

Если указан файл private_key, по умолчанию используется имя файла private_key без расширения.

Если для private_key указано содержимое в формате PEM, по умолчанию используется значение username.

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

description

псевдонимы: descr

string

Описание группы источников Fabric SPAN.

destination_group

псевдонимы: dst_group

string

Имя группы назначений Fabric SPAN, связываемой с группой источников.

host

псевдонимы: hostname

string

IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible.

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

name_alias

string

Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.

output_level

string

Влияет на вывод этого модуля ACI.

normal — стандартный вывод, включая словарь current

info добавляет информационный вывод, включая словари previous, proposed и sent

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.

source_group

псевдонимы: name, src_group

string

Имя группы источников Fabric SPAN.

state

string

Для добавления или удаления используйте present или absent.

Для получения списка одного или нескольких объектов используйте query.

Варианты:

• "absent"
• "present" ← (по умолчанию)
• "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, перед отправкой POST-запроса на обновление в APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

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

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым.

Предыдущее состояние объекта проверяться не будет, а POST-запрос на обновление будет содержать все свойства.

Варианты:

• false
• true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, после отправки POST-запроса на обновление в APIC не будет отправлен проверочный GET-запрос.

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

Значение по умолчанию: false.

ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение current будет установлено в предложенное значение.

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

Варианты:

• false
• true

timeout

integer

Тайм-аут на уровне сокета в секундах.

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

Значение по умолчанию: 30.

use_proxy

boolean

Если false, прокси использоваться не будет, даже если он задан в переменной среды на целевых узлах.

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

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

Варианты:

• false
• true

use_ssl

boolean

Если false, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение.

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

При локальном подключении значение по умолчанию — true.

Варианты:

• false
• true

username

псевдонимы: user

string

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

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

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

validate_certs

boolean

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

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

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

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

Варианты:

• false
• true

current

list / элементы=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 / элементы=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 / элементы=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"