Citrix Virtual Apps and Desktops SDK

Get-BrokerAutoscalePlugin

Introduced in: Citrix Virtual Apps and Desktop 7 2407

Gets autoscale plugins in the site

Syntax

Get-BrokerAutoscalePlugin
   [[-Name] <String>]
   [-Description <String>]
   [-Property <String[]>]
   [-ReturnTotalRecordCount]
   [-MaxRecordCount <Int32>]
   [-Skip <Int32>]
   [-SortBy <String>]
   [-Filter <String>]
   [-FilterScope <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Get-BrokerAutoscalePlugin
   [-Uid] <Int32>
   [-Property <String[]>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

Returns autoscale plugins matching the specified search criteria that are available for use in the site. If no search criteria are specified, all autoscale plugins are obtained.

Autoscale plugins are used to dynamically override certain aspects of a desktop group’s autoscale and power policy settings on a day-by-day basis.

Plugins must be preinstalled on all of the site’s controllers before they can be used. Once installed plugins are automatically discovered during controller start-up and corresponding BrokerAutoscalePlugin objects created for them, therefore there is no cmdlet to add new plugins.

————————– BrokerAutoscalePlugin Object

The BrokerAutoscalePlugin object represents an autoscale plugin within the site. It contains the following properties:

  • Description (System.String)

    Optional description of the plugin. The description is purely informational and does not alter the behavior of the plugin in any way.

  • Name (System.String)

    Name of the plugin. A plugin’s name is defined by its installer and cannot be changed.

  • Uid (System.Int32)

    The unique ID of the plugin. The plugin’s UID is set at discovery time.

Examples

EXAMPLE 1

Returns all autoscale plugins in the site with a name starting with “Citrix”.

Get-BrokerAutoscalePlugin -Name Citrix*
<!--NeedCopy-->

Parameters

-Uid

Gets only the plugin with the specified Uid.

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

-Name

Gets only plugins with names matching the specified pattern.

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

-Description

Gets only plugins with descriptions matching the specified pattern.

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

You cannot pipe input into this cmdlet.

Outputs

Citrix.Broker.Admin.SDK.AutoscalePlugin

Get-BrokerAutoscalePlugin returns all plugins that match the specified selection criteria.

Get-BrokerAutoscalePlugin