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

Примечание

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

Для его установки используйте: 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` dict `info` добавляет информативный вывод, включая `previous`, `proposed` и `sent` dicts `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 Management Information Model reference: Дополнительная информация о внутреннем классе 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': 'производство', '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': 'производство', 'nameAlias': '', 'ownerKey': '', 'ownerTag': ''}}}]
proposed словарь	информация	Собранная конфигурация из параметров пользователя Пример: {'fvTenant': {'attributes': {'descr': 'Производственная среда', 'name': 'производство'}}}
raw строка	ошибка разбора	Необработанный результат, возвращённый REST API 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

Авторы

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.10/collections/cisco/aci/aci_tenant_action_rule_profile_module.html