модуль cisco.aci.aci_l3out_interface — управление интерфейсами Layer 3 Outside (L3Out) (l3ext:RsPathL3OutAtt)

Примечание

Этот модуль входит в коллекцию cisco.aci (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.aci.

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_l3out_interface.

Краткое описание
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Управление интерфейсами L3Out в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
address псевдонимы: addr, ip_address строка	IP-адрес.
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменная окружения `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
auto_state строка	Автоматическое состояние SVI. Варианты: `"enabled"` `"disabled"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, привязанного к пользователю APIC AAA, который используется для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется имя файла `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание интерфейса.
encap строка	Инкапсуляция на интерфейсе (например, «vlan-500»).
encap_scope строка	Область действия инкапсуляции на интерфейсе. Варианты: `"vrf"` `"local"`
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_HOST`.
interface_profile псевдонимы: interface_profile_name, logical_interface строка / обязательный	Имя профиля интерфейса.
interface_type строка	Тип создаваемого интерфейса. Варианты: `"l3-port"` `"sub-interface"` `"ext-svi"`
ipv6_dad строка	Функция DAD для IPv6. Варианты: `"enabled"` `"disabled"`
l3out псевдонимы: l3out_name строка / обязательный	Имя существующего объекта L3Out.
mac псевдонимы: mac_address строка	MAC-адрес интерфейса.
micro_bfd логическое значение	Включить micro BFD на интерфейсе. Micro BFD следует настраивать только на интерфейсах Direct Port Channel в Infra SR-MPLS L3Out. Варианты: `false` `true`
micro_bfd_destination псевдонимы: micro_bfd_address, micro_bfd_destination_address строка	Адрес назначения micro BFD интерфейса.
micro_bfd_timer псевдонимы: micro_bfd_start_timer, micro_bfd_start целое число	Таймер запуска micro BFD в секундах. При создании APIC устанавливает значение `0`, если параметр не задан.
mode строка	Режим интерфейса; используется только при значении ext-svi параметра instance_type. Варианты: `"regular"` `"native"` `"untagged"`
mtu строка	MTU интерфейса.
node_id строка	Узел, на котором создаётся интерфейс для Port-channel и одиночных портов. Для vPC укажите пару узлов через дефис (например, «201-202»).
node_profile псевдонимы: node_profile_name, logical_node строка / обязательный	Имя профиля узла.
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`.
path_ep строка	Путь к интерфейсу. Имя группы политик интерфейса для Port-channel и vPC. Номер порта для одиночного порта (например, «eth1/12»).
pod_id строка	Pod, на котором создаётся интерфейс.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PORT`.
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`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверено, а 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`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должны существовать tenant, l3out, node_profile и interface_profile. Для этого можно использовать cisco.aci.aci_tenant, cisco.aci.aci_l3out, cisco.aci.aci_l3out_logical_node_profile и cisco.aci.aci_l3out_logical_interface_profile.

См. также

cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_l3out: Управление объектами Layer 3 Outside (L3Out) (l3ext:Out).
cisco.aci.aci_l3out_logical_node_profile: Управление логическими профилями узлов Layer 3 Outside (L3Out) (l3ext:LNodeP).
cisco.aci.aci_l3out_logical_interface_profile: Управление логическими профилями интерфейсов Layer 3 Outside (L3Out) (l3ext:LIfP).
Справочник модели управленческой информации APIC: Дополнительные сведения о внутреннем классе APIC l3ext:RsPathL3OutAtt
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add a new routed interface
  cisco.aci.aci_l3out_interface:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    interface_type: l3-port
    address: 192.168.10.1/27
    state: present
  delegate_to: localhost

- name: Add a new SVI vPC
  cisco.aci.aci_l3out_interface:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201-202
    path_ep: my_vpc_ipg
    interface_type: ext-svi
    encap: vlan-800
    mode: regular
    state: present
  delegate_to: localhost

- name: Add direct port channel interface in the infra SR-MPLS l3out interface profile with micro BFD enabled
  aci_l3out_interface:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: infra
    l3out: ansible_infra_sr_mpls_l3out
    interface_profile: ansible_infra_sr_mpls_l3out_interface_profile
    pod_id: 1
    node_id: 101
    path_ep: pc_ansible_test
    interface_type: l3-port
    addr: 192.168.90.1/24
    micro_bfd: true
    micro_bfd_destination: 192.168.90.2
    micro_bfd_timer: 75
    state: present
  delegate_to: localhost

- name: Delete an interface
  cisco.aci.aci_l3out_interface:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    state: absent
  delegate_to: localhost

- name: Query an interface
  cisco.aci.aci_l3out_interface:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l3out: my_l3out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    node_id: 201
    path_ep: eth1/12
    state: query
  delegate_to: localhost
  register: query_result

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:

Ключ	Описание
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"`

Авторы

Tim Cragg (@timcragg)
Akini Ross (@akinross)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_l3out_interface_module.html