Invoke-CMUserCollectionUpdate
Invoke-CMUserCollectionUpdate
Invokes an update to a user collection.
Syntax
Parameter Set: SearchByIdMandatory
Invoke-CMUserCollectionUpdate -CollectionId <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Invoke-CMUserCollectionUpdate -Name <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Invoke-CMUserCollectionUpdate -InputObject <IResultObject> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Invoke-CMUserCollectionUpdate cmdlet invokes an update to a user collection.
User collections represent logical groupings of users in Microsoft System Center 2012 Configuration Manager, such as the default All Users collection and All User Groups collection.
Parameters
-CollectionId<String>
Specifies a collection ID in Configuration Manager.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a CMUserCollectionUpdate object. To obtain a CMUserCollectionUpdate object, use the Get-CMUserCollection cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies a name of a user collection.
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 user collection update
This command invokes an update of the All Local Users collection.
PS C:\> Invoke-CMUserCollectionUpdate -Name “All Local Users”