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

Примечание

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

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

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

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

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

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

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

Параметры

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

Примеры

- name: Fetch a specific SMTP Policy by name
  cisco.intersight.intersight_smtp_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "smtp-policy-test"

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

- name: Fetch all SMTP Policies
  cisco.intersight.intersight_smtp_policy_info:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"

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

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

Ключ	Описание
api_response dictionary	Выходные данные ответа API, возвращённые указанным ресурсом. Возвращается: всегда Пример: `{"api_response": [{"Description": "SMTP Policy for Alerting", "Enabled": true, "MinSeverity": "warning", "Name": "smtp-policy-test", "ObjectType": "smtp.Policy", "SenderEmail": "alerts@example.com", "SmtpPort": 25, "SmtpRecipients": ["admin@example.com", "devops@example.com"], "SmtpServer": "smtp.example.com", "Tags": []}]}`

Ключ

Описание

api_response

dictionary

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

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

Пример: {"api_response": [{"Description": "SMTP Policy for Alerting", "Enabled": true, "MinSeverity": "warning", "Name": "smtp-policy-test", "ObjectType": "smtp.Policy", "SenderEmail": "alerts@example.com", "SmtpPort": 25, "SmtpRecipients": ["admin@example.com", "devops@example.com"], "SmtpServer": "smtp.example.com", "Tags": []}]}

Авторы

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