cisco.aci.aci_tenant_action_rule_profile – Управление профилями правил действия (rtctrl:AttrP)

Примечание

Этот плагин входит в коллекцию cisco.aci (версия 2.0.0).

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

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

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

Обзор

Управление профилями правил действия на тканях Cisco ACI.

Параметры

Параметр	Варианты/Значения по умолчанию	Комментарии
action_rule строка		Имя профиля правила действия. псевдонимы: action_rule_name, name
annotation строка		Пользовательская строка для аннотации объекта. Если значение не указано в задаче, используется значение переменной среды `ACI_ANNOTATION`.
certificate_name строка		Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если предоставлено имя файла `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` предоставлено содержимое в формате PEM, по умолчанию используется значение `username`. Если значение не указано в задаче, используется значение переменной среды `ACI_CERTIFICATE_NAME`. псевдонимы: cert_name
description строка		Описание профиля правила действия. псевдонимы: descr
host строка / обязательно		IP-адрес или имя хоста APIC, разрешаемый управляющим хостом Ansible. Если значение не указано в задаче, используется значение переменной среды `ACI_HOST`. псевдонимы: hostname
name_alias строка		Псевдоним текущего объекта. Он относится к полю nameAlias в ACI.
output_level строка	Варианты: debug info normal ←	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая `current` словарь. `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` словари. `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и `url` информацию. Если значение не указано в задаче, используется значение переменной среды `ACI_OUTPUT_LEVEL`.
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 строка		Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр взаимоисключающий с `password`. Если также указан `password`, он будет проигнорирован. Если значение не указано в задаче, используется значение переменной среды `ACI_PRIVATE_KEY`. псевдонимы: cert_key
state строка	Варианты: absent present ← query	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов.
tenant строка		Имя клиента. псевдонимы: tenant_name
timeout целое число	Значение по умолчанию: 30	Таймаут уровня сокета в секундах. Если значение не указано в задаче, используется значение переменной среды `ACI_TIMEOUT`.
use_proxy булево	Варианты: no yes ←	Если `no`, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_PROXY`.
use_ssl булево	Варианты: no yes ←	Если `no`, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. Если значение не указано в задаче, используется значение переменной среды `ACI_USE_SSL`.
username строка	Значение по умолчанию: "admin"	Имя пользователя для аутентификации. Если значение не указано в задаче, используется значение переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. псевдонимы: user
validate_certs булево	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверены. Это следует устанавливать в `no` только при использовании на контролируемых сайтах с самоподписанными сертификатами. Если значение не указано в задаче, используется значение переменной среды `ACI_VALIDATE_CERTS`.

Примечания

Примечание

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

См. также

cisco.aci.aci_tenant: Официальная документация по модулю cisco.aci.aci_tenant.
Ссылка на руководство по модели информации управления APIC: Дополнительная информация о внутреннем классе APIC rtctrl:AttrP.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- cisco.aci.aci_tenant_action_rule_profile:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: '{{ action_rule }}'
    description: '{{ descr }}'
    tenant: '{{ tenant }}'
  delegate_to: localhost

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

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

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

Авторы

Dag Wieers (@dagwieers)

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