Модуль cisco.mso.ndo_match_rule_community_term — управление условиями соответствия сообществу в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.ndo_match_rule_community_term.

Добавлено в cisco.mso 2.12.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

Краткое описание

Управление условиями соответствия сообществу в политике правил соответствия в Cisco Nexus Dashboard Orchestrator (NDO).
Этот модуль поддерживается только в ND v4.1 (NDO v5.1) и более поздних версиях.

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

Multi Site Orchestrator v2.1 или новее

Параметры

Параметр	Комментарии
description псевдонимы: match_community_term_description строка	Описание условия соответствия сообществу.
host псевдонимы: hostname строка	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_HOST`.
login_domain строка	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, используется переменная инвентаря `ansible_httpapi_login_domain`.
match_community_factors список / элементы=словарь	Список факторов соответствия сообществу.
community_factor псевдонимы: community строка	Фактор сообщества для сопоставления. Например: regular:as2-nn2:4:15, extended:as4-nn2:5:16, extended:color:35, no-export, no-advertise и т. д.
description псевдонимы: match_community_description строка	Описание фактора соответствия сообществу.
scope строка	Область действия фактора соответствия сообществу. При создании, если значение не задано, используется `transitive`. Варианты: `"transitive"` `"non_transitive"`
match_rule_policy строка	Имя политики правил соответствия. Необходимо указать этот параметр или `match_rule_policy_uuid`.
match_rule_policy_uuid строка	UUID политики правил соответствия. Необходимо указать этот параметр или `match_rule_policy`.
name псевдонимы: match_community_term строка	Имя условия соответствия сообществу.
output_level строка	Определяет состав выходных данных этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password строка	Пароль для аутентификации. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port целое число	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_PORT`.
state строка	Для удаления используйте `absent`. Для просмотра одного или нескольких объектов используйте `query`. Для создания или обновления используйте `present`. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template строка	Имя шаблона. Шаблон должен быть шаблоном политик арендатора. Необходимо указать этот параметр или `template_id`.
template_id строка	Идентификатор шаблона. Шаблон должен быть шаблоном политик арендатора. Необходимо указать этот параметр или `template`.
timeout целое число	Тайм-аут сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_TIMEOUT`.
use_proxy логическое значение	Если `false`, прокси-сервер использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl логическое значение	Если `false`, вместо HTTPS-подключения, используемого по умолчанию, будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, используется переменная инвентаря `ansible_httpapi_use_ssl`. По умолчанию используется `false` при подключении через HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`
username строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
validate_certs логическое значение	Если `false`, проверка SSL-сертификатов выполняться не будет. Значение `false` следует задавать только для подконтрольных вам сайтов, использующих самоподписанные сертификаты. Если значение не указано в задаче, вместо него используется значение переменной окружения `MSO_VALIDATE_CERTS`. Значение по умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке должен существовать template. Для создания шаблона политик арендатора используйте cisco.mso.ndo_template.
Перед использованием этого модуля в плейбуке должна существовать match_rule_policy. Для создания политики правил соответствия используйте cisco.mso.ndo_match_rule_policy.
Этот модуль разработан для поддержки Multi Site Orchestrator v2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.ndo_template: Управление шаблонами в Cisco Nexus Dashboard Orchestrator (NDO).
cisco.mso.ndo_match_rule_policy: Управление политиками правил соответствия в Cisco Nexus Dashboard Orchestrator (NDO).

Примеры

- name: Create a Match Community Term
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    name: ansible_match_community_term
    description: Ansible Match Community Term
    match_community_factors:
      - community_factor: no-export
        scope: transitive
        description: no export and transitive
    state: present
  register: create_match_name

- name: Update a Match Community Term using Match Rule Policy's name
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    name: ansible_match_community_term
    description: Updated Ansible Match Community Term
    match_community_factors:
      - community_factor: no-export
        scope: non_transitive
        description: no export and non-transitive
      - community_factor: no-advertise
        scope: transitive
        description: no advertise and transitive
    state: present

- name: Update a Match Community Term using Match Rule Policy's UUID
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy_uuid: "{{ create_match_name.current.matchRulePolicyUuid }}"
    name: ansible_match_community_term
    description: Updated Ansible Match Community Term
    match_community_factors:
      - community_factor: no-export
        scope: non_transitive
        description: no export and non-transitive
      - community_factor: no-advertise
        scope: transitive
        description: no advertise and transitive
    state: present

- name: Update a Match Community Term by removing a Match Community
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    name: ansible_match_community_term
    description: Updated Ansible Match Community Term
    match_community_factors:
      - community_factor: no-advertise
        scope: transitive
        description: no advertise and transitive
    state: present

- name: Update a Match Community Term by removing all Match Communities
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    name: ansible_match_community_term
    description: Updated Ansible Match Community Term
    match_community_factors: []
    state: present

- name: Query a Match Community Term using Match Rule Policy's name
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    name: ansible_match_community_term
    state: query
  register: query_with_name

- name: Query a Match Community Term using  Match Rule Policy's UUID
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy_uuid: "{{ create_match_name.current.matchRulePolicyUuid }}"
    name: ansible_match_community_term
    state: query
  register: query_with_uuid

- name: Query all Match Community Terms in a Match Rule Policy
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    state: query
  register: query_all_objects

- name: Delete a Match Community Term using Match Rule Policy's name
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_test
    match_rule_policy: ansible_match_rule_policy
    name: ansible_match_community_term
    state: absent

- name: Delete a Match Community Term using Match Rule Policy's UUID
  cisco.mso.ndo_match_rule_community_term:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template_id: ansible_test
    match_rule_policy_uuid: "{{ create_match_name.current.matchRulePolicyUuid }}"
    name: ansible_match_community_term
    state: absent

Авторы

Gaspard Micol (@gmicol)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/mso/ndo_match_rule_community_term_module.html