cisco.aci.aci_access_span_dst_group module – Управление группами назначения Access SPAN (span:DestGrp)

access_interface

dictionary

Интерфейс назначения.

Параметры access_interface и destination_epg нельзя настроить одновременно.

mtu

integer

Размер усечения MTU для пакетов.

При создании, если значение не задано, APIC использует 1518.

node

aliases: node_id

integer / обязательный

Идентификатор узла в пути назначения.

path

string / обязательный

Интерфейсная часть пути назначения.

Если тип пути — port, необходимо указать интерфейс, например eth1/7.

Если тип пути — direct_port_channel, необходимо указать имя группы политик, например test_PolGrp.

pod

aliases: pod_id, pod_number

integer / обязательный

Идентификатор pod в пути назначения.

annotation

string

Пользовательская строка для аннотирования объекта.

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

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

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

certificate_name

aliases: cert_name

string

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

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

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

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

description

aliases: descr

string

Описание группы назначения Access SPAN.

destination_epg

dictionary

Группа конечных точек назначения.

Параметры access_interface и destination_epg нельзя настроить одновременно.

ap

aliases: ap_name, app_profile, app_profile_name

string / обязательный

Имя профиля приложения.

destination_ip

string / обязательный

IP-адрес назначения.

dscp

string

Значение DSCP для отправки отслеживаемых пакетов с использованием ERSPAN.

При создании, если значение не задано, APIC использует unspecified.

Варианты:

• "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 / обязательный

Имя группы конечных точек.

flow_id

integer

Идентификатор потока пакета SPAN.

При создании, если значение не задано, APIC использует 1.

mtu

integer

Размер усечения MTU для пакетов.

При создании, если значение не задано, APIC использует 1518.

source_ip

string / обязательный

Исходный IP-адрес или префикс.

span_version

string

Версия SPAN.

При создании, если значение не задано, APIC использует version_2.

Варианты:

• "version_1"
• "version_2"

tenant

aliases: tenant_name

string / обязательный

Имя арендатора.

ttl

integer

Время жизни пакетов сеанса SPAN.

При создании, если значение не задано, APIC использует 64.

version_enforced

boolean

Принудительно задавать версию SPAN.

Варианты:

• false
• true

destination_group

aliases: name, dst_group

string

Имя группы назначения Access SPAN.

host

aliases: 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

aliases: 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

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Варианты:

• false
• true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения 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, вместо 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

current

list / elements=string

Текущая конфигурация APIC после завершения работы модуля

Возвращается: success

Пример: [{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

error

dictionary

Информация об ошибке, возвращенная APIC

Возвращается: failure

Пример: {"code": "122", "text": "unknown managed object class foo"}

filter_string

string

Строка фильтра, использованная для запроса

Возвращается: failure or debug

Пример: "?rsp-prop-include=config-only"

method

string

Метод HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "POST"

previous

list / elements=string

Исходная конфигурация APIC до начала работы модуля

Возвращается: info

Пример: [{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]

proposed

dictionary

Собранная конфигурация на основе параметров, предоставленных пользователем

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}

raw

string

Необработанный вывод, возвращенный REST API 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

string

Ответ HTTP от APIC

Возвращается: failure or debug

Пример: "OK (30 bytes)"

sent

list / elements=string

Фактическая/минимальная конфигурация, отправленная в APIC

Возвращается: info

Пример: {"fvTenant": {"attributes": {"descr": "Production environment"}}}

status

integer

Статус HTTP от APIC

Возвращается: failure or debug

Пример: 200

url

string

URL HTTP, использованный для запроса к APIC

Возвращается: failure or debug

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"