Модуль cisco.aci.aci_qos_dot1p_class – Управление классом QoS Dot1P (qos:Dot1PClass)

Примечание

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

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

Для установки используйте: ansible-galaxy collection install cisco.aci.

Для использования в книге задач укажите: cisco.aci.aci_qos_dot1p_class.

Обзор
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Обзор

Управление уровнями класса Dot1P для пользовательских политик QoS на тканях Cisco ACI.
Уровень класса для Dot1P для приоритезации карты.

Параметры

Параметр	Комментарии
annotation string	Пользовательская строка для аннотации объекта. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_ANNOTATION`. Если значение не указано в задаче и переменной окружения `ACI_ANNOTATION`, то будет использовано значение по умолчанию. Default: `"orchestrator:ansible"`
certificate_name aliases: cert_name string	Имя сертификата X.509, прикрепленного к пользователю APIC AAA, используемому для аутентификации на основе подписи. Если указано имя файла `private_key`, значение по умолчанию будет базовым именем `private_key`, без расширения. Если для `private_key` было предоставлено содержимое в формате PEM, значение по умолчанию будет `username`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_CERTIFICATE_NAME`.
dot1p_from string	Начальное значение диапазона Dot1P. Choices: `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
dot1p_target aliases: target string	Целевое значение Dot1P. APIC использует значение по умолчанию `unspecified`, если оно не установлено во время создания. Choices: `"AF11"` `"AF12"` `"AF13"` `"AF21"` `"AF22"` `"AF23"` `"AF31"` `"AF32"` `"AF33"` `"AF41"` `"AF42"` `"AF43"` `"CS0"` `"CS1"` `"CS2"` `"CS3"` `"CS4"` `"CS5"` `"CS6"` `"CS7"` `"EF"` `"VA"` `"unspecified"`
dot1p_to string	Конечное значение диапазона Dot1P. Choices: `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
host aliases: hostname string	IP-адрес или имя хоста APIC, разрешаемые узлом управления Ansible. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_HOST`.
output_level string	Влияет на вывод этого модуля ACI. `normal` означает стандартный вывод, включая словарь `current` `info` добавляет информационный вывод, включая словари `previous`, `proposed` и `sent` `debug` добавляет отладочный вывод, включая информацию `filter_string`, `method`, `response`, `status` и `url` Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_LEVEL`. Choices: `"debug"` `"info"` `"normal"` ← (default)
output_path string	Путь к файлу, который будет использоваться для сохранения сгенерированных модулем объектов конфигурации ACI в формате JSON. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OUTPUT_PATH`.
owner_key string	Пользовательская строка для атрибута ownerKey объекта ACI. Этот атрибут представляет собой ключ, позволяющий клиентам владеть своими данными для корреляции сущностей. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_KEY`.
owner_tag string	Пользовательская строка для атрибута ownerTag объекта ACI. Этот атрибут представляет собой тег, позволяющий клиентам добавлять свои собственные данные. Например, для указания того, кто создал этот объект. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_OWNER_TAG`.
password string	Пароль для аутентификации. Этот параметр взаимоисключает `private_key`. Если также предоставлен `private_key`, он будет использован вместо него. Если значение не указано в задаче, вместо него будут использованы значения переменных окружения `ACI_PASSWORD` или `ANSIBLE_NET_PASSWORD`.
port integer	Номер порта, который будет использоваться для REST-соединения. Значение по умолчанию зависит от параметра `use_ssl`. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения `ACI_PORT`.
priority aliases: prio string	Требуемый уровень класса QoS, который будет использоваться. APIC использует значение по умолчанию `unspecified`, если оно не установлено во время создания. Choices: `"level1"` `"level2"` `"level3"` `"level4"` `"level5"` `"level6"` `"unspecified"`

private_key aliases: cert_key строка	Файл закрытого ключа в формате PEM или содержимое закрытого ключа, используемого для аутентификации на основе подписи. Это значение также влияет на значение по умолчанию `certificate_name`, которое используется. Этот параметр является взаимоисключающим с `password`. Если `password` также предоставлен, он будет проигнорирован. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_PRIVATE_KEY` или `ANSIBLE_NET_SSH_KEYFILE`.
qos_custom_policy aliases: qos_custom_policy_name строка	Имя политики QoS Custom Policy.
state строка	Используйте `present` или `absent` для добавления или удаления. Используйте `query` для перечисления объекта или нескольких объектов. Варианты: `"absent"` `"present"` ← (по умолчанию) `"query"`
suppress_previous aliases: no_previous, ignore_previous логическое	Если `true`, GET-запрос для проверки предыдущего состояния не будет отправлен перед обновлением POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_PREVIOUS`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к тому, что предыдущее возвращаемое значение станет пустым. Предыдущее состояние объекта не будет проверяться, и обновление POST будет содержать все свойства. Варианты: `false` `true`
suppress_verification aliases: no_verification, no_verify, suppress_verify, ignore_verify, ignore_verification логическое	Если `true`, проверка GET не будет отправлена после обновления POST в APIC. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_SUPPRESS_VERIFICATION`. Значение по умолчанию - `false`. ПРЕДУПРЕЖДЕНИЕ - Это приводит к установке текущего возвращаемого значения в предложенное значение. Текущий объект, включая значения по умолчанию, не будет проверяем в одной задаче. Варианты: `false` `true`
target_cos строка	Целевой COS, который будет задаваться на основе диапазона входных значений Dot1P, поступающих в Fabric. APIC по умолчанию устанавливает значение `unspecified` при отсутствии настройки при создании. Варианты: `"background"` `"best_effort"` `"excellent_effort"` `"critical_applications"` `"video"` `"voice"` `"internetwork_control"` `"network_control"` `"unspecified"`
tenant aliases: tenant_name строка	Имя существующего Tenant.
timeout целое число	Таймаут уровня сокета в секундах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_TIMEOUT`. Значение по умолчанию 30.
use_proxy логическое	Если `false`, прокси не будет использоваться, даже если он определен в переменной среды на целевых хостах. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_PROXY`. Значение по умолчанию - true. Варианты: `false` `true`
use_ssl логическое	Если `false`, будет использовано HTTP-соединение вместо соединения HTTPS по умолчанию. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_USE_SSL`. Значение по умолчанию - true при локальном соединении. Варианты: `false` `true`
username aliases: user строка	Имя пользователя для аутентификации. Если значение не указано в задаче, вместо него будут использованы значения переменных среды `ACI_USERNAME` или `ANSIBLE_NET_USERNAME`. Значение по умолчанию - admin.
validate_certs логическое	Если `false`, сертификаты SSL не будут проверяться. Это следует устанавливать в `false` только при использовании на сайтах с самоподписанными сертификатами, находящимися под вашим контролем. Если значение не указано в задаче, вместо него будет использовано значение переменной среды `ACI_VALIDATE_CERTS`. Значение по умолчанию - true. Варианты: `false` `true`

Примечания

Примечание

tenant и qos_custom_policy должны существовать до использования данного модуля в вашей книге задач. Для этого можно использовать cisco.aci.aci_tenant и cisco.aci.aci_qos_custom_policy.

См. также

cisco.aci.aci_tenant: Управление арендаторами (fv:Tenant).
cisco.aci.aci_qos_custom_policy: Управление политикой QoS (qos:CustomPol).
APIC Management Information Model reference: Дополнительная информация об внутреннем классе APIC qos:Dot1PClass.
Руководство по Cisco ACI: Подробная информация о том, как управлять вашей инфраструктурой ACI с помощью Ansible.
Разработка модулей Cisco ACI: Подробное руководство по написанию собственных модулей Cisco ACI для участия в проекте.

Примеры

- name: Add a new QoS dot1P Class
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    priority: level3
    dot1p_from: best_effort
    dot1p_to: excellent_effort
    dot1p_target: unspecified
    target_cos: unspecified
    state: present
  delegate_to: localhost

- name: Query a QoS dot1P Class
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    dot1p_from: best_effort
    dot1p_to: excellent_effort
    state: query
  delegate_to: localhost

- name: Query all QoS dot1P Classes in my_qos_custom_policy
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    state: query
  delegate_to: localhost

- name: Query all QoS dot1P Classes
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    state: query
  delegate_to: localhost

- name: Delete a QoS dot1P Class
  cisco.aci.aci_qos_dot1p_class:
    host: apic
    username: admin
    password: SomeSecretPassword
    tenant: my_tenant
    qos_custom_policy: my_qos_custom_policy
    dot1p_from: best_effort
    dot1p_to: excellent_effort
    state: absent
  delegate_to: localhost

Значения возврата

Общие значения возврата описаны здесь, следующие поля уникальны для данного модуля:

Ключ	Описание
current список / элементы=строка	Текущая конфигурация с APIC после завершения модуля Возвращается: успех Пример: `[{"fvTenant": {"attributes": {"descr": "Production environment", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
error словарь	Информация об ошибке, возвращенная с APIC Возвращается: неудача Пример: `{"code": "122", "text": "unknown managed object class foo"}`
filter_string строка	Используемая строка фильтра для запроса Возвращается: неудача или отладка Пример: `"?rsp-prop-include=config-only"`
method строка	Используемый HTTP-метод для запроса к APIC Возвращается: неудача или отладка Пример: `"POST"`
previous список / элементы=строка	Исходная конфигурация с APIC до запуска модуля Возвращается: информация Пример: `[{"fvTenant": {"attributes": {"descr": "Production", "dn": "uni/tn-production", "name": "production", "nameAlias": "", "ownerKey": "", "ownerTag": ""}}}]`
proposed словарь	Собраная конфигурация из параметров пользователя Возвращается: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment", "name": "production"}}}`
raw строка	Необработанный вывод, возвращенный APIC REST API (xml или json) Возвращается: ошибка парсинга Пример: `"<?xml version=\"1.0\" encoding=\"UTF-8\"?><imdata totalCount=\"1\"><error code=\"122\" text=\"unknown managed object class foo\"/></imdata>"`
response строка	HTTP-ответ с APIC Возвращается: неудача или отладка Пример: `"OK (30 bytes)"`
sent список / элементы=строка	Фактическая/минимальная конфигурация, отправленная в APIC Возвращается: информация Пример: `{"fvTenant": {"attributes": {"descr": "Production environment"}}}`
status целое число	HTTP-статус с APIC Возвращается: неудача или отладка Пример: `200`
url строка	Используемый HTTP-URL для запроса к APIC Возвращается: неудача или отладка Пример: `"https://10.11.12.13/api/mo/uni/tn-production.json"`

Авторы

Gaspard Micol (@gmicol)

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

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