W3cubDocs

/Ansible

cisco.mso.ndo_l3out_node_group_policy module – Manage L3Out Node Group Policy 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_l3out_node_group_policy.

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage L3Out Node Group Policy on Cisco Nexus Dashboard Orchestrator (NDO).
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
bfd aliases: bfd_multi_hop dictionary	The Bidirectional Forwarding Detection (BFD) multi-hop configuration of the L3Out Node Group Policy. Providing an empty dictionary will remove the `bfd={}` from the L3Out Node Group Policy.
auth aliases: bfd_multi_hop_authentication string	The BFD multi-hop authentication of the L3Out Node Group Policy. Choices: `"enabled"` `"disabled"`
key string	The BFD multi-hop key of the L3Out Node Group Policy.
key_id integer	The BFD multi-hop key ID of the L3Out Node Group Policy.
description string	The description of the L3Out Node Group 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.
l3out aliases: l3out_name string / required	The name of the L3Out.
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.
name aliases: l3out_node_group_policy string	The name of the L3Out Node Group Policy.
node_routing_policy string	The name of the L3Out Node Routing Policy. Providing an empty string will remove the `node_routing_policy=""` from L3Out Node Group 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.
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"`
target_dscp string	The DSCP Level of the L3Out Node Group Policy. Choices: `"af11"` `"af12"` `"af13"` `"af21"` `"af22"` `"af23"` `"af31"` `"af32"` `"af33"` `"af41"` `"af42"` `"af43"` `"cs0"` `"cs1"` `"cs2"` `"cs3"` `"cs4"` `"cs5"` `"cs6"` `"cs7"` `"expedited_forwarding"` `"unspecified"` `"voice_admit"`
template aliases: l3out_template string / required	The name of the template. The template must be an L3Out 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.
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 L3Out template.
The l3out must exist before using this module in your playbook. Use cisco.mso.ndo_l3out_template to create the L3Out object under the L3Out template.
The node_routing_policy must exist before using this module in your playbook. Use cisco.mso.ndo_l3out_node_routing_policy to create the L3Out Node Routing 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 new L3Out node group policy
  cisco.mso.ndo_l3out_node_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: node_group_policy_1
    state: present

- name: Update an existing L3Out node group policy
  cisco.mso.ndo_l3out_node_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: node_group_policy_1
    description: "Updated description"
    node_routing_policy: ans_node_policy_group_1
    bfd:
      auth: enabled
      key_id: 1
      key: TestKey
    target_dscp: af11
    state: present

- name: Query an existing L3Out node group policy with name
  cisco.mso.ndo_l3out_node_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: node_group_policy_1
    state: query
  register: query_with_name

- name: Query all L3Out node group policy
  cisco.mso.ndo_l3out_node_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    state: query
  register: query_all

- name: Delete an existing L3Out node group policy with name
  cisco.mso.ndo_l3out_node_group_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: l3out_template
    l3out: l3out
    name: node_group_policy_1
    state: absent

Authors

Sabari Jaganathan (@sajagana)

Collection links

© 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_l3out_node_group_policy_module.html