модуль cisco.mso.ndo_service_device_cluster – Управление кластерами сервисных устройств в Cisco Nexus Dashboard Orchestrator (NDO).

Примечание

Этот модуль входит в коллекцию cisco.mso (версия 2.13.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.mso. Для использования этого модуля необходимы дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: cisco.mso.ndo_service_device_cluster.

Добавлено в cisco.mso 2.11.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры

Краткое описание

Управление кластерами сервисных устройств в Cisco Nexus Dashboard Orchestrator (NDO).
Модуль поддерживается в ND v3.2 (NDO v4.4) и более поздних версиях.

Требования

На хосте, выполняющем этот модуль, должны быть соблюдены следующие требования.

Multi Site Orchestrator версии 2.1 или новее

Параметры

Параметр	Комментарии
description string	Описание кластера сервисных устройств.
device_mode string	Задает рабочий режим устройства. Варианты: `"layer1"` `"layer2"` `"layer3"`
device_type string	Определяет тип настраиваемого устройства. Варианты: `"firewall"` `"load_balancer"` `"other"`
host псевдонимы: hostname string	IP-адрес или имя хоста ACI Multi Site Orchestrator. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_HOST`.
interface_properties list / элементы=dictionary	Список, содержащий конфигурацию интерфейса. Старый `interface_properties` будет заменен новым `interface_properties` при обновлении.
anycast boolean	Указывает, включен ли anycast. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
bd dictionary	Сведения о конфигурации bd. Этот параметр, `interface_properties.bd_uuid`, `interface_properties.external_epg_uuid` или `interface_properties.external_epg` является обязательным.
name string / обязательный	Имя, связанное с bd.
schema string	Схема, связанная с bd. Этот параметр или `interface_properties.bd.schema_id` является обязательным.
schema_id string	Идентификатор схемы, связанной с bd. Этот параметр или `interface_properties.bd.schema` является обязательным.
template string	Шаблон, связанный с bd. Этот параметр или `interface_properties.bd.template_id` является обязательным.
template_id string	Идентификатор шаблона, связанного с bd. Этот параметр или `interface_properties.bd.template` является обязательным.
bd_uuid string	UUID bd. Этот параметр, `interface_properties.bd`, `interface_properties.external_epg_uuid` или `interface_properties.external_epg` является обязательным.
config_static_mac псевдонимы: static_mac_configuration boolean	Указывает, включена ли конфигурация статического MAC-адреса. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
external_epg dictionary	Сведения о конфигурации external_epg. Этот параметр, `interface_properties.bd`, `interface_properties.external_epg_uuid` или `interface_properties.bd_uuid` является обязательным.
name string / обязательный	Имя, связанное с external_epg.
schema string	Схема, связанная с external_epg. Этот параметр или `interface_properties.external_epg.schema_id` является обязательным.
schema_id string	Идентификатор схемы, связанной с external_epg. Этот параметр или `interface_properties.external_epg.schema` является обязательным.
template string	Шаблон, связанный с external_epg. Этот параметр или `interface_properties.external_epg.template_id` является обязательным.
template_id string	Идентификатор шаблона, связанного с external_epg. Этот параметр или `interface_properties.external_epg.template` является обязательным.
external_epg_uuid string	UUID external_epg. Этот параметр, `interface_properties.bd`, `interface_properties.external_epg` или `interface_properties.bd_uuid` является обязательным.
ipsla_monitoring_policy dictionary	Конфигурация политики мониторинга IPSLA.
name string	Имя политики мониторинга IPSLA.
template string	Шаблон для политики мониторинга IPSLA. Этот параметр или `interface_properties.ipsla_monitoring_policy.template_id` является обязательным.
template_id string	Идентификатор шаблона для политики мониторинга IPSLA. Этот параметр или `interface_properties.ipsla_monitoring_policy.template` является обязательным.
ipsla_monitoring_policy_uuid string	UUID политики мониторинга IP SLA.
is_backup_redirect_ip boolean	Указывает, является ли IP-адрес перенаправления резервным. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
load_balance_hashing string	Метод хеширования для балансировки нагрузки. Если этот параметр не указан, по умолчанию используется значение `source_destination_and_protocol`. Варианты: `"source_destination_and_protocol"` `"source_ip"` `"destination_ip"`
max_threshold integer	Максимальное пороговое значение для перенаправления. Если этот параметр не указан, по умолчанию используется значение 0. Значение должно находиться в диапазоне от 0 до 100.
min_threshold integer	Минимальное пороговое значение для перенаправления. Если этот параметр не указан, по умолчанию используется значение 0. Значение должно находиться в диапазоне от 0 до 100. Это значение не может быть больше максимального порогового значения или равно ему.
name string / обязательный	Имя интерфейса.
pod_aware_redirection boolean	Указывает, включено ли перенаправление с учетом pod. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
preferred_group boolean	Указывает, входит ли интерфейс в предпочтительную группу. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
qos_policy dictionary	Конфигурация политики качества обслуживания (QoS).
name string	Имя политики QoS.
template string	Шаблон для политики QoS. Этот параметр или `interface_properties.qos_policy.template_id` является обязательным.
template_id string	Идентификатор шаблона для политики QoS. Этот параметр или `interface_properties.qos_policy` является обязательным.
qos_policy_uuid string	UUID политики QoS.
resilient_hashing boolean	Указывает, включено ли устойчивое хеширование. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
rewrite_source_mac boolean	Указывает, следует ли переписывать MAC-адрес источника. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
tag_based_sorting boolean	Указывает, включена ли сортировка на основе тегов. Если этот параметр не указан, по умолчанию используется значение False. Варианты: `false` `true`
threshold_down_action string	Действие при снижении значения ниже порога. Варианты: `"permit"` `"deny"` `"bypass"`
login_domain string	Имя домена входа, используемого для аутентификации. Значение по умолчанию — Local. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_LOGIN_DOMAIN`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаризации `ansible_httpapi_login_domain`.
name псевдонимы: service_device_cluster string	Имя кластера сервисных устройств.
output_level string	Определяет формат вывода этого модуля MSO. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая `previous`, `proposed` и словари `sent` `debug` добавляет отладочный вывод, включая `filter_string`, `method`, `response`, `status` и информацию `url` Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_OUTPUT_LEVEL`. Варианты: `"debug"` `"info"` `"normal"` ← (по умолчанию)
password string	Пароль для аутентификации. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта для REST-подключения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_PORT`.
state string	Используйте `absent` для удаления. Используйте `query` для вывода одного или нескольких объектов. Используйте `present` для создания или обновления. Варианты: `"absent"` `"query"` ← (по умолчанию) `"present"`
template string	Имя шаблона. Шаблон должен быть шаблоном сервисного устройства. Этот параметр или `template_id` является обязательным.
template_id string	Идентификатор шаблона сервисного устройства. Этот параметр или `template` является обязательным.
timeout integer	Тайм-аут на уровне сокета в секундах. Значение по умолчанию — 30 секунд. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_TIMEOUT`.
use_proxy boolean	Если задано значение `false`, прокси использоваться не будет, даже если он определен в переменной среды на целевых узлах. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USE_PROXY`. Значение по умолчанию — `true`. Варианты: `false` `true`
use_ssl boolean	Если задано значение `false`, вместо HTTPS-подключения по умолчанию будет использоваться HTTP-подключение. Если значение не указано в задаче, вместо него будет использоваться значение переменной среды `MSO_USE_SSL`. При использовании плагина подключения HTTPAPI, если этот атрибут не указан, будет использоваться переменная инвентаризации `ansible_httpapi_use_ssl`. По умолчанию используется значение `false` при работе с плагином подключения HTTPAPI (mso или nd) и `true` при использовании устаревшего метода подключения (только для mso). Варианты: `false` `true`

username string	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будет использовано значение переменных среды `MSO_USERNAME` или `ANSIBLE_NET_USERNAME`.
uuid aliases: service_device_cluster_uuid string	UUID кластера сервисных устройств.
validate_certs boolean	Если `false`, сертификаты SSL проверяться не будут. Это значение следует устанавливать в `false` только при использовании на контролируемых пользователем сайтах с самоподписанными сертификатами. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `MSO_VALIDATE_CERTS`. По умолчанию — `true`. Варианты: `false` `true`

Примечания

Примечание

Перед использованием этого модуля в плейбуке необходимо создать template. Для создания шаблона сервисных устройств используйте cisco.mso.ndo_template.
Этот модуль разработан для поддержки Multi Site Orchestrator версии 2.1 или новее. Некоторые или все функции могут не работать в более ранних версиях.

См. также

cisco.mso.ndo_template: Управление шаблонами в Cisco Nexus Dashboard Orchestrator (NDO).

Примеры

- 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

Авторы

Shreyas Srish (@shrsr)

Ссылки на коллекцию

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