Invoke-CMClientNotification

Invoke-CMClientNotification

Sends a notification to client computers to trigger an immediate client action.

Syntax

Parameter Set: SearchByDeviceIdMandatory
Invoke-CMClientNotification -DeviceId <String> [-NotificationType <ClientNotificationType> {RequestMachinePolicyNow | RequestUsersPolicyNow} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDeviceNameMandatory
Invoke-CMClientNotification -DeviceName <String> [-NotificationType <ClientNotificationType> {RequestMachinePolicyNow | RequestUsersPolicyNow} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByDeviceValueMandatory
Invoke-CMClientNotification -Device <IResultObject> [-NotificationType <ClientNotificationType> {RequestMachinePolicyNow | RequestUsersPolicyNow} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByIdMandatory
Invoke-CMClientNotification -DeviceCollectionId <String> [-NotificationType <ClientNotificationType> {RequestMachinePolicyNow | RequestUsersPolicyNow} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByNameMandatory
Invoke-CMClientNotification -DeviceCollectionName <String> [-NotificationType <ClientNotificationType> {RequestMachinePolicyNow | RequestUsersPolicyNow} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Parameter Set: SearchByValueMandatory
Invoke-CMClientNotification -DeviceCollection <IResultObject> [-NotificationType <ClientNotificationType> {RequestMachinePolicyNow | RequestUsersPolicyNow} ] [-Confirm] [-WhatIf] [ <CommonParameters>]

Detailed Description

The Invoke-CMClientNotification 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.

Parameters

-Device<IResultObject>

Specifies a CMDevice object. To obtain a CMDevice object, use the Get-CMDevice cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceCollection<IResultObject>

Specifies a CMDeviceCollection object. To obtain a CMDeviceCollection object, use the Get-CMDeviceCollection cmdlet.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceCollectionId<String>

Specifies the ID of a device collection.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceCollectionName<String>

Specifies the name of a device collection.

Aliases

none

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceId<String>

Specifies the ID of a device.

Aliases

ResourceID

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-DeviceName<String>

Specifies a device name. You can specify a NetBIOS name or a fully qualified domain name (FQDN).

Aliases

Name

Required?

true

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-NotificationType<ClientNotificationType>

Specifies the type of notification to send. Valid values are:

-- RequestMachinePolicyNow. The client computer requests the latest machine policy from the management point. Machine policy includes configuration settings for a computer, or software updates that are deployed to a computer.
-- RequestUsersPolicyNow. The client computer requests the latest user policy from the management point. User policy includes applications or packages deployed for a user.

Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

True (ByPropertyName)

Accept Wildcard Characters?

false

-Confirm

Prompts you for confirmation before running the cmdlet.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

Required?

false

Position?

named

Default Value

false

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

<CommonParameters>

This cmdlet supports the common parameters: -Verbose, -Debug, -ErrorAction, -ErrorVariable, -OutBuffer, and -OutVariable. For more information, see    about_CommonParameters (https://go.microsoft.com/fwlink/p/?LinkID=113216).

Inputs

The input type is the type of the objects that you can pipe to the cmdlet.

Outputs

The output type is the type of the objects that the cmdlet emits.

Examples

Example: Send a notification to trigger an event

This command sends a notification of the type RequestMachinePolicyNow to the device named Computer073.

PS C:\> Invoke-CMClientNotification -DeviceName "Computer073" -NotificationType RequestMachinePolicyNow

Get-CMDevice

Get-CMDeviceCollection