aci_aep – Управление объектами профиля доступа (AEP) с возможностью присоединения (infra:AttEntityP, infra:ProvAcc)

Новое в версии 2.4.

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

Описание

Подключение к внешним виртуальным и физическим доменам с помощью профилей доступа (AEP) с возможностью присоединения на Cisco ACI-матрицах.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
aep строка / обязательно		Имя профиля доступа с возможностью присоединения. псевдонимы: aep_name, name
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла `private_key`, по умолчанию используется `private_key` без расширения. Если предоставлено содержимое в формате PEM для `private_key`, по умолчанию используется значение `username`. псевдонимы: cert_name
description строка		Описание AEP. псевдонимы: descr
host строка / обязательно		IP-адрес или имя хоста APIC, разрешимый управляющим хостом Ansible. псевдонимы: hostname
infra_vlan логическое добавлено в 2.5	Варианты: no yes	Включить инфраструктурный VLAN. Функции гипервизора AEP. `no` отключит инфраструктурный VLAN, если он включен. псевдонимы: infrastructure_vlan
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого ACI-модуля. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию.
password строка / обязательно		Пароль для аутентификации. Этот параметр исключает `private_key`. Если также предоставлено `private_key`, оно будет использоваться вместо него.
port целое число		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key строка / обязательно		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемые для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр исключает `password`. Если также предоставлено `password`, оно будет проигнорировано. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
timeout целое число	По умолчанию: 30	Таймаут уровня сокета в секундах.
use_proxy логическое	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах.
use_ssl логическое	Варианты: no yes ←	Если `no`, вместо стандартного HTTPS-соединения будет использоваться HTTP-соединение.
username строка	По умолчанию: "admin"	Имя пользователя для аутентификации. псевдонимы: user
validate_certs логическое	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это значение следует устанавливать в `no` только при использовании на контролируемых вами сайтах с самоподписанными сертификатами.

См. также

aci_aep_to_domain – Связывание AEP с физическими или виртуальными доменам (infra:RsDomP): Официальная документация по модулю aci_aep_to_domain.
Ссылка на справочник модели информации управления APIC: Дополнительная информация о внутренних классах APIC infra:AttEntityP и infra:ProvAcc.
Руководство по Cisco ACI: Подробная информация о том, как управлять своей ACI-инфраструктурой с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных Cisco ACI-модулей для внесения вклада.

Примеры

- name: Add a new AEP
  aci_aep:
    host: apic
    username: admin
    password: SomeSecretPassword
    aep: ACI-AEP
    description: default
    state: present
  delegate_to: localhost

- name: Remove an existing AEP
  aci_aep:
    host: apic
    username: admin
    password: SomeSecretPassword
    aep: ACI-AEP
    state: absent
  delegate_to: localhost

- name: Query all AEPs
  aci_aep:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific AEP
  aci_aep:
    host: apic
    username: admin
    password: SomeSecretPassword
    aep: ACI-AEP
    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 строка	ошибка разбора	Необработанный результат, возвращенный API REST 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

Статус

Этот модуль не гарантирует обратную совместимость. [превью]
Этот модуль поддерживается партнёром Ansible. [сертифицировано]

Авторы

Swetha Chunduri (@schunduri)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/aci_aep_module.html