Citrix Virtual Apps and Desktops SDK

Set-BrokerHostingPowerAction

Changes the priority of one or more pending power actions.

Syntax

Set-BrokerHostingPowerAction
   [-InputObject] <HostingPowerAction[]>
   [-PassThru]
   [-ActualPriority <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->
Set-BrokerHostingPowerAction
   [-MachineName] <String>
   [-PassThru]
   [-ActualPriority <Int32>]
   [-LoggingId <Guid>]
   [<CitrixCommonParameters>]
   [<CommonParameters>]
<!--NeedCopy-->

Description

The Set-BrokerHostingPowerAction cmdlet modifies an existing power action in the site’s power action queue. The only property of power actions you can change, is the current priority of the action.

For a detailed description of the queuing mechanism, see ‘help about_Broker_PowerManagement’.

Examples

EXAMPLE 1

Sets the current priority of actions for the machine called ‘XD_VDA1’ to 25. Numerically lower priority values indicate more important actions that will be processed in preference to actions with numerically higher priority settings.

Set-BrokerHostingPowerAction -MachineName 'XD_VDA1' -ActualPriority 25
<!--NeedCopy-->

Parameters

-InputObject

The power action whose priority is to be changed.

Type: HostingPowerAction[]
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByValue)
Accept wildcard characters: False

-MachineName

Changes the priority of actions that are for machines whose name (of the form domain\machine) matches the specified string.

Type: String
Position: 2
Default value: None
Required: True
Accept pipeline input: True (ByPropertyName)
Accept wildcard characters: True

-PassThru

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it returns the affected record.

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

-ActualPriority

Specifies a new priority value for the action in the queue.

This priority is the current action priority; the ‘base’ or original priority for actions cannot be altered. Numerically lower priority values indicate more important actions that are processed in preference to actions with numerically higher priority settings.

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

-LoggingId

Specifies the identifier of the high level operation that this cmdlet call forms a part of. Desktop Studio and Desktop Director typically create High Level Operations. PowerShell scripts can also wrap a series of cmdlet calls in a High Level Operation by way of the Start-LogHighLevelOperation and Stop-LogHighLevelOperation cmdlets.

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

Citrix.Broker.Admin.SDK.HostingPowerAction

The power action whose priority is to be changed.

Outputs

None or Citrix.Broker.Admin.SDK.HostingPowerAction

This cmdlet does not generate any output, unless you use the PassThru parameter, in which case it generates a Citrix.Broker.Admin.SDK.HostingPowerAction object.

Set-BrokerHostingPowerAction