Get-CMConfigurationItem
Gets Configuration Manager configuration items.
Syntax
SearchByName (Default)
Get-CMConfigurationItem
[[-Name] <String>]
[-Fast]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
SearchByIdMandatory
Get-CMConfigurationItem
[-Id] <Int32>
[-Fast]
[-DisableWildcardHandling]
[-ForceWildcardHandling]
[<CommonParameters>]
Description
The Get-CMConfigurationItem cmdlet gets configuration item objects in Configuration Manager. You can use this cmdlet to get items for other cmdlets to use. For instance, you might get configuration items so you can use the Set-CMConfigurationItem to change settings on them.
Configuration items contain one or more settings, along with compliance rules. 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: Get an item using a name
PS XYZ:\> Get-CMConfigurationItem -Name "ConfigItem76"
This command gets a configuration item named ConfigItem76.
Example 2: Get an item to use with another cmdlet
PS XYZ:\> $CIObj=Get-CMConfigurationItem -Id "16777568"
PS XYZ:\> Remove-CMConfigurationItem -InputObject $CIObj
The first command gets a configuration item with the specified identifier and stores it in the $CIObj variable.
The second command removes the item in the $CIObj variable.
Parameters
-DisableWildcardHandling
This parameter treats wildcard characters as literal character values. You can't combine it with ForceWildcardHandling.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Fast
Indicates that the cmdlet does not automatically refresh lazy properties.
Lazy properties contain values that are relatively inefficient to retrieve which can cause additional network traffic and decrease cmdlet performance. If lazy properties are not needed, this parameter should be specified.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-ForceWildcardHandling
This parameter processes wildcard characters and may lead to unexpected behavior (not recommended). You can't combine it with DisableWildcardHandling.
Parameter properties
Type: | SwitchParameter |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Parameter sets
(All)
Position: | Named |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Id
Specifies an array of identifiers for one or more configuration items. You can use a comma separated list.
Parameter properties
Type: | Int32 |
Default value: | None |
Supports wildcards: | False |
DontShow: | False |
Aliases: | CIId, CI_ID |
Parameter sets
SearchByIdMandatory
Position: | 0 |
Mandatory: | True |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
-Name
Specifies an array of names of configuration items. You can use a comma separated list.
Parameter properties
Type: | String |
Default value: | None |
Supports wildcards: | True |
DontShow: | False |
Aliases: | LocalizedDisplayName |
Parameter sets
SearchByName
Position: | 0 |
Mandatory: | False |
Value from pipeline: | False |
Value from pipeline by property name: | False |
Value from remaining arguments: | False |
CommonParameters
This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutBuffer, -OutVariable, -PipelineVariable, -ProgressAction, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.
Inputs
None
Outputs
IResultObject
IResultObject
Related Links
- Introduction to Compliance Settings in Configuration Manager
- Get-CMConfigurationItemXMLDefinition
- Get-CMConfigurationItemHistory
- New-CMConfigurationItem
- Set-CMConfigurationItem
- Remove-CMConfigurationItem
- Import-CMConfigurationItem
- Export-CMConfigurationItem
- ConvertTo-CMConfigurationItem
- ConvertFrom-CMConfigurationItem