Модуль cisco.aci.aci_match_community_factor — Управление фактором сопоставления сообщества (rtctrl:MatchCommFactor)

Примечание

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

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

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

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

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

Обзор

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

Параметры

Параметр	Комментарии
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 строка	Значение сообщества сопоставления.
description псевдонимы: descr строка	Описание фактора сопоставления сообщества.
host псевдонимы: hostname строка	IP-адрес или имя хоста APIC, разрешаемый хостом управления Ansible. Если значение не указано в задаче, будет использовано значение переменной среды `ACI_HOST`.
match_community_term псевдонимы: match_community_term_name строка	Имя существующего термина сообщества сопоставления.
match_rule псевдонимы: match_rule_name строка	Имя существующего профиля правил сопоставления.
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`.
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 псевдонимы: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`. Этот параметр взаимоисключающий с `password`. Если также предоставлен `password`, он будет проигнорирован. Если значение не указано в задаче, будет использовано значение переменных среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
scope строка	Область элемента. Если область транзитивная, это сообщество может передаваться между AS. Если область не транзитивная, это сообщество должно передаваться только внутри локального AS. Варианты: `"transitive"` `"non-transitive"`

state string	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous псевдонимы: no_previous, ignore_previous boolean	Если `true`, GET-запрос для проверки предыдущего значения не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение становится пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification псевдонимы: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification boolean	Если `true`, GET-запрос для проверки не будет отправлен после обновления POST в APIC. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию: `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяться в одной задаче. Варианты: `false` `true`
tenant псевдонимы: tenant_name string	Имя существующего объекта арендатора.
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 псевдонимы: user string	Имя пользователя для аутентификации. Если значение не указано в задаче, будут использованы переменные окружения `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию: admin.
validate_certs boolean	Если `false`, сертификаты SSL не будут проверены. Это следует установить в `false` только при использовании на сайтах с собственными сертификатами, контролируемых лично. Если значение не указано в задаче, будет использовано значение переменной окружения `ACI_VALIDATE_CERTS`. Значение по умолчанию: true. Варианты: `false` `true`

Примечания

Примечание

Перед использованием данного модуля в вашем плане необходимо убедиться в существовании tenant, match_rule и match_community_term. Для этого можно использовать модули cisco.aci.aci_tenant, cisco.aci.aci_match_rule и cisco.aci.aci_match_community_term.

См. также

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

Примеры

- name: Create a match match AS-path regex term
  cisco.aci.aci_match_community_factor:
    host: apic
    username: admin
    password: SomeSecretPassword
    match_rule: prod_match_rule
    match_community_term: prod_match_community_term
    community: regular:as2-nn2:4:15
    scope: transitive
    tenant: production
    state: present
  delegate_to: localhost

- name: Delete a match match AS-path regex term
  cisco.aci.aci_match_community_factor:
    host: apic
    username: admin
    password: SomeSecretPassword
    match_rule: prod_match_rule
    tenant: production
    match_community_term: prod_match_community_term
    community: regular:as2-nn2:4:15
    state: absent
  delegate_to: localhost

- name: Query all match AS-path regex terms
  cisco.aci.aci_match_community_factor:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost
  register: query_result

- name: Query a specific match match AS-path regex term
  cisco.aci.aci_match_community_factor:
    host: apic
    username: admin
    password: SomeSecretPassword
    match_rule: prod_match_rule
    tenant: production
    match_community_term: prod_match_community_term
    community: regular:as2-nn2:4:15
    state: query
  delegate_to: localhost
  register: query_result

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

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

Ключ	Описание
current список / элементы=строка	Существующая конфигурация с APIC после завершения работы модуля Возвращено: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerauto_continue": ""}}}]`
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": "", "ownerauto_continue": ""}}}]`
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"`

Авторы

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_match_community_factor_module.html