Модуль cisco.aci.aci_aaa_role — управление ролями AAA (aaa:Role)

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
certificate_name псевдонимы: cert_name string	Имя сертификата X.509, связанного с пользователем APIC AAA и используемого для аутентификации на основе подписи. Если указан файл `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_role 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`.
privileges псевдонимы: priv list / элементы=string	Привилегии, назначенные роли. Варианты: `"admin"` `"aaa"` `"tenant-connectivity"` `"tenant-protocol"` `"vmm-policy"` `"tenant-ext-connectivity"` `"tenant-ext-protocol"` `"tenant-qos"` `"tenant-security"` `"tenant-network-profile"` `"tenant-epg"` `"fabric-connectivity"` `"fabric-protocol"` `"fabric-equipment"` `"access-connectivity"` `"access-protocol"` `"access-equipment"` `"access-qos"` `"nw-svc-params"` `"ops"` `"nw-svc-policy"` `"site-admin"` `"site-policy"` `"config-manager"` `"custom-privilege-1"` `"custom-privilege-2"` `"custom-privilege-3"` `"custom-privilege-4"` `"custom-privilege-5"` `"custom-privilege-6"` `"custom-privilege-7"` `"custom-privilege-8"` `"custom-privilege-9"` `"custom-privilege-10"` `"custom-privilege-11"` `"custom-privilege-12"` `"custom-privilege-13"` `"custom-privilege-14"` `"custom-privilege-15"` `"custom-privilege-16"` `"custom-privilege-17"` `"custom-privilege-18"` `"custom-privilege-19"` `"custom-privilege-20"` `"custom-privilege-21"` `"custom-privilege-22"` `"custom-port-privilege"`
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_domain: Управление доменами AAA (aaa:Domain).
Управление доменами AAA (aaa:Domain): Дополнительная информация о классе доменов AAA aaa:Domain.
Руководство по Cisco ACI: Подробная информация об управлении инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по созданию собственных модулей Cisco ACI для внесения вклада в проект.

Примеры

- name: Add a aaa role
  cisco.aci.aci_aaa_role:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: anstest
    privileges: aaa
    state: present
  delegate_to: localhost

- name: Add list of aaa roles
  cisco.aci.aci_aaa_role:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: "{{ item.name }}"
    privileges: "{{ item.privilege }}"
    state: present
  delegate_to: localhost
  with_items:
    - name: anstest1
      privilege: site-admin
    - name: anstest2
      privilege: site-policy

- name: Query a aaa role with name
  cisco.aci.aci_aaa_role:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: anstest
    state: query
  delegate_to: localhost

- name: Query all aaa roles
  cisco.aci.aci_aaa_role:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove a aaa role with name
  cisco.aci.aci_aaa_role:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: anstest
    state: absent
  delegate_to: localhost

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

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

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