Invoke-CMClientAction
Sends a notification to client computers to trigger an immediate client action.
Syntax
Invoke-CMClientAction
[-ActionType <ClientActionType>]
-Collection <IResultObject>
[-NotificationType <ClientNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMClientAction
[-ActionType <ClientActionType>]
-DeviceName <String>
[-NotificationType <ClientNotificationType>]
[-ParentCollection <IResultObject>]
[-ParentCollectionId <String>]
[-ParentCollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMClientAction
[-ActionType <ClientActionType>]
-DeviceId <String>
[-NotificationType <ClientNotificationType>]
[-ParentCollection <IResultObject>]
[-ParentCollectionId <String>]
[-ParentCollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMClientAction
[-ActionType <ClientActionType>]
-Device <IResultObject>
[-NotificationType <ClientNotificationType>]
[-ParentCollection <IResultObject>]
[-ParentCollectionId <String>]
[-ParentCollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMClientAction
[-ActionType <ClientActionType>]
-CollectionName <String>
[-NotificationType <ClientNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Invoke-CMClientAction
[-ActionType <ClientActionType>]
-CollectionId <String>
[-NotificationType <ClientNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>] Description
The Invoke-CMClientAction cmdlet sends a notification to client computers to trigger an immediate client action. You can specify one or more client computers, or send a notification to all the computers in a specified device collection.
For more information about these actions, see Client notification.
Note
Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.
Examples
Example 1: Wake up a device
The following example sends the wake-up action to a device in a specific collection:
Invoke-CMClientAction -DeviceName "SleepDevice01" -ActionType ClientNotificationWakeUpClientNow -ParentCollectionId $col.CollectionIDExample 2: Request machine policy from a device
This command sends a notification of the type RequestMachinePolicyNow to the device named Computer073.
Invoke-CMClientAction -DeviceName "Computer073" -NotificationType RequestMachinePolicyNowParameters
-ActionType
Specify an action keyword to send to the client. To request machine or user policy, use the -NotificationType parameter.
| Type: | ClientActionType |
| Accepted values: | None, EndpointProtectionFullScan, EndpointProtectionQuickScan, EndpointProtectionDownloadDefinition, EndpointProtectionEvaluateSoftwareUpdate, EndpointProtectionExcludeScanPaths, EndpointProtectionAllowThreat, EndpointProtectionRestoreQuarantinedItems, ClientNotificationRequestMachinePolicyNow, ClientNotificationRequestUsersPolicyNow, ClientNotificationRequestDDRNow, ClientNotificationRequestSWInvNow, ClientNotificationRequestHWInvNow, ClientNotificationAppDeplEvalNow, ClientNotificationSUMDeplEvalNow, ClientRequestSUPChangeNow, ClientRequestDHAChangeNow, ClientNotificationRebootMachine, DiagnosticsEnableVerboseLogging, DiagnosticsDisableVerboseLogging, DiagnosticsCollectFiles, EndpointProtectionRestoreWithDeps, ClientNotificationCheckComplianceNow, RequestScriptExecution, RequestCMPivotExecution, ClientNotificationWakeUpClientNow |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Collection
Specify a collection object to target.
| Type: | IResultObject |
| Aliases: | DeviceCollection |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-CollectionId
Specify a collection by ID to target.
| Type: | String |
| Aliases: | DeviceCollectionId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-CollectionName
Specify a collection by name to target.
| Type: | String |
| Aliases: | DeviceCollectionName |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Confirm
Prompts you for confirmation before running the cmdlet.
| Type: | SwitchParameter |
| Aliases: | cf |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-Device
Specify a device object to target.
| Type: | IResultObject |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | True |
| Accept wildcard characters: | False |
-DeviceId
Specify a device by ID to target.
| Type: | String |
| Aliases: | ResourceId |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DeviceName
Specify a device by name to target.
| Type: | String |
| Aliases: | Name |
| Position: | Named |
| Default value: | None |
| Required: | True |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
| Type: | SwitchParameter |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-NotificationType
Request machine or user policy from a client. To trigger all other actions, use the -ActionType parameter.
| Type: | ClientNotificationType |
| Accepted values: | RequestMachinePolicyNow, RequestUsersPolicyNow |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ParentCollection
Use this parameter to support waking up a machine.
| Type: | IResultObject |
| Aliases: | ParentDeviceCollection |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ParentCollectionId
Use this parameter to support waking up a machine.
| Type: | String |
| Aliases: | ParentDeviceCollectionId |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-ParentCollectionName
Use this parameter to support waking up a machine.
| Type: | String |
| Aliases: | ParentDeviceCollectionName |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
-WhatIf
Shows what would happen if the cmdlet runs. It doesn't run the cmdlet.
| Type: | SwitchParameter |
| Aliases: | wi |
| Position: | Named |
| Default value: | None |
| Required: | False |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object
Notes
Cmdlet aliases: Invoke-CMClientNotification