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

Примечание

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

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

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

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

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

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

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

Параметры

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

Примеры

- name: Fetch a specific SNMP Policy by name
  cisco.intersight.intersight_snmp_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "mixed-snmp-policy"

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

- name: Fetch all SNMP Policies
  cisco.intersight.intersight_snmp_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"

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

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

Ключ	Описание
api_response dictionary	Результат ответа API, возвращенный указанным ресурсом. Возвращается: всегда Пример: {"api_response": [{"AccessCommunityString": "public", "CommunityAccess": "Full", "Enabled": true, "EngineId": "custom-engine-id", "Name": "mixed-snmp-policy", "ObjectType": "snmp.Policy", "SnmpPort": 161, "SnmpTraps": [{"Community": "trapcomm", "Destination": "192.168.1.100", "Enabled": true, "Port": 162, "Type": "Trap", "Version": "V2"}], "SnmpUsers": [{"AuthType": "SHA", "IsAuthPasswordSet": true, "IsPrivacyPasswordSet": true, "Name": "admin", "PrivacyType": "AES", "SecurityLevel": "AuthPriv"}], "SysContact": "admin@example.com", "SysLocation": "Data Center A", "Tags": [{"Key": "Environment", "Value": "Production"}], "TrapCommunity": "trapcomm", "V2Enabled": true, "V3Enabled": true}, {"CommunityAccess": "Disabled", "Enabled": true, "EngineId": "v3-engine-id", "Name": "v3-only-snmp-policy", "ObjectType": "snmp.Policy", "SnmpPort": 161, "SnmpTraps": [], "SnmpUsers": [{"AuthType": "SHA", "IsAuthPasswordSet": true, "IsPrivacyPasswordSet": true, "Name": "v3user", "PrivacyType": "AES", "SecurityLevel": "AuthPriv"}], "SysContact": "admin@example.com", "SysLocation": "Data Center B", "Tags": [], "V3Enabled": true}]}

Ключ

Описание

api_response

dictionary

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

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

Пример: {"api_response": [{"AccessCommunityString": "public", "CommunityAccess": "Full", "Enabled": true, "EngineId": "custom-engine-id", "Name": "mixed-snmp-policy", "ObjectType": "snmp.Policy", "SnmpPort": 161, "SnmpTraps": [{"Community": "trapcomm", "Destination": "192.168.1.100", "Enabled": true, "Port": 162, "Type": "Trap", "Version": "V2"}], "SnmpUsers": [{"AuthType": "SHA", "IsAuthPasswordSet": true, "IsPrivacyPasswordSet": true, "Name": "admin", "PrivacyType": "AES", "SecurityLevel": "AuthPriv"}], "SysContact": "admin@example.com", "SysLocation": "Data Center A", "Tags": [{"Key": "Environment", "Value": "Production"}], "TrapCommunity": "trapcomm", "V2Enabled": true, "V3Enabled": true}, {"CommunityAccess": "Disabled", "Enabled": true, "EngineId": "v3-engine-id", "Name": "v3-only-snmp-policy", "ObjectType": "snmp.Policy", "SnmpPort": 161, "SnmpTraps": [], "SnmpUsers": [{"AuthType": "SHA", "IsAuthPasswordSet": true, "IsPrivacyPasswordSet": true, "Name": "v3user", "PrivacyType": "AES", "SecurityLevel": "AuthPriv"}], "SysContact": "admin@example.com", "SysLocation": "Data Center B", "Tags": [], "V3Enabled": true}]}

Авторы

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