модуль cisco.aci.aci_l3out – Управление объектами внешней сети уровня 3 (L3Out) (l3ext:Out)

annotation

строка

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

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

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

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

asn

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

целое число

Номер AS для L3Out.

Применяется только при использовании «eigrp» в качестве l3protocol.

certificate_name

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

строка

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

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

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

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

description

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

строка

Описание L3Out.

domain

псевдонимы: ext_routed_domain_name, routed_domain

строка

Имя внешнего домена уровня 3, связанного с L3Out.

dscp

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

строка

Целевое значение дифференцированного обслуживания (DSCP).

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

Варианты:

• "AF11"
• "AF12"
• "AF13"
• "AF21"
• "AF22"
• "AF23"
• "AF31"
• "AF32"
• "AF33"
• "AF41"
• "AF42"
• "AF43"
• "CS0"
• "CS1"
• "CS2"
• "CS3"
• "CS4"
• "CS5"
• "CS6"
• "CS7"
• "EF"
• "VA"
• "unspecified"

host

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

строка

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

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

l3out

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

строка

Имя создаваемого L3Out.

l3protocol

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

Протокол маршрутизации для L3Out.

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

В противном случае протоколы удаляются, если они не указаны при каждом изменении l3out.

Первый пример: чтобы добавить протокол BGP в l3out с протоколом OSPF, пользователь должен ввести [ bgp, ospf ], несмотря на то, что ранее был указан «ospf».

Второй пример: чтобы изменить протокол OSPF на EIGRP, пользователю достаточно ввести [ eigrp ], и предыдущий протокол OSPF будет удалён.

Чтобы удалить все существующие протоколы, пользователь должен ввести [ static ].

Для SR-MPLS Infra L3out требуется, чтобы l3protocol имел значение «bgp».

Варианты:

• "bgp"
• "eigrp"
• "ospf"
• "pim"
• "static"

mpls

строка

Указывает, включён ли MPLS (коммутация по меткам для нескольких протоколов).

При создании APIC устанавливает значение no, если оно не задано.

SR-MPLS поддерживается только в APIC версии 5.0 и выше.

Дочерние классы mplsExtP, mplsRsLabelPol и l3extProvLbl будут отображаться в выводе только при условии yes.

Варианты:

• "no"
• "yes"

name_alias

строка

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

ospf

словарь

Параметры протокола OSPF.

area_cost

целое число

Стоимость области OSPF.

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

area_ctrl

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

Параметры управления перераспределением и созданием сводных LSA в областях NSSA и Stub.

При создании APIC устанавливает значение redistribute,summary, если оно не задано.

Варианты:

• "redistribute"
• "summary"
• "suppress-fa"
• "unspecified"

area_id

строка

Идентификатор области OSPF.

Область — это логическая совокупность сетей, маршрутизаторов и каналов OSPF с одинаковым идентификатором области.

Маршрутизатор в пределах области должен поддерживать топологическую базу данных для области, к которой он принадлежит.

Маршрутизатор не располагает подробными сведениями о топологии сети за пределами своей области, что позволяет уменьшить размер его базы данных.

Области ограничивают распространение информации о маршрутах. Фильтрация обновлений маршрутов внутри области невозможна.

База данных состояний каналов (LSDB) маршрутизаторов в одной области должна быть синхронизирована и полностью совпадать.

Однако между разными областями возможны суммирование маршрутов и фильтрация.

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

Области идентифицируются с помощью идентификатора области.

Программное обеспечение Cisco IOS поддерживает идентификаторы областей в формате IP-адреса или десятичном формате; например, область 0.0.0.0 соответствует области 0.

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

area_type

строка

Тип области OSPF.

При создании APIC устанавливает значение nssa, если оно не задано.

Варианты:

• "nssa"
• "regular"
• "stub"

description

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

строка

Задаёт описание компонента политики.

multipod_internal

строка

Запуск OSPF в экземпляре WAN вместо экземпляра по умолчанию.

При создании APIC устанавливает значение no, если оно не задано.

Варианты:

• "no"
• "yes"

name_alias

строка

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

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.

owner_key

строка

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

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

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

owner_tag

строка

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

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

Например, чтобы указать, кто создал этот объект.

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

password

строка

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

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

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

port

целое число

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

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

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

private_key

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

строка

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

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

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

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

route_control

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

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

Направление применения управления маршрутами. Допустимы только значения export или import,export.

При создании APIC устанавливает значение export, если оно не задано.

Варианты:

• "export"
• "import"

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

vrf

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

строка

Имя VRF, связанной с L3Out.

Для SR-MPLS Infra L3out требуется VRF «overlay-1».

current

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

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

Возвращается: при успехе

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

error

словарь

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

Возвращается: при сбое

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

filter_string

строка

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

Возвращается: при сбое или в режиме отладки

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

method

строка

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

Возвращается: при сбое или в режиме отладки

Пример: "POST"

previous

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

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

Возвращается: при выводе информации

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

proposed

словарь

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

Возвращается: при выводе информации

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

raw

строка

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

строка

Ответ HTTP от APIC

Возвращается: при сбое или в режиме отладки

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

sent

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

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

Возвращается: при выводе информации

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

status

целое число

Статус HTTP от APIC

Возвращается: при сбое или в режиме отладки

Пример: 200

url

строка

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

Возвращается: при сбое или в режиме отладки

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