Модуль cisco.aci.aci_aaa_custom_privilege — Управление пользовательскими привилегиями AAA RBAC (aaa:RbacClassPriv)

Примечание

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

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

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

Для использования в плейбуке укажите: cisco.aci.aci_aaa_custom_privilege.

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

Обзор

Управление пользовательскими привилегиями AAA с правилами RBAC на фабриках Cisco ACI.

Параметры

Параметр	Комментарии
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если было предоставлено имя файла `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен контент в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_CERTIFICATE_NAME`.
description псевдонимы: descr строка	Описание пользовательского привилегия AAA.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемые хостом Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
name псевдонимы: custom_privilege_name строка	Имя класса объекта, для которого вы настраиваете доступ.
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`.
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`.
read_privilege псевдонимы: read_priv, r_priv строка	Имя пользовательского привилегия, которое будет включать доступ для чтения к объектам класса. Варианты: `"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"`
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для отображения объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous логическое значение	Если `true`, GET для проверки предыдущего значения не будет отправлен перед обновлением POST на APIC. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение будет пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`

END_OF_DOCUMENT_MARKER

suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, после обновления POST в APIC не будет отправлен GET-запрос для проверки. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверен в одной задаче. Выбираемые значения: `false` `true`
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определен в переменной окружения на целевых хостах. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию true. Выбираемые значения: `false` `true`
use_ssl boolean	Если `false`, будет использоваться HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию true при локальном соединении. Выбираемые значения: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задании, будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать в `false` только при работе с сайтами, контролируемыми самостоятельно, использующими самоподписанные сертификаты. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию true. Выбираемые значения: `false` `true`
write_privilege aliases: write_priv, w_priv string	Имя настраиваемого привилегия, которое будет включать запись в объекты класса. Выбираемые значения: `"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"`

См. также

cisco.aci.aci_aaa_domain: Управление домен AAA (aaa:Domain).
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC aaa:Domain.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой Cisco ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Add a custom privilege
  cisco.aci.aci_aaa_custom_privilege:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabricPod
    write_privilege: custom-privilege-1
    read_privilege: custom-privilege-1
    state: present
  delegate_to: localhost

- name: Add list of custom privileges
  cisco.aci.aci_aaa_custom_privilege:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: "{{ item.name }}"
    write_privilege: "{{ item.write_privilege }}"
    read_privilege: "{{ item.read_privilege | default('') }}"
    state: present
  with_items:
    - name: fvTenant
      write_privilege: custom-privilege-2
      read_privilege: custom-privilege-2
    - name: aaaUser
      write_privilege: custom-privilege-3
  delegate_to: localhost

- name: Query a custom privilege with name
  cisco.aci.aci_aaa_custom_privilege:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabricPod
    state: query
  delegate_to: localhost

- name: Query all custom privileges
  cisco.aci.aci_aaa_custom_privilege:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Remove a custom privilege
  cisco.aci.aci_aaa_custom_privilege:
    host: apic
    username: admin
    password: SomeSecretPassword
    name: fabricPod
    state: absent
  delegate_to: localhost

Значения возврата

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

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

Авторы

Сабари Джаганатан (@sajagana)

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

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