-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerSharedDesktop
-
-
-
-
-
-
-
-
-
-
-
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-BrokerSharedDesktop
Get shared desktops configured for this site.
Syntax
Get-BrokerSharedDesktop
[[-MachineName] <String>]
[-AgentVersion <String>]
[-ControllerDNSName <String>]
[-DesktopGroupUid <Int32>]
[-DNSName <String>]
[-HostedMachineId <String>]
[-HostedMachineName <String>]
[-HostingServerName <String>]
[-HypervisorConnectionUid <Int32>]
[-InMaintenanceMode <Boolean>]
[-IPAddress <String>]
[-LastDeregistrationReason <DeregistrationReason>]
[-LastDeregistrationTime <DateTime>]
[-LastHostingUpdateTime <DateTime>]
[-OSType <String>]
[-OSVersion <String>]
[-PowerState <PowerState>]
[-RegistrationState <RegistrationState>]
[-SID <String>]
[-Tag <String>]
[-WillShutdownAfterUse <Boolean>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerSharedDesktop
[-Uid] <Int32>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
This cmdlet is deprecated, please use the Get-BrokerMachine cmdlet instead.
Retrieve shared desktops matching the specified criteria. If no parameters are specified, all shared desktops are enumerated.
Get-BrokerSharedDesktop returns configuration information only for shared desktops (a DesktopKind of ‘Shared’).
For information about advanced filtering options, see about_Broker_Filtering; for information about desktops, see about_Broker_Desktops.
————————– BrokerSharedDesktop Object
Shared desktops are desktops that are assigned randomly to users upon connection from a pool of available machines.
-
AgentVersion (System.String)
Version of the Citrix Virtual Delivery Agent (VDA) installed on the desktop.
-
ControllerDNSName (System.String)
The DNS host name of the controller that the desktop is registered to.
-
DesktopGroupUid (System.Int32)
Uid of the desktop group the desktop has been assigned to.
-
DNSName (System.String)
The DNS host name of the desktop.
-
HostedMachineId (System.String)
Unique ID within the hosting unit of the target managed desktop.
-
HostedMachineName (System.String)
The friendly name of a hosted desktop as used by its hypervisor. This is not necessarily the DNS name of the desktop.
-
HostingServerName (System.String)
DNS name of the hypervisor that is hosting the desktop if managed.
-
HypervisorConnectionUid (System.Int32?)
The UID of the hypervisor connection that the desktop has been assigned to, if managed.
-
InMaintenanceMode (System.Boolean)
Denotes whether the desktop is in maintentance mode.
-
IPAddress (System.String)
The IP address of the desktop.
-
LastDeregistrationReason (Citrix.Broker.Admin.SDK.DeregistrationReason?)
The reason for the last deregistration of the desktop with the broker. Possible values are: AgentShutdown, AgentSuspended, AgentRequested, IncompatibleVersion, AgentAddressResolutionFailed, AgentNotContactable, AgentWrongActiveDirectoryOU, EmptyRegistrationRequest, MissingRegistrationCapabilities, MissingAgentVersion, InconsistentRegistrationCapabilities, NotLicensedForFeature, UnsupportedCredentialSecurityVersion, InvalidRegistrationRequest, SingleMultiSessionMismatch, FunctionalLevelTooLowForCatalog, FunctionalLevelTooLowForDesktopGroup, PowerOff, DesktopRestart, DesktopRemoved, AgentRejectedSettingsUpdate, SendSettingsFailure, SessionAuditFailure, SessionPrepareFailure, ContactLost, SettingsCreationFailure, UnknownError and BrokerRegistrationLimitReached.
-
LastDeregistrationTime (System.DateTime?)
Time of the last deregistration of the desktop from the controller.
-
LastHostingUpdateTime (System.DateTime?)
Time of last update to any hosting data for this desktop reported by the hypervisor connection.
-
MachineName (System.String)
DNS host name of the machine associated with the desktop.
-
OSType (System.String)
A string that can be used to identify the operating system that is running on the desktop.
-
OSVersion (System.String)
A string that can be used to identify the version of the operating system running on the desktop, if known.
-
PowerState (Citrix.Broker.Admin.SDK.PowerState)
The current power state of the desktop. Possible values are: Unmanaged, Unknown, Unavailable, Off, On, Suspended, TurningOn, TurningOff, Suspending, resuming.
-
RegistrationState (Citrix.Broker.Admin.SDK.RegistrationState)
Indicates the registration state of the desktop. Possible values are: Unregistered, Initializing, Registered, AgentError.
-
SID (System.String)
The security identifier of the shared desktop.
-
Uid (System.Int32)
The uid of the shared desktop.
-
WillShutdownAfterUse (System.Boolean)
Flag indicating whether this desktop is tainted and will be shutdown after all sessions on the desktop have ended. This flag should only ever be true on power managed, single-session desktops. Note: The desktop will not shut down if it is in maintenance mode, but will shut down after the desktop is taken out of maintenance mode.
Examples
EXAMPLE 1
Get all shared desktops hosted by the hypervisor server BigServer12.
Get-BrokerSharedDesktop -HostingServerName BigServer12*
<!--NeedCopy-->
EXAMPLE 2
List all shared desktops running Windows XP, including the machine name and OS details.
Get-BrokerSharedDesktop -OSType 'Windows XP*' | ft -a MachineName,OSType,OSVersion
<!--NeedCopy-->
Parameters
-Uid
Gets desktops by Uid.
| Type: | Int32 |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MachineName
Gets desktops by machine name (in the form ‘domain\machine’).
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-AgentVersion
Gets desktops with a specific Virtual Desktop Agent version.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-ControllerDNSName
Gets desktops by the DNS name of the controller they are registered with.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-DesktopGroupUid
Gets desktops from a desktop group with a specific Uid.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DNSName
Gets desktops by DNS name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HostedMachineId
Gets desktops by the machine id known to the hypervisor.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HostedMachineName
Gets desktops by the machine name known to the hypervisor.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HostingServerName
Gets desktops by the name of the hosting hypervisor server.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-HypervisorConnectionUid
Gets desktops by the uid of the hosting hypervisor connection.
| Type: | Int32 |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-InMaintenanceMode
Gets desktops by the InMaintenanceMode setting.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-IPAddress
Gets desktops by IP address.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-LastDeregistrationReason
Gets desktops whose broker last recorded a specific deregistration reason.
Valid values are $null, AgentShutdown, AgentSuspended, AgentRequested, IncompatibleVersion, AgentAddressResolutionFailed, AgentNotContactable, AgentWrongActiveDirectoryOU, EmptyRegistrationRequest, MissingRegistrationCapabilities, MissingAgentVersion, InconsistentRegistrationCapabilities, NotLicensedForFeature, UnsupportedCredentialSecurityVersion, InvalidRegistrationRequest, SingleMultiSessionMismatch, FunctionalLevelTooLowForCatalog, FunctionalLevelTooLowForDesktopGroup, PowerOff, DesktopRestart, DesktopRemoved, AgentRejectedSettingsUpdate, SendSettingsFailure, SessionAuditFailure, SessionPrepareFailure, ContactLost, SettingsCreationFailure, UnknownError and BrokerRegistrationLimitReached.
| Type: | DeregistrationReason |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastDeregistrationTime
Gets desktops by the time that they were last deregistered.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-LastHostingUpdateTime
Gets desktops by the time that the hosting information was last updated.
| Type: | DateTime |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-OSType
Gets desktops by the type of operating system they are running.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-OSVersion
Gets desktops by the version of the operating system they are running.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-PowerState
Gets desktops by power state.
Valid values are Unmanaged, Unknown, Unavailable, Off, On, Suspended, TurningOn, TurningOff, Suspending, and Resuming.
| Type: | PowerState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-RegistrationState
Gets desktops by registration state.
Valid values are Registered, Unregistered, and AgentError.
| Type: | RegistrationState |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SID
Gets desktops by machine SID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-Tag
Get desktops tagged with the given tag.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-WillShutdownAfterUse
Gets desktops depending on whether they shutdown after use or not.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ReturnTotalRecordCount
When specified, this causes the cmdlet to output an error record containing the number of records available. This error record is additional information and does not affect the objects written to the output pipeline. See about_Broker_Filtering for details.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | False |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-MaxRecordCount
Specifies the maximum number of records to return.
| Type: | Int32 |
| Position: | Named |
| Default value: | 250 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Skip
Skips the specified number of records before returning results. Also reduces the count returned by -ReturnTotalRecordCount.
| Type: | Int32 |
| Position: | Named |
| Default value: | 0 |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-SortBy
Sorts the results by the specified list of properties. The list is a set of property names separated by commas, semi-colons, or spaces. Optionally, prefix each name with a + or - to indicate ascending or descending order. Ascending order is assumed if no prefix is present.
| Type: | String |
| Position: | Named |
| Default value: | The default sort order is by name or unique identifier. |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Filter
Gets records that match a PowerShell style filter expression. See about_Broker_Filtering for details.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-FilterScope
Gets only results allowed by the specified scope id.
| Type: | Guid |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Property
Specifies the properties to be returned. This is similar to piping the output of the command through Select-Object, but the properties are filtered more efficiently at the server.
| Type: | String[] |
| 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 cannot pipe input into this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.SharedDesktop
Get-BrokerSharedDesktop returns an object for each matching shared desktop.
Notes
To compare dates/times, use -Filter and relative comparisons. For more information, see about_Broker_Filtering.
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.