Edit

Share via

Set-CMConfigurationItem

  • Reference
Module:
ConfigurationManager

Changes settings for a Configuration Manager configuration item.

Syntax

Set-CMConfigurationItem
   [-AddCategory <String[]>]
   [-Description <String>]
   [-Digest <ConfigurationItem>]
   [-DigestPath <String>]
   [-DigestXml <String>]
   [-Id] <Int32>
   [-NewName <String>]
   [-PassThru]
   [-RemoveCategory <String[]>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMConfigurationItem
   [-AddCategory <String[]>]
   [-Description <String>]
   [-Digest <ConfigurationItem>]
   [-DigestPath <String>]
   [-DigestXml <String>]
   [-Name] <String>
   [-NewName <String>]
   [-PassThru]
   [-RemoveCategory <String[]>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMConfigurationItem
   [-AddCategory <String[]>]
   [-Description <String>]
   [-Digest <ConfigurationItem>]
   [-DigestPath <String>]
   [-DigestXml <String>]
   [-InputObject] <IResultObject>
   [-NewName <String>]
   [-PassThru]
   [-RemoveCategory <String[]>]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-CMConfigurationItem cmdlet changes settings for a 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.

Note

Run Configuration Manager cmdlets from the Configuration Manager site drive, for example PS XYZ:\>. For more information, see getting started.

Examples

Example 1: Change the name of a configuration item

PS XYZ:\> Set-CMConfigurationItem -Name "CITest" -NewName "CITest01"

This command changes the name of the configuration item named CITest to CITest01.

Example 2: Set item settings

PS XYZ:\> Set-CMConfigurationItem -Name "CITest01" -SecurityScopeAction AddMembership -SecurityScopeName "DefaultScope"

This command sets the security scope action to AddMembership and the security scope name to DefaultScope for the item named CITest01.

Example 3: Change item settings

PS XYZ:\> Set-CMConfigurationItem -Name "CITest01" -SecurityScopeAction RemoveMembership -SecurityScopeName "DefaultScope"

This command sets the security scope action to RemoveMembership and the security scope name to DefaultScope for the item named CITest01.

Parameters

-AddCategory

Specifies an array of localized names of the categories to which the configuration item belongs.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Confirm

Prompts you for confirmation before running the cmdlet.

Type:SwitchParameter
Aliases:cf
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Description

Specifies a description for a configuration item.

Type:String
Aliases:LocalizedDescription
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Digest

Specifies the Digest that contain the configuration item.

Type:ConfigurationItem
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DigestPath

Specifies the path of the Digest.

Type:String
Aliases:DesiredConfigurationDigestPath
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DigestXml

Specifies the XML definition.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DisableWildcardHandling

This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ForceWildcardHandling

This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Id

Specifies an array of identifiers for one or more configuration items. You can use a comma separated list.

Type:Int32
Aliases:CIId, CI_ID
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-InputObject

Specifies a configuration item object. To obtain a configuration item object, you can use the Get-CMConfigurationItem cmdlet.

Type:IResultObject
Position:0
Default value:None
Required:True
Accept pipeline input:True
Accept wildcard characters:False

-Name

Specifies an array of names for configuration items.

Type:String
Aliases:LocalizedDisplayName
Position:0
Default value:None
Required:True
Accept pipeline input:False
Accept wildcard characters:False

-NewName

Specifies a new name for a configuration item.

Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-PassThru

Returns the current working object. By default, this cmdlet does not generate any output.

Type:SwitchParameter
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-RemoveCategory

Specifies an array of localized names of the categories from which to remove the configuration item.

Type:String[]
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-WhatIf

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

Type:SwitchParameter
Aliases:wi
Position:Named
Default value:False
Required:False
Accept pipeline input:False
Accept wildcard characters:False

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object