модуль cisco.intersight.intersight_flow_control_policy — настройка политики управления потоком для Cisco Intersight

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install cisco.intersight.

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

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

Обзор

Управляет настройкой политики управления потоком в Cisco Intersight.
Политика для настройки Priority Flow Control (PFC) и параметров управления потоком на уровне канала для управляемых Cisco Intersight коммутаторов Fabric Interconnect.
Priority Flow Control (PFC) обеспечивает отсутствие потерь для определённых классов трафика, а управление потоком на уровне канала регулирует поток трафика на канальном уровне.
Дополнительные сведения см. в разделе Cisco Intersight.

Параметры

Параметр	Комментарии
api_key_id string / обязательный	Идентификатор открытого API-ключа, связанного с закрытым ключом. Если значение не задано, используется значение переменной среды INTERSIGHT_API_KEY_ID.
api_private_key path / обязательный	Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате 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"`
description псевдонимы: descr string	Описание политики управления потоком, заданное пользователем. Описание может содержать буквы (a-z, A-Z), цифры (0-9), дефис (-), точку (.), двоеточие (:) или символ подчёркивания (_).
name string / обязательный	Имя, присвоенное политике управления потоком. Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.
organization string	Имя организации, которой назначен этот ресурс. Профили и политики, созданные в пользовательской организации, применимы только к устройствам в этой же организации. По умолчанию: `"default"`
priority_flow_control_mode string	Настройка Priority Flow Control (PFC) для каждого порта обеспечивает отсутствие потерь для CoS, определённого политикой системного QoS. PFC работает совместно с политикой Ethernet QoS, обеспечивая отсутствие потерь для определённых значений CoS. Если для PFC выбрано значение Auto или On, управление потоком на уровне канала для приёма и отправки будет отключено. `auto` — PFC настраивается автоматически на основе политик QoS (по умолчанию). `on` — PFC всегда включён для настроенных значений CoS. `off` — PFC отключён. Вместо него будут использоваться параметры управления потоком на уровне канала. Варианты: `"auto"` ← (по умолчанию) `"on"` `"off"`
receive_direction string	Управление потоком на уровне канала, настроенное для направления приёма. Этот параметр применим только в том случае, если для `priority_flow_control_mode` задано значение `off`. Если для `priority_flow_control_mode` задано значение `auto` или `on`, этому параметру автоматически присваивается значение `disabled`. `enabled` — включить управление потоком в направлении приёма. `disabled` — отключить управление потоком в направлении приёма. Варианты: `"enabled"` ← (по умолчанию) `"disabled"`
send_direction string	Управление потоком на уровне канала, настроенное для направления отправки. Этот параметр применим только в том случае, если для `priority_flow_control_mode` задано значение `off`. Если для `priority_flow_control_mode` задано значение `auto` или `on`, этому параметру автоматически присваивается значение `disabled`. `enabled` — включить управление потоком в направлении отправки. `disabled` — отключить управление потоком в направлении отправки. Варианты: `"enabled"` ← (по умолчанию) `"disabled"`
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 a Flow Control Policy with auto PFC mode
  cisco.intersight.intersight_flow_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "FlowControl-Auto-Policy"
    description: "Flow control policy with auto PFC"
    priority_flow_control_mode: auto
    tags:
      - Key: "Site"
        Value: "DataCenter-A"
    state: present

- name: Create a Flow Control Policy with PFC enabled
  cisco.intersight.intersight_flow_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "FlowControl-PFC-On-Policy"
    description: "Flow control policy with PFC always on"
    priority_flow_control_mode: on
    state: present

- name: Create a Flow Control Policy with link-level flow control
  cisco.intersight.intersight_flow_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "FlowControl-LinkLevel-Policy"
    description: "Flow control policy with link-level settings"
    priority_flow_control_mode: off
    receive_direction: enabled
    send_direction: enabled
    state: present

- name: Create a Flow Control Policy with disabled flow control
  cisco.intersight.intersight_flow_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "FlowControl-Disabled-Policy"
    priority_flow_control_mode: off
    receive_direction: disabled
    send_direction: disabled
    state: present

- name: Update a Flow Control Policy
  cisco.intersight.intersight_flow_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "FlowControl-Auto-Policy"
    description: "Updated flow control policy"
    priority_flow_control_mode: on
    state: present

- name: Delete a Flow Control Policy
  cisco.intersight.intersight_flow_control_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "FlowControl-Auto-Policy"
    state: absent

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

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

Ключ	Описание
api_response dictionary	Результат ответа API, возвращённый указанным ресурсом. Возвращается: всегда Пример: `{"api_response": {"Name": "FlowControl-Auto-Policy", "ObjectType": "fabric.FlowControlPolicy", "PriorityFlowControlMode": "auto", "ReceiveDirection": "Enabled", "SendDirection": "Enabled", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}`

Ключ

Описание

api_response

dictionary

Результат ответа API, возвращённый указанным ресурсом.

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

Пример: {"api_response": {"Name": "FlowControl-Auto-Policy", "ObjectType": "fabric.FlowControlPolicy", "PriorityFlowControlMode": "auto", "ReceiveDirection": "Enabled", "SendDirection": "Enabled", "Tags": [{"Key": "Site", "Value": "DataCenter-A"}]}}

Авторы

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_flow_control_policy_module.html