New-BrokerDelayedHostingPowerAction
Causes a power action to be queued after a delay.
Syntax
New-BrokerDelayedHostingPowerAction
-Action <PowerManagementAction>
-Delay <TimeSpan>
[-MachineName] <String>
[-LoggingId <Guid>]
[<CitrixCommonParameters>]
[<CommonParameters>]
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'.
Examples
EXAMPLE 1
Causes the machine called XD_VDA1 to be shut down after a delay of two minutes.
New-BrokerDelayedHostingPowerAction -Action Shutdown -MachineName 'XD_VDA1' -Delay '00:02:00'
Parameters
-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.
| Type: | String |
| Position: | 2 |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | True |
-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.
| Type: | PowerManagementAction |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| Accept wildcard characters: | False |
-Delay
Specifies a timespan delay before the action is queued.
| Type: | TimeSpan |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True (ByPropertyName) |
| 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
None
You cannot pipe input into this cmdlet.
Outputs
Citrix.Broker.Admin.SDK.DelayedHostingPowerAction
New-BrokerDelayedHostingPowerAction returns the created delayed power action.