cisco.aci.aci_domain_to_encap_pool – Bind Domain to Encap Pools (infra:RsVlanNs)

Примечание

Этот плагин является частью коллекции cisco.aci (версия 1.1.1).

Для его установки используйте: ansible-galaxy collection install cisco.aci.

Для использования в playbook, укажите: cisco.aci.aci_domain_to_encap_pool.

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

Краткое описание

Привязка домена к пулам инкапсуляции в тканях 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 строка		Имя домена, ассоциируемого с пулом инкапсуляции. алиасы: domain_name, domain_profile
domain_type строка / обязательно	Варианты: fc l2dom l3dom phys vmm	Определяет, является ли домен физическим (phys) или виртуальным (vmm).
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`. алиасы: hostname
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` dict `info` добавляет информационный вывод, включая `previous`, `proposed` и `sent` dict `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 строка	Варианты: dynamic static	Метод, используемый для распределения инкапсуляции ресурсам. Только vlan и vsan поддерживают режимы распределения. алиасы: allocation_mode, mode
pool_type строка / обязательно	Варианты: vlan vsan vxlan	Тип инкапсуляции `pool`.
port целое число		Номер порта, который будет использоваться для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
private_key строка		Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр взаимоисключает `password`. Если `password` также предоставлен, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PRIVATE_KEY`. алиасы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения одного объекта или нескольких объектов.
timeout целое число	Значение по умолчанию: 30	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_TIMEOUT`.
use_proxy булево	Варианты: no yes ←	Если `no`, прокси использоваться не будет, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, будет использовано HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использоваться значения переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. алиасы: user
validate_certs булево	Варианты: no yes ←	Если `no`, SSL-сертификаты проверяться не будут. Это следует устанавливать в `no` только при использовании на лично контролируемых сайтах с самоподписанными сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`.
vm_provider строка	Варианты: cloudfoundry kubernetes microsoft openshift openstack redhat vmware	Платформа виртуальных машин для доменов 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: Дополнительная информация о внутреннем классе 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': 'Production environment', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
error словарь	сбой	Информация об ошибке, возвращаемая APIC Пример: {'code': '122', 'text': 'unknown managed object class foo'}
filter_string строка	сбой или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	сбой или отладка	HTTP-метод, используемый для запроса к APIC Пример: POST
previous список / элементы=строка	информация	Исходная конфигурация из APIC до начала работы модуля Пример: [{'fvTenant': {'attributes': {'descr': 'Production', 'dn': 'uni/tn-production', 'name': 'production', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров, предоставленных пользователем Пример: {'fvTenant': {'attributes': {'descr': 'Production environment', 'name': 'production'}}}
raw строка	ошибка синтаксического анализа	Необработанный вывод, возвращаемый API REST APIC (xml или json) Пример: <?xml version="1.0" encoding="UTF-8"?><imdata totalCount="1"><error code="122" text="unknown managed object class foo"/></imdata>
response строка	сбой или отладка	HTTP-ответ от APIC Пример: OK (30 bytes)
sent список / элементы=строка	информация	Фактическая/минимальная конфигурация, отправленная в APIC Пример: {'fvTenant': {'attributes': {'descr': 'Production environment'}}}
status целое число	сбой или отладка	HTTP-статус от APIC Пример: 200
url строка	сбой или отладка	HTTP-адрес, используемый для запроса к APIC Пример: https://10.11.12.13/api/mo/uni/tn-production.json

Авторы

Dag Wieers (@dagwieers)

© 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_domain_to_encap_pool_module.html