Edit

Share via

Set-CMClientSettingSoftwareInventory

  • Reference
Module:
ConfigurationManager

Sets a client setting software inventory.

Syntax

Set-CMClientSettingSoftwareInventory
   [-AddCollectFile <Hashtable[]>]
   [-AddInventoryFileType <Hashtable[]>]
   [-CleanCollectFile]
   [-CleanInventoryFileType]
   [-Enable <Boolean>]
   [-FileDisplayName <String>]
   [-FileInventoriedName <String>]
   [-FileName <String>]
   [-RemoveCollectFile <Hashtable[]>]
   [-RemoveInventoryFileType <Hashtable[]>]
   [-ReportOption <ReportOptionType>]
   [-Schedule <IResultObject>]
   -Name <String>
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMClientSettingSoftwareInventory
   [-AddCollectFile <Hashtable[]>]
   [-AddInventoryFileType <Hashtable[]>]
   [-CleanCollectFile]
   [-CleanInventoryFileType]
   [-Enable <Boolean>]
   [-FileDisplayName <String>]
   [-FileInventoriedName <String>]
   [-FileName <String>]
   [-RemoveCollectFile <Hashtable[]>]
   [-RemoveInventoryFileType <Hashtable[]>]
   [-ReportOption <ReportOptionType>]
   [-Schedule <IResultObject>]
   [-DefaultSetting]
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-CMClientSettingSoftwareInventory
   [-AddCollectFile <Hashtable[]>]
   [-AddInventoryFileType <Hashtable[]>]
   [-CleanCollectFile]
   [-CleanInventoryFileType]
   [-Enable <Boolean>]
   [-FileDisplayName <String>]
   [-FileInventoriedName <String>]
   [-FileName <String>]
   [-RemoveCollectFile <Hashtable[]>]
   [-RemoveInventoryFileType <Hashtable[]>]
   [-ReportOption <ReportOptionType>]
   [-Schedule <IResultObject>]
   -InputObject <IResultObject>
   [-PassThru]
   [-DisableWildcardHandling]
   [-ForceWildcardHandling]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

Note

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

Examples

Example 1

Activate Software Inventory for "My custom setting" and set a recurring schedule for every first Sunday of every month. Also, add .exe as inventory file type with the default inventory settings.

PS XYZ:\>$inventoryFileTypeTable = @{FileName="*.exe";ExcludeWindirAndSubfolders=$True;ExcludeEncryptedAndCompressedFiles=$True;Subdirectories=$True;Path='All client hard disks'}
PS XYZ:\>$schedule = New-CMSchedule -Start '2022-01-01 04:00' -DayOfWeek Sunday -WeekOrder First
PS XYZ:\>Set-CMClientSettingSoftwareInventory -Name 'My custom setting' -Enable $true -Schedule $schedule -AddInventoryFileType $inventoryFileTypeTable

Parameters

-AddCollectFile

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

-AddInventoryFileType

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

-CleanCollectFile

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

-CleanInventoryFileType

Type:SwitchParameter
Aliases:CleanInventoryFileTypes
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:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-DefaultSetting

Type:SwitchParameter
Position:Named
Default value:None
Required:True
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

-Enable

Type:Boolean
Aliases:EnableSoftwareInventory
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-FileDisplayName

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

-FileInventoriedName

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

-FileName

Type:String
Aliases:SoftwareInventoryFileName
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

-InputObject

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

-Name

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

-PassThru

Returns an object representing the item with which you are working. By default, this cmdlet may not generate any output.

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

-RemoveCollectFile

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

-RemoveInventoryFileType

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

-ReportOption

Type:ReportOptionType
Accepted values:None, ProductOnly, FileOnly, FullDetail
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-Schedule

Type:IResultObject
Aliases:InventorySchedule, SoftwareInventorySchedule
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 doesn't run.

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

Inputs

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object