Модуль cisco.aci.aci_domain_to_vlan_pool — привязка домена к пулам VLAN (infra:RsVlanNs)

Примечание

Этот модуль входит в состав коллекции cisco.aci (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в состав ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

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

Чтобы использовать коллекцию в плейбуке, укажите: cisco.aci.aci_domain_to_vlan_pool.

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

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

Привязка домена к пулам VLAN в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
annotation строка	Заданная пользователем строка для добавления аннотации к объекту. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_ANNOTATION`. Если значение не указано в задаче и переменная среды `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, привязанного к пользователю APIC AAA и используемого для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` указано содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_CERTIFICATE_NAME`.
domain псевдонимы: domain_name, domain_profile строка	Имя домена, связываемого с пулом VLAN.
domain_type строка / обязательный	Определяет, является ли домен физическим (phys) или виртуальным (vmm). Варианты: `"fc"` `"l2dom"` `"l3dom"` `"phys"` `"vmm"`
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, которое может разрешить управляющий узел Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_HOST`.
output_level строка	Управляет выводом этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая сведения `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записаны объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_OUTPUT_PATH`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также указан `private_key`, будет использовано именно это значение. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
pool псевдонимы: pool_name, vlan_pool строка	Имя пула.
pool_allocation_mode псевдонимы: allocation_mode, mode строка / обязательный	Метод распределения VLAN между ресурсами. Варианты: `"dynamic"` `"static"`
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение по умолчанию для `certificate_name`. Этот параметр несовместим с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Для добавления или удаления используйте `present` или `absent`. Для получения списка одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, перед отправкой POST-запроса на обновление в APIC не будет отправляться GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ: предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, а POST-запрос на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое значение	Если `true`, после отправки POST-запроса на обновление в APIC не будет отправляться проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ: в качестве текущего возвращаемого значения будет установлено предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут сокета в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию: 30.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он указан в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию: true. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо подключения HTTPS, используемого по умолчанию, будет использоваться подключение HTTP. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_USE_SSL`. Значение по умолчанию — true при локальном подключении. Варианты: `false` `true`
username псевдоним: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использоваться значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию: admin.
validate_certs логическое значение	Если `false`, сертификаты SSL проверяться не будут. Устанавливайте значение `false` только для подконтрольных вам сайтов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию: true. Варианты: `false` `true`
vm_provider строка	Платформа виртуальных машин для доменов VMM. Поддержка Kubernetes добавлена в ACI v3.0. Поддержка CloudFoundry, OpenShift и Red Hat добавлена в ACI v3.1. Варианты: `"cloudfoundry"` `"kubernetes"` `"microsoft"` `"openshift"` `"openstack"` `"redhat"` `"vmware"` `"nutanix"`

Примечания

Примечание

Перед использованием этого модуля должны существовать параметры domain и vlan_pool. Для этого можно использовать cisco.aci.aci_domain и cisco.aci.aci_vlan_pool.

См. также

cisco.aci.aci_domain: Управление профилями физических, виртуальных, мостовых, маршрутизируемых доменов или доменов FC (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP).
cisco.aci.aci_vlan_pool: Управление пулами VLAN (fvns:VlanInstP).
Справочник информационной модели управления APIC: Дополнительная информация о внутреннем классе APIC infra:RsVlanNs.
Руководство по Cisco ACI: Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Bind a VMM domain to VLAN pool
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmw_dom
    domain_type: vmm
    pool: vmw_pool
    pool_allocation_mode: dynamic
    vm_provider: vmware
    state: present
  delegate_to: localhost

- name: Remove a VMM domain to VLAN pool binding
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: vmw_dom
    domain_type: vmm
    pool: vmw_pool
    pool_allocation_mode: dynamic
    vm_provider: vmware
    state: absent
  delegate_to: localhost

- name: Bind a physical domain to VLAN pool
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    pool: phys_pool
    pool_allocation_mode: static
    state: present
  delegate_to: localhost

- name: Bind a physical domain to VLAN pool
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    pool: phys_pool
    pool_allocation_mode: static
    state: absent
  delegate_to: localhost

- name: Query an domain to VLAN pool binding
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain: phys_dom
    domain_type: phys
    pool: phys_pool
    pool_allocation_mode: static
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all domain to VLAN pool bindings
  cisco.aci.aci_domain_to_vlan_pool:
    host: apic
    username: admin
    password: SomeSecretPassword
    domain_type: phys
    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 строка	Необработанные данные, возвращённые REST API 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 строка	URL HTTP, использованный для запроса к APIC Возвращается: при сбое или отладке Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Dag Wieers (@dagwieers)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_domain_to_vlan_pool_module.html