cisco.mso.ndo_route_map_policy_route_control_context module – Manage Route Map Policy for Route Control Context on Cisco Nexus Dashboard Orchestrator (NDO).

Note

This module is part of the cisco.mso collection (version 2.12.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_route_map_policy_route_control_context.

New in cisco.mso 2.12.0

Synopsis

  • Manage Route Map Policy for Route Control Context on Cisco Nexus Dashboard Orchestrator (NDO).

  • This module is only supported on ND v4.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

action

string

The action of the Route Control context.

Defaults to permit when unset during creation.

Choices:

  • "permit"

  • "deny"

description

string

The description of the Route Control context.

Providing an empty string description="" will remove description from the Route Control context.

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_rules

list / elements=dictionary

The list of Match Rule Policy references.

Providing an empty list match_rules=[] will remove Match Rule Policies from the Route Control context.

When the match_rules is null the update will not change existing configuration.

The old match_rules list will be replaced by the new list during an update.

reference

aliases: ref

dictionary

The reference of the Match Rule Policy.

This parameter can be used instead of match_rules.uuid.

name

string

The name of the Match Rule Policy.

template

string

The template associated with the Match Rule Policy.

This parameter or match_rules.reference.template_id is required.

template_id

string

The template ID associated with the Match Rule Policy.

This parameter or match_rules.reference.template is required.

uuid

string

The UUID of the Match Rule Policy.

This parameter can be used instead of match_rules.reference.

name

string

The name of the Route Control context.

order

integer

The order of the Route Control context.

The value must be a number between 0 and 9.

Defaults to 0 when unset during creation.

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.

route_map_policy

string

The name of the Route Map Policy for Route Control.

This parameter or route_map_policy_uuid is required.

route_map_policy_uuid

string

The UUID of the Route Map Policy for Route Control.

This parameter or route_map_policy is required.

set_rule

dictionary

The Set Rule Policy reference details for the Route Control context.

Providing an empty dictionary set_rule={} will remove Set Rule Policy from the Route Control context.

reference

aliases: ref

dictionary

The reference details of the Set Rule Policy.

This parameter can be used instead of set_rule.uuid.

name

string

The name of the Set Rule Policy.

template

string

The template associated with the Set Rule Policy.

This parameter or set_rule.reference.template_id is required.

template_id

string

The template ID associated with the Set Rule Policy.

This parameter or set_rule.reference.template is required.

uuid

string

The UUID of the Set Rule Policy.

This parameter can be used instead of set_rule.reference.

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 template.

This parameter or template_id is required.

template_id

string

The ID of the tenant 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

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_route_map_policy_route_control

Manage Route Map Policy for Route Control on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_set_rule_policy

Manage Tenant Set Rule Policies on Cisco Nexus Dashboard Orchestrator (NDO).

cisco.mso.ndo_match_rule_policy

Manage Match Rule Policies on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Add Route Map Policy for Route Control Context
  cisco.mso.ndo_route_map_policy_route_control_context:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    route_map_policy: ansible_test_route_map_policy
    name: route_map_policy_context_1
    order: 1
    set_rule:
      uuid: "{{ add_set_rule_policy_1.current.uuid }}"
    match_rules:
      - uuid: "{{ add_match_rule_policy_1.current.uuid }}"
      - reference:
          template_id: "{{ add_ansible_tenant_template.current.templateId }}"
          name: ansible_match_rule_policy_2
    state: present

- name: Update Route Map Policy for Route Control Context
  cisco.mso.ndo_route_map_policy_route_control_context:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    route_map_policy: ansible_test_route_map_policy
    name: route_map_policy_context_1
    order: 2
    set_rule:
      reference:
        template_id: "{{ add_ansible_tenant_template.current.templateId }}"
        name: ansible_set_rule_policy_2
    match_rules:
      - reference:
          template_id: "{{ add_ansible_tenant_template.current.templateId }}"
          name: ansible_match_rule_policy_2
    state: present

- name: Update and remove Set Rule and Match Rules from Route Map Policy for Route Control Context
  cisco.mso.ndo_route_map_policy_route_control_context:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    route_map_policy: ansible_test_route_map_policy
    name: route_map_policy_context_1
    order: 2
    set_rule: {}
    match_rules: []
    state: present

- name: Query Route Map Policy for Route Control Context using name
  cisco.mso.ndo_route_map_policy_route_control_context:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    route_map_policy: ansible_test_route_map_policy
    name: route_map_policy_context_1
    state: query
  register: query_one

- name: Query all Route Map Policy for Route Control Context
  cisco.mso.ndo_route_map_policy_route_control_context:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    route_map_policy: ansible_test_route_map_policy
    state: query
  register: query_one

- name: Delete Route Map Policy for Route Control Context
  cisco.mso.ndo_route_map_policy_route_control_context:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    route_map_policy: ansible_test_route_map_policy
    name: route_map_policy_context_1
    state: absent

Authors

  • Sabari Jaganathan (@sajagana)