Spec-Zone.ru › Ansible

cisco.aci.aci_vmm_credential модуль — Управление профилями учетных данных виртуальных доменов (vmm:UsrAccP)

Примечание

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

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

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

Для использования в книге задач укажите: cisco.aci.aci_vmm_credential.

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

Описание

  • Управление профилями учетных данных виртуальных доменов на тканях Cisco ACI.

Параметры

Параметр

Комментарии

annotation

string

Пользовательская строка для аннотации объекта.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_ANNOTATION.

Если значение не указано в задаче и переменной окружения ACI_ANNOTATION, будет использовано значение по умолчанию.

Default: "orchestrator:ansible"

certificate_name

aliases: cert_name

string

Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи.

Если указано имя файла private_key, значение по умолчанию будет базовым именем private_key, без расширения.

Если для private_key указано содержимое в формате PEM, значение по умолчанию будет username.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_CERTIFICATE_NAME.

credential_password

string

Пароль контроллера VMM.

Указание этого параметра всегда приведет к изменению, поскольку это защищенное свойство, которое невозможно получить из APIC.

credential_username

string

Имя пользователя контроллера VMM.

description

aliases: descr

string

Описание для клиента.

domain

aliases: domain_name, domain_profile

string

Имя профиля виртуального домена.

host

aliases: hostname

string

IP-адрес или имя хоста APIC, разрешаемое узлом управления Ansible.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_HOST.

name

aliases: credential_name, credential_profile

string

Имя профиля учетных данных.

name_alias

string

Псевдоним для текущего объекта. Это относится к полю nameAlias в ACI.

output_level

string

Влияет на вывод этого модуля ACI.

normal означает стандартный вывод, включая словарь current

info добавляет информационный вывод, включая словари previous, proposed и sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_OUTPUT_LEVEL.

Choices:

  • "debug"
  • "info"
  • "normal" ← (default)

output_path

string

Путь к файлу, который будет использоваться для сохранения сгенерированных модулем объектов конфигурации ACI в формате JSON.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_OUTPUT_PATH.

owner_key

string

Пользовательская строка для атрибута ownerKey объекта ACI.

Этот атрибут представляет ключ для предоставления клиентам права владения своими данными для корреляции сущностей.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_OWNER_KEY.

owner_tag

string

Пользовательская строка для атрибута ownerTag объекта ACI.

Этот атрибут представляет тег, позволяющий клиентам добавлять свои собственные данные.

Например, для указания того, кто создал этот объект.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_OWNER_TAG.

password

string

Пароль, используемый для аутентификации.

Этот параметр является взаимоисключающим с private_key. Если указан private_key, он будет использоваться вместо этого.

Если значение не указано в задаче, вместо него будут использованы значения переменных окружения ACI_PASSWORD или ANSIBLE_NET_PASSWORD.

port

integer

Номер порта, используемый для соединения REST.

Значение по умолчанию зависит от параметра use_ssl.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_PORT.

private_key

aliases: cert_key

string

Либо файл закрытого ключа в формате PEM, либо содержимое закрытого ключа, используемого для аутентификации на основе подписи.

Это значение также влияет на используемое значение certificate_name по умолчанию.

Этот параметр является взаимоисключающим с password. Если указан password, он будет игнорироваться.

Если значение не указано в задаче, вместо него будет использовано значение переменной окружения ACI_PRIVATE_KEY или ANSIBLE_NET_SSH_KEYFILE.

state

string

Используйте present или absent для добавления или удаления.

Используйте query для перечисления объекта или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

псевдонимы: no_previous, ignore_previous

boolean

Если true, GET-запрос для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства.

Варианты:

  • false
  • true

suppress_verification

псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, проверочный GET-запрос не будет отправлен после обновления POST в APIC.

Если значение не указано в задаче, будет использовано значение переменной среды ACI_SUPPRESS_VERIFICATION.

Значение по умолчанию false.

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что текущее возвращаемое значение устанавливается в предложенное значение.

Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче.

Варианты:

  • false
  • true

timeout

целое число

Таймаут уровня сокета в секундах.

Если значение не указано в задаче, будет использовано значение переменной среды 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

псевдонимы: 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"

См. также

См. также

cisco.aci.aci_domain

Управление физическими, виртуальными, мостовыми, маршрутизируемыми или FC-доменами (phys:DomP, vmm:DomP, l2ext:DomP, l3ext:DomP и fc:DomP).

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": "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

строка

Используемый HTTP-URL для запроса к APIC

Возвращено: неудача или отладка

Пример: "https://10.11.12.13/api/mo/uni/tn-production.json"

Авторы

  • Jason Juenger (@jasonjuenger)

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

  • Система отслеживания задач
  • Репозиторий (исходные коды)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API