Spec-Zone.ru › Ansible

Модуль cisco.mso.ndo_tenant_custom_qos_policy — управление пользовательскими политиками QoS в шаблонах политик арендаторов в 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_tenant_custom_qos_policy.

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

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

  • Управление пользовательскими политиками качества обслуживания (QoS) в шаблонах политик арендаторов в Cisco Nexus Dashboard Orchestrator (NDO).
  • Этот модуль поддерживается только в ND версии 3.1 (NDO версии 4.3) и более поздних.

Требования

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

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

Параметры

Параметр

Комментарии

cos_mappings

список / elements=dictionary

Сопоставления класса обслуживания (CoS) пользовательской политики QoS.

Для cos_mappings.dot1p_from и cos_mappings.dot1p_to нельзя задать значение unspecified.

При передаче нового списка cos_mappings существующий список в пользовательской политике QoS будет полностью заменен.

Передача пустого списка удалит cos_mappings=[] из пользовательской политики QoS.

dot1p_from

псевдонимы: from

строка

Начальное значение/тип трафика диапазона CoS.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допускаются как значения CoS, так и соответствующие им типы трафика. Например, cos_mappings.dot1p_from=cos0 и cos_mappings.dot1p_from=background являются эквивалентными допустимыми значениями.

Допустимые значения:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

dot1p_to

псевдонимы: to

строка

Конечное значение/тип трафика диапазона CoS.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допускаются как значения CoS, так и типы трафика. Например, cos_mappings.dot1p_to=cos0 и cos_mappings.dot1p_to=background являются эквивалентными допустимыми значениями.

Допустимые значения:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

dscp_target

псевдонимы: target

строка

Целевая точка кодирования DSCP для исходящего трафика.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допустимые значения:

  • "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"

qos_priority

псевдонимы: priority, prio

строка

Уровень приоритета QoS, которому будут сопоставлены значения DSCP.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допустимые значения:

  • "level1"
  • "level2"
  • "level3"
  • "level4"
  • "level5"
  • "level6"
  • "unspecified"

target_cos

строка

Целевое значение CoS/тип трафика для исходящего трафика.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допускаются как значения CoS, так и соответствующие им типы трафика. Например, cos_mappings.target_cos=cos0 и cos_mappings.target_cos=background являются эквивалентными допустимыми значениями.

Допустимые значения:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

description

строка

Описание пользовательской политики QoS.

Передача пустой строки удалит description="" из пользовательской политики QoS.

dscp_mappings

список / elements=dictionary

Сопоставления кода дифференцированного обслуживания (DSCP) пользовательской политики QoS.

Для dscp_mappings.dscp_from и dscp_mappings.dscp_to нельзя задать значение unspecified.

При передаче нового списка dscp_mappings существующий список в пользовательской политике QoS будет полностью заменен.

Передача пустого списка удалит cos_mappings=[] из пользовательской политики QoS.

dscp_from

псевдонимы: from

строка

Начальная точка кодирования диапазона DSCP.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допустимые значения:

  • "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"

dscp_target

псевдонимы: target

строка

Целевая точка кодирования DSCP для исходящего трафика.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допустимые значения:

  • "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"

dscp_to

псевдонимы: to

строка

Конечная точка кодирования диапазона DSCP.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допустимые значения:

  • "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"

qos_priority

псевдонимы: priority, prio

строка

Уровень приоритета QoS, которому будут сопоставлены значения DSCP.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допустимые значения:

  • "level1"
  • "level2"
  • "level3"
  • "level4"
  • "level5"
  • "level6"
  • "unspecified"

target_cos

строка

Целевое значение CoS/тип трафика для исходящего трафика.

Если при создании параметр не задан, по умолчанию используется unspecified.

Допускаются как значения CoS, так и типы трафика. Например, dscp_mappings.target_cos=cos0 и dscp_mappings.target_cos=background являются эквивалентными допустимыми значениями.

Допустимые значения:

  • "background"
  • "cos0"
  • "best_effort"
  • "cos1"
  • "excellent_effort"
  • "cos2"
  • "critical_applications"
  • "cos3"
  • "video"
  • "cos4"
  • "voice"
  • "cos5"
  • "internetwork_control"
  • "cos6"
  • "network_control"
  • "cos7"
  • "unspecified"
  • "cos8"

host

псевдонимы: hostname

строка

IP-адрес или имя хоста узла ACI Multi Site Orchestrator.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_HOST.

login_domain

строка

Имя домена входа для аутентификации.

Значение по умолчанию — Local.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_LOGIN_DOMAIN.

При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря ansible_httpapi_login_domain.

name

псевдонимы: custom_qos_policy

строка

Имя пользовательской политики QoS.

output_level

строка

Управляет выводом этого модуля MSO.

normal — стандартный вывод, включая словарь current

info добавляет информационный вывод, включая словари previous, proposed и sent

debug добавляет отладочный вывод, включая информацию filter_string, method, response, status и url

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_OUTPUT_LEVEL.

Допустимые значения:

  • "debug"
  • "info"
  • "normal" ← (значение по умолчанию)

password

строка

Пароль для аутентификации.

Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: MSO_PASSWORD или ANSIBLE_NET_PASSWORD.

port

целое число

Номер порта для REST-соединения.

Значение по умолчанию зависит от параметра `use_ssl`.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_PORT.

state

строка

Используйте absent для удаления.

Используйте query для просмотра одного или нескольких объектов.

Используйте present для создания или обновления.

Допустимые значения:

  • "absent"
  • "query" ← (значение по умолчанию)
  • "present"

template

псевдонимы: tenant_template

строка / обязательный

Имя шаблона арендатора.

timeout

целое число

Тайм-аут на уровне сокета в секундах.

Значение по умолчанию — 30 секунд.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_TIMEOUT.

use_proxy

логическое значение

Если задано значение false, прокси использоваться не будет, даже если он указан в переменной среды на целевых хостах.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_USE_PROXY.

Значение по умолчанию — true.

Допустимые значения:

  • false
  • true

use_ssl

логическое значение

Если задано значение false, вместо HTTPS-соединения по умолчанию будет использоваться HTTP-соединение.

Если значение не указано в задаче, вместо него будет использовано значение переменной среды MSO_USE_SSL.

При использовании подключаемого модуля соединения HTTPAPI, если этот атрибут не указан, будет использована переменная инвентаря ansible_httpapi_use_ssl.

Значение по умолчанию — false при использовании подключаемого модуля соединения HTTPAPI (mso или nd) и true при использовании устаревшего способа подключения (только для mso).

Допустимые значения:

  • false
  • true

username

строка

Имя пользователя для аутентификации.

Если значение не указано в задаче, вместо него будет использовано значение одной из переменных среды: MSO_USERNAME или ANSIBLE_NET_USERNAME.

uuid

псевдонимы: custom_qos_policy_uuid

строка

UUID пользовательской политики QoS.

Этот параметр обязателен, если требуется обновить пользовательскую политику QoS name.

validate_certs

логическое значение

Если задано значение 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 new Custom QoS Policy object
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_1
    dscp_mappings:
      - dscp_from: af11
        dscp_to: af12
        dscp_target: af11
        target_cos: background
        qos_priority: level1
    cos_mappings:
      - dot1p_from: background
        dot1p_to: best_effort
        target: af11
        target_cos: background
        qos_priority: level1
    state: present
  register: custom_qos_policy_1

- name: Update a Custom QoS Policy object name with UUID
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_2
    uuid: "{{ custom_qos_policy_1.current.uuid }}"
    state: present

- name: Query a Custom QoS Policy object with name
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_1
    state: query
  register: query_name

- name: Query a Custom QoS Policy object with UUID
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ custom_qos_policy_1.current.uuid }}"
    state: query
  register: query_uuid

- name: Query all Custom QoS Policy objects in a Tenant Template
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    state: query
  register: query_all

- name: Delete a Custom QoS Policy object with name
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    name: custom_qos_policy_1
    state: absent

- name: Delete a Custom QoS Policy object with UUID
  cisco.mso.ndo_tenant_custom_qos_policy:
    host: mso_host
    username: admin
    password: SomeSecretPassword
    template: tenant_template
    uuid: "{{ custom_qos_policy_1.current.uuid }}"
    state: absent

Авторы

  • Gaspard Micol (@gmicol)

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

  • Отслеживание проблем
  • Главная страница
  • Репозиторий (исходный код)

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API