модуль cisco.aci.aci_aaa_domain — управление доменами AAA (aaa:Domain)

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: cisco.aci.aci_aaa_domain.

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

Краткое описание

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

Параметры

Параметр	Комментарии
certificate_name псевдонимы: cert_name string	Имя сертификата X.509, привязанного к пользователю AAA APIC и используемого для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr string	Описание домена AAA.
host псевдонимы: hostname string	IP-адрес или имя узла APIC, разрешаемое управляющим узлом Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_HOST`.
name псевдонимы: aaa_domain string	Имя домена AAA.
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`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path string	Путь к файлу, в который будут записываться объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OUTPUT_PATH`.
password string	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также задан `private_key`, будет использоваться он. Если значение не указано в задаче, вместо него будет использоваться значение одной из переменных окружения: `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PORT`.
private_key псевдонимы: cert_key string	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемое для аутентификации на основе подписи. Это значение также влияет на используемое значение `certificate_name` по умолчанию. Этот параметр несовместим с `password`. Если также задан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использоваться значение одной из переменных окружения: `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
restricted_rbac_domain boolean	`True` для включения ограниченного домена RBAC в домене безопасности AAA. Варианты: `false` `true`
state string	Для добавления или удаления используйте `present` или `absent`. Для вывода одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, перед POST-обновлением APIC не будет отправляться GET-запрос для проверки предыдущего состояния. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение previous будет пустым. Предыдущее состояние объекта не будет проверяться, а POST-обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после POST-обновления APIC не будет отправляться проверочный GET-запрос. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое значение current будет установлено в предложенное значение. Текущий объект, включая значения по умолчанию, нельзя будет проверить в рамках одной задачи. Варианты: `false` `true`
timeout integer	Тайм-аут сокетного уровня в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `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`

См. также

cisco.aci.aci_aaa_role: Управление ролями AAA (aaa:Role).
Управление ролями AAA (aaa:Role): Дополнительная информация о классе ролей AAA aaa:Role.
Руководство по Cisco ACI: Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для участия в разработке.

Примеры

- name: Add an aaa security domain
  cisco.aci.aci_aaa_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: anstest_security_domain
    description: "Anstest Sec Domain Descr"
    state: present
  delegate_to: localhost

- name: Add list of aaa security domain
  cisco.aci.aci_aaa_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: "{{ item.name }}"
    description: "{{ item.description }}"
    state: present
  with_items:
    - name: anstest1
      description: "Anstest Sec Domain Descr 1"
    - name: anstest2
      description: "Anstest Sec Domain Descr 2"
  delegate_to: localhost

- name: Query an aaa security domain with name
  cisco.aci.aci_aaa_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: anstest_security_domain
    state: query
  delegate_to: localhost

- name: Query all aaa security domains
  cisco.aci.aci_aaa_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove an aaa security domain
  cisco.aci.aci_aaa_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: anstest_security_domain
    state: absent
  delegate_to: localhost

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

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

Ключ	Описание
current list / elements=string	Существующая конфигурация APIC после завершения работы модуля Возвращается: success Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error dictionary	Сведения об ошибке, возвращённые APIC Возвращается: failure Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string string	Строка фильтра, использованная в запросе Возвращается: failure или debug Пример: `"?rsp-prop-include=config-only"`
method string	Метод HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: `"POST"`
previous list / elements=string	Исходная конфигурация APIC до запуска модуля Возвращается: info Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed dictionary	Собранная конфигурация на основе параметров, заданных пользователем Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw string	Необработанный вывод, возвращённый REST API APIC (xml или json) Возвращается: parse error Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response string	Ответ HTTP от APIC Возвращается: failure или debug Пример: `"OK (30 bytes)"`
sent list / elements=string	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: info Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status integer	Статус HTTP от APIC Возвращается: failure или debug Пример: `200`
url string	URL HTTP, использованный для запроса к APIC Возвращается: failure или debug Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Sabari Jaganathan (@sajagana)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/aci/aci_aaa_domain_module.html