Модуль cisco.aci.aci_l2out — управление объектами Layer2 Out (L2Out) (l2ext:Out)

annotation

string

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

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

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

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

bd

string

Имя мостового домена, связанного с L2Out.

certificate_name

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

string

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

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

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

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

description

string

Описание L2Out.

domain

string

Имя внешнего домена L2, связанного с L2Out.

host

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

string

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

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

l2out

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

string

Имя внешнего уровня 2.

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.

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

tenant

string

Имя существующего арендатора.

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

vlan

integer

VLAN, связанный с L2Out.

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 \"/></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"