aci_l3out – Управление объектами Layer 3 Outside (L3Out) (l3ext:Out)

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

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

Описание

Управление объектами Layer 3 Outside (L3Out) на Cisco ACI фабриках.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
asn целое число добавлен в 2.8		Номер AS для L3Out. Применимо только при использовании 'eigrp' в качестве l3protocol псевдонимы: as_number
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, значение по умолчанию – `private_key` без расширения. Если для `private_key` был предоставлен контент в формате PEM, значение по умолчанию – `username`. псевдонимы: 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	Целевое значение Differentiated Service (DSCP). APIC по умолчанию устанавливает значение `unspecified`, если оно не задано при создании. псевдонимы: target
host строка / обязательно		IP-адрес или имя хоста, разрешаемое управляющим хостом Ansible. псевдонимы: hostname
l3out строка / обязательно		Имя создаваемого L3Out. псевдонимы: l3out_name, name
l3protocol список	Варианты: bgp eigrp ospf pim static	Протокол маршрутизации для L3Out.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password строка / обязательно		Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если также предоставлен `private_key`, он будет использован вместо него.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключает `password`. Если также предоставлен `password`, он будет проигнорирован. псевдонимы: cert_key
route_control список	Варианты: export import	Направление принудительного управления маршрутом. Допустимы только значения export или import. псевдонимы: route_control_enforcement
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для вывода списка объекта или нескольких объектов.
tenant строка / обязательно		Имя существующего арендатора. псевдонимы: tenant_name
timeout целое число	По умолчанию: 30	Таймаут на уровне сокета в секундах.
use_proxy логическое значение	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.
use_ssl логическое значение	Варианты: no yes ←	Если `no`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при работе с сайтами, управляемыми лично, использующими самозаверяющие сертификаты.
vrf строка / обязательно		Имя VRF, ассоциируемой с L3Out. псевдонимы: vrf_name

Примечания

Примечание

tenant и domain и vrf должны существовать до использования этого модуля в вашем плане. Для этого можно использовать модули aci_tenant, aci_domain и aci_vrf.

См. также

aci_tenant – Управление клиентами (fv:Tenant): Официальная документация по модулю aci_tenant.
aci_domain – Управление профилями физических, виртуальных, мостовых, маршрутизированных или FC доменов (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP, fc:DomP): Официальная документация по модулю aci_domain.
aci_vrf – Управление контекстами или VRF (fv:Ctx): Официальная документация по модулю aci_vrf.
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC l3ext:Out.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой 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
    state: present
  delegate_to: localhost

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

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

Значения возврата

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

Ключ	Возвращаемое значение	Описание
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 строка	ошибка разбора	Необработанный вывод, возвращённый APIC REST API (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. [сертифицировано]

Авторы

Ростислав Давыденко (@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.9/modules/aci_l3out_module.html