Storefront Powershell SDK 2411

Set-STFRoamingAccount

Set the roaming account properties

Syntax

Set-STFRoamingAccount [-StoreService] <StoreService> [[-Published] <Boolean>] [[-RoamingService] <RoamingService>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Configure the roaming account properties for a given Store.

Parameters

Name Description Required? Pipeline Input Default Value
StoreService Store service true true (ByValue)  
Published Publish the Store service account record. false false  
RoamingService The Roaming service false false  

Input Type

Citrix.StoreFront.Model.Store.StoreService

Parameter StoreService: A .NET class representing the configuration of a StoreFront Store service

System.Boolean

Parameter Published: The .NET System.Boolean value type

Citrix.StoreFront.Model.Roaming.RoamingService

Parameter RoamingService: A .NET class representing the configuration of a StoreFront Roaming service

Return Values

None

Examples

EXAMPLE 1 Set the roaming account properties to hide the Store

$store = Get-STFStoreService
Set-STFRoamingAccount -StoreService $store -Published $false
<!--NeedCopy-->

REMARKS

Set the Roaming account for the only configured Store service to hide the Store from Receivers.

Set-STFRoamingAccount