Note
Access to this page requires authorization. You can try signing in or .
Access to this page requires authorization. You can try .
Invoke-CMClientAction
- Module:
- ConfigurationManager Module
Sends a notification to client computers to trigger an immediate client action.
Syntax
SearchByValueMandatory (Default)
Invoke-CMClientAction
-Collection <IResultObject>
[-ActionType <ClientActionType>]
[-NotificationType <ClientNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByDeviceNameMandatory
Invoke-CMClientAction
-DeviceName <String>
[-ActionType <ClientActionType>]
[-NotificationType <ClientNotificationType>]
[-ParentCollection <IResultObject>]
[-ParentCollectionId <String>]
[-ParentCollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByDeviceIdMandatory
Invoke-CMClientAction
-DeviceId <String>
[-ActionType <ClientActionType>]
[-NotificationType <ClientNotificationType>]
[-ParentCollection <IResultObject>]
[-ParentCollectionId <String>]
[-ParentCollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByDeviceValueMandatory
Invoke-CMClientAction
-Device <IResultObject>
[-ActionType <ClientActionType>]
[-NotificationType <ClientNotificationType>]
[-ParentCollection <IResultObject>]
[-ParentCollectionId <String>]
[-ParentCollectionName <String>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByNameMandatory
Invoke-CMClientAction
-CollectionName <String>
[-ActionType <ClientActionType>]
[-NotificationType <ClientNotificationType>]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[-WhatIf]
[-Confirm]
[<CommonParameters>]
SearchByIdMandatory
Invoke-CMClientAction
-CollectionId <String>
[-ActionType <ClientActionType>]
[-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.CollectionID
Example 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 RequestMachinePolicyNow
Parameters
-ActionType
Specify an action keyword to send to the client. To request machine or user policy, use the -NotificationType parameter.
Parameter properties
| Type: | ClientActionType |
| Default value: | None |
| 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 |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-Collection
Specify a collection object to target.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DeviceCollection |
Parameter sets
-CollectionId
Specify a collection by ID to target.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DeviceCollectionId |
Parameter sets
-CollectionName
Specify a collection by name to target.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | DeviceCollectionName |
Parameter sets
-Confirm
Prompts you for confirmation before running the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | cf |
Parameter sets
-Device
Specify a device object to target.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-DeviceId
Specify a device by ID to target.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ResourceId |
Parameter sets
-DeviceName
Specify a device by name to target.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | Name |
Parameter sets
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-NotificationType
Request machine or user policy from a client. To trigger all other actions, use the -ActionType parameter.
Parameter properties
| Type: | ClientNotificationType |
| Default value: | None |
| Accepted values: | RequestMachinePolicyNow, RequestUsersPolicyNow |
| Supports wildcards: | False |
| DontShow: | False |
Parameter sets
-ParentCollection
Use this parameter to support waking up a machine.
Parameter properties
| Type: | IResultObject |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ParentDeviceCollection |
Parameter sets
-ParentCollectionId
Use this parameter to support waking up a machine.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ParentDeviceCollectionId |
Parameter sets
-ParentCollectionName
Use this parameter to support waking up a machine.
Parameter properties
| Type: | String |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | ParentDeviceCollectionName |
Parameter sets
-WhatIf
Shows what would happen if the cmdlet runs. It doesn't run the cmdlet.
Parameter properties
| Type: | SwitchParameter |
| Default value: | None |
| Supports wildcards: | False |
| DontShow: | False |
| Aliases: | wi |
Parameter sets
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
Microsoft.ConfigurationManagement.ManagementProvider.IResultObject
Outputs
System.Object
Notes
Cmdlet aliases: Invoke-CMClientNotification
Related Links
Feedback
Was this page helpful?