Spec-Zone.ru › Ansible

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

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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, перед обновлением POST на APIC не будет отправлен GET-запрос для проверки предыдущего состояния.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды ACI_SUPPRESS_PREVIOUS.

Значение по умолчанию: false.

ВНИМАНИЕ! В результате возвращаемое значение previous будет пустым.

Предыдущее состояние объекта не будет проверено, а запрос 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

write_privilege

псевдонимы: write_priv, w_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"

См. также

См. также

cisco.aci.aci_aaa_domain

Управление доменами AAA (aaa:Domain).

Справочник модели управления APIC

Дополнительные сведения о внутреннем классе APIC aaa:Domain.

Руководство по Cisco ACI

Подробная информация об управлении инфраструктурой 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 после завершения работы модуля

Возвращается: 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"

Авторы

  • 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_custom_privilege_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API