cisco.mso.ndo_ipsla_monitoring_policy module – Manage IPSLA Monitoring Policies 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_ipsla_monitoring_policy.

Synopsis
Requirements
Parameters
Notes
Examples

Synopsis

Manage IPSLA Monitoring Policies 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
description string	The description of the IPSLA Monitoring Policy.
destination_port integer	The port used for SLA. This is only applicable when `sla_type=tcp` or `sla_type=http`. The value defaults to 80 when `sla_type=http`. The value must be in the range 1 - 65535 when `sla_type=tcp`.
detect_multiplier integer	The detection multiplier for SLA. The value must be in the range 1 - 100. The default value is 3.
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.
http_uri string	The URI used for HTTP SLA. This is only applicable when `sla_type=http`. The default value is ‘/’.
http_version string	The HTTP version used for SLA. This is only applicable when `sla_type=http`. The default value is `HTTP10`. Choices: `"HTTP10"` `"HTTP11"`
ipsla_monitoring_policy aliases: name string	The name of the IPSLA Monitoring Policy.
ipsla_monitoring_policy_uuid aliases: uuid string	The UUID of the IPSLA Monitoring Policy. This parameter is required when the `ipsla_monitoring_policy` attribute needs to be updated.
ipv6_traffic_class integer	The IPv6 Traffic Class. The value must be in the range 0 - 255. The default value is 0.
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.
operation_timeout integer	The operation_timeout for SLA in milliseconds. The default value is 900 milliseconds.
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.
request_data_size integer	The size of the request data in bytes. The value must be in the range 0 - 17513. The default value is 28 bytes.
sla_frequency integer	The frequency of SLA monitoring in seconds. The value must be in the range 1 - 300. The default value is 60 seconds.
sla_type string	The type of SLA. The default value is `icmp`. Choices: `"http"` `"tcp"` `"icmp"` `"l2ping"`
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 / required	The name of the template. The template must be a tenant template.
threshold integer	The threshold for SLA in milliseconds. The default value is 900 milliseconds.
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.
type_of_service integer	The IPv4 Type of Service. The value must be in the range 0 - 255. The default value is 0.
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

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 IPSLA monitoring policy
  cisco.mso.ndo_ipsla_monitoring_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    ipsla_monitoring_policy: ansible_test_ipsla_monitoring_policy
    sla_type: http
    http_version: HTTP11
    http_uri: /test
    sla_frequency: 120
    detect_multiplier: 5
    request_data_size: 64
    type_of_service: 16
    operation_timeout: 1000
    threshold: 1000
    ipv6_traffic_class: 32
    state: present

- name: Query an IPSLA monitoring policy with name
  cisco.mso.ndo_ipsla_monitoring_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    ipsla_monitoring_policy: ansible_test_ipsla_monitoring_policy
    state: query
  register: query_one

- name: Query all IPSLA monitoring policies in the template
  cisco.mso.ndo_ipsla_monitoring_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    state: query
  register: query_all

- name: Delete an IPSLA monitoring policy
  cisco.mso.ndo_ipsla_monitoring_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    ipsla_monitoring_policy: ansible_test_ipsla_monitoring_policy
    state: absent

- name: Query an IPSLA monitoring policy with UUID
  cisco.mso.ndo_ipsla_monitoring_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    ipsla_monitoring_policy_uuid: "{{ query_one.current.uuid }}"
    state: query
  register: query_one_uuid

- name: Delete an IPSLA monitoring policy with UUID
  cisco.mso.ndo_ipsla_monitoring_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_tenant_template
    ipsla_monitoring_policy_uuid: "{{ query_one.current.uuid }}"
    state: absent

Authors

Shreyas Srish (@shrsr)

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_ipsla_monitoring_policy_module.html