cisco.aci.aci_vmm_credential – Управление профилями учетных данных виртуальных домен (vmm:UsrAccP)
Примечание
Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).
Для его установки используйте: ansible-galaxy collection install cisco.aci.
Для использования в книге задач укажите: cisco.aci.aci_vmm_credential.
Обзор
- Управление профилями учетных данных виртуальных доменов на Cisco ACI сетях.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| annotation строка | Пользовательская строка для аннотации объекта. Если значение не указано в задаче, будет использовано значение переменной среды ACI_ANNOTATION. | |
| certificate_name строка | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл с именем private_key, по умолчанию используется имя файла private_key, без расширения.Если для private_key был предоставлен контент в формате PEM, по умолчанию используется значение username. Если значение не указано в задаче, будет использовано значение переменной среды ACI_CERTIFICATE_NAME. псевдонимы: cert_name | |
| credential_password строка | Пароль контроллера VMM. | |
| credential_username строка | Имя пользователя контроллера VMM. | |
| description строка | Описание для арендатора. псевдонимы: descr | |
| domain строка | Имя профиля виртуального домена. псевдонимы: domain_name, domain_profile, name | |
| host строка / обязательно | IP-адрес или имя хоста APIC, разрешаемое хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды ACI_HOST. псевдонимы: hostname | |
| name строка | Имя профиля учетных данных. псевдонимы: credential_name, credential_profile | |
| name_alias строка | Псевдоним текущего объекта. Связан с полем nameAlias в ACI. | |
| 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 | |
| state строка |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| 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. |
| vm_provider строка |
| Платформа виртуальных машин для доменов VMM. Поддержка Kubernetes была добавлена в ACI v3.0. Поддержка CloudFoundry, OpenShift и Red Hat была добавлена в ACI v3.1. |
См. также
См. также
- cisco.aci.aci_domain
-
Официальная документация по модулю cisco.aci.aci_domain.
- APIC Management Information Model reference
-
Дополнительная информация о внутренних классах APIC vmm:DomP
- Руководство по Cisco ACI
-
Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
- Разработка модулей Cisco ACI
-
Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.
Примеры
- name: Add credential to VMware VMM domain
cisco.aci.aci_vmm_credential:
host: apic
username: admin
password: SomeSecretPassword
domain: vmware_dom
description: secure credential
name: vCenterCredential
credential_username: vCenterUsername
credential_password: vCenterPassword
vm_provider: vmware
state: present
- name: Remove credential from VMware VMM domain
cisco.aci.aci_vmm_credential:
host: apic
username: admin
password: SomeSecretPassword
domain: vmware_dom
name: myCredential
vm_provider: vmware
state: absent
- name: Query a specific VMware VMM credential
cisco.aci.aci_vmm_credential:
host: apic
username: admin
password: SomeSecretPassword
domain: vmware_dom
name: vCenterCredential
vm_provider: vmware
state: query
delegate_to: localhost
register: query_result
- name: Query all VMware VMM credentials
cisco.aci.aci_vmm_credential:
host: apic
username: admin
password: SomeSecretPassword
domain: vmware_dom
vm_provider: vmware
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 строка | ошибка разбора | Необработанный вывод, возвращённый REST API APIC (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 |
Авторы
- Jason Juenger (@jasonjuenger)
© 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_vmm_credential_module.html
