cisco.aci.aci_l3out – Управление объектами внешнего уровня 3 (L3Out) (l3ext:Out)
Примечание
Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в книге задач укажите: cisco.aci.aci_l3out.
Обзор
- Управление внешним уровнем 3 (L3Out) на Cisco ACI устройствах.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| annotation строка | Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION. | |
| asn целое число | Номер AS для L3Out. Применимо только при использовании 'eigrp' в качестве l3protocol псевдонимы: as_number | |
| certificate_name строка | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемого для аутентификации на основе подписи. Если был указан файл с именем private_key, по умолчанию используется имя файла private_key без расширения.Если для private_key был предоставлен контент в формате PEM, по умолчанию используется значение username.Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME. псевдонимы: cert_name | |
| description строка | Описание L3Out. псевдонимы: descr | |
| domain строка | Имя внешней домен L3, ассоциированной с L3Out. псевдонимы: ext_routed_domain_name, routed_domain | |
| dscp строка |
| Целевое значение Differentiated Service (DSCP). APIC по умолчанию использует unspecified при отсутствии значения при создании.псевдонимы: target |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешимое хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST. псевдонимы: hostname | |
| l3out строка | Имя создаваемого L3Out. псевдонимы: l3out_name, name | |
| l3protocol список / элементы=строка |
| Протокол маршрутизации для L3Out |
| name_alias строка | Псевдоним текущего объекта. Связан с полем nameAlias в ACI. | |
| output_level строка |
| Влияет на вывод этого модуля ACI. normal означает стандартный вывод, включая current словарь.info добавляет информационный вывод, включая previous, proposed и sent словари.debug добавляет отладочный вывод, включая filter_string, method, response, status и url информацию.Если значение не указано в задаче, будет использовано значение переменной среды ACI_OUTPUT_LEVEL. |
| output_path строка | Путь к файлу, который будет использован для вывода сгенерированных модулем ACI JSON-объектов конфигурации. Если значение не указано в задаче, будет использовано значение переменной среды ACI_OUTPUT_PATH. | |
| owner_key строка | Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, будет использовано значение переменной среды ACI_OWNER_KEY. | |
| owner_tag строка | Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой метку, позволяющую клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, будет использовано значение переменной среды ACI_OWNER_TAG. | |
| password строка | Пароль для аутентификации. Этот параметр взаимоисключающий с private_key. Если указан private_key, он будет использован вместо этого.Если значение не указано в задаче, будет использовано значение переменных среды ACI_PASSWORD или ANSIBLE_NET_PASSWORD. | |
| port целое число | Порт, используемый для подключения REST. Значение по умолчанию зависит от параметра use_ssl.Если значение не указано в задаче, будет использовано значение переменной среды ACI_PORT. | |
| private_key строка | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемый для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию certificate_name, используемое в модуле.Этот параметр взаимоисключающий с password. Если указан password, он будет проигнорирован.Если значение не указано в задаче, будет использовано значение переменной среды ACI_PRIVATE_KEY. псевдонимы: cert_key | |
| route_control список / элементы=строка |
| Направление применения Route Control. Допустимые значения — export или import,export. псевдонимы: route_control_enforcement |
| state строка |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| tenant строка | Имя существующего арендатора. псевдонимы: tenant_name | |
| timeout целое число | По умолчанию: 30 | Таймаут на уровне сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды ACI_TIMEOUT. |
| use_proxy логическое значение |
| Если no, не будет использоваться прокси, даже если он определен в переменной среды на целевых хостах.Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_PROXY. |
| use_ssl логическое значение |
| Если no, вместо стандартного HTTPS соединения будет использовано HTTP соединение.Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_SSL. |
| username строка | По умолчанию: "admin" | Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.псевдонимы: user |
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены.Это следует установить на no только при работе с сайтами, контролируемыми лично, с самозаверяющими сертификатами.Если значение не указано в задаче, будет использовано значение переменной среды ACI_VALIDATE_CERTS. |
| vrf строка | Имя ассоциированной VRF. псевдонимы: vrf_name |
Примечания
Примечание
- Перед использованием данного модуля в вашем плане действий должны существовать
tenantиdomainиvrf. Модули cisco.aci.aci_tenant, cisco.aci.aci_domain и cisco.aci.aci_vrf могут быть использованы для этого.
См. также
См. также
- cisco.aci.aci_tenant
-
Официальная документация по модулю cisco.aci.aci_tenant.
- cisco.aci.aci_domain
-
Официальная документация по модулю cisco.aci.aci_domain.
- cisco.aci.aci_vrf
-
Официальная документация по модулю cisco.aci.aci_vrf.
- APIC Management Information Model reference
-
Дополнительная информация об внутренней APIC-классе l3ext:Out.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Add a new L3Out
cisco.aci.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
cisco.aci.aci_l3out:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
name: prod_l3out
state: absent
delegate_to: localhost
- name: Query L3Out information
cisco.aci.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 |
Авторы
- Ростислав Давыденко (@rost-d)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/aci/aci_l3out_module.html
