cisco.aci.aci_l3out_extsubnet – Управление объектами внешних подсетей (l3extSubnet:extsubnet)
Примечание
Этот плагин является частью коллекции cisco.aci (версия 1.1.1).
Для его установки используйте: ansible-galaxy collection install cisco.aci.
Чтобы использовать его в книге задач, укажите: cisco.aci.aci_l3out_extsubnet.
Обзор
- Управление объектами внешних подсетей (l3extSubnet:extsubnet)
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| annotation строка | Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION. | |
| certificate_name строка | Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлён файл с именем private_key, по умолчанию используется имя файла private_key, без расширения.Если для private_key был предоставлен контент в формате PEM, по умолчанию используется значение username. Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME. псевдонимы: cert_name | |
| description строка | Описание внешней подсети. псевдонимы: descr | |
| extepg строка / обязательно | Имя существующего ExtEpg. псевдонимы: extepg_name | |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешимое контрольным хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST.псевдонимы: hostname | |
| l3out строка / обязательно | Имя существующего L3Out. псевдонимы: l3out_name | |
| name_alias строка | Псевдоним текущего объекта. Он относится к полю nameAlias в ACI. | |
| network строка | Адрес сети для подсети. псевдонимы: address, ip | |
| 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 | |
| scope список / элементы=строка |
["import-security"] | Определяет область подсети. Параметр export-rtctrl управляет тем, какие внешние сети рекламируются из ткани с использованием карт маршрутизации и списков IP-префиксов.Параметр import-security классифицирует для внешнего EPG. Правила и контракты, определённые в этом внешнем EPG, применяются к сетям, соответствующим этой подсети.Параметр shared-rtctrl управляет тем, какие внешние префиксы рекламируются другим арендаторам для совместного использования ресурсов.Параметр shared-security настраивает классификатор для подсетей в VRF, где маршруты передаются.APIC по умолчанию использует import-security, если это не установлено при создании. |
| state строка |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| subnet_name строка | Имя создаваемой внешней подсети. псевдонимы: name | |
| tenant строка / обязательно | Имя существующего арендатора. псевдонимы: tenant_name | |
| timeout целое число | Значение по умолчанию: 30 | Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной среды ACI_TIMEOUT. |
| use_proxy булево |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах.Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_PROXY. |
| use_ssl булево |
| Если no, будет использоваться соединение HTTP вместо стандартного соединения HTTPS.Если значение не указано в задаче, будет использовано значение переменной среды ACI_USE_SSL. |
| username строка | Значение по умолчанию: "admin" | Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы значения переменных среды ACI_USERNAME или ANSIBLE_NET_USERNAME.псевдонимы: user |
| validate_certs булево |
| Если no, сертификаты SSL не будут проверены.Это следует установить только в значение no при использовании на сайтах под вашим контролем, использующих самоподписанные сертификаты.Если значение не указано в задаче, будет использовано значение переменной среды ACI_VALIDATE_CERTS. |
Примечания
Примечание
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 External Subnet
cisco.aci.aci_l3out_extsubnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
extepg: prod_extepg
description: External Subnet for Production ExtEpg
network: 192.0.2.0/24
scope: export-rtctrl
state: present
delegate_to: localhost
- name: Delete External Subnet
cisco.aci.aci_l3out_extsubnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
extepg: prod_extepg
network: 192.0.2.0/24
state: absent
delegate_to: localhost
- name: Query ExtEpg Subnet information
cisco.aci.aci_l3out_extsubnet:
host: apic
username: admin
password: SomeSecretPassword
tenant: production
l3out: prod_l3out
extepg: prod_extepg
network: 192.0.2.0/24
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-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json |
Авторы
- Ростислав Давыденко (@rost-d)
- Цинди Чжао (@cizhao)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/cisco/aci/aci_l3out_extsubnet_module.html
