Модуль cisco.intersight.intersight_flow_control_policy_info — сбор информации о политиках управления потоком в 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_info.

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

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

Сбор информации о политиках управления потоком в Cisco Intersight.
Информацию можно отфильтровать по organization и name.
Если фильтры не переданы, будут возвращены все политики управления потоком.

Параметры

Параметр	Комментарии
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"`
name string	Имя политики управления потоком, сведения о которой нужно собрать.
organization string	Имя организации, которой принадлежит политика управления потоком.
use_proxy boolean	Если `no`, прокси использоваться не будет, даже если он задан в переменной окружения на целевых узлах. Варианты: `false` `true` ← (по умолчанию)
validate_certs boolean	Логический параметр, управляющий проверкой сертификата TLS для api_uri Варианты: `false` `true` ← (по умолчанию)

Примеры

- name: Fetch a specific Flow Control Policy by name
  cisco.intersight.intersight_flow_control_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "FlowControl-Auto-Policy"

- name: Fetch all Flow Control Policies in a specific Organization
  cisco.intersight.intersight_flow_control_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "org_test"

- name: Fetch all Flow Control Policies
  cisco.intersight.intersight_flow_control_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"

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

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

Ключ	Описание
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"}]}, {"Name": "FlowControl-LinkLevel-Policy", "ObjectType": "fabric.FlowControlPolicy", "PriorityFlowControlMode": "off", "ReceiveDirection": "Enabled", "SendDirection": "Enabled", "Tags": [{"Key": "Environment", "Value": "Production"}]}]}`

Ключ

Описание

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"}]}, {"Name": "FlowControl-LinkLevel-Policy", "ObjectType": "fabric.FlowControlPolicy", "PriorityFlowControlMode": "off", "ReceiveDirection": "Enabled", "SendDirection": "Enabled", "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_flow_control_policy_info_module.html