1. Packages
  2. Powerscale Provider
  3. API Docs
  4. getClusterEmail
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

powerscale.getClusterEmail

Explore with Pulumi AI

powerscale logo
powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell

    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

    import * as pulumi from "@pulumi/pulumi";
    import * as powerscale from "@pulumi/powerscale";
    
    const test = powerscale.getClusterEmail({});
    export const powerscaleClusterEmailOutput = test;
    
    import pulumi
    import pulumi_powerscale as powerscale
    
    test = powerscale.get_cluster_email()
    pulumi.export("powerscaleClusterEmailOutput", test)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/powerscale/powerscale"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := powerscale.LookupClusterEmail(ctx, map[string]interface{}{}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("powerscaleClusterEmailOutput", test)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Powerscale = Pulumi.Powerscale;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Powerscale.GetClusterEmail.Invoke();
    
        return new Dictionary<string, object?>
        {
            ["powerscaleClusterEmailOutput"] = test,
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.powerscale.PowerscaleFunctions;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var test = PowerscaleFunctions.getClusterEmail();
    
            ctx.export("powerscaleClusterEmailOutput", test.applyValue(getClusterEmailResult -> getClusterEmailResult));
        }
    }
    
    variables:
      test:
        fn::invoke:
          function: powerscale:getClusterEmail
          arguments: {}
    outputs:
      # 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
      powerscaleClusterEmailOutput: ${test}
    

    Using getClusterEmail

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getClusterEmail(opts?: InvokeOptions): Promise<GetClusterEmailResult>
    function getClusterEmailOutput(opts?: InvokeOptions): Output<GetClusterEmailResult>
    def get_cluster_email(opts: Optional[InvokeOptions] = None) -> GetClusterEmailResult
    def get_cluster_email_output(opts: Optional[InvokeOptions] = None) -> Output[GetClusterEmailResult]
    func LookupClusterEmail(ctx *Context, opts ...InvokeOption) (*LookupClusterEmailResult, error)
    func LookupClusterEmailOutput(ctx *Context, opts ...InvokeOption) LookupClusterEmailResultOutput

    > Note: This function is named LookupClusterEmail in the Go SDK.

    public static class GetClusterEmail 
    {
        public static Task<GetClusterEmailResult> InvokeAsync(InvokeOptions? opts = null)
        public static Output<GetClusterEmailResult> Invoke(InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetClusterEmailResult> getClusterEmail(InvokeOptions options)
    public static Output<GetClusterEmailResult> getClusterEmail(InvokeOptions options)
    
    fn::invoke:
      function: powerscale:index/getClusterEmail:getClusterEmail
      arguments:
        # arguments dictionary

    getClusterEmail Result

    The following output properties are available:

    Id string
    Unique identifier.
    Settings GetClusterEmailSettings
    Cluster email notification settings.
    Id string
    Unique identifier.
    Settings GetClusterEmailSettings
    Cluster email notification settings.
    id String
    Unique identifier.
    settings GetClusterEmailSettings
    Cluster email notification settings.
    id string
    Unique identifier.
    settings GetClusterEmailSettings
    Cluster email notification settings.
    id str
    Unique identifier.
    settings GetClusterEmailSettings
    Cluster email notification settings.
    id String
    Unique identifier.
    settings Property Map
    Cluster email notification settings.

    Supporting Types

    GetClusterEmailSettings

    BatchMode 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.
    MailRelay 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.
    MailSender string
    The full email address that will appear as the sender of notification messages.
    MailSubject string
    The subject line for notification messages from this cluster.
    SmtpAuthPasswdSet bool
    Indicates if an SMTP authentication password is set.
    SmtpAuthSecurity 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.
    SmtpAuthUsername string
    Username to authenticate with if SMTP authentication is being used.
    SmtpPort double
    The port on the SMTP server to be used for relaying the notification messages.
    UseSmtpAuth bool
    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.
    UserTemplate string
    Location of a custom template file that can be used to specify the layout of the notification emails.
    BatchMode 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.
    MailRelay 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.
    MailSender string
    The full email address that will appear as the sender of notification messages.
    MailSubject string
    The subject line for notification messages from this cluster.
    SmtpAuthPasswdSet bool
    Indicates if an SMTP authentication password is set.
    SmtpAuthSecurity 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.
    SmtpAuthUsername string
    Username to authenticate with if SMTP authentication is being used.
    SmtpPort float64
    The port on the SMTP server to be used for relaying the notification messages.
    UseSmtpAuth bool
    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.
    UserTemplate string
    Location of a custom template file that can be used to specify the layout of the notification emails.
    batchMode 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.
    mailRelay 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.
    mailSender String
    The full email address that will appear as the sender of notification messages.
    mailSubject String
    The subject line for notification messages from this cluster.
    smtpAuthPasswdSet Boolean
    Indicates if an SMTP authentication password is set.
    smtpAuthSecurity 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.
    smtpAuthUsername String
    Username to authenticate with if SMTP authentication is being used.
    smtpPort Double
    The port on the SMTP server to be used for relaying the notification messages.
    useSmtpAuth 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.
    userTemplate String
    Location of a custom template file that can be used to specify the layout of the notification emails.
    batchMode 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.
    mailRelay 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.
    mailSender string
    The full email address that will appear as the sender of notification messages.
    mailSubject string
    The subject line for notification messages from this cluster.
    smtpAuthPasswdSet boolean
    Indicates if an SMTP authentication password is set.
    smtpAuthSecurity 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.
    smtpAuthUsername string
    Username to authenticate with if SMTP authentication is being used.
    smtpPort number
    The port on the SMTP server to be used for relaying the notification messages.
    useSmtpAuth 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.
    userTemplate string
    Location of a custom template file that can be used to specify the layout of the notification emails.
    batch_mode str
    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 str
    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 str
    The full email address that will appear as the sender of notification messages.
    mail_subject str
    The subject line for notification messages from this cluster.
    smtp_auth_passwd_set bool
    Indicates if an SMTP authentication password is set.
    smtp_auth_security str
    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 str
    Username to authenticate with if SMTP authentication is being used.
    smtp_port float
    The port on the SMTP server to be used for relaying the notification messages.
    use_smtp_auth bool
    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 str
    Location of a custom template file that can be used to specify the layout of the notification emails.
    batchMode 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.
    mailRelay 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.
    mailSender String
    The full email address that will appear as the sender of notification messages.
    mailSubject String
    The subject line for notification messages from this cluster.
    smtpAuthPasswdSet Boolean
    Indicates if an SMTP authentication password is set.
    smtpAuthSecurity 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.
    smtpAuthUsername String
    Username to authenticate with if SMTP authentication is being used.
    smtpPort Number
    The port on the SMTP server to be used for relaying the notification messages.
    useSmtpAuth 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.
    userTemplate String
    Location of a custom template file that can be used to specify the layout of the notification emails.

    Package Details

    Repository
    powerscale dell/terraform-provider-powerscale
    License
    Notes
    This Pulumi package is based on the powerscale Terraform Provider.
    powerscale logo
    powerscale 1.7.1 published on Wednesday, Apr 30, 2025 by dell