Set-ConfigSite
Changes the overall settings of the site.
Syntax
Set-ConfigSite
[-SiteName <String>]
[-ProductCode <String>]
[-ProductEdition <String>]
[-ProductVersion <String>]
[-LicensingModel <String>]
[-LicenseServerName <String>]
[-LicenseServerPort <Int32>]
[-LicenseServerUri <Uri>]
[-UseLicenseActivationService <Boolean>]
[-PrimaryZone <Zone>]
[-IgnoreZoneHealth <Boolean>]
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
Description
The Set-ConfigSite cmdlet modifies properties of the site.
The site is a top-level, logical representation of the XenDesktop site, from the perspective of the configuration services running within the site.
A XenDesktop installation has only a single site instance.
Modifications to the product code, product edition, product version and licensing model properties are successful only if their values are consistent with the feature table. Use the Get-ConfigProduct, Get-ConfigProductEdition, Get-ConfigProductVersion and Get-ConfigLicensingModel cmdlets to determine consistent values.
To configure the site, first import the feature table using the Import-ConfigFeatureTable cmdlet.
Examples
EXAMPLE 1
Specifies the use of a Platinum edition license. A suitable license must be available on the site's license server.
Set-ConfigSite -ProductEdition PLT
Parameters
-SiteName
Changes the name of the site.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
| Disallowed characters: | \/;:#.*?=<>\|[]()"' |
-ProductCode
Changes the product code.
The Get-ConfigProduct cmdlet returns a list of supported values.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-ProductEdition
Changes the license edition. A license matching the specified edition must be available within the site's license server.
The Get-ConfigProductEdition returns a list of supported values.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-ProductVersion
Changes the product version.
The Get-ConfigProductVersion returns a list of supported values.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-LicensingModel
Changes the license model. A license matching the specified model must be available within the site's license server.
The Get-ConfigLicensingModel returns a list of supported values.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 64 |
-LicenseServerName
Changes the machine used by the brokering services to obtain licenses for desktop and application session brokering. The specified machine must be running a Citrix license server and have suitable licenses installed.
The license server machine can be specified by its DNS name ('machine.domain') or its numeric IP address.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Length range: | 1 to 255 |
-LicenseServerPort
Changes the port number on the license server machine used by the brokering services to contact the Citrix license server.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseServerUri
Changes the Uri of the web server for licensing. The hostname component of this Uri must match the Site's LicenseServerName property.
| Type: | Uri |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-UseLicenseActivationService
Changes the config to use LicenseActivationService instead of LPE.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-PrimaryZone
Changes the primary zone for the site.
Primary zone can be specified by Uid, Name or by passing a Zone object.
| Type: | Zone |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IgnoreZoneHealth
IgnoreZoneHealth Configuration
This configuration allows to treat machines in an unhealthy zone as if the zone is healthy. When enabled, operations like launching sessions and managing power will be attempted on machines in the unhealthy zone, disregarding the actual zone health status. This can be useful in scenarios where access to machines in an unhealthy zone are impacted. Administrators must reset the IgnoreZoneHealth configuration to restore normal behavior. Normal behavior utilizes the zone health status (isHealthy) to determine whether operations on machines within that zone should proceed.
| Type: | Boolean |
| 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.