Citrix Virtual Apps and Desktops SDK

New-Brokerdelayedhostingpoweraction

August 3, 2023

Contributed by:

Causes a power action to be queued after a delay.

Syntax

New-BrokerDelayedHostingPowerAction [-MachineName] <String> -Action <PowerManagementAction> -Delay <TimeSpan> [-LoggingId <Guid>] [-AdminAddress <String>] [-BearerToken <String>] [-TraceParent <String>] [-TraceState <String>] [-VirtualSiteId <String>] [<CommonParameters>]
<!--NeedCopy-->

Detailed Description

Causes a power action to be queued after the specified period of time.

Only ShutDown or Suspend actions can be requested to be delayed in this manner.

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

Parameters

Name	Description	Required?	Pipeline Input	Default Value
MachineName	Specifies the machine that the action is to be performed on.
The machine can be identified by DNS name, short name, SID, or name of the form domain\machine.	true	true (ByPropertyName)
Action	Specifies the power state change action that is to be performed on the specified machine after the specified delay.
Valid values are Shutdown and Suspend.	true	true (ByPropertyName)
Delay	Specifies a timespan delay before the action is queued.	true	true (ByPropertyName)
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.	false	false
AdminAddress	Specifies the address of a XenDesktop controller that the PowerShell snapin will connect to. This can be provided as a host name or an IP address.	false	false	Localhost. Once a value is provided by any cmdlet, this value will become the default.
BearerToken	Specifies the bearer token assigned to the calling user	false	false
TraceParent	Specifies the trace parent assigned for internal diagnostic tracing use	false	false
TraceState	Specifies the trace state assigned for internal diagnostic tracing use	false	false
VirtualSiteId	Specifies the virtual site the PowerShell snap-in will connect to.	false	false

Input Type

None

You cannot pipe input into this cmdlet.

Return Values

Citrix.Broker.Admin.Sdk.Delayedhostingpoweraction

New-BrokerDelayedHostingPowerAction returns the created delayed power action.

Examples

Example 1

C:\PS> New-BrokerDelayedHostingPowerAction -Action Shutdown -MachineName 'XD_VDA1' -Delay '00:02:00'
<!--NeedCopy-->

Description

Causes the machine called XD_VDA1 to be shut down after a delay of two minutes.

The official version of this content is in English. Some of the Cloud Software Group documentation content is machine translated for your convenience only. Cloud Software Group has no control over machine-translated content, which may contain errors, inaccuracies or unsuitable language. No warranty of any kind, either expressed or implied, is made as to the accuracy, reliability, suitability, or correctness of any translations made from the English original into any other language, or that your Cloud Software Group product or service conforms to any machine translated content, and any warranty provided under the applicable end user license agreement or terms of service, or any other agreement with Cloud Software Group, that the product or service conforms with any documentation shall not apply to the extent that such documentation has been machine translated. Cloud Software Group will not be held responsible for any damage or issues that may arise from using machine-translated content.

Was this helpful

New-Brokerdelayedhostingpoweraction

August 3, 2023

Contributed by:

August 3, 2023

Contributed by:

New-Brokerdelayedhostingpoweraction

Syntax

Detailed Description

Related Commands

Parameters

Input Type

None

Return Values

Citrix.Broker.Admin.Sdk.Delayedhostingpoweraction

Examples

Example 1

Description

In this article