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

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
адрес псевдонимы: addr, ip_address строка	IP-адрес.
комментарий строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задании и переменной окружения `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
автоматическое состояние строка	Автоматическое состояние SVI. Варианты: `"enabled"` `"disabled"`
имя_сертификата псевдонимы: имя_сертификата строка	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME` вместо него.
описание псевдонимы: описание строка	Описание интерфейса.
капсулирование строка	Капсулирование в интерфейсе (например, “vlan-500”).
область_капсулирования строка	Область капсулирования в интерфейсе. Варианты: `"vrf"` `"local"`
хост псевдонимы: имя_хоста строка	IP-адрес или имя хоста, разрешаемый хост-системой Ansible. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_HOST`.
профиль_интерфейса псевдонимы: имя_профиля_интерфейса, логический_интерфейс строка / обязательно	Имя профиля интерфейса.
тип_интерфейса строка	Тип создаваемого интерфейса. Варианты: `"l3-port"` `"sub-interface"` `"ext-svi"`
ipv6_dad строка	Функция IPv6 DAD. Варианты: `"enabled"` `"disabled"`
l3out псевдонимы: имя_l3out строка / обязательно	Имя существующего L3Out.
mac псевдонимы: mac-адрес строка	MAC-адрес интерфейса.
micro_bfd логическое	Включить micro BFD на интерфейсе. Micro BFD должен быть настроен только на интерфейсах L3Out Infra SR-MPLS Direct Port Channel. Варианты: `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` при его отсутствии во время создания.
режим строка	Режим интерфейса, используется только если тип_инстанции ext-svi. Варианты: `"regular"` `"native"` `"untagged"`
mtu строка	MTU интерфейса.

node_id string	Узел для создания интерфейса для каналов связи и отдельных портов. Через дефис разделенная пара узлов (например, “201-202”) для vPC.
node_profile aliases: node_profile_name, logical_node string / обязательный	Имя профиля узла.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, который будет использоваться для выгрузки объектов конфигурации ACI JSON, сгенерированных модулем. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_PATH`.
password string	Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если указан `private_key`, он будет использован вместо него. Если значение не указано в задаче, используется значение переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
path_ep string	Путь к интерфейсу. Имя группы политики интерфейса для каналов связи и vPC. Номер порта для отдельных портов (например, “eth1/12”).
pod_id string	Подразделение, на котором создается интерфейс.
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`.
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 / обязательный	Имя существующего арендатора.
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию true. Варианты: `false` `true`

use_ssl boolean	Если `false`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `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`

Примечания

Примечание

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 могут быть использованы для этого.

См. также

aci_tenant: Официальная документация по модулю aci_tenant.
aci_l3out: Официальная документация по модулю aci_l3out.
aci_l3out_logical_node_profile: Официальная документация по модулю aci_l3out_logical_node_profile.
aci_l3out_logical_interface_profile: Официальная документация по модулю aci_l3out_logical_interface_profile.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе 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 список / элементы=строка	Существующая конфигурация из 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 строка	Необработанный вывод, возвращенный API REST 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 строка	Используемый HTTP-URL для запроса к APIC Возвращено: неудача или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

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

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

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