Spec-Zone.ru › Ansible

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

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

Обзор

  • Получение информации о политиках адаптеров Fibre Channel из Cisco Intersight.
  • Запрос политик по организации или имени политики.
  • Возвращает структурированные данные с метаданными политики и сведениями о конфигурации адаптера Fibre Channel.
  • Если фильтры не указаны, будут возвращены все политики адаптеров Fibre Channel.

Параметры

Параметр

Комментарии

api_key_id

string / обязательный

Идентификатор открытого API-ключа, связанного с закрытым ключом.

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

api_private_key

path / обязательный

Имя файла (абсолютный путь) или строка с данными закрытого ключа в формате PEM, используемого для аутентификации в Intersight API.

Если используется строка, для шифрования строковых данных следует использовать 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 для доступа к Intersight API.

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

По умолчанию: "https://intersight.com/api/v1"

name

string

Точное имя политики адаптера Fibre Channel, сведения о которой требуется получить.

Если параметр указан, будет возвращена только соответствующая политика.

organization

string

Имя организации для фильтрации политик адаптеров Fibre Channel.

Для организации по умолчанию используйте ‘default’.

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

use_proxy

boolean

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

Варианты:

  • false
  • true ← (по умолчанию)

validate_certs

boolean

Логический параметр для проверки TLS-сертификата api_uri

Варианты:

  • false
  • true ← (по умолчанию)

Примеры

# Basic Usage Examples
- name: Fetch all Fibre Channel Adapter Policies from all organizations
  cisco.intersight.intersight_fibre_channel_adapter_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
  register: all_fc_adapter_policies

# Organization-specific Examples
- name: Fetch all Fibre Channel Adapter Policies from the default organization
  cisco.intersight.intersight_fibre_channel_adapter_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
  register: default_org_policies

- name: Fetch all Fibre Channel Adapter Policies from a custom organization
  cisco.intersight.intersight_fibre_channel_adapter_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Engineering"
  register: engineering_policies

# Specific Policy Examples
- name: Fetch a specific Fibre Channel Adapter Policy by name
  cisco.intersight.intersight_fibre_channel_adapter_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "fc-adapter-policy-01"
  register: specific_policy

- name: Fetch a specific policy from a specific organization
  cisco.intersight.intersight_fibre_channel_adapter_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "Production"
    name: "fc-adapter-policy-prod"
  register: specific_org_policy

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

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

Ключ

Описание

api_response

list / elements=string

Ответ API со сведениями о политике адаптера Fibre Channel.

Возвращает список.

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

Пример: [{"Description": "Fibre Channel Adapter policy for production servers", "ErrorDetectionTimeout": 5000, "ErrorRecoverySettings": {"Enabled": true, "IoRetryCount": 10, "IoRetryTimeout": 8, "LinkDownTimeout": 20000, "PortDownTimeout": 5000}, "FlogiSettings": {"Retries": 12, "Timeout": 8000}, "InterruptSettings": {"Mode": "MSIx"}, "IoThrottleCount": 1024, "LunCount": 4096, "LunQueueDepth": 254, "Moid": "1234567890abcdef12345678", "Name": "fc-adapter-policy-01", "ObjectType": "vnic.FcAdapterPolicy", "Organization": {"Moid": "abcdef1234567890abcdef12", "Name": "default", "ObjectType": "organization.Organization"}, "PlogiSettings": {"Retries": 12, "Timeout": 30000}, "ResourceAllocationTimeout": 15000, "RxQueueSettings": {"RingSize": 128}, "ScsiQueueSettings": {"Count": 8, "RingSize": 512}, "Tags": [{"Key": "Environment", "Value": "Production"}, {"Key": "Owner", "Value": "Storage-Team"}], "TxQueueSettings": {"RingSize": 128}}]

Авторы

  • 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_adapter_policy_info_module.html

Spec-Zone.ru

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