cisco.aci.aci_domain_to_encap_pool – Привязка домена к пулам Encap (infra:RsVlanNs)
Примечание
Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в playbook, укажите: cisco.aci.aci_domain_to_encap_pool.
Обзор
- Привязывает домен к пулам Encap на Cisco ACI фабриках.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| annotation строка | Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, используется значение переменной среды ACI_ANNOTATION. | |
| certificate_name строка | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла private_key, по умолчанию используется имя файла без расширения private_key. Если для private_key предоставлено содержимое в формате PEM, по умолчанию используется значение username. Если значение не указано в задаче, используется значение переменной среды ACI_CERTIFICATE_NAME. псевдонимы: cert_name | |
| domain строка | Имя домена, который будет связан с пулом Encap. псевдонимы: domain_name, domain_profile | |
| domain_type строка / обязательно |
| Определяет, является ли домен физическим (phys) или виртуальным (vmm). |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешаемое контрольным хостом Ansible. Если значение не указано в задаче, используется значение переменной среды ACI_HOST. псевдонимы: hostname | |
| 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. | |
| pool строка | Имя пула. псевдонимы: pool_name | |
| pool_allocation_mode строка |
| Метод, используемый для выделения encaps ресурсам. Только vlan и vsan поддерживают режимы выделения. псевдонимы: allocation_mode, mode |
| pool_type строка / обязательно |
| Тип encaps pool. |
| port целое число | Порт, который будет использоваться для REST-соединения. Значение по умолчанию зависит от параметра use_ssl. Если значение не указано в задаче, используется значение переменной среды ACI_PORT. | |
| private_key строка | Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое по умолчанию certificate_name. Этот параметр взаимоисключающий с password. Если также предоставлено password, оно будет проигнорировано.Если значение не указано в задаче, используется значение переменной среды ACI_PRIVATE_KEY. псевдонимы: cert_key | |
| state строка |
| Используйте present или absent для добавления или удаления.Используйте query для отображения объекта или нескольких объектов. |
| 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. |
| vm_provider строка |
| Платформа виртуальных машин для доменных VMM. Поддержка Kubernetes была добавлена в ACI v3.0. Поддержка CloudFoundry, OpenShift и Red Hat была добавлена в ACI v3.1. |
Примечания
Примечание
- Параметры
domainиencap_poolдолжны существовать перед использованием этого модуля. Модули cisco.aci.aci_domain и cisco.aci.aci_encap_pool могут использоваться для этого.
См. также
См. также
- cisco.aci.aci_domain
-
Официальная документация по модулю cisco.aci.aci_domain.
- cisco.aci.aci_encap_pool
-
Официальная документация по модулю cisco.aci.aci_encap_pool.
- APIC Management Information Model reference
-
Дополнительная информация о внутреннем классе APIC infra:RsVlanNs.
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.
Примеры
- name: Add domain to VLAN pool binding
cisco.aci.aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
pool: test_pool
pool_type: vlan
pool_allocation_mode: dynamic
state: present
delegate_to: localhost
- name: Remove domain to VLAN pool binding
cisco.aci.aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
domain_type: phys
pool: test_pool
pool_type: vlan
pool_allocation_mode: dynamic
state: absent
delegate_to: localhost
- name: Query our domain to VLAN pool binding
cisco.aci.aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain: phys_dom
pool: test_pool
pool_type: vlan
pool_allocation_mode: dynamic
state: query
delegate_to: localhost
register: query_result
- name: Query all domain to VLAN pool bindings
cisco.aci.aci_domain_to_encap_pool:
host: apic
username: admin
password: SomeSecretPassword
domain_type: phys
pool_type: vlan
pool_allocation_mode: dynamic
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 |
Авторы
- Dag Wieers (@dagwieers)
© 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_domain_to_encap_pool_module.html
