Invoke-CMDeviceCollectionUpdate
Invoke-CMDeviceCollectionUpdate
Starts an update operation for a device collection.
Syntax
Parameter Set: SearchByIdMandatory
Invoke-CMDeviceCollectionUpdate -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Invoke-CMDeviceCollectionUpdate -Name <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Invoke-CMDeviceCollectionUpdate -InputObject <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Invoke-CMDeviceCollectionUpdate cmdlet starts an operation to update the membership of a device collection. This operation discovers new devices in the site hierarchy and adds them to the collection.
Parameters
-CollectionId<String>
Specifies the ID of the device collection that this cmdlet updates.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies the device collection object of the device collection that this cmdlet updates. To obtain a device collection object, use the Get-CMDeviceCollection cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of the device collection that this cmdlet updates.
Aliases |
none |
Required? |
true |
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 1: Invoke a device collection update by using a name
This command starts a device collection update on the device collection named All Systems.
PS C:\> Invoke-CMDeviceCollectionUpdate -Name "All Systems"