Модуль 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

строка

Имя внешней L3-доменной области, ассоциированной с L3Out.

dscp

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

строка

Значение целевого параметра Differentiated Service (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-адрес или имя хоста, разрешаемое хостом управления Ansible.

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

l3out

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

строка

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

l3protocol

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

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

Протоколы, уже связанные с 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 (Multi-Protocol Label Switching).

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

string

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

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

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

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

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

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

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

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

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

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

APIC по умолчанию использует 1 при отсутствии значения при создании.

area_type

string

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

APIC по умолчанию использует nssa при отсутствии значения при создании.

Варианты:

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

description

aliases: descr

string

Указывает описание компонента политики.

multipod_internal

string

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

APIC по умолчанию использует no при отсутствии значения при создании.

Варианты:

• "no"
• "yes"

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 вместо него.

route_control

aliases: route_control_enforcement

list / elements=string

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

APIC по умолчанию использует export при отсутствии значения при создании.

Варианты:

• "export"
• "import"

state

string

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

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

Варианты:

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

suppress_previous

aliases: no_previous, ignore_previous

boolean

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

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

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

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

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

Варианты:

• false
• true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

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

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

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

ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение.

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

Варианты:

• false
• true

tenant

aliases: tenant_name

string

Имя существующего Tenant.

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

vrf

aliases: vrf_name

string

Имя VRF, ассоциированной с L3Out.

Для SR-MPLS Infra L3out VRF должна быть «overlay-1».