aci_tenant_action_rule_profile - Управление профилями правил действий (rtctrl:AttrP)
Новая версия 2.4.
Краткое описание
- Управление профилями правил действий на фэбриках Cisco ACI.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| action_rule | Имя профиля правила действия. Псевдонимы: action_rule_name, name | |
| certificate_name | Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. По умолчанию — private_key базовое имя без расширения.Псевдонимы: cert_name | |
| description | Описание профиля правила действия. Псевдонимы: descr | |
| host обязательно | IP-адрес или имя хоста APIC, разрешаемое хостом управления Ansible. Псевдонимы: hostname | |
| output_level |
| Влияет на вывод этого модуля ACI. normal означает стандартный вывод, вкл. current dictinfo добавляет информативный вывод, вкл. previous, proposed и sent dictsdebug добавляет отладочный вывод, вкл. filter_string, method, response, status и url информацию |
| password обязательно | Пароль для аутентификации. Этот параметр взаимоисключающий с private_key. Если также указан private_key, он будет использован вместо него. | |
| port | Порт, используемый для подключения REST. Значение по умолчанию зависит от параметра `use_ssl`. | |
| private_key обязательно | Файл в формате PEM, содержащий ваш закрытый ключ, используемый для аутентификации на основе подписи. Имя ключа (без расширения) используется как имя сертификата в ACI, если не указан certificate_name. Этот параметр взаимоисключающий с password. Если также указан password, он будет проигнорирован.Псевдонимы: cert_key | |
| state |
| Используйте present или absent для добавления или удаления.Используйте query для перечисления объекта или нескольких объектов. |
| tenant | Имя клиента. Псевдонимы: tenant_name | |
| timeout int | По умолчанию: 30 | Таймаут уровня сокета в секундах. |
| use_proxy bool |
| Если no, прокси не будет использоваться, даже если он определён в переменной среды на целевых хостах. |
| use_ssl bool |
| Если no, будет использовано HTTP-соединение вместо стандартного HTTPS-соединения. |
| username | По умолчанию: "admin" | Имя пользователя для аутентификации. Псевдонимы: user |
| validate_certs bool |
| Если no, SSL-сертификаты не будут проверены.Это следует установить в no только при работе с сайтами, на которых вы контролируете сертификаты (самозаверенные сертификаты). |
Примечания
Примечание
- Необходимо, чтобы
tenantсуществовал перед использованием этого модуля в вашем плейбуке. Для этого можно использовать модуль aci_tenant. - Дополнительную информацию об внутреннем классе APIC rtctrl:AttrP можно найти в справочнике по модели информации управления APIC.
- Для более подробной информации о управлении вашей инфраструктурой ACI с помощью Ansible, пожалуйста, обратитесь к Руководству по Cisco ACI.
Примеры
- aci_tenant_action_rule_profile:
host: apic
username: admin
password: SomeSecretPassword
action_rule: '{{ action_rule }}'
description: '{{ descr }}'
tenant: '{{ tenant }}'
Возвращаемые значения
Общие значения возвращаемых данных описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращённое значение | Описание |
|---|---|---|
| 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 строка | ошибка разбора | Необработанный вывод, возвращённый API REST APIC (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 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сообщество, что означает, что он поддерживается сообществом Ansible. Дополнительную информацию см. в разделе Техническое обслуживание и поддержка модулей.
Список других модулей, также поддерживаемых сообществом Ansible, см. здесь.
Автор
- Dag Wieers (@dagwieers)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.6/modules/aci_tenant_action_rule_profile_module.html