This content has been machine translated dynamically.
Dieser Inhalt ist eine maschinelle Übersetzung, die dynamisch erstellt wurde. (Haftungsausschluss)
Cet article a été traduit automatiquement de manière dynamique. (Clause de non responsabilité)
Este artículo lo ha traducido una máquina de forma dinámica. (Aviso legal)
此内容已经过机器动态翻译。 放弃
このコンテンツは動的に機械翻訳されています。免責事項
이 콘텐츠는 동적으로 기계 번역되었습니다. 책임 부인
Este texto foi traduzido automaticamente. (Aviso legal)
Questo contenuto è stato tradotto dinamicamente con traduzione automatica.(Esclusione di responsabilità))
This article has been machine translated.
Dieser Artikel wurde maschinell übersetzt. (Haftungsausschluss)
Ce article a été traduit automatiquement. (Clause de non responsabilité)
Este artículo ha sido traducido automáticamente. (Aviso legal)
この記事は機械翻訳されています.免責事項
이 기사는 기계 번역되었습니다.책임 부인
Este artigo foi traduzido automaticamente.(Aviso legal)
这篇文章已经过机器翻译.放弃
Questo articolo è stato tradotto automaticamente.(Esclusione di responsabilità))
Translation failed!
Get-ConfigSite
Gets the overall settings of the site.
Syntax
Get-ConfigSite
[-LicenseServerName <String>]
[-LicenseServerPort <Int32>]
[-LicenseServerUri <Uri>]
[-UseLicenseActivationService <Boolean>]
[-LicensingModel <String>]
[-PrimaryZone <Zone>]
[-ProductCode <String>]
[-ProductEdition <String>]
[-ProductVersion <String>]
[-SiteName <String>]
[-IgnoreZoneHealth <Boolean>]
[-LogServerEnabled <Boolean>]
[-LogServerName <String>]
[-LogServerPort <Int32>]
[-AdminAddress <String>]
[-BearerToken <String>]
[-TraceParent <String>]
[-TraceState <String>]
[-VirtualSiteId <String>]
[<CommonParameters>]
<!--NeedCopy-->
Description
The Get-ConfigSite cmdlet gets the overall settings 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.
Examples
EXAMPLE 1
Gets the site.
Get-ConfigSite
<!--NeedCopy-->
Parameters
-LicenseServerName
Gets the site where the machine used by the brokering services to obtain licenses for desktop and application session brokering matches the specified value.
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: | True |
-LicenseServerPort
Gets the site where the port number on the license server machine used by the brokering services to contact the Citrix license server matches the specified value.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LicenseServerUri
Gets the site where the Uri of the web server for licensing matches the specified value. 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
Gets the site matching the specified value for using LicenseActivationService instead of LPE. NOTE: Only available in 2203 CU7 or later.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 CU7 |
-LicensingModel
Gets the site where the license model matches the specified value.
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: | True |
-PrimaryZone
Gets the site where the primary zone matches the specified value.
The 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 |
-ProductCode
Gets the site where the product code matches the specified value.
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: | True |
-ProductEdition
Gets the site where the license edition matches the specified value.
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 |
-ProductVersion
Gets the site where the product version matches the specified value.
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: | True |
-SiteName
Gets the site where the name matches the specified value.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IgnoreZoneHealth
Gets the site matching the specified IgnoreZoneHealth configuration value.
This configuration allows treating 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.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 CU7 |
-LogServerEnabled
Gets the site matching the specified value for whether use of the Citrix log server for log collection is enabled or disabled.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 CU7 |
-LogServerName
Gets the site where the machine used by the brokering services for centralized log collection matches the specified value. The specified machine must be running a Citrix log server and have suitable licenses.
The log 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: | True |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 CU7 |
-LogServerPort
Gets the site where the port number used by the brokering services to contact the centralized log server matches the specified value.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2203 CU7 |
CitrixCommonParameters
-AdminAddress
Specifies the address of a XenDesktop controller the PowerShell snap-in will connect to. You can provide this as a host name or an IP address.
| Type: | String |
| Position: | Named |
| Default value: | Localhost. Once a value is provided by any cmdlet, this value becomes the default. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-BearerToken
Specifies the bearer token assigned to the calling user.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-TraceParent
Specifies the OpenTelemetry distributed tracing trace parent for this cmdlet call.
This property should follow the W3C Trace Context format for a traceparent header.
Note this property will also detect any ambient Activity provided by the caller provided by Activity.Current.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Available Since: | Citrix Virtual Apps and Desktop 7 2106 |
-TraceState
Specifies the OpenTelemetry distributed tracing trace state for this cmdlet call.
This property will be ignored if no TraceParent is specified.
This property should follow the W3C Trace Context format for a tracestate header.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
| Available Since: | Citrix Virtual Apps and Desktop 7 2106 |
-VirtualSiteId
Specifies the virtual site the PowerShell snap-in will connect to.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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
Citrix.Configuration.Sdk.Site
Provides information about the site
Related Links
Share
Share
In this article
This Preview product documentation is Citrix Confidential.
You agree to hold this documentation confidential pursuant to the terms of your Citrix Beta/Tech Preview Agreement.
The development, release and timing of any features or functionality described in the Preview documentation remains at our sole discretion and are subject to change without notice or consultation.
The documentation is for informational purposes only and is not a commitment, promise or legal obligation to deliver any material, code or functionality and should not be relied upon in making Citrix product purchase decisions.
If you do not agree, select I DO NOT AGREE to exit.