-
-
-
-
-
Get-BrokerUnconfiguredMachine
-
-
-
-
-
-
-
-
-
-
-
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-BrokerUnconfiguredMachine
Gets machines that have registered but are not yet configured in this site.
Syntax
Get-BrokerUnconfiguredMachine
[[-MachineName] <String>]
[-AgentVersion <String>]
[-ControllerDNSName <String>]
[-CurrentlyRegistered <Boolean>]
[-DNSName <String>]
[-FunctionalLevel <FunctionalLevel>]
[-LastDeregistrationTime <DateTime>]
[-OSType <String>]
[-OSVersion <String>]
[-SessionSupport <SessionSupport>]
[-Property <String[]>]
[-ReturnTotalRecordCount]
[-MaxRecordCount <Int32>]
[-Skip <Int32>]
[-SortBy <String>]
[-Filter <String>]
[-FilterScope <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Get-BrokerUnconfiguredMachine
-SID <String>
[-Property <String[]>]
[<CitrixCommonParameters>]
[<CommonParameters>]
<!--NeedCopy-->
Description
Retrieve machines matching the specified criteria, where the machine has or was previously registered with a controller in the site, but the machine has not yet been configured to be part of the site. If no parameters are specified, this cmdlet enumerates all such machines that are currently registered.
See about_Broker_Filtering for information about advanced filtering options, and about_Broker_Machines for background information about machines.
————————– BrokerUnconfiguredMachine Object
An unconfigured machine is a machine that has registered with the site but is not configured in either a desktop group or a catalog.
-
AgentVersion (System.String)
Version of the Citrix Virtual Delivery Agent (VDA) installed on the unconfigured machine.
-
ControllerDNSName (System.String)
The DNS name of the controller that the unconfigured machine is registered with. This property’s value is null for machines that are no longer registered.
-
CurrentlyRegistered (System.Boolean)
True if the unconfigured machine is currently registered with the site, or false if the unconfigured machine is no longer registered with the site (but was registered at some point in the past).
-
DNSName (System.String)
The DNS name of the unconfigured machine.
-
FunctionalLevel (Citrix.Broker.Admin.SDK.FunctionalLevel?)
The functional level of the unconfigured machine. This is determined by the version of the Citrix VDA software installed on the machine.
-
LastDeregistrationTime (System.DateTime?)
The time when the unconfigured machine last deregistered with the Citrix Broker Service.
-
MachineName (System.String)
The machine name of the unconfigured machine in the form domain\machine.
-
OSType (System.String)
The type of operating system installed on the unconfigured machine.
-
OSVersion (System.String)
The version of the operating sysetem installed on the unconfigured machine.
-
SessionSupport (Citrix.Broker.Admin.SDK.SessionSupport?)
The session support of the unconfigured machine. Valid values are: SingleSession, MultiSession
-
SID (System.String)
Security identifier of the unconfigured machine.
Examples
EXAMPLE 1
This command returns all unconfigured XP SP3 machines which are registered with the controller called ‘Controller1.domain.com’.
Get-BrokerUnconfiguredMachine -Filter { ControllerDNSName -eq 'Controller1.domain.com' -and OSType -eq 'Windows XP Service Pack 3' }
<!--NeedCopy-->
EXAMPLE 2
This command returns all unconfigured machines which have registered with the site in the past, but which are not registered at present.
Get-BrokerUnconfiguredMachine -CurrentlyRegistered $false
<!--NeedCopy-->
EXAMPLE 3
This command returns all unconfigured machines which are currently registered with the site or which have registered with the site in the past.
Get-BrokerUnconfiguredMachine -Filter { CurrentlyRegistered -eq $true -or CurrentlyRegistered -eq $false }
<!--NeedCopy-->
Parameters
-SID
Gets machines by their machine SID.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-MachineName
Gets machines by their 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 machines 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 machines 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 |
-CurrentlyRegistered
Gets machines by whether they are currently registered with the site. If there is no CurrentlyRegistered filter, then the default is to return unconfigured machines that are currently registered.
| Type: | Boolean |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DNSName
Gets machines by their DNS name.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | True |
-FunctionalLevel
Gets machines with a specific FunctionalLevel.
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 |
-LastDeregistrationTime
Gets machines 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 |
-OSType
Gets machines 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 machines 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 |
-SessionSupport
Gets machines 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 |
-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.UnconfiguredMachine
Get-BrokerUnconfiguredMachine returns an object for each matching machine
Notes
It is generally better to compare dates and times using -Filter and relative comparisons. See about_Broker_Filtering and the examples in this topic for more information.
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.