Citrix Virtual Apps and Desktops SDK

Get-BrokerMachineInRegistrationSinBin

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Gets machines that are placed in the registration sin bin due to registration failures.

Syntax

Get-BrokerMachineInRegistrationSinBin
   [[-MachineName] <String>]
   [-CatalogUid <Int32>]
   [-DesktopGroupUid <Int32>]
   [-DNSName <String>]
   [-LastDeregistrationReason <String>]
   [-SinBinReleaseTime <DateTime>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerMachineInRegistrationSinBin
   -SID <String>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves machines currently in the registration sin bin matching the specified criteria. If no parameters are specified, this cmdlet enumerates all machines in the sin bin.

Machines whose registration attempts repeatedly fail are placed into a sin bin. To reduce the load on the site, registration attempts received while in the sin bin are not processed. Every few minutes machines are released from the sin bin so that their next registration can be processed in full, a further failure results in a machine being put back into the sin bin.

Repeated registration failures are typically caused by configuration problems that may need the administrator to remedy.

————————– BrokerMachineInRegistrationSinBin Object

The MachineInRegistrationSinBin represents a single machine that has been placed in the registration sin bin.

  • CatalogUid (System.Int32)

    UID of the catalog the machine is a member of.

  • DesktopGroupUid (System.Int32?)

    UID of the desktop group the machine is a member of.

  • DNSName (System.String)

    The DNS name of the machine in the sin bin.

  • LastDeregistrationReason (System.String)

    The failure reason of the last processed registration attempt by the machine.

  • MachineName (System.String)

    The machine name in the form domain\machine.

  • SID (System.String)

    Security identifier of the machine.

  • SinBinReleaseTime (System.DateTime?)

    Time until which the machines stay in the sin bin due to registration failure.

Examples

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

-CatalogUid

UID of the catalog the machine is a member of

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

-DesktopGroupUid

UID of the desktop group the machine is a member of.

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

-LastDeregistrationReason

Gets machines by their last registration failure reason.

Type: String
Accepted values: AgentShutdown, AgentSuspended, AgentRequested, IncompatibleVersion, AgentAddressResolutionFailed, AgentNotContactable, AgentWrongActiveDirectoryOU, EmptyRegistrationRequest, MissingRegistrationCapabilities, MissingAgentVersion, InconsistentRegistrationCapabilities, NotLicensedForFeature, UnsupportedCredentialSecurityVersion, InvalidRegistrationRequest, SingleMultiSessionMismatch, FunctionalLevelTooLowForCatalog, FunctionalLevelTooLowForDesktopGroup, OSNotCompatibleWithDdc, VMNotCompatibleWithDdc, PowerOff, DesktopRestart, DesktopRemoved, AgentRejectedSettingsUpdate, SendSettingsFailure, SessionAuditFailure, SessionPrepareFailure, ContactLost, SettingsCreationFailure, UnknownError, BrokerRegistrationLimitReached, RegistrationStateMismatch, MachineInRegistrationSinBin
Position: Named
Default value: None
Required: False
Accept pipeline input: False
Accept wildcard characters: False

-SinBinReleaseTime

Gets machines by the time at which they will be released from the sin bin.

Type: DateTime
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.MachineInRegistrationSinBin

Get-BrokerMachineInRegistrationSinBin returns an object for each matching machine

Get-BrokerMachineInRegistrationSinBin