Citrix Daas SDK

Get-BrokerDesktopGroup

Gets broker desktop groups configured for this site.

Syntax

Get-BrokerDesktopGroup
   [[-Name] <String>]
   [-AdminFolderName <String>]
   [-AdminFolderUid <Int32>]
   [-AllowReconnectInMaintenanceMode <Boolean>]
   [-AppDisk <Guid>]
   [-AppDnaAnalysisState <AppDnaAnalysisState>]
   [-AppDnaCompatibility <AppDnaCompatibility>]
   [-AppProtectionKeyLoggingRequired <Boolean>]
   [-AppProtectionScreenCaptureRequired <Boolean>]
   [-AutomaticPowerOnForAssigned <Boolean>]
   [-AutomaticPowerOnForAssignedDuringPeak <Boolean>]
   [-AutomaticRestartForUntaggedMachines <Boolean>]
   [-AutoscaleLogOffReminderEnabled <Boolean>]
   [-AutoscaleLogOffReminderIntervalSecondsOffPeak <Int32>]
   [-AutoscaleLogOffReminderIntervalSecondsPeak <Int32>]
   [-AutoscaleLogOffReminderMessage <String>]
   [-AutoscaleLogOffReminderTitle <String>]
   [-AutoscaleLogOffWarningMessage <String>]
   [-AutoscaleLogOffWarningTitle <String>]
   [-AutoscaleMaxSecondsBeforeForcedLogOffDuringOffPeak <Int32>]
   [-AutoscaleMaxSecondsBeforeForcedLogOffDuringPeak <Int32>]
   [-AutoscalingEnabled <Boolean>]
   [-ColorDepth <ColorDepth>]
   [-DeliveryType <DeliveryType>]
   [-Description <String>]
   [-DesktopGroupName <String>]
   [-DesktopKind <DesktopKind>]
   [-DisconnectOffPeakIdleSessionAfterSeconds <Int32>]
   [-DisconnectPeakIdleSessionAfterSeconds <Int32>]
   [-Enabled <Boolean>]
   [-InMaintenanceMode <Boolean>]
   [-IsRemotePC <Boolean>]
   [-IsUsedByGpo <Boolean>]
   [-LicenseModel <LicenseModel>]
   [-LogoffOffPeakDisconnectedSessionAfterSeconds <Int32>]
   [-LogoffPeakDisconnectedSessionAfterSeconds <Int32>]
   [-MachineCost <Decimal>]
   [-MachineLogOnType <MachineLogOnType>]
   [-Metadata <String>]
   [-MinimumFunctionalLevel <FunctionalLevel>]
   [-OffPeakBufferSizePercent <Int32>]
   [-OffPeakDisconnectAction <SessionChangeHostingAction>]
   [-OffPeakDisconnectTimeout <Int32>]
   [-OffPeakExtendedDisconnectAction <SessionChangeHostingAction>]
   [-OffPeakExtendedDisconnectTimeout <Int32>]
   [-OffPeakLogOffAction <SessionChangeHostingAction>]
   [-OffPeakLogOffTimeout <Int32>]
   [-PeakAutoscaleAssignedPowerOnIdleAction <String>]
   [-PeakAutoscaleAssignedPowerOnIdleTimeout <Int32>]
   [-PeakBufferSizePercent <Int32>]
   [-PeakDisconnectAction <SessionChangeHostingAction>]
   [-PeakDisconnectTimeout <Int32>]
   [-PeakExtendedDisconnectAction <SessionChangeHostingAction>]
   [-PeakExtendedDisconnectTimeout <Int32>]
   [-PeakLogOffAction <SessionChangeHostingAction>]
   [-PeakLogOffTimeout <Int32>]
   [-PolicySetGuid <Guid>]
   [-PowerOffDelay <Int32>]
   [-ProductCode <String>]
   [-PublishedName <String>]
   [-RequiredSleepCapability <String>]
   [-ResourceLeasingEnabled <Boolean>]
   [-RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak <Int32>]
   [-RestrictAutoscaleMinIdleUntaggedPercentDuringPeak <Int32>]
   [-RestrictAutoscaleTagUid <Int32>]
   [-ReuseMachinesWithoutShutdownInOutage <Boolean>]
   [-ScopeId <Guid>]
   [-ScopeName <String>]
   [-SecureIcaRequired <Boolean>]
   [-SessionSupport <SessionSupport>]
   [-SettlementPeriodBeforeAutoShutdown <TimeSpan>]
   [-SettlementPeriodBeforeUse <TimeSpan>]
   [-ShutdownDesktopsAfterUse <Boolean>]
   [-Tag <String>]
   [-TenantId <Guid>]
   [-TimeZone <String>]
   [-TotalApplicationGroups <Int32>]
   [-TotalApplications <Int32>]
   [-TurnOnAddedMachine <Boolean>]
   [-UseVerticalScaling <Boolean>]
   [-UUID <Guid>]
   [-ZonePreference <ZonePreference>]
   [-ApplicationGroupUid <Int32>]
   [-ApplicationUid <Int32>]
   [-TagUid <Int32>]
   [-PowerTimeSchemeUid <Int32>]
   [-MachineConfigurationUid <Int32>]
   [-RemotePCCatalogUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerDesktopGroup
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieve desktop groups matching the specified criteria. If no parameters are specified this cmdlet enumerates all desktop groups.

Desktop groups represent groups of desktops that are managed together for brokering purposes.

————————– BrokerDesktopGroup Object

A desktop group object represents a collection of machines that are fully configured in a site that is able to run either a Microsoft Windows desktop environment, individual applications, or both.

  • AdminFolderName (System.String)

    The name of the admin folder the desktop group is in (including trailing backslash), or the empty string if the desktop group is at the root level

  • AdminFolderUid (System.Int32)

    The Uid of the admin folder the desktop group is in (if any)

  • AllowReconnectInMaintenanceMode (System.Boolean)

    Specifies whether reconnecting sessions are allowed for machines in Maintenance mode.

  • AppDisks (System.Guid[])

    The Application Disks used by machines in the desktop group.

  • AppDnaAnalysisState (Citrix.Broker.Admin.SDK.AppDnaAnalysisState?)

    Specifies the current state of AppDNA Analysis on the desktop group

  • AppDnaCompatibility (Citrix.Broker.Admin.SDK.AppDnaCompatibility?)

    The compatibility with the application disks attached to the desktop group

  • AppProtectionKeyLoggingRequired (System.Boolean)

    Specifies whether key logging app protection is required.

  • AppProtectionScreenCaptureRequired (System.Boolean)

    Specifies whether screen capture app protection is required.

  • AutomaticPowerOnForAssigned (System.Boolean)

    Specifies whether assigned desktops in the desktop group are automatically started at the start of peak time periods. Only relevant for groups whose DesktopKind is Private.

  • AutomaticPowerOnForAssignedDuringPeak (System.Boolean)

    Specifies whether assigned desktops in the desktop are automatically started throughout peak time periods. Only relevant for groups whose DesktopKind is Private and which have AutomaticPowerOnForAssigned set to true.

  • AutomaticRestartForUntaggedMachines (System.Boolean)

    Indicates whether untagged single-session machines belonging to a desktop group configured for restrict Autoscale and shutdown after use should restart after untainting.

  • AutoscaleLogOffReminderEnabled (System.Boolean)

    Boolean value indicating whether the warning messages should be sent on an interval to nudge a logoff should be sent on an interval when autoscale is enabled.

  • AutoscaleLogOffReminderIntervalSecondsOffPeak (System.Int32)

    Represents the time interval at which messages are sent to the user during off peak time when autoscale is enabled. This message will nudge users to log off instead of forcibly logging them off.

  • AutoscaleLogOffReminderIntervalSecondsPeak (System.Int32)

    Represents the time interval at which messages are sent to the user during peak time when autoscale is enabled. This message will nudge users to log off instead of forcibly logging them off.

  • AutoscaleLogOffReminderMessage (System.String)

    Notification message to display to users in active sessions belonging to machines needed by Autoscale for shutdown.

  • AutoscaleLogOffReminderTitle (System.String)

    Notification message dialog title displayed when Autoscale issues a logoff reminder request.

  • AutoscaleLogOffWarningMessage (System.String)

    Warning message to display to users in active sessions prior to Autoscale issuing a logoff request.

  • AutoscaleLogOffWarningTitle (System.String)

    Warning message dialog title displayed prior to Autoscale issuing a logoff request.

  • AutoscaleMaxSecondsBeforeForcedLogOffDuringOffPeak (System.Int32)

    Minimum time that needs to elapse before Autoscale logs off active sessions on a draining machine in the delivery group during off-peak time. This property will override the power-off delay behavior if it is configured to a value greater than zero.

  • AutoscaleMaxSecondsBeforeForcedLogOffDuringPeak (System.Int32)

    Minimum time that needs to elapse before Autoscale logs off active sessions on a draining machine in the delivery group during peak time. This property will override the power-off delay behavior if it is configured to a value greater than zero.

  • AutoscalingEnabled (System.Boolean)

    Specifies whether machines in this desktop group can be Autoscaled.

  • ColorDepth (Citrix.Broker.Admin.SDK.ColorDepth)

    Default color depth of sessions started with machines in the desktop group. Possible values are: FourBit, EightBit, SixteenBit, TwentyFourBit.

  • ConfigurationSlotUids (System.Int32[])

    Uids of any configuration slots which hold machine configurations associated with the desktop group. The order of slot UIDs in this list correspond with the order of items in the associated MachineConfigurationNames and MachineConfigurationUids list properties, and so the same slot UID can appear more than once.

  • DeliveryType (Citrix.Broker.Admin.SDK.DeliveryType)

    The type of resources being published. Possible values are: DesktopsOnly, AppsOnly, DesktopsAndApps.

  • Description (System.String)

    Description of the desktop group.

  • DesktopGroupName (System.String)

    Name of the desktop group (must be unique within a Folder)

  • DesktopKind (Citrix.Broker.Admin.SDK.DesktopKind)

    The kind of the desktops being published, possible values are: Private and Shared.

  • DesktopsAvailable (System.Int32)

    The number of machines in the desktop group in state Available; this is the number of machines with no sessions present.

  • DesktopsDisconnected (System.Int32)

    The number of disconnected sessions present on machines in the desktop group.

  • DesktopsFaulted (System.Int32)

    The number of machines in the desktop group whose FaultState is not None.

  • DesktopsInUse (System.Int32)

    The number of machines in the desktop group in state InUse; this is the number of machines with at least one session present.

  • DesktopsNeverRegistered (System.Int32)

    The number of machines in the desktop group that have never registered with the current site.

  • DesktopsPreparing (System.Int32)

    This property is no longer supported.

  • DesktopsUnregistered (System.Int32)

    The number of machines in the desktop group that are currently unregistered.

  • DisconnectOffPeakIdleSessionAfterSeconds (System.Int32)

    Specifies the time in seconds after which an idle session belonging to the delivery group is disconnected during off-peak time.

  • DisconnectPeakIdleSessionAfterSeconds (System.Int32)

    Specifies the time in seconds after which an idle session belonging to the delivery group is disconnected during peak time.

  • Enabled (System.Boolean)

    Specifies whether the desktop group is enabled or not; disabled desktop groups do not appear to users.

  • IconUid (System.Int32)

    The Uid of the icon to be used as a default for desktops in the desktop group. Individual desktop objects can override this default by setting the IconUid parameter on the desktop object.

  • InMaintenanceMode (System.Boolean)

    Specifies whether the machines in the desktop group are in maintenance mode or not.

  • IsRemotePC (System.Boolean)

    Specifies whether the desktop group is a Remote PC desktop group.

  • IsUsedByGpo (System.Boolean?)

    Indicate if the desktop group is used by group policy.

  • LicenseModel (Citrix.Broker.Admin.SDK.LicenseModel?)

    Specifies the license model for this desktop group. If none is specified, then the site-wide license model is used.

  • LogoffOffPeakDisconnectedSessionAfterSeconds (System.Int32)

    Specifies the time in seconds after which a disconnected session belonging to the delivery group is terminated during off-peak time.

  • LogoffPeakDisconnectedSessionAfterSeconds (System.Int32)

    Specifies the time in seconds after which a disconnected session belonging to the delivery group is terminated during peak time.

  • MachineConfigurationNames (System.String[])

    The MachineConfiguration names associated with the desktop group.

  • MachineConfigurationUids (System.Int32[])

    The MachineConfiguration uids associated with the desktop group.

  • MachineCost (System.Decimal)

    The per-hour instance cost of machines in this desktop group.

  • MachineLogOnType (Citrix.Broker.Admin.SDK.MachineLogOnType?)

    Specifies the login type (activedirectory/localmappedaccount) for machines in this desktop group.

  • MetadataMap (System.Collections.Generic.Dictionary<string, string>)

    Metadata associated with the desktop group.

  • MinimumFunctionalLevel (Citrix.Broker.Admin.SDK.FunctionalLevel)

    The minimum FunctionalLevel required for the machines in the desktop group to be able to register with the Citrix Broker Service.

  • Name (System.String)

    Site-wide unique full path name of the desktop group including all containing folders, for example, Folder1\Folder2\MyDesktopGroup.

  • OffPeakBufferSizePercent (System.Int32)

    The percentage of single-session machines that are kept available in an idle state, or for multi-session machines, the percentage of the total load capacity to be kept available outside peak hours.

  • OffPeakDisconnectAction (Citrix.Broker.Admin.SDK.SessionChangeHostingAction)

    The action that is performed after a configurable period of a user session disconnecting outside peak hours. Possible values are Nothing, Suspend or Shutdown.

  • OffPeakDisconnectTimeout (System.Int32)

    The number of minutes before the configured action is performed after a user session disconnects outside peak hours.

  • OffPeakExtendedDisconnectAction (Citrix.Broker.Admin.SDK.SessionChangeHostingAction)

    The action performed after a second configurable period of a user session disconnecting outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

  • OffPeakExtendedDisconnectTimeout (System.Int32)

    The number of minutes before the second configured action is performed after a user session disconnects outside peak hours.

  • OffPeakLogOffAction (Citrix.Broker.Admin.SDK.SessionChangeHostingAction)

    The action performed after a configurable period of a user session ending outside peak hours. Possible values are Nothing, Suspend, or Shutdown.

  • OffPeakLogOffTimeout (System.Int32)

    The number of minutes before the configured action is performed after a user session ends outside peak hours.

  • PeakAutoscaleAssignedPowerOnIdleAction (System.String)

    The action to be performed on an assigned machine started by Autoscale if that machine then remains unused for a defined period of time.

  • PeakAutoscaleAssignedPowerOnIdleTimeout (System.Int32)

    The number of minutes before the configured action is performed on an assigned machine previously started by autoscale that subsequently remains unused.

  • PeakBufferSizePercent (System.Int32)

    The percentage of single-session machines that are kept available in an idle state, or for multi-session machines, the percentage of the total load capacity to be kept available in peak hours.

  • PeakDisconnectAction (Citrix.Broker.Admin.SDK.SessionChangeHostingAction)

    The action performed after a configurable period of a user session disconnecting in peak hours. Possible values are Nothing, Suspend, or Shutdown.

  • PeakDisconnectTimeout (System.Int32)

    The number of minutes before the configured action is performed after a user session disconnects in peak hours.

  • PeakExtendedDisconnectAction (Citrix.Broker.Admin.SDK.SessionChangeHostingAction)

    The action performed after a second configurable period of a user session disconnecting in peak hours. Possible values are Nothing, Suspend, or Shutdown.

  • PeakExtendedDisconnectTimeout (System.Int32)

    The number of minutes before the second configured action is performed after a user session disconnects in peak hours.

  • PeakLogOffAction (Citrix.Broker.Admin.SDK.SessionChangeHostingAction)

    The action performed after a configurable period of a user session ending in peak hours. Possible values are Nothing, Suspend, or Shutdown.

  • PeakLogOffTimeout (System.Int32)

    The number of minutes before the configured action is performed after a user session ends in peak hours.

  • PolicySetGuid (System.Guid?)

    The policy set assigned to this delivery group. If this is null, the policy set of the site is used.

  • PowerOffDelay (System.Int32)

    The number of minutes following a power-on operation that Auto Scale will wait before attempting to power off that same machine. Possible values are in the range 0 - 60.

  • ProductCode (System.String)

    Specifies the licensing product code for this desktop group. If none is specified, then the site-wide product code is used.

  • ProtocolPriority (System.String[])

    A list of protocol names in the order in which they are attempted for use during connection.

  • PublishedName (System.String)

    The name of the desktop group as it is to appear to the user in StoreFront.

  • RequiredSleepCapability (System.String)

    The sleep capability of this desktop group. Possible values are None, or Suspend.

  • ResourceLeasingEnabled (System.Boolean)

    Indicates if this desktop group is enabled for resource leasing.

  • RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak (System.Int32)

    This indicates the percentage that the number of untagged single-session machines in an idle state, or for multi-session machines, the untagged available load capacity must fall below before Autoscale powers on and manages ‘tagged’ machines, as per policy, in off-peak. If the number of untagged machines in an idle state, or the untagged available load capacity goes above this threshold value, Autoscale will attempt to shut down ‘tagged’ machines. Possible values are in the range -1 - 100, where -1 (default) disables this behavior. This is only relevant for desktop groups configured for Restrict Autoscaling.

  • RestrictAutoscaleMinIdleUntaggedPercentDuringPeak (System.Int32)

    This indicates the percentage that the number of untagged single-session machines in an idle state, or for multi-session machines, the untagged available load capacity must fall below before Autoscale powers on and manages ‘tagged’ machines, as per policy, in peak time. If the number of untagged machines in an idle state, or the untagged available load capacity goes above this threshold value, Autoscale will attempt to shut down ‘tagged’ machines. Possible values are in the range -1 - 100, where -1 (default) disables this behavior. This is only relevant for desktop groups configured for Restrict Autoscaling.

  • RestrictAutoscaleTagUid (System.Int32?)

    If set to a Tag UID, only machines that have this tag will be auto scaled.

  • ReuseMachinesWithoutShutdownInOutage (System.Boolean)

    Specifies whether desktops should not be shut down after being used during outage mode.

  • Scopes (Citrix.Fma.Sdk.DelegatedAdminInterfaces.ScopeReference[])

    The list of the delegated admin scopes to which the desktop group belongs.

  • SecureIcaRequired (System.Boolean)

    Flag that specifies if the SecureICA encryption of the HDX protocol is required for sessions of desktops in the desktop group.

  • Sessions (System.Int32)

    The total number of user sessions currently running on all of the machines in the desktop group.

  • SessionSupport (Citrix.Broker.Admin.SDK.SessionSupport)

    Specifies the session support (single/multi) of the machines in the desktop group. Machines with the incorrect session support for the desktop group will be unable to register with the Citrix Broker Service.

  • SettlementPeriodBeforeAutoShutdown (System.TimeSpan)

    Time after a session ends during which automatic shutdown requests (for example, shutdown after use, idle pool management) are deferred. Any outstanding shutdown request takes effect after the settlement period expires. This is typically used to configure time to allow logoff scripts to complete.

  • SettlementPeriodBeforeUse (System.TimeSpan)

    Idle period before a machine can be selected to host a new session after registration or the end of a previous session. This is typically used to allow a machine to become idle following processing associated with start-up or logoff actions. A machine may still be selected during the idle period if no other machine is available for immediate use.

  • ShutdownDesktopsAfterUse (System.Boolean)

    Specifies if the desktops will shut down after they have been used and there are no sessions running on the machine. The machines will not shut down if they are placed into maintenance mode, even if this flag is set to $true. The machines, however, will shutdown after the machine is taken out of maintenance mode if the flag is still set.

  • Tags (System.String[])

    Tags associated with the desktop group.

  • TenantId (System.Guid?)

    Identity of tenant associated with desktop group. Not applicable (always blank) in non-multitenant sites.

  • TimeZone (System.String)

    The timezone that desktops in the desktop group are in (for power policy purposes).

  • TotalApplicationGroups (System.Int32)

    Total number of application groups associated with the desktop group.

  • TotalApplications (System.Int32)

    Total number of applications associated with the desktop group.

  • TotalDesktops (System.Int32)

    Total number of machines in the desktop group.

  • TurnOnAddedMachine (System.Boolean)

    Specifies whether the broker should attempt to turn on power-managed machines when they are added to the desktop group.

  • Uid (System.Int32)

    Uid of the desktop group.

  • UseVerticalScaling (System.Boolean?)

    Indicates whether to use vertical scaling when finding an RDS machine in the desktop group for a session launch.

  • UUID (System.Guid)

    UUID of the desktop group.

  • ZonePreferences (Citrix.Broker.Admin.SDK.ZonePreference[])

    Ordered list of zone preferences taken into account when launching resources from this desktop group. Possible values for each preference are UserLocation, UserHome, UserHomeOnly and ApplicationHome.

Examples

EXAMPLE 1

Finds all desktop groups with published names starting with “EMEA”.

Get-BrokerDesktopGroup -PublishedName EMEA*
<!--NeedCopy-->

EXAMPLE 2

Finds all desktop groups in maintenance mode.

Get-BrokerDesktopGroup -InMaintenanceMode $true
<!--NeedCopy-->

Parameters

-Uid

Gets desktop groups with the specified value of Uid.

Type: Int32
Position: 2
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Name

Gets desktop groups whose full path name matches the supplied pattern.

Type: String
Position: 2
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AdminFolderName

Gets desktop groups that are in admin folders matching the specified name.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AdminFolderUid

Gets desktop groups that are in the specified admin folder.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AllowReconnectInMaintenanceMode

Gets desktop groups which allows session reconnection while in Maintenance mode.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AppDisk

Gets only desktop groups using the specified application disk.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AppDnaAnalysisState

Gets only desktop groups with specified value of AppDnaAnalysisState

Type: AppDnaAnalysisState
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AppDnaCompatibility

Gets only desktop groups with specified value of AppDnaCompatibility

Type: AppDnaCompatibility
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AppProtectionKeyLoggingRequired

Specifies whether key logging app protection is required.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AppProtectionScreenCaptureRequired

Specifies whether screen capture app protection is required.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutomaticPowerOnForAssigned

Gets only desktop groups with the specified value of AutomaticPowerOnForAssigned.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutomaticPowerOnForAssignedDuringPeak

Gets only desktop groups with the specified value of AutomaticPowerOnForAssignedDuringPeak.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutomaticRestartForUntaggedMachines

Gets desktop groups with the specified value of AutomaticRestartForUntaggedMachines.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoscaleLogOffReminderEnabled

Gets the value indicating whether the warning messages should be sent on an interval to nudge a logoff should be sent on an interval when autoscale is enabled.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoscaleLogOffReminderIntervalSecondsOffPeak

Gets the interval in seconds which represents the time interval at which messages are sent to the user during off peak time when autoscale is enabled. This message will nudge users to log off instead of forcibly logging them off

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoscaleLogOffReminderIntervalSecondsPeak

Gets the interval in seconds which represents the time interval at which messages are sent to the user during peak time when autoscale is enabled. This message will nudge users to log off instead of forcibly logging them off

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoscaleLogOffReminderMessage

Gets the notification message to display to users in active sessions belonging to machines needed by Autoscale for shutdown.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AutoscaleLogOffReminderTitle

Gets the notification message dialog title displayed when Autoscale issues a logoff reminder request.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AutoscaleLogOffWarningMessage

Gets the warning message to display to users in active sessions prior to Autoscale issuing a logoff request.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AutoscaleLogOffWarningTitle

Gets the warning message dialog title displayed prior to Autoscale issuing a logoff request.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-AutoscaleMaxSecondsBeforeForcedLogOffDuringOffPeak

Gets the minimum seconds that need to elapse before Autoscale logs off the active sessions on the draining machines belonging to the delivery group during off-peak time. This property will override the power-off delay behavior if it is configured to a value greater than zero.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoscaleMaxSecondsBeforeForcedLogOffDuringPeak

Gets the minimum seconds that need to elapse before Autoscale logs off the active sessions on the draining machines belonging to the delivery group during peak time. This property will override the power-off delay behavior if it is configured to a value greater than zero.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-AutoscalingEnabled

Specifies whether machines in this desktop group can be Autoscaled.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ColorDepth

Gets only desktop groups with the specified color depth.

Valid values are FourBit, EightBit, SixteenBit, and TwentyFourBit.

Type: ColorDepth
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DeliveryType

Gets desktop groups according to their delivery type.

Valid values are DesktopsOnly, AppsOnly and DesktopsAndApps.

Type: DeliveryType
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Description

Gets desktop groups whose description matches the supplied pattern.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-DesktopGroupName

Gets Desktop groups that match the specified simple name.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-DesktopKind

Gets desktops of a particular kind.

Valid values are Private and Shared.

Type: DesktopKind
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DisconnectOffPeakIdleSessionAfterSeconds

Specifies the time in seconds after which an idle session belonging to the delivery group is disconnected during off-peak time.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-DisconnectPeakIdleSessionAfterSeconds

Specifies the time in seconds after which an idle session belonging to the delivery group is disconnected during peak time.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Enabled

Gets desktop groups with the specified value of Enabled.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-InMaintenanceMode

Gets desktop groups with the specified value of InMaintenanceMode.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-IsRemotePC

Gets desktop groups with the specified IsRemotePC value.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-IsUsedByGpo

Gets desktop groups that are used by group policy.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LicenseModel

Gets desktop groups with the specified license model.

Type: LicenseModel
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LogoffOffPeakDisconnectedSessionAfterSeconds

Specifies the time in seconds after which a disconnected session belonging to the delivery group is terminated during off-peak time.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-LogoffPeakDisconnectedSessionAfterSeconds

Specifies the time in seconds after which a disconnected session belonging to the delivery group is terminated during peak time.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MachineCost

The per-hour instance cost of machines in this desktop group.

Type: Decimal
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MachineLogOnType

Gets desktop groups that have the specified login type. Values can be:

  • ActiveDirectory - Perform Active Directory login on the machine.
  • LocalMappedAccount - Perform local mapped account login on the machine.
Type: MachineLogOnType
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Metadata

Gets records with matching metadata entries.

The value being compared with is a concatenation of the key name, a colon, and the value. For example: -Metadata “abc:x*” matches records with a metadata entry having a key name of “abc” and a value starting with the letter “x”.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MinimumFunctionalLevel

Gets desktop groups with a specific MinimumFunctionalLevel.

Valid values are L5, L7, L7_6, L7_7, L7_8, L7_9, L7_20, L7_25

Type: FunctionalLevel
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakBufferSizePercent

Gets desktop groups with the specified value of OffPeakBufferSizePercent.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakDisconnectAction

Gets desktop groups with the specified value of OffPeakDisconnectAction.

Type: SessionChangeHostingAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakDisconnectTimeout

Gets desktop groups with the specified value of OffPeakDisconnectTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakExtendedDisconnectAction

Gets desktop groups with the specified value of OffPeakExtendedDisconnectAction.

Type: SessionChangeHostingAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakExtendedDisconnectTimeout

Gets desktop groups with the specified value of OffPeakExtendedDisconnectTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakLogOffAction

Gets desktop groups with the specified value of OffPeakLogOffAction.

Type: SessionChangeHostingAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-OffPeakLogOffTimeout

Gets desktop groups with the specified value of OffPeakLogOffTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakAutoscaleAssignedPowerOnIdleAction

Gets desktop groups with the specified value of PeakAutoscaleAssignedPowerOnIdleAction.

Type: String
Accepted values: Nothing, Shutdown, Suspend
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakAutoscaleAssignedPowerOnIdleTimeout

Gets desktop groups with the specified value of PeakAutoscaleAssignedPowerOnIdleTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakBufferSizePercent

Gets desktop groups with the specified value of PeakBufferSizePercent.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakDisconnectAction

Gets desktop groups with the specified value of PeakDisconnectAction.

Type: SessionChangeHostingAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakDisconnectTimeout

Gets desktop groups with the specified value of PeakDisconnectTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakExtendedDisconnectAction

Gets desktop groups with the specified value of PeakExtendedDisconnectAction.

Type: SessionChangeHostingAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakExtendedDisconnectTimeout

Gets desktop groups with the specified value of PeakExtendedDisconnectTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakLogOffAction

Gets desktop groups with the specified value of PeakLogOffAction.

Type: SessionChangeHostingAction
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PeakLogOffTimeout

Gets desktop groups with the specified value of PeakLogOffTimeout.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PolicySetGuid

Gets the policy set assigned to this delivery group.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PowerOffDelay

The number of minutes following a power-on operation that Auto Scale will wait before attempting to power off that same machine. Possible values are in the range 0 - 60.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ProductCode

Gets desktop groups with the specified licensing product code.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-PublishedName

Gets desktop groups whose published name matches the supplied pattern.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-RequiredSleepCapability

Gets desktop groups with the specified value of RequiredSleepCapability.

Type: String
Accepted values: None, Suspend
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ResourceLeasingEnabled

Gets desktop groups with the specified value of ResourceLeasingEnabled.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak

Gets desktop groups with the specified value of RestrictAutoscaleMinIdleUntaggedPercentDuringOffPeak.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RestrictAutoscaleMinIdleUntaggedPercentDuringPeak

Gets desktop groups with the specified value of RestrictAutoscaleMinIdleUntaggedPercentDuringPeak.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RestrictAutoscaleTagUid

If set to a Tag UID, only machines that have this tag will be auto scaled.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ReuseMachinesWithoutShutdownInOutage

Gets only desktop groups that won’t shut down machines after they been used during outage.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeId

Gets desktop groups that are associated with the given scope identifier.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ScopeName

Gets desktop groups that are associated with the given scope name.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-SecureIcaRequired

Gets desktop groups with the specified value of SecureIcaRequired.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SessionSupport

Gets desktop groups that have the specified session capability. Values can be:

  • SingleSession - Single-session only machine.
  • MultiSession - Multi-session capable machine.
Type: SessionSupport
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SettlementPeriodBeforeAutoShutdown

Gets desktop groups with the specified value of SettlementPeriodBeforeAutoShutdown.

Type: TimeSpan
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SettlementPeriodBeforeUse

Gets desktop groups with the specified value of SettlementPeriodBeforeUse.

Type: TimeSpan
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ShutdownDesktopsAfterUse

Gets desktop groups with the specified value of ShutdownDesktopsAfterUse.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-Tag

Gets desktop groups tagged with the specified tag.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-TenantId

Gets desktop groups associated with the specified tenant identity.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-TimeZone

Gets desktop groups with the specified value of TimeZone.

Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-TotalApplicationGroups

Gets desktop groups that are acting as delivery groups for the specified number of application groups.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-TotalApplications

Gets desktop groups that are acting as delivery groups for the specified number of applications.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-TurnOnAddedMachine

Gets desktop groups with the specified value of TurnOnAddedMachine value.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UseVerticalScaling

Gets desktop groups with the specified value of UseVerticalScaling.

Type: Boolean
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-UUID

Gets desktop groups with the specified value of UUID.

Type: Guid
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ZonePreference

Gets desktop groups with a zone preference list containing the specified zone preference.

Type: ZonePreference
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ApplicationGroupUid

Gets only desktop groups with which the specified application group has been associated.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-ApplicationUid

Gets desktop groups that publish the specified application (identified by Uid)

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-TagUid

Gets desktop groups to which the specified tag (identified by its Uid) has been added to help identify it - see Add-BrokerTag for more information.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-PowerTimeSchemeUid

Gets desktop groups associated with the specified power time scheme (identified by its Uid).

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MachineConfigurationUid

Gets desktop groups with the specified value of MachineConfiguration.

Type: Int32
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-RemotePCCatalogUid

Gets Remote PC desktop groups associated with the specified catalog.

Type: Int32
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.DesktopGroup

Get-BrokerDesktopGroup returns an object for each matching desktop group.

Notes

To perform greater-than or less-than comparisons, use -Filter. For more information, see about_Broker_Filtering and the examples.

Get-BrokerDesktopGroup