cisco.mso.ndo_match_rule_community_term module – Manage Match Community Terms on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.13.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install cisco.mso. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.mso.ndo_match_rule_community_term.

New in cisco.mso 2.12.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage Match Community Terms inside a Match Rule Policy on Cisco Nexus Dashboard Orchestrator (NDO).
This module is only supported on ND v4.1 (NDO v5.1) and later.

Requirements

The below requirements are needed on the host that executes this module.

Multi Site Orchestrator v2.1 or newer

Parameters

Parameter	Comments
description aliases: match_community_term_description string	The description of the Match Community Term.
host aliases: hostname string	IP Address or hostname of the ACI Multi Site Orchestrator host. If the value is not specified in the task, the value of environment variable `MSO_HOST` will be used instead.
login_domain string	The login domain name to use for authentication. The default value is Local. If the value is not specified in the task, the value of environment variable `MSO_LOGIN_DOMAIN` will be used instead. When using a HTTPAPI connection plugin the inventory variable `ansible_httpapi_login_domain` will be used if this attribute is not specified.
match_community_factors list / elements=dictionary	The list of Match Community Factors.
community_factor aliases: community string	The Community Factor to match. e.g., regular:as2-nn2:4:15, extended:as4-nn2:5:16, extended:color:35, no-export, no-advertise, etc.
description aliases: match_community_description string	The description of the Match Community Factor.
scope string	The scope of the Match Community Factor. Defaults to `transitive` when unset during creation. Choices: `"transitive"` `"non_transitive"`
match_rule_policy string	The name of the Match Rule Policy. This parameter or `match_rule_policy_uuid` is required.
match_rule_policy_uuid string	The UUID of the Match Rule Policy. This parameter or `match_rule_policy` is required.
name aliases: match_community_term string	The name of the Match Community Term.
output_level string	Influence the output of this MSO module. `normal` means the standard output, incl. `current` dict `info` adds informational output, incl. `previous`, `proposed` and `sent` dicts `debug` adds debugging output, incl. `filter_string`, `method`, `response`, `status` and `url` information If the value is not specified in the task, the value of environment variable `MSO_OUTPUT_LEVEL` will be used instead. Choices: `"debug"` `"info"` `"normal"` ← (default)
password string	The password to use for authentication. If the value is not specified in the task, the value of environment variables `MSO_PASSWORD` or `ANSIBLE_NET_PASSWORD` will be used instead.
port integer	Port number to be used for the REST connection. The default value depends on parameter `use_ssl`. If the value is not specified in the task, the value of environment variable `MSO_PORT` will be used instead.
state string	Use `absent` for removing. Use `query` for listing an object or multiple objects. Use `present` for creating or updating. Choices: `"absent"` `"query"` ← (default) `"present"`
template string	The name of the template. The template must be a Tenant Policy template. This parameter or `template_id` is required.
template_id string	The ID of the template. The template must be a Tenant Policy template. This parameter or `template` is required.
timeout integer	The socket level timeout in seconds. The default value is 30 seconds. If the value is not specified in the task, the value of environment variable `MSO_TIMEOUT` will be used instead.
use_proxy boolean	If `false`, it will not use a proxy, even if one is defined in an environment variable on the target hosts. If the value is not specified in the task, the value of environment variable `MSO_USE_PROXY` will be used instead. The default is `true`. Choices: `false` `true`
use_ssl boolean	If `false`, an HTTP connection will be used instead of the default HTTPS connection. If the value is not specified in the task, the value of environment variable `MSO_USE_SSL` will be used instead. When using a HTTPAPI connection plugin the inventory variable `ansible_httpapi_use_ssl` will be used if this attribute is not specified. The default is `false` when using a HTTPAPI connection plugin (mso or nd) and `true` when using the legacy connection method (only for mso). Choices: `false` `true`
username string	The username to use for authentication. If the value is not specified in the task, the value of environment variables `MSO_USERNAME` or `ANSIBLE_NET_USERNAME` will be used instead.
validate_certs boolean	If `false`, SSL certificates will not be validated. This should only set to `false` when used on personally controlled sites using self-signed certificates. If the value is not specified in the task, the value of environment variable `MSO_VALIDATE_CERTS` will be used instead. The default is `true`. Choices: `false` `true`

Notes

Note

The template must exist before using this module in your playbook. Use cisco.mso.ndo_template to create the Tenant Policy template.
The match_rule_policy must exist before using this module in your playbook. Use cisco.mso.ndo_match_rule_policy to create the Match Rule Policy.
This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

Examples

- 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

Authors

Gaspard Micol (@gmicol)

Collection links

© 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