W3cubDocs

/Ansible

cisco.mso.ndo_service_device_cluster module – Manage Service Device Clusters 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_service_device_cluster.

New in cisco.mso 2.11.0

Synopsis
Requirements
Parameters
Notes
See Also
Examples

Synopsis

Manage Service Device Clusters on Cisco Nexus Dashboard Orchestrator (NDO).
This module is supported on ND v3.2 (NDO v4.4) 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 Service Device Cluster.
device_mode string	Specifies the operational mode of the device. Choices: `"layer1"` `"layer2"` `"layer3"`
device_type string	Defines the type of device being configured. Choices: `"firewall"` `"load_balancer"` `"other"`
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.
interface_properties list / elements=dictionary	A list containing interface configuration. The old `interface_properties` will be replaced with the new `interface_properties` during an update.
anycast boolean	Indicates if anycast is enabled. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
bd dictionary	bd configuration details. This parameter or `interface_properties.bd_uuid` or `interface_properties.external_epg_uuid` or `interface_properties.external_epg` is required.
name string / required	The name associated with the bd.
schema string	Schema associated with the bd. This parameter or `interface_properties.bd.schema_id` is required.
schema_id string	ID of the schema associated with the bd. This parameter or `interface_properties.bd.schema` is required.
template string	Template associated with the bd. This parameter or `interface_properties.bd.template_id` is required.
template_id string	ID of the template associated with the bd. This parameter or `interface_properties.bd.template` is required.
bd_uuid string	UUID of the bd. This parameter or `interface_properties.bd` or `interface_properties.external_epg_uuid` or `interface_properties.external_epg` is required.
config_static_mac aliases: static_mac_configuration boolean	Indicates if static MAC configuration is enabled. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
external_epg dictionary	external_epg configuration details. This parameter or `interface_properties.bd` or `interface_properties.external_epg_uuid` or `interface_properties.bd_uuid` is required.
name string / required	The name associated with the external_epg.
schema string	Schema associated with the external_epg. This parameter or `interface_properties.external_epg.schema_id` is required.
schema_id string	ID of the schema associated with the external_epg. This parameter or `interface_properties.external_epg.schema` is required.
template string	Template associated with the external_epg. This parameter or `interface_properties.external_epg.template_id` is required.
template_id string	ID of the template associated with the external_epg. This parameter or `interface_properties.external_epg.template` is required.
external_epg_uuid string	UUID of the external_epg. This parameter or `interface_properties.bd` or `interface_properties.external_epg` or `interface_properties.bd_uuid` is required.
ipsla_monitoring_policy dictionary	IPSLA monitoring policy configuration.
name string	Name of the IPSLA monitoring policy.
template string	Template for the IPSLA monitoring policy. This parameter or `interface_properties.ipsla_monitoring_policy.template_id` is required.
template_id string	ID of the template for the IPSLA monitoring policy. This parameter or `interface_properties.ipsla_monitoring_policy.template` is required.
ipsla_monitoring_policy_uuid string	UUID of the IP SLA monitoring policy.
is_backup_redirect_ip boolean	Indicates if it is a backup redirect IP. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
load_balance_hashing string	Load balancing hashing method. If this parameter is unspecified, it defaults to `source_destination_and_protocol`. Choices: `"source_destination_and_protocol"` `"source_ip"` `"destination_ip"`
max_threshold integer	Maximum threshold value for redirect. If this parameter is unspecified, it defaults to 0. This value must be between 0 and 100.
min_threshold integer	Minimum threshold value for redirect. If this parameter is unspecified, it defaults to 0. This value must be between 0 and 100. This value cannot be greater than or equal to maximum threshold.
name string / required	The name of the interface.
pod_aware_redirection boolean	Indicates if pod-aware redirection is enabled. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
preferred_group boolean	Whether the interface belongs to a preferred group. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
qos_policy dictionary	Quality of Service (QoS) policy configuration.
name string	Name of the QoS policy.
template string	Template for the QoS policy. This parameter or `interface_properties.qos_policy.template_id` is required.
template_id string	ID of the template for the QoS policy. This parameter or `interface_properties.qos_policy` is required.
qos_policy_uuid string	UUID of the QoS policy.
resilient_hashing boolean	Indicates if resilient hashing is enabled. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
rewrite_source_mac boolean	Whether to rewrite the source MAC address. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
tag_based_sorting boolean	Indicates if tag-based sorting is enabled. If this parameter is unspecified, it defaults to False. Choices: `false` `true`
threshold_down_action string	Action to take when the threshold is down. Choices: `"permit"` `"deny"` `"bypass"`
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: service_device_cluster string	The name of the Service Device Cluster.
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 string	The name of the template. The template must be a service device template. This parameter or `template_id` is required.
template_id string	The ID of the service device 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.
uuid aliases: service_device_cluster_uuid string	The UUID of the Service Device Cluster.
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 service device template.
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 service device cluster with one arm
  cisco.mso.ndo_service_device_cluster:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_device_template
    name: device1
    device_mode: layer3
    device_type: firewall
    interface_properties:
      - name: interface1
        external_epg:
          name: ansible_test_epg
          template: ansible_template
          schema: ansible_test
        ipsla_monitoring_policy:
          name: ansible_test_ipsla_monitoring_policy
          template: ansible_tenant_template
        qos_policy:
          name: ansible_custom_qos_policy
          template: ansible_tenant_template
        preferred_group: true
        rewrite_source_mac: false
        config_static_mac: false
        is_backup_redirect_ip: true
        load_balance_hashing: source_ip
        pod_aware_redirection: false
        resilient_hashing: true
        tag_based_sorting: false
        min_threshold: 10
        max_threshold: 100
        threshold_down_action: permit
    state: present
  register: add_device1

- name: Update the service device cluster to advanced
  cisco.mso.ndo_service_device_cluster:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_device_template
    name: device1
    device_mode: layer3
    device_type: firewall
    interface_properties:
      - name: interface1
        external_epg::
          name: ansible_test_epg
          template: ansible_template
          schema: ansible_test
        ipsla_monitoring_policy:
          name: ansible_test_ipsla_monitoring_policy
          template: ansible_tenant_template
        qos_policy:
          name: ansible_custom_qos_policy
          template: ansible_tenant_template
        preferred_group: true
        rewrite_source_mac: false
        config_static_mac: false
        is_backup_redirect_ip: true
        load_balance_hashing: source_ip
        pod_aware_redirection: false
        resilient_hashing: true
        tag_based_sorting: false
        min_threshold: 10
        max_threshold: 100
        threshold_down_action: permit
      - name: interface2
        bd_uuid: '{{ ansible_test_bd_query.current.uuid }}'
        ipsla_monitoring_policy_uuid: '{{ ipsla_monitoring_policy.current.uuid }}'
        qos_policy:
          name: ansible_custom_qos_policy
          template_id: '{{ ansible_test_policy.current.templateId }}'
        preferred_group: true
        rewrite_source_mac: false
        config_static_mac: false
        is_backup_redirect_ip: true
        load_balance_hashing: source_ip
        pod_aware_redirection: false
        resilient_hashing: true
        tag_based_sorting: false
        min_threshold: 10
        max_threshold: 100
        threshold_down_action: permit
      - name: interface3
        bd:
          name: ansible_test_bd
          template: ansible_template
          schema_id: '{{ ansible_test_bd.current.vrfRef.schemaId }}'
        qos_policy:
          name: ansible_custom_qos_policy
          template_id: '{{ ansible_test_policy.current.templateId }}'
        anycast: true
        rewrite_source_mac: false
        config_static_mac: false
        is_backup_redirect_ip: true
        load_balance_hashing: destination_ip
        pod_aware_redirection: false
        resilient_hashing: true
        tag_based_sorting: false
        min_threshold: 10
        max_threshold: 100
        threshold_down_action: deny
    state: present

- name: Query the service device cluster using name
  cisco.mso.ndo_service_device_cluster:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_device_template
    name: device1
    state: query
  register: query_device

- name: Query the service device cluster using UUID
  cisco.mso.ndo_service_device_cluster:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_device_template
    uuid: '{{ add_device1.current.uuid }}'
    state: query
  register: query_device_uuid

- name: Query all the device clusters
  cisco.mso.ndo_service_device_cluster:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_device_template
    state: query
  register: query_all

- name: Remove the service device cluster
  cisco.mso.ndo_service_device_cluster:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: ansible_device_template
    name: device1
    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_service_device_cluster_module.html