Skip to content

Latest commit

 

History

History
82 lines (65 loc) · 4.16 KB

cluster_email.md

File metadata and controls

82 lines (65 loc) · 4.16 KB
Raw
title linkTitle page_title subcategory description
powerscale_cluster_email data source
powerscale_cluster_email
powerscale_cluster_email Data Source - terraform-provider-powerscale
This datasource is used to query the Cluster Email Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

powerscale_cluster_email (Data Source)

This datasource is used to query the Cluster Email Settings from PowerScale array. The information fetched from this datasource can be used for getting the details or for further processing in resource block.

Example Usage

/*
Copyright (c) 2023-2024 Dell Inc., or its subsidiaries. All Rights Reserved.

Licensed under the Mozilla Public License Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://mozilla.org/MPL/2.0/


Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

# Returns PowerScale cluster email settings detail
data "powerscale_cluster_email" "test" {
}

# Output value of above block by executing 'terraform output' command
# The user can use the fetched information by the variable data.powerscale_cluster_email.example
output "powerscale_cluster_email_output" {
  value = data.powerscale_cluster_email.test
}

Schema

Read-Only

  • id (String) Unique identifier.
  • settings (Attributes) Cluster email notification settings. (see below for nested schema)

Nested Schema for settings

Read-Only:

  • batch_mode (String) This setting determines how notifications will be batched together to be sent by email. 'none' means each notification will be sent separately. 'severity' means notifications of the same severity will be sent together. 'category' means notifications of the same category will be sent together. 'all' means all notifications will be batched together and sent in a single email.
  • mail_relay (String) The address of the SMTP server to be used for relaying the notification messages. An SMTP server is required in order to send notifications. If this string is empty, no emails will be sent.
  • mail_sender (String) The full email address that will appear as the sender of notification messages.
  • mail_subject (String) The subject line for notification messages from this cluster.
  • smtp_auth_passwd_set (Boolean) Indicates if an SMTP authentication password is set.
  • smtp_auth_security (String) The type of secure communication protocol to use if SMTP is being used. If 'none', plain text will be used, if 'starttls', the encrypted STARTTLS protocol will be used.
  • smtp_auth_username (String) Username to authenticate with if SMTP authentication is being used.
  • smtp_port (Number) The port on the SMTP server to be used for relaying the notification messages.
  • use_smtp_auth (Boolean) If true, this cluster will send SMTP authentication credentials to the SMTP relay server in order to send its notification emails. If false, the cluster will attempt to send its notification emails without authentication.
  • user_template (String) Location of a custom template file that can be used to specify the layout of the notification emails.