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

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

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

Описание

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

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
certificate_name строка		Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если было предоставлено имя файла `private_key`, значение по умолчанию устанавливается как базовое имя `private_key` без расширения. Если для `private_key` был предоставлен PEM-формат, значение по умолчанию устанавливается как значение `username`. псевдонимы: 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 или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `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` только при работе с сайтами под собственным контролем, использующими самозаверяющие сертификаты.

См. также

aci_ap – Управление профилями приложений верхнего уровня (AP) (fv:Ap): Официальная документация по модулю aci_ap.
aci_bd – Управление областями мостов (BD) (fv:BD): Официальная документация по модулю aci_bd.
aci_contract – Управление ресурсами контрактов (vz:BrCP): Официальная документация по модулю aci_contract.
aci_filter – Управление фильтрами верхнего уровня (vz:Filter): Официальная документация по модулю aci_filter.
aci_vrf – Управление контекстами или VRF (fv:Ctx): Официальная документация по модулю aci_vrf.
Ссылка на руководство по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC fv:Tenant.
Руководство по 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.9/modules/aci_tenant_module.html