Spec-Zone.ru › Ansible

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

Примечание

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

У вас, возможно, уже установлена эта коллекция, если вы используете пакет 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

строка

Имя сертификата 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

псевдонимы: aaa_role

строка

Имя роли aaa.

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.

privileges

псевдонимы: priv

список / элементы=строка

Привилегии, назначенные роли.

Варианты:

  • "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

строка

Используйте present или absent для добавления или удаления.

Используйте query для отображения объекта или нескольких объектов.

Варианты:

  • "absent"
  • "present" ← (по умолчанию)
  • "query"

suppress_previous

aliases: no_previous, ignore_previous

boolean

Если true, запрос GET для проверки предыдущего состояния не будет отправлен перед обновлением POST на APIC.

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

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

ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым.

Предыдущее состояние объекта не будет проверено, и обновление POST будет содержать все свойства.

Возможные значения:

  • false
  • true

suppress_verification

aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification

boolean

Если true, проверка GET не будет отправлена после обновления POST на APIC.

Если значение не указано в задаче, будет использовано значение переменной среды 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 не будут проверяться.

Это следует использовать только на сайтах с собственными сертификатами, управляемых лично.

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

Значение по умолчанию — true.

Возможные значения:

  • false
  • true

См. также

См. также

cisco.aci.aci_aaa_domain

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

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

Дополнительная информация о классе AAA domains 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

список / элементы=строка

Настройка, существующая на 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"

Авторы

  • Sabari Jaganathan (@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_role_module.html

Spec-Zone.ru

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