aci_tenant – Управление арендаторами (fv:Tenant)

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

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

Описание

Управление арендаторами на фэбраиках Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name -		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе сертификата. По умолчанию используется `private_key` базовое имя без расширения. Псевдонимы: cert_name
description -		Описание арендатора. Псевдонимы: 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 - / обязательно		Пароль для аутентификации. Этот параметр взаимоисключающий с `private_key`. Если указан `private_key`, то будет использован он.
port -		Номер порта для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`.
private_key - / обязательно		Файл в формате PEM, содержащий ваш закрытый ключ для аутентификации на основе сертификата. Имя ключа (без расширения) используется в качестве имени сертификата в ACI, если не указан `certificate_name`. Этот параметр взаимоисключающий с `password`. Если указан `password`, то он будет проигнорирован. Псевдонимы: cert_key
state -	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов.
tenant - / обязательно		Имя арендатора. Псевдонимы: name, 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` только при использовании на контролируемых сайтах с самозаверяющими сертификатами.

Примечания

Примечание

Дополнительная информация о внутреннем классе APIC fv:Tenant из справочника по модели управления информацией APIC.

См. также

Руководство по Cisco ACI: Подробная информация о том, как управлять инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a new tenant
  aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    description: Production tenant
    state: present
  delegate_to: localhost

- name: Remove a tenant
  aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: absent
  delegate_to: localhost

- name: Query a tenant
  aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: production
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all tenants
  aci_tenant:
    host: apic
    username: admin
    password: SomeSecretPassword
    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. [сертифицировано]

Авторы

Jacob McGill (@jmcgill298)

Подсказка

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

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