cisco.aci.aci_aaa_user_domain module – Управление доменами пользователей AAA (aaa:UserDomain)

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.aci.

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

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

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

Управление конфигурацией доменов пользователей AAA в фабриках Cisco ACI.

Параметры

Параметр	Комментарии
aaa_user псевдонимы: user_name строка	Имя существующего пользователя AAA
aaa_user_type строка	Обычный это пользователь или appuser. Варианты: `"appuser"` `"user"` ← (по умолчанию)
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменная окружения `ACI_ANNOTATION`, будет использоваться значение по умолчанию. По умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, связанного с пользователем APIC AAA и используемого для аутентификации на основе подписи. Если указано имя файла `private_key`, по умолчанию используется базовое имя `private_key` без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_CERTIFICATE_NAME`.
host псевдонимы: hostname строка	IP-адрес или имя узла APIC, доступное для разрешения на управляющем узле Ansible. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_HOST`.
name псевдонимы: domain_name, user_domain строка	Имя домена пользователя
name_alias строка	Псевдоним текущего объекта. Соответствует полю nameAlias в ACI.
output_level строка	Управляет выводом этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
output_path строка	Путь к файлу, в который будут записываться объекты конфигурации ACI в формате JSON, созданные модулем. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key строка	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OWNER_KEY`.
owner_tag строка	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет тег, позволяющий клиентам добавлять собственные данные. Например, для указания создателя объекта. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_OWNER_TAG`.
password строка	Пароль для аутентификации. Этот параметр несовместим с `private_key`. Если также задан `private_key`, он будет использован вместо этого параметра. Если значение не указано в задаче, вместо него будут использоваться переменные окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_PORT`.
private_key псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на используемое значение по умолчанию `certificate_name`. Этот параметр несовместим с `password`. Если также задан `password`, он будет проигнорирован. Если значение не указано в задаче, вместо него будут использоваться переменные окружения `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
state строка	Для добавления или удаления используйте `present` или `absent`. Для получения списка одного или нескольких объектов используйте `query`. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, перед отправкой обновления POST в APIC запрос GET для проверки предыдущего состояния отправляться не будет. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — в результате возвращаемое предыдущее значение будет пустым. Предыдущее состояние объекта проверяться не будет, а запрос POST на обновление будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое значение	Если `true`, после отправки обновления POST в APIC проверочный запрос GET отправляться не будет. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ — в результате для текущего возвращаемого значения будет задано предлагаемое значение. Текущий объект, включая значения по умолчанию, невозможно проверить в рамках одной задачи. Варианты: `false` `true`
timeout целое число	Тайм-аут на уровне сокета в секундах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию: 30.
use_proxy логическое значение	Если `false`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию: true. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_USE_SSL`. При локальном подключении значение по умолчанию — true. Варианты: `false` `true`
username псевдонимы: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использоваться переменные окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию: admin.
validate_certs логическое значение	Если `false`, сертификаты SSL проверяться не будут. Задавайте значение `false` только на контролируемых вами сайтах, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него будет использоваться значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию: true. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должен существовать aaa_user. Для этого можно использовать модули cisco.aci.aci_aaa_user.

См. также

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

Примеры

- name: Add a security domain to a aaa_user
  cisco.aci.aci_aaa_user_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: my_user
    name: my_domain
    state: present
  delegate_to: localhost

- name: Remove a security domain from a aaa_user
  cisco.aci.aci_aaa_user_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: my_user
    name: my_domain
    state: absent
  delegate_to: localhost

- name: Add list of security domains to a aaa_user
  cisco.aci.aci_aaa_user_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: my_user
    name: "{{ item.name }}"
    state: present
  with_items:
    - name: common
    - name: all
    - name: mgmt
  delegate_to: localhost

- name: Query a security domain from a aaa_user
  cisco.aci.aci_aaa_user_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: my_user
    name: my_domain
    state: query
  delegate_to: localhost
  register: query_result

- name: Query all security domains of a aaa_user
  cisco.aci.aci_aaa_user_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    aaa_user: my_user
    state: query
  delegate_to: localhost
  register: query_results

- name: Query all security domains to user associations
  cisco.aci.aci_aaa_user_domain:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_all_domains

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

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

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

Авторы

Tim Cragg (@timcragg)
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_user_domain_module.html