модуль cisco.aci.aci_static_binding_to_epg — привязка статических путей к EPG (fv:RsPathAtt)

annotation

строка

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

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

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

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

ap

псевдонимы: app_profile, app_profile_name

строка

Имя существующего профиля сети приложений, который будет содержать EPG.

certificate_name

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

строка

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

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

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

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

deploy_immediacy

строка

Немедленность развертывания статического EPG на PC, VPC или интерфейсе.

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

Допустимые значения:

• "immediate"
• "lazy"

description

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

строка

Описание привязки статического пути к EPG.

encap_id

псевдонимы: vlan, vlan_id

целое число

Идентификатор инкапсуляции, связывающий epg с путем интерфейса.

При использовании микросегментации он служит вторичным encap_id.

Допустимые значения — любой действительный идентификатор инкапсуляции для указанного типа инкапсуляции; в настоящее время диапазон составляет от 1 до 4096.

epg

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

строка

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

extpaths

список / элементы=строка

Целочисленная часть extpaths значения tDn.

extpaths используется только в том случае, если interface_type имеет значение fex, fex_vpc или fex_port_channel.

Если interface_type имеет значение fex_vpc, то extpaths — это список, содержащий оба идентификатора FEX.

Обычно это значение выглядит примерно так: 1011.

host

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

строка

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

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

interface

строка

Строковая часть interface значения tDn.

Обычно это группа политик, например test-IntPolGrp, или интерфейс в одном из следующих форматов 1/7, в зависимости от interface_type.

interface_mode

псевдонимы: interface_mode_name, mode

строка

Определяет, как считываются теги уровня 2 из кадров и добавляются в них.

Значения 802.1p и native идентичны.

Значения access и untagged идентичны.

Значения regular, tagged и trunk идентичны.

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

Допустимые значения:

• "802.1p"
• "access"
• "native"
• "regular"
• "tagged"
• "trunk"
• "untagged"

interface_type

строка

Тип интерфейса для развертывания статического EPG.

Допустимые значения:

• "fex"
• "port_channel"
• "switch_port" ← (по умолчанию)
• "vpc"
• "fex_port_channel"
• "fex_vpc"

leafs

псевдонимы: leaves, nodes, paths, switches

список / элементы=строка

Идентификаторы коммутаторов, к которым относится interface.

Если interface_type имеет значение switch_port, port_channel или fex, то leafs — это строка с идентификатором листового коммутатора.

Если interface_type имеет значение vpc, то leafs — это список, содержащий оба идентификатора листовых коммутаторов.

Значение leafs обычно имеет вид «101» или «101-102» в зависимости от connection_type.

output_level

строка

Управляет выводом этого модуля ACI.

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

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

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

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

Допустимые значения:

• "debug"
• "info"
• "normal" ← (по умолчанию)

output_path

строка

Путь к файлу, в который будут записываться объекты конфигурации ACI в формате JSON, созданные модулем.

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

password

строка

Пароль для аутентификации.

Этот параметр несовместим с private_key. Если также задан private_key, будет использован он.

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

pod_id

псевдонимы: pod, pod_number

целое число

Номер pod — часть значения tDn.

pod_id обычно является целым числом меньше 10.

port

целое число

Номер порта для REST-подключения.

Значение по умолчанию зависит от параметра use_ssl.

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

primary_encap_id

псевдонимы: primary_vlan, primary_vlan_id

строка

Определяет основной идентификатор инкапсуляции, связывающий epg с путем интерфейса при использовании микросегментации.

Допустимые значения — любой действительный идентификатор инкапсуляции для указанного типа инкапсуляции; в настоящее время диапазон составляет от 1 до 4096 и unknown.

unknown является значением по умолчанию; использование unknown отключает микросегментацию.

private_key

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

строка

Файл закрытого ключа в формате PEM или содержимое закрытого ключа для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр несовместим с password. Если также задан password, он будет проигнорирован.

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

state

строка

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

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

Допустимые значения:

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

suppress_previous

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

логический

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

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

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

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

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

Допустимые значения:

• false
• true

suppress_verification

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

логический

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

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

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

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

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

Допустимые значения:

• false
• true

tenant

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

строка

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

timeout

целое число

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

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

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

use_proxy

логический

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

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

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

Допустимые значения:

• false
• true

use_ssl

логический

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

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

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

Допустимые значения:

• false
• true

username

псевдоним: user

строка

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

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

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

validate_certs

логический

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

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

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

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

Допустимые значения:

• false
• true

current

list / elements=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 / elements=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 / elements=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"