Spec-Zone.ru › Ansible

модуль cisco.intersight.intersight_smtp_policy — настройка политики 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.

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

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

  • Управляет настройкой политики SMTP в Cisco Intersight.
  • Настраивает параметры SMTP для отправки уведомлений по электронной почте.
  • Дополнительную информацию см. в документации Cisco Intersight.

Параметры

Параметр

Комментарии

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"

description

псевдонимы: descr

string

Описание политики SMTP, заданное пользователем.

Описание может содержать буквы (a–z, A–Z), цифры (0–9), дефис (-), точку (.), двоеточие (:) или символ подчёркивания (_).

enabled

boolean

Если параметр включён, управляет состоянием службы SMTP-клиента на управляемом устройстве.

Варианты:

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

min_severity

string

Минимальный уровень серьёзности неисправности для получения уведомлений по электронной почте.

Уведомления отправляются для всех неисправностей, уровень серьёзности которых равен выбранному уровню или превышает его.

Варианты:

  • "critical" ← (по умолчанию)
  • "major"
  • "minor"
  • "warning"
  • "condition"
  • "condition"

name

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

Имя, присвоенное политике SMTP.

Имя должно содержать от 1 до 62 буквенно-цифровых символов; допускаются специальные символы :-_.

organization

string

Имя организации, которой назначен этот ресурс.

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

По умолчанию: "default"

sender_email

string

Указанный здесь адрес электронной почты будет отображаться в поле отправителя (адрес, с которого получено письмо) всех получаемых оповещений SMTP.

Если параметр не настроен, в поле отправителя используется имя хоста сервера.

smtp_port

integer

Номер порта, используемого SMTP-сервером для отправки данных по SMTP.

Допустимый диапазон: 1–65535.

По умолчанию: 25

smtp_recipients

list / элементы=string

Список адресов электронной почты, на которые будут отправляться уведомления о неисправностях.

smtp_server

string

IP-адрес или имя хоста SMTP-сервера.

Управляемое устройство использует SMTP-сервер для отправки уведомлений по электронной почте.

Обязательный параметр, если enabled имеет значение True.

state

string

Если задано значение present, проверяется наличие ресурса и при необходимости он создаётся.

Если задано значение absent, проверяется отсутствие ресурса и при необходимости он удаляется.

Варианты:

  • "present" ← (по умолчанию)
  • "absent"

tags

list / элементы=dictionary

Список тегов в формате «Ключ:<заданный пользователем ключ> Значение:<заданное пользователем значение>».

По умолчанию: []

use_proxy

boolean

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

Варианты:

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

validate_certs

boolean

Логический параметр, управляющий проверкой TLS-сертификата api_uri.

Варианты:

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

Примеры

- name: Create SMTP Policy
  cisco.intersight.intersight_smtp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    organization: "default"
    name: "smtp-policy-test"
    description: "SMTP Policy for Alerting"
    enabled: true
    smtp_server: "smtp.example.com"
    smtp_port: 25
    min_severity: "warning"
    sender_email: "alerts@example.com"
    smtp_recipients:
      - "admin@example.com"
      - "devops@example.com"
    tags:
      - Key: "Environment"
        Value: "Production"
    state: present

- name: Disable SMTP Policy
  cisco.intersight.intersight_smtp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "smtp-policy-test"
    enabled: false
    state: present

- name: Delete SMTP Policy
  cisco.intersight.intersight_smtp_policy:
    api_private_key: "{{ api_private_key }}"
    api_key_id: "{{ api_key_id }}"
    name: "smtp-policy-test"
    state: absent

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

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

Ключ

Описание

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": [{"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_smtp_policy_module.html

Spec-Zone.ru

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