Модуль cisco.aci.aci_action_rule_additional_communities – Управление правилами действий на основе дополнительных сообществ (rtctrl:SetAddComm)

Примечание

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

Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
action_rule псевдонимы: action_rule_name строка	Имя профиля правила действия.
annotation строка	Пользовательская строка для аннотирования объекта. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задании и переменная окружения `ACI_ANNOTATION`, то будет использовано значение по умолчанию. Значение по умолчанию: `"orchestrator:ansible"`
certificate_name псевдонимы: cert_name строка	Имя сертификата X.509, прикреплённого к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если был предоставлен файл `private_key`, по умолчанию используется имя файла `private_key`, без расширения. Если для `private_key` был предоставлен PEM-формат, по умолчанию используется значение `username`. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
community строка	Значение сообщества.
criteria строка	Критерии сообщества. Опция для добавления или замены значения сообщества. Варианты: `"append"` `"replace"` `"none"`
description псевдонимы: descr строка	Описание профиля правила действия.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемое хостом Ansible. Если значение не указано в задании, будет использовано значение переменной окружения `ACI_HOST`.
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 строка	Путь к файлу, который будет использоваться для вывода JSON-конфигураций объектов ACI, сгенерированных модулем. Если значение не указано в задании, будет использовано значение переменной окружения `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`.
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`
tenant aliases: tenant_name string	Имя тенанта.
timeout integer	Таймаут уровня сокета в секундах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_TIMEOUT`. Значение по умолчанию — 30.
use_proxy boolean	Если `false`, прокси не будет использоваться, даже если он определён в переменной окружения на целевых хостах. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_PROXY`. Значение по умолчанию — true. Варианты: `false` `true`
use_ssl boolean	Если `false`, вместо стандартного соединения HTTPS будет использовано соединение HTTP. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_USE_SSL`. Значение по умолчанию — true, когда соединение локальное. Варианты: `false` `true`
username aliases: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будет использовано значение переменных окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию — admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует устанавливать в `false` только при работе с сайтами, контролируемыми лично, использующими самоподписанные сертификаты. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию — true. Варианты: `false` `true`

Примечания

Примечание

Модули tenant и action_rule должны существовать, прежде чем использовать этот модуль в вашей книге задач. Для этого можно использовать модули cisco.aci.aci_tenant и cisco.aci.aci_tenant_action_rule_profile.

См. также

cisco.aci.aci_tenant: Управление тенентами (fv:Tenant).
cisco.aci.aci_tenant_action_rule_profile: Управление профилями правил действия (rtctrl:AttrP).
APIC Management Information Model reference: Дополнительная информация о внутреннем классе APIC rtctrl:SetAddComm.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для внесения вклада.

Примеры

- name: Create an additional communities action rule
  cisco.aci.aci_action_rule_additional_communities:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    community: no-advertise
    criteria: replace
    state: present
  delegate_to: localhost

- name: Delete an additional communities action rule
  cisco.aci.aci_action_rule_additional_communities:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    community: no-advertise
    state: absent
  delegate_to: localhost

- name: Query all additional communities action rules
  cisco.aci.aci_action_rule_additional_communities:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query an additional communities action rule
  cisco.aci.aci_action_rule_additional_communities:
    host: apic
    username: admin
    password: SomeSecretPassword
    action_rule: my_action_rule
    tenant: prod
    community: no-advertise
    state: query
  delegate_to: localhost
  register: query_result

Значения возврата

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

Ключ	Описание
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 строка	Необработанный вывод, возвращённый REST API 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"`

Авторы

Gaspard Micol (@gmicol)

Ссылки на коллекции

© 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_action_rule_additional_communities_module.html