aci_ap — Управление объектами профилей приложений верхнего уровня (AP) (fv:Ap)

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Автор

Обзор

Управление объектами профилей приложений (AP) верхнего уровня на платформах Cisco ACI

Параметры

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

Примечания

Примечание

Этот модуль не управляет EPG, см. aci_epg для этого.
tenant должен существовать до использования этого модуля в вашем исполняемом файле. Для этого можно использовать модуль aci_tenant.
Дополнительную информацию о внутреннем классе APIC fv:Ap см. в справочнике по модели управления информацией APIC.
По умолчанию, если на целевом узле установлена переменная среды <protocol>_proxy, запросы будут отправляться через этот прокси. Это поведение можно переопределить, установив переменную для этой задачи (см. установку среды) или с помощью параметра use_proxy.
Перенаправления HTTP могут перенаправлять с HTTP на HTTPS, поэтому вы должны убедиться, что ваша среда прокси для обоих протоколов корректна.

Примеры

- name: Add a new AP
  aci_ap:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: default
    description: default ap
    state: present

- name: Remove an AP
  aci_ap:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: default
    state: absent

- name: Query an AP
  aci_ap:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    ap: default
    state: query

- name: Query all APs
  aci_ap:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query

Возвращаемые значения

Общие значения возврата описаны в здесь, следующие поля уникальны для этого модуля:

Ключ	Возвращаемое значение	Описание
current список	успех	Текущая конфигурация с APIC после завершения модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производственная среда', 'nameAlias': '', 'ownerTag': ''}}}]
error словарь	ошибка	Информация об ошибке, возвращенная APIC Пример: {'text': 'неизвестный управляемый объект класса foo', 'code': '122'}
filter_string строка	ошибка или отладка	Строка фильтра, используемая для запроса Пример: ?rsp-prop-include=config-only
method строка	ошибка или отладка	Метод HTTP, используемый для запроса к APIC Пример: POST
previous список	информация	Исходная конфигурация с APIC до запуска модуля Пример: [{'fvTenant': {'attributes': {'dn': 'uni/tn-production', 'ownerKey': '', 'name': 'production', 'descr': 'Производство', 'nameAlias': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собраная конфигурация из параметров, заданных пользователем Пример: {'fvTenant': {'attributes': {'name': 'production', 'descr': 'Производственная среда'}}}
raw строка	ошибка парсинга	Необработанный вывод, возвращенный APIC REST API (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

Статус

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

Автор

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.5/modules/aci_ap_module.html