cisco.mso.ndo_l3out_annotation module – Manage L3Outs Annotation 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_annotation.

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Manage L3Outs Annotation 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
annotation_key aliases: key string	The key of the Annotation object.
annotation_value aliases: value string	The value of the Annotation object.
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.
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 aliases: l3out_template string / required	The name of the template. The template must be a 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.
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: Add an annotation with key and value
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1"
    annotation_value: "annotation_value_1"
    state: present

- name: Update an annotation with value
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1_updated"
    annotation_value: "annotation_value_1"
    state: present

- name: Query a specific annotation with key
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1_updated"
    state: query
  register: query_one

- name: Query all annotations
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    state: query
  register: query_all

- name: Delete an annotation
  cisco.mso.ndo_l3out_annotation:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_l3out_template
    l3out: "L3OutAnnotation"
    annotation_key: "annotation_key_1_updated"
    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_annotation_module.html