Set-CMConfigurationItem
Set-CMConfigurationItem
Changes settings for a Configuration Manager configuration item.
Syntax
Parameter Set: SetByIdMandatory
Set-CMConfigurationItem -Id <String[]> [-AddCategory <String[]> ] [-Description <String> ] [-DesiredConfigurationDigestPath <String> ] [-NewName <String> ] [-RemoveCategory <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetByNameMandatory
Set-CMConfigurationItem -Name <String[]> [-AddCategory <String[]> ] [-Description <String> ] [-DesiredConfigurationDigestPath <String> ] [-NewName <String> ] [-RemoveCategory <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetByValueMandatory
Set-CMConfigurationItem -InputObject <IResultObject> [-AddCategory <String[]> ] [-Description <String> ] [-DesiredConfigurationDigestPath <String> ] [-NewName <String> ] [-RemoveCategory <String[]> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetSecurityScopeById
Set-CMConfigurationItem -Id <String[]> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetSecurityScopeByName
Set-CMConfigurationItem -Name <String[]> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SetSecurityScopeByValue
Set-CMConfigurationItem -InputObject <IResultObject> -SecurityScopeAction <SecurityScopeActionType> {AddMembership | RemoveMembership} -SecurityScopeName <String> [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-CMConfigurationItem cmdlet changes settings for a Microsoft System Center 2012 SP1 Configuration Manager configuration item.
Configuration items contain one or more settings, along with compliance rules. Items usually define a unit of configuration you want to monitor. For more information about configuration items, see Introduction to Compliance Settings in Configuration Manager (https://go.microsoft.com/fwlink/?LinkId=211014) on TechNet.
Parameters
-AddCategory<String[]>
Specifies an array of localized names of the categories to which the configuration item belongs.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Description<String>
Specifies a description for a configuration item.
Aliases |
LocalizedDescription |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DesiredConfigurationDigestPath<String>
Specifies a path and file name for the digest file of this configuration item.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Id<String[]>
Specifies an array of identifiers for one or more configuration items. You can use a comma separated list.
Aliases |
CIId |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a configuration item object. To obtain a configuration item object, you can use the Get-CMConfigurationItem cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String[]>
Specifies an array of names for configuration items.
Aliases |
LocalizedDisplayName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-NewName<String>
Specifies a new name for a configuration item.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-RemoveCategory<String[]>
Specifies an array of localized names of the categories from which to remove the configuration item.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SecurityScopeAction<SecurityScopeActionType>
Specifies an action for a security scope. The acceptable values for this parameter are:
-- AddMembership
-- RemoveMembership
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SecurityScopeName<String>
Specifies the name of a security scope. A security scope name can be Default or the name of a custom security scope.
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: Change the name of a configuration item
This command changes the name of the configuration item named CITest to CITest01.
PS C:\> Set-CMConfigurationItem -Name "CITest" -NewName "CITest01"
Example 2: Set item settings
This command sets the security scope action to AddMembership and the security scope name to DefaultScope for the item named CITest01.
PS C:\> Set-CMConfigurationItem -Name "CITest01" -SecurityScopeAction AddMembership -SecurityScopeName "DefaultScope"
Example 3: Change item settings
This command sets the security scope action to RemoveMembership and the security scope name to DefaultScope for the item named CITest01.
PS C:\> Set-CMConfigurationItem -Name "CITest01" -SecurityScopeAction RemoveMembership -SecurityScopeName "DefaultScope"
Related topics
Get-CMConfigurationItemXMLDefinition
Get-CMConfigurationItemHistory
Introduction to Compliance Settings in Configuration Manager