aci_l3out — Управление объектами внешнего уровня 3 (L3Out) (l3ext:Out)

Новая версия с 2.6.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Состояние
Техническое обслуживание
- Автор

Обзор

Управление внешним уровнем 3 (L3Out) на сетях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию равно `private_key` basename без расширения. Псевдонимы: cert_name
description		Описание для L3Out. Псевдонимы: descr
domain обязательно		Имя внешней доменной зоны L3, ассоциированной с L3Out. Псевдонимы: ext_routed_domain_name, routed_domain
dscp	Варианты: AF11 AF12 AF13 AF21 AF22 AF23 AF31 AF32 AF33 AF41 AF42 AF43 CS0 CS1 CS2 CS3 CS4 CS5 CS6 CS7 EF VA unspecified	Целевое значение DSCP (Differentiated Services). APIC по умолчанию устанавливает `unspecified`, если параметр не указан при создании. Псевдонимы: target
host обязательно		IP-адрес или имя хоста, разрешаемые контроллером Ansible. Псевдонимы: hostname
l3out обязательно		Имя создаваемого L3Out. Псевдонимы: l3out_name, name
l3protocol	Варианты: static bgp ospf pim	Протокол маршрутизации для L3Out.
output_level	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию
password обязательно		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если также указан `private_key`, он будет использован вместо него.
port		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key обязательно		Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указано `certificate_name`. Этот параметр взаимоисключает `password`. Если также указан `password`, он будет проигнорирован. Псевдонимы: cert_key
route_control	Варианты: export import	Направление принудительной маршрутизации. Допустимы только значения export или import, export. Псевдонимы: route_control_enforcement
state	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant обязательно		Имя существующего клиента. Псевдонимы: tenant_name
timeout int	По умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy bool	Варианты: no yes ←	Если `no`, не будет использоваться прокси, даже если он определён в переменной среды на целевых хостах.
use_ssl bool	Варианты: no yes ←	Если `no`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения.
username	По умолчанию: "admin"	Имя пользователя для аутентификации. Псевдонимы: user
validate_certs bool	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует устанавливать только в `no` при работе с сайтами, контролируемыми лично, использующими самозаверенные сертификаты.
vrf обязательно		Имя VRF, ассоциированное с L3Out. Псевдонимы: vrf_name

Примечания

Примечание

tenant и domain и vrf должны существовать до использования данного модуля в вашем плейбуке. Для этого можно использовать модули aci_tenant и aci_domain и aci_vrf.
Дополнительную информацию о внутреннем классе APIC l3ext:Out см. в справке по модели управления информацией APIC https://developer.cisco.com/docs/apic-mim-ref/.
Более подробную информацию об управлении инфраструктурой ACI с помощью Ansible см. в руководстве Cisco ACI Руководство по Cisco ACI.

Примеры

- name: Add a new L3Out
  aci_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    name: prod_l3out
    description: L3Out for Production tenant
    domain: l3dom_prod
    vrf: prod
    l3protocol: ospf

- name: Delete L3Out
  aci_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    name: prod_l3out
    state: absent

- name: Query L3Out information
  aci_l3out:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    name: prod_l3out
    state: query

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

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

Ключ	Результат	Описание
current список	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производственная среда', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращённая APIC Пример: {'code': '122', 'text': 'неизвестный класс управляемого объекта foo'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Производство', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'production'}}}
raw строка	ошибка разбора	Необработанный результат, возвращённый API REST APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="неизвестный класс управляемого объекта foo"/></imdata>
response строка	ошибка или отладка	HTTP-ответ от APIC Пример: OK (30 байт)
sent список	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда'}}}
status целое число	ошибка или отладка	HTTP-статус от APIC Пример: 200
url строка	ошибка или отладка	HTTP-URL, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Статус

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

Техническое обслуживание

Этот модуль помечен как общественный, что означает, что он поддерживается сообществом Ansible. См. Поддержка и Техническое обслуживание модулей для получения дополнительной информации.

Список других модулей, поддерживаемых сообществом Ansible, см. в здесь.

Автор

Ростислав Давыденко (@rost-d)

Подсказка

Если вы обнаружите какие-либо проблемы в этой документации, вы можете изменить этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aci_l3out_module.html