cisco.aci.aci_aep_to_domain модуль — Связывание AEP с физическими или виртуальными домены (infra:RsDomP)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_aep_to_domain.

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

Обзор

Связывает AEP с физическими или виртуальными доменами на платформах Cisco ACI.

Параметры

Параметр	Комментарии
aep псевдонимы: aep_name строка	Имя профиля Attachable Access Entity.
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 строка	Имя физического или виртуального домена, ассоциируемого с AEP.
domain_type псевдонимы: type строка	Определяет, является ли домен физическим (phys) или виртуальным (vmm). Выбо ры: `"fc"` `"l2dom"` `"l3dom"` `"phys"` `"vmm"`
host псевдонимы: hostname строка	IP-адрес или имя хоста, разрешаемого хостом управления 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`.
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`, GET для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверяться, а обновление POST будет содержать все свойства. Выбо ры: `false` `true`

suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после обновления POST в APIC не будет отправлен GET-запрос для проверки. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию — `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Доступные значения: `false` `true`
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию — true. Доступные значения: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного HTTPS соединения будет использовано HTTP соединение. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию — true при локальном соединении. Доступные значения: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут валидированы. Это должно быть установлено в `false` только при работе с сайтами, управляемыми вами, которые используют самозаверяющие сертификаты. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Доступные значения: `false` `true`
vm_provider string	Платформа виртуальной машины для VMM доменов. Поддержка Kubernetes была добавлена в ACI v3.0. Поддержка CloudFoundry, OpenShift и Red Hat была добавлена в ACI v3.1. Доступные значения: `"cloudfoundry"` `"kubernetes"` `"microsoft"` `"openshift"` `"openstack"` `"redhat"` `"vmware"`

Примечания

Примечание

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

См. также

cisco.aci.aci_aep: Управление объектами профилей профилей доступа (AEP) (infra:AttEntityP и infra:ProvAcc).
cisco.aci.aci_domain: Управление физическими, виртуальными, мостовыми, маршрутизированными или FC профилями доменов (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP).
APIC Management Information Model reference: Дополнительная информация об внутреннем классе APIC infra:RsDomP.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add AEP to domain binding
  cisco.aci.aci_aep_to_domain: &binding_present
    host: apic
    username: admin
    password: SomeSecretPassword
    aep: test_aep
    domain: phys_dom
    domain_type: phys
    state: present
  delegate_to: localhost

- name: Remove AEP to domain binding
  cisco.aci.aci_aep_to_domain: &binding_absent
    host: apic
    username: admin
    password: SomeSecretPassword
    aep: test_aep
    domain: phys_dom
    domain_type: phys
    state: absent
  delegate_to: localhost

- name: Query our AEP to domain binding
  cisco.aci.aci_aep_to_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    aep: test_aep
    domain: phys_dom
    domain_type: phys
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all AEP to domain bindings
  cisco.aci.aci_aep_to_domain: &binding_query
    host: apic
    username: admin
    password: SomeSecretPassword
    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-URL для запроса к APIC Возвращено: неудача или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Dag Wieers (@dagwieers)

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

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