модуль cisco.intersight.intersight_fibre_channel_qos_policy — управление политиками QoS Fibre Channel для Cisco Intersight

Примечание

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

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

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

Чтобы использовать её в плейбуке, укажите: cisco.intersight.intersight_fibre_channel_qos_policy.

Краткое описание
Параметры
Примеры
Возвращаемые значения

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

Создание, обновление и удаление политик QoS Fibre Channel в Cisco Intersight.
Политики QoS Fibre Channel задают параметры качества обслуживания для виртуальных интерфейсов Fibre Channel.
Эти политики управляют ограничениями пропускной способности, максимальным размером поля данных, классом обслуживания и пакетным трафиком.
Дополнительные сведения см. в документации Cisco Intersight.

Параметры

Параметр	Комментарии
api_key_id string / обязательный	Идентификатор общедоступного ключа API, связанного с закрытым ключом. Если параметр не задан, используется значение переменной окружения INTERSIGHT_API_KEY_ID.
api_private_key путь / обязательный	Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM для аутентификации в API Intersight. Если используется строка, для шифрования строковых данных следует использовать Ansible Vault. Пример: ansible-vault encrypt_string --vault-id tme@/Users/dsoper/Documents/vault_password_file ‘-----BEGIN EC PRIVATE KEY----- <your private key data> -----END EC PRIVATE KEY-----’ Если параметр не задан, используется значение переменной окружения INTERSIGHT_API_PRIVATE_KEY.
api_uri string	URI для доступа к API Intersight. Если параметр не задан, используется значение переменной окружения INTERSIGHT_API_URI. По умолчанию: `"https://intersight.com/api/v1"`
burst integer	Допустимый для vHBA пакетный трафик в байтах. Допустимый диапазон — от 1 до 1000000 байт. По умолчанию: `10240`
cos integer	Класс обслуживания, назначаемый трафику на виртуальном интерфейсе. Допустимый диапазон — от 0 до 6. По умолчанию: `3`
description псевдонимы: descr string	Описание политики QoS Fibre Channel, заданное пользователем. Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или подчёркивание (_).
max_data_field_size integer	Максимальный размер полезной нагрузки кадра Fibre Channel в байтах, поддерживаемый виртуальным интерфейсом. Допустимый диапазон — от 256 до 2112 байт. По умолчанию: `2112`
name string / обязательный	Имя, присвоенное политике QoS Fibre Channel. Должно быть уникальным в пределах организации. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.
organization string	Имя организации, которой назначен этот ресурс. Политики, созданные в пользовательской организации, применимы только к устройствам этой организации. Для организации по умолчанию используйте ‘default’. По умолчанию: `"default"`
rate_limit integer	Ограничение скорости передачи данных на виртуальном интерфейсе в Мбит/с. Значение 0 означает отсутствие ограничения скорости. Допустимый диапазон — от 0 до 100000 Мбит/с. По умолчанию: `0`
state string	Если указано `present`, модуль проверит наличие ресурса и при необходимости создаст его. Если указано `absent`, модуль проверит отсутствие ресурса и при необходимости удалит его. Варианты: `"present"` ← (по умолчанию) `"absent"`
tags list / элементы=dictionary	Список тегов в формате «Ключ:<ключ, заданный пользователем> Значение:<значение, заданное пользователем>».
use_proxy boolean	Если указано `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр, управляющий проверкой TLS-сертификата api_uri Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Create Fibre Channel QoS Policy with default settings
  cisco.intersight.intersight_fibre_channel_qos_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "fc-qos-default"
    description: "Fibre Channel QoS policy with default values"
    state: present

- name: Create Fibre Channel QoS Policy with custom settings
  cisco.intersight.intersight_fibre_channel_qos_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "fc-qos-custom"
    description: "Fibre Channel QoS policy with custom values"
    rate_limit: 10000
    max_data_field_size: 2048
    cos: 5
    burst: 20480
    tags:
      - Key: Environment
        Value: Production
    state: present

- name: Create Fibre Channel QoS Policy with maximum rate limit
  cisco.intersight.intersight_fibre_channel_qos_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Engineering"
    name: "fc-qos-high-bandwidth"
    description: "Fibre Channel QoS policy with maximum bandwidth"
    rate_limit: 100000
    max_data_field_size: 2112
    cos: 6
    burst: 1000000
    state: present

- name: Create Fibre Channel QoS Policy with minimal frame size
  cisco.intersight.intersight_fibre_channel_qos_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "fc-qos-minimal"
    description: "Fibre Channel QoS policy with minimal frame size"
    rate_limit: 0
    max_data_field_size: 256
    cos: 0
    burst: 1
    state: present

- name: Update Fibre Channel QoS Policy description
  cisco.intersight.intersight_fibre_channel_qos_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "fc-qos-default"
    description: "Updated Fibre Channel QoS policy description"
    state: present

- name: Delete Fibre Channel QoS Policy
  cisco.intersight.intersight_fibre_channel_qos_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "fc-qos-default"
    state: absent

Возвращаемые значения

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

Ключ	Описание
api_response dictionary	Ответ API, возвращённый для указанного ресурса. Возвращается: всегда Пример: `{"api_response": {"Burst": 20480, "Cos": 5, "Description": "Fibre Channel QoS policy with custom values", "MaxDataFieldSize": 2048, "Moid": "1234567890abcdef12345678", "Name": "fc-qos-custom", "ObjectType": "vnic.FcQosPolicy", "Organization": {"Moid": "abcdef1234567890abcdef12", "ObjectType": "organization.Organization"}, "RateLimit": 10000, "Tags": [{"Key": "Environment", "Value": "Production"}]}}`

Ключ

Описание

api_response

dictionary

Ответ API, возвращённый для указанного ресурса.

Возвращается: всегда

Пример: {"api_response": {"Burst": 20480, "Cos": 5, "Description": "Fibre Channel QoS policy with custom values", "MaxDataFieldSize": 2048, "Moid": "1234567890abcdef12345678", "Name": "fc-qos-custom", "ObjectType": "vnic.FcQosPolicy", "Organization": {"Moid": "abcdef1234567890abcdef12", "ObjectType": "organization.Organization"}, "RateLimit": 10000, "Tags": [{"Key": "Environment", "Value": "Production"}]}}

Авторы

Ron Gershburg (@rgershbu)

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

© 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/intersight/intersight_fibre_channel_qos_policy_module.html