Citrix StoreFront SDK PowerShell Modules

Set-STFWebReceiverAdminNotification

June 20, 2025

Contributed by:

Set the WebReceiver Admin Notification

Syntax

Set-STFWebReceiverAdminNotification [-WebReceiverService] <WebReceiverService> [-UserNotifications] <List`1> [-Enabled] <Boolean> [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Set the WebReceiver Admin Notification.

Parameters

Name	Description	Required?	Pipeline Input
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.Collections.Generic.List`1[[Citrix.StoreFront.Model.ReceiverForWeb.UserNotification, Citrix.StoreFront.Model, Version=3.32.0.0, Culture=neutral, PublicKeyToken=e8b77d454fa2a856]]

Parameter UserNotifications: The .NET System.Collections.Generic.List1[[Citrix.StoreFront.Model.ReceiverForWeb.UserNotification, Citrix.StoreFront.Model, Version=3.32.0.0, Culture=neutral, PublicKeyToken=e8b77d454fa2a856]]` reference type

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
<!--NeedCopy-->

REMARKS

Sets the admin notification for the WebReceiver and enables it to display in the UI.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

Set-STFWebReceiverAdminNotification

June 20, 2025

Contributed by:

June 20, 2025

Contributed by:

Set-STFWebReceiverAdminNotification

Syntax

Detailed Description

Related Commands

Parameters

Input Type

Citrix.StoreFront.Model.ReceiverForWeb.WebReceiverService

System.Collections.Generic.List`1[[Citrix.StoreFront.Model.ReceiverForWeb.UserNotification, Citrix.StoreFront.Model, Version=3.32.0.0, Culture=neutral, PublicKeyToken=e8b77d454fa2a856]]

System.Boolean

Return Values

None

Examples

EXAMPLE 1 Set WebReceiver Admin Notification

In this article