Set-MonitorNotificationEmailServerConfiguration
Saves a new email server configuration
Syntax
Set-MonitorNotificationEmailServerConfiguration
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-MonitorNotificationEmailServerConfiguration
[-InputObject] <MonitorNotificationEmailServerConfiguration>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Set-MonitorNotificationEmailServerConfiguration
-ProtocolType <EmailProtocolType>
-ServerName <String>
-PortNumber <Int32>
-SenderEmailAddress <String>
-RequiresAuthentication <Boolean>
[-Credential <PSCredential>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The saved configuration describes the new settings to be used to send emails
Examples
EXAMPLE 1
Set new email server configration using the specified parameters
$secpasswd = ConvertTo-SecureString "PasswordHere" -AsPlainText -Force
$mycreds = New-Object System.Management.Automation.PSCredential ("username", $secpasswd)
Set-MonitorNotificationEmailServerConfiguration -ProtocolType Smtp -ServerName "mail.citrix.com" -PortNumber 1111 -SenderEmailAddress "user1@abc.com" -RequiresAuthentication $true -Credential $mycreds
Parameters
-InputObject
Configuration object to persist
| Type: | MonitorNotificationEmailServerConfiguration |
| Position: | 1 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ProtocolType
Email protocol type.
Possible values are
Smtp
SmtpSsl
SmtpTls
| Type: | EmailProtocolType |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ServerName
Email server name
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PortNumber
Email server port number
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SenderEmailAddress
Sender's email address
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RequiresAuthentication
Whether the server requires authentication
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Credential
Configuration credential
| Type: | PSCredential |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LoggingId
Specifies the identifier of the high-level operation this cmdlet call forms a part of. Citrix Studio and Director typically create high-level operations. PowerShell scripts can also wrap a series of cmdlet calls in a high-level operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
CitrixCommonParameters
This cmdlet supports the common Citrix parameters: -AdminAddress, -AdminClientIP, -BearerToken, -TraceParent, -TraceState and -VirtualSiteId. For more information, see about_CitrixCommonParameters.
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
You can't pipe objects to this cmdlet.
Outputs
MonitorNotificationEmailServerConfiguration
The saved configuration