Set-STFWebReceiverAdminNotification
Set the WebReceiver Admin Notification
Syntax
Set-STFWebReceiverAdminNotification [-WebReceiverService] <WebReceiverService> [-UserNotifications] <List`1> [-Enabled] <Boolean> [<CommonParameters>]
Detailed Description
Set the WebReceiver Admin Notification.
Related Commands
Parameters
| Name | Description | Required? | Pipeline Input | Default Value |
|---|---|---|---|---|
| WebReceiverService | The WebReceiver service. | true | true (ByValue) | |
| UserNotifications | A List containing UserNotification objects. We currently only support one notification but for future compatibility we take a list here | true | true (ByValue) | |
| Enabled | Bool value to enable or disable admin notification | true | true (ByValue) |
Input Type
Citrix.StoreFront.Model.ReceiverForWeb.WebReceiverService
Parameter WebReceiverService: A .NET class representing the configuration of a StoreFront Web Receiver service
System.Boolean
Parameter Enabled: The .NET
System.Boolean value type
Return Values
None
Examples
EXAMPLE 1 Set WebReceiver Admin Notification
$webReceiver = Get-STFWebReceiverService
$notification = New-Object -TypeName Citrix.StoreFront.Model.ReceiverForWeb.UserNotification
$notification.Id = New-Guid
$notification.Name = "/Service Outage Notification"/
$notification.Message = New-Object 'system.collections.generic.dictionary[string,string]'
$notification.Message["/en"/] = "/The service is undergoing an outage"/
$notification.Position = "/Top"/
$notification.Type = "/Banner"/
$notification.TimeZone = "/UTC"/
$notification.StartTime = (Get-Date -Year 2025 -Month 12 -Day 31)
$notification.ExpireTime = (Get-Date -Year 2026 -Month 01 -Day 20)
Set-STFWebReceiverAdminNotification -WebReceiverService $webReceiver -UserNotifications $notification -Enabled $true
REMARKS
Sets the admin notification for the WebReceiver and enables it to display in the UI.