-
Understanding the Citrix Virtual Apps and Desktops Administration Model
-
-
-
-
-
Get-BrokerMachineCommand
-
-
-
-
-
-
-
-
-
-
-
-
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-BrokerMachineCommand
Get the list of commands queued for delivery to a desktop.
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>]
<!--NeedCopy-->
Get-BrokerMachineCommand
-Uid <Int64>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
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<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
<!--NeedCopy-->
EXAMPLE 2
Returns all queued commands.
Get-BrokerMachineCommand -State Pending
<!--NeedCopy-->
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 |
| Accepted values: | Pending, Sent, Failed, Canceled, Expired |
| 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 |
| Introduced in: | Citrix Virtual Apps and Desktop 7 2106 |
-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.
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.