Get-BrokerMachineCommand

Last published : Oct 31, 2026
Get the list of commands queued for delivery to a desktop.
Related information
about_Broker_AccessPolicy

Syntax

Get-BrokerMachineCommand
   [-Category <String>]
   [-CommandName <String>]
   [-CompletionTime <DateTime>]
   [-MachineName <String>]
   [-MachineUid <Int32>]
   [-Metadata <String>]
   [-RequestTime <DateTime>]
   [-SendDeadline <TimeSpan>]
   [-SendDeadlineTime <DateTime>]
   [-SendTrigger <MachineCommandTrigger>]
   [-SessionUid <Int64>]
   [-State <MachineCommandState>]
   [-User <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
Get-BrokerMachineCommand
   -Uid <Int64>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]

Description

Get the list of commands queued for delivery to a desktop. Commands are batched and can be configured to be delivered at various times during a desktop session's lifetime. Normally commands are sent within a few minutes of being queued, but it is also possible to queue a command for a user who is not currently logged on or a desktop that is currently switched off.
See about_Broker_Filtering for information about advanced filtering options.
-------------------------- BrokerMachineCommand Object
The command object returned represents a command handled by a specific service on a desktop as determined by the Category property.
  • Category (System.String)
    Category of the command.
  • CommandData (System.Byte\[\])
    Additional binary data included when the command is sent.
  • CommandName (System.String)
    Name of the command.
  • CompletionTime (System.DateTime?)
    Time at which the command was sent, expired or canceled.
  • DesktopGroupNames (System.String\[\])
    List of desktop group names that the command was restricted to.
  • MachineName (System.String)
    Name of the machine this command is targeted at.
  • MachineUid (System.Int32?)
    Unique ID of the machine this command is targeted at.
  • MetadataMap (System.Collections.Generic.Dictionary\&lt;string, string\>)
    Metadata for this command.
  • RequestTime (System.DateTime)
    Time at which this command was created.
  • SendDeadline (System.TimeSpan)
    Duration after which this command expires if it has not been sent yet.
  • SendDeadlineTime (System.DateTime?)
    Time at which this command expires if it has not been sent yet.
  • SendTrigger (Citrix.Broker.Admin.SDK.MachineCommandTrigger?)
    Event that triggers the sending of the command. Valid values are NextContact, Broker, LogOn, Logoff, Disconnect and Reconnect.
  • SessionUid (System.Int64?)
    Unique ID of the session this command is targeted at.
  • State (Citrix.Broker.Admin.SDK.MachineCommandState)
    Indicates whether the command is pending, sent, expired or canceled.
  • Synchronous (System.Boolean)
    Flag that indicates if this is a synchronous command.
  • Uid (System.Int64)
    Unique identifier of this machine command.
  • User (System.String)
    Name of the user this command is targeted at.

Examples

EXAMPLE 1

Returns all pending, canceled, expired and sent commands.
Get-BrokerMachineCommand

EXAMPLE 2

Returns all queued commands.
Get-BrokerMachineCommand -State Pending

Parameters

-Uid

Get only the command with the specified unique identifier.
Type: Int64
Position: Named
Default value: None
Required: True
Accept pipeline input: False
Accept wildcard characters: False

-Category

Get only commands targeted to the specified service category.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-CommandName

Get only commands with the specified command name.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-CompletionTime

Get only commands that entered the Sent, Failed, Canceled or Expired state at the specified time.
Type: DateTime
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-MachineName

Get only commands targeted to the specified machine.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-MachineUid

Get only commands targeted to the specified machine.
Type: Int32
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

-RequestTime

Get only commands that were requested at the specified time.
Type: DateTime
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SendDeadline

Get only commands that expire after the specified time span.
Type: TimeSpan
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SendDeadlineTime

Get only commands that have the specified deadline time.
Type: DateTime
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SendTrigger

Get only commands that are due to be sent when the specified trigger occurs. Valid values are NextContact, Broker, LogOn, Logoff, Disconnect and Reconnect.
Type: MachineCommandTrigger
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SessionUid

Get only commands targeted to the specified session.
Type: Int64
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-State

Get only commands in the specified state. Valid values are Pending, Sent, Failed, Canceled and Expired.
Type: MachineCommandState
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-User

Get only commands targeted to the specified user.
Type: String
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: True

-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

No parameter is accepted from the input pipeline.

Outputs

Citrix.Broker.Admin.SDK.MachineCommand

Returns Command objects matching all specified selection criteria.