Citrix Virtual Apps and Desktops SDK

Get-BrokerMachineConfiguration

Gets machine configurations defined for this site.

Syntax

Get-BrokerMachineConfiguration
   [[-Name] <String>]
   [-ConfigurationSlotUid <Int32>]
   [-LeafName <String>]
   [-Metadata <String>]
   [-ApplicationUid <Int32>]
   [-DesktopGroupUid <Int32>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerMachineConfiguration
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Retrieves machine configurations matching the specified criteria. If no parameters are specified this cmdlet enumerates all machine configurations.

Machine configurations contain binary arrays of settings data that are managed using SDK snap-ins. Each machine configuration is associated with a configuration slot and referenced by Name. The configuration slot restricts the settings that can be held by the machine configuration. For example, only configurations for Citrix User Profile Manager can be associated with the “User Profile Manager” slot.

See about_Broker_Filtering for information about advanced filtering options.

————————– BrokerMachineConfiguration Object

The machine configuration object returned represents a named collection of related settings values that are applied to a desktop group.

  • ApplicationUids (System.Int32[])

    List of application Uids that this machine configuration has been added to.

  • ConfigurationSlotUid (System.Int32)

    Uid of the associated configuration slot.

  • Description (System.String)

    Optional description of the machine configuration.

  • DesktopGroupUids (System.Int32[])

    List of desktop group Uids that this machine configuration has been added to.

  • LeafName (System.String)

    Name of this machine configuration.

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

    Map of metadata associated with this machine configuration.

  • Name (System.String)

    Unique “SlotName\MachineConfigurationName” for this machine configuration.

  • Policy (System.Byte[])

    A binary array of encoded settings.

  • Uid (System.Int32)

    Uid of this machine configuration.

Examples

EXAMPLE 1

Retrieves a list of every defined machine configuration.

Get-BrokerMachineConfiguration
<!--NeedCopy-->

EXAMPLE 2

Retrieves the machine configuration named “Receiver\Engineering”.

Get-BrokerMachineConfiguration -Name Receiver\Engineering
<!--NeedCopy-->

EXAMPLE 3

Retrieves a list of every machine configuration associated with the configuration slot named “UPM”.

Get-BrokerMachineConfiguration -Name UPM\*
<!--NeedCopy-->

EXAMPLE 4

Retrieves a list of every machine configuration with a LeafName that starts with “Dept”, regardless of the associated configuration slot.

Get-BrokerMachineConfiguration -LeafName "Dept*"
<!--NeedCopy-->

Parameters

-Uid

Get only the machine configuration with the specified unique identifier.

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

-Name

Get only the machine configuration with the specified name.

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

-ConfigurationSlotUid

Get only the machine configurations associated with the specified configuration slot.

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

-LeafName

Get only the machine configurations that have the specified leaf name.

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

-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

-ApplicationUid

Get only the machine configurations that have been assigned to the specified application.

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

-DesktopGroupUid

Get only the machine configurations that have been assigned to the specified desktop group.

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
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

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.MachineConfiguration

Get-BrokerMachineConfiguration returns an object for each matching machine configuration.

Get-BrokerMachineConfiguration