Модуль cisco.aci.aci_l2out_logical_interface_path — управление путем логического интерфейса внешней сети уровня 2 (L2Out) (l2ext:RsPathL2OutAtt)

Примечание

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

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

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

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

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

Обзор

Управление записью пути интерфейса узла внешней сети уровня 2 (расширение BD) в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменная окружения `ACI_ANNOTATION`, будет использовано значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name string	Имя сертификата X.509, назначенного пользователю APIC AAA и используемого для аутентификации на основе подписи. Если указан файл `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
host псевдонимы: hostname string	IP-адрес или имя узла APIC, доступное для разрешения с управляющего узла Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
interface string	Строковое значение `interface`, являющееся частью tDn. Обычно это группа политик, например `test-IntPolGrp`, или интерфейс в формате `1/7` — в зависимости от `interface_type`.
interface_profile псевдонимы: name, interface_profile_name, logical_interface string	Имя профиля интерфейса.
interface_type string	Тип интерфейса для статического развертывания EPG. Варианты: `"switch_port"` ← (по умолчанию) `"port_channel"` `"vpc"`
l2out псевдонимы: l2out_name string	Имя существующего L2Out.
leaves псевдонимы: leafs, nodes, paths, switches list / elements=string	Идентификаторы коммутаторов, к которым относится `interface`. Если `interface_type` — это `switch_port` или `port_channel`, то `leaves` — строка с идентификатором leaf-коммутатора. Если `interface_type` — это `vpc`, то `leaves` — список с идентификаторами обоих leaf-коммутаторов. Значение `leaves` обычно имеет вид «101» или «101-102» в зависимости от `connection_type`.
node_profile псевдонимы: node_profile_name, logical_node string	Имя профиля узла.
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`.
password string	Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если также указан `private_key`, будет использован он. Если значение не указано в задаче, вместо него будет использовано значение одной из переменных окружения: `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
pod_id псевдонимы: pod, pod_number integer	Номер pod в составе tDn. `pod_id` обычно является целым числом меньше `10`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
private_key псевдонимы: 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 псевдонимы: no_previous, ignore_previous boolean	Если `true`, перед обновлением POST на APIC не будет отправляться GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверяться, а обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после обновления POST на APIC не будет отправляться проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение current будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
tenant псевдонимы: tenant_name string	Имя существующего арендатора.
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 псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение одной из переменных окружения: `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, SSL-сертификаты проверяться не будут. Устанавливайте значение `false` только при использовании на подконтрольных вам сайтах с самоподписанными сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

См. также

cisco.aci.aci_l2out: Управление объектами Layer2 Out (L2Out) (l2ext:Out).
cisco.aci.aci_l2out_logical_node_profile: Управление профилями логических узлов внешней сети уровня 2 (L2Out) (l2ext:LNodeP).
cisco.aci.aci_l2out_logical_interface_profile: Управление профилями интерфейсов внешней сети уровня 2 (L2Out) (l2ext:LIfP).
cisco.aci.aci_l2out_extepg: Управление объектами внешнего сетевого экземпляра (внешняя EPG L2Out) (l2ext:InstP).
Справочник информационной модели управления APIC: Дополнительные сведения о внутреннем классе APIC l2ext:RsPathL2OutAtt.
Руководство по Cisco ACI: Подробные сведения об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Add new path to interface profile
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l2out: my_l2out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    leaves: 101-102
    interface: L2o1
    state: present
  delegate_to: localhost

- name: Delete path to interface profile
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l2out: my_l2out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    leaves: 101-102
    interface: L2o1
    state: absent
  delegate_to: localhost

- name: Query a path to interface profile
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    l2out: my_l2out
    node_profile: my_node_profile
    interface_profile: my_interface_profile
    pod_id: 1
    leaves: 101-102
    interface: L2o1
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all paths to interface profiles
  cisco.aci.aci_l2out_logical_interface_path:
    host: apic
    username: admin
    password: SomeSecretPassword
    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"`

Авторы

Oleksandr Kreshchenko (@alexkross)

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

© 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_l2out_logical_interface_path_module.html