W3cubDocs

/Ansible

cisco.mso.ndo_mcp_global_policy module – Manage the MCP Global Policy in a Fabric Policy Template on Cisco Nexus Dashboard Orchestrator (NDO).

Note

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

Synopsis

  • Manage the MisCabling Protocol (MCP) Global Policy in a Fabric Policy Template on Cisco Nexus Dashboard Orchestrator (NDO).
  • There can only be a single MCP Global Policy in a Fabric Policy Template.
  • This module is only supported on ND v3.1 (NDO v4.3) 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

admin_state

string

The administrative state of the MCP Global Policy.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

description

string

The description of the MCP Global Policy.

Providing an empty string will remove the description="" from the MCP Global Policy.

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.

initial_delay_time

aliases: initial_delay

integer

The MCP initial delay time in seconds.

Defaults to 180 when unset during creation.

The value must be between 0 and 1800.

key

string

The key of the MCP Global Policy.

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.

loop_detection_factor

aliases: loop_factor, loop_detection_mult_factor

integer

The amount of MCP packets that will be received before port disable loop protection action takes place.

Defaults to 3 when unset during creation.

The value must be between 1 and 255.

name

aliases: mcp_global_policy

string

The name of the MCP Global Policy.

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.

per_vlan

aliases: per_epg, mcp_pdu_per_vlan

string

When enabled MCP will send packets on a per End Point Group (EPG) basis.

If disabled, the packets will only be sent on untagged EPGs which allows detecting loops in the native VLAN only.

Defaults to disabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

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.

port_disable

aliases: port_disable_protection

string

Enable or disable port disabling when MCP packets are received.

Defaults to enabled when unset during creation.

Choices:

  • "enabled"
  • "disabled"

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

aliases: fabric_template

string / required

The name of the template.

The template must be a Fabric Policy template.

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.

transmission_frequency_msec

aliases: tx_freq_ms

integer

The MCP transmission frequency in milliseconds.

Defaults to 0 when unset during creation.

The value must be between 0 and 999.

transmission_frequency_sec

aliases: tx_freq

integer

The MCP transmission frequency in seconds.

Defaults to 2 when unset during creation.

The value must be between 0 and 300.

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.

uuid

aliases: mcp_global_policy_uuid

string

The UUID of the MCP Global Policy.

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 Fabric Policy template.
  • Attempts to create any additional MCP Global Policies will only update the existing object in the Fabric Policy template.
  • This module was written to support Multi Site Orchestrator v2.1 or newer. Some or all functionality may not work on earlier versions.

See Also

See also

cisco.mso.ndo_template

Manage Templates on Cisco Nexus Dashboard Orchestrator (NDO).

Examples

- name: Create the MCP Global Policy object
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: example_mcp_global_policy
    state: present
  register: mcp_global_policy_new

- name: Create the MCP Global Policy object with all attributes
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: example_mcp_global_policy
    description: A Global MCP Policy
    key: cisco
    admin_state: enabled
    per_vlan: enabled
    loop_detection_factor: 3
    port_disable: enabled
    initial_delay_time: 180
    transmission_frequency_sec: 2
    transmission_frequency_msec: 10
    state: present
  register: mcp_global_policy_all

- name: Update the MCP Global Policy object with UUID
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: mcp_global_policy_update
    uuid: "{{ mcp_global_policy_all.current.uuid }}"
    state: present

- name: Query the MCP Global Policy object with name
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: example_mcp_global_policy
    state: query
  register: query_name

- name: Query the MCP Global Policy object with UUID
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    uuid: "{{ mcp_global_policy_all.current.uuid }}"
    state: query
  register: query_uuid

- name: Query the MCP Global Policy object in a Fabric Template
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    state: query
  register: query_all

- name: Delete the MCP Global Policy object with name
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    name: example_mcp_global_policy
    state: absent

- name: Delete the MCP Global Policy object with UUID
  cisco.mso.ndo_mcp_global_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: fabric_template
    uuid: "{{ mcp_global_policy_all.current.uuid }}"
    state: absent

Authors

  • Samita Bhattacharjee (@samiib)

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