модуль cisco.intersight.intersight_macsec_policy_info — сбор информации о политиках MACsec в Cisco Intersight

Примечание

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

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

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

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

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

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

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

Параметры

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

Примеры

- name: Fetch a specific MACsec Policy by name
  cisco.intersight.intersight_macsec_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "macsec-policy-01"

- name: Fetch all MACsec Policies in a specific Organization
  cisco.intersight.intersight_macsec_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"

- name: Fetch all MACsec Policies
  cisco.intersight.intersight_macsec_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"

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

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

Ключ	Описание
api_response dictionary	Выходные данные ответа API, возвращённые указанным ресурсом. Возвращается: всегда Пример: {"api_response": [{"CipherSuite": "GCM-AES-XPN-256", "ConfidentialityOffset": "CONF-OFFSET-0", "Description": "MACsec policy with primary keychain", "FallbackKeyChain": {"Name": "", "SecKeys": null}, "IncludeIcvIndicator": false, "KeyServerPriority": 16, "MacSecEaPol": {"EaPolEthertype": "0x888e", "EaPolMacAddress": "0180.C200.0003"}, "Name": "macsec-policy-01", "ObjectType": "fabric.MacsecPolicy", "PrimaryKeyChain": {"Name": "primary-keychain", "SecKeys": [{"CryptographicAlgorithm": "AES_256_CMAC", "Id": "1234", "IsOctetStringSet": true, "KeyType": "Type-6", "SendLifetimeInfinite": false, "SendLifetimeUnlimited": true}]}, "ReplayWindowSize": 148809600, "SakExpiryTime": 0, "SecurityPolicy": "Should-secure", "Tags": [{"Key": "Environment", "Value": "Production"}]}]}

Ключ

Описание

api_response

dictionary

Выходные данные ответа API, возвращённые указанным ресурсом.

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

Пример: {"api_response": [{"CipherSuite": "GCM-AES-XPN-256", "ConfidentialityOffset": "CONF-OFFSET-0", "Description": "MACsec policy with primary keychain", "FallbackKeyChain": {"Name": "", "SecKeys": null}, "IncludeIcvIndicator": false, "KeyServerPriority": 16, "MacSecEaPol": {"EaPolEthertype": "0x888e", "EaPolMacAddress": "0180.C200.0003"}, "Name": "macsec-policy-01", "ObjectType": "fabric.MacsecPolicy", "PrimaryKeyChain": {"Name": "primary-keychain", "SecKeys": [{"CryptographicAlgorithm": "AES_256_CMAC", "Id": "1234", "IsOctetStringSet": true, "KeyType": "Type-6", "SendLifetimeInfinite": false, "SendLifetimeUnlimited": true}]}, "ReplayWindowSize": 148809600, "SakExpiryTime": 0, "SecurityPolicy": "Should-secure", "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_macsec_policy_info_module.html