Edit

Share via

Set-CMClientSettingComputerAgent

Module:
ConfigurationManager Module

Sets a client setting computer agent.

Syntax

SetCustomSettingByName (Default) 

Set-CMClientSettingComputerAgent
    -Name <String>
    [-AddPortalToTrustedSiteList <Boolean>]
    [-AllowPortalToHaveElevatedTrust <Boolean>]
    [-BrandingTitle <String>]
    [-DisableDeadlineRandom <Boolean>]
    [-DisplayNewProgramNotification <Boolean>]
    [-EnableHealthAttestation <Boolean>]
    [-EnableThirdPartyOrchestration <EnableThirdPartyOrchestrationType>]
    [-FinalReminderMins <Int32>]
    [-HealthAttestationUrl <String>]
    [-InitialReminderHr <Int32>]
    [-InstallRestriction <InstallRestrictionType>]
    [-InterimReminderHr <Int32>]
    [-PortalUrl <String>]
    [-PowerShellExecutionPolicy <PowerShellExecutionPolicyType>]
    [-SelectWebsitePoint <ApplicationCatalogWebsitePointType>]
    [-SuspendBitLocker <SuspendBitLockerType>]
    [-UseNewSoftwareCenter <Boolean>]
    [-UseOnPremisesHealthAttestation <Boolean>]
    [-WebsitePointServerName <String>]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetDefaultSetting 

Set-CMClientSettingComputerAgent
    [-AddPortalToTrustedSiteList <Boolean>]
    [-AllowPortalToHaveElevatedTrust <Boolean>]
    [-BrandingTitle <String>]
    [-DisableDeadlineRandom <Boolean>]
    [-DisplayNewProgramNotification <Boolean>]
    [-EnableHealthAttestation <Boolean>]
    [-EnableThirdPartyOrchestration <EnableThirdPartyOrchestrationType>]
    [-FinalReminderMins <Int32>]
    [-HealthAttestationUrl <String>]
    [-InitialReminderHr <Int32>]
    [-InstallRestriction <InstallRestrictionType>]
    [-InterimReminderHr <Int32>]
    [-PortalUrl <String>]
    [-PowerShellExecutionPolicy <PowerShellExecutionPolicyType>]
    [-SelectWebsitePoint <ApplicationCatalogWebsitePointType>]
    [-SuspendBitLocker <SuspendBitLockerType>]
    [-UseNewSoftwareCenter <Boolean>]
    [-UseOnPremisesHealthAttestation <Boolean>]
    [-WebsitePointServerName <String>]
    [-DefaultSetting]
    [-PassThru]
    [-DisableWildcardHandling]
    [-ForceWildcardHandling]
    [-WhatIf]
    [-Confirm]
    [<CommonParameters>]

SetCustomSettingByValue 

Set-CMClientSettingComputerAgent
    -InputObject <IResultObject>
    [-AddPortalToTrustedSiteList <Boolean>]
    [-AllowPortalToHaveElevatedTrust <Boolean>]
    [-BrandingTitle <String>]
    [-DisableDeadlineRandom <Boolean>]
    [-DisplayNewProgramNotification <Boolean>]
    [-EnableHealthAttestation <Boolean>]
    [-EnableThirdPartyOrchestration <EnableThirdPartyOrchestrationType>]
    [-FinalReminderMins <Int32>]
    [-HealthAttestationUrl <String>]
    [-InitialReminderHr <Int32>]
    [-InstallRestriction <InstallRestrictionType>]
    [-InterimReminderHr <Int32>]
    [-PortalUrl <String>]
    [-PowerShellExecutionPolicy <PowerShellExecutionPolicyType>]
    [-SelectWebsitePoint <ApplicationCatalogWebsitePointType>]
    [-SuspendBitLocker <SuspendBitLockerType>]
    [-UseNewSoftwareCenter <Boolean>]
    [-UseOnPremisesHealthAttestation <Boolean>]
    [-WebsitePointServerName <String>]
    [-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

PS XYZ:\>

Parameters

-AddPortalToTrustedSiteList

Note

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

Parameter properties

Type:Boolean
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

-AllowPortalToHaveElevatedTrust

Note

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

Parameter properties

Type:Boolean
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

-BrandingTitle

Note

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

Parameter properties

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

-Confirm

Prompts you for confirmation before running the cmdlet.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:cf

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DefaultSetting

Note

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

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetDefaultSetting
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-DisableDeadlineRandom

Note

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:DisableDeadlineRandomization

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-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

-DisplayNewProgramNotification

Note

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

Parameter properties

Type:Boolean
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

-EnableHealthAttestation

Note

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:EnableHealthAttestationService

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-EnableThirdPartyOrchestration

Note

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

Parameter properties

Type:EnableThirdPartyOrchestrationType
Default value:None
Accepted values:No, Yes
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

-FinalReminderMins

Note

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:FinalReminderMinutesInterval, FinalReminderMinutes

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

-HealthAttestationUrl

Note

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:OnPremisesHealthAttestationServiceUrl

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InitialReminderHr

Note

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:InitialReminderHoursInterval, InitialReminderHours

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-InputObject

Note

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

Parameter properties

Type:IResultObject
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetCustomSettingByValue
Position:Named
Mandatory:True
Value from pipeline:True
Value from pipeline by property name:False
Value from remaining arguments:False

-InstallRestriction

Note

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

Parameter properties

Type:InstallRestrictionType
Default value:None
Accepted values:AllUsers, OnlyAdministrators, OnlyAdministratorsAndPrimaryUsers, NoUsers
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

-InterimReminderHr

Note

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

Parameter properties

Type:Int32
Default value:None
Supports wildcards:False
DontShow:False
Aliases:InterimReminderHoursInterval, InterimReminderHours

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-Name

Note

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False

Parameter sets

SetCustomSettingByName
Position:Named
Mandatory:True
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-PassThru

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

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

-PortalUrl

Note

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

Parameter properties

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

-PowerShellExecutionPolicy

Note

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

Parameter properties

Type:PowerShellExecutionPolicyType
Default value:None
Accepted values:AllSigned, Bypass, Restricted
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

-SelectWebsitePoint

Don't use this parameter. The application catalog is no longer supported.

Parameter properties

Type:ApplicationCatalogWebsitePointType
Default value:None
Accepted values:Fqdn, AutoDetect, NetBios
Supports wildcards:False
DontShow:False
Aliases:SelectApplicationCatalogWebsitePoint

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-SuspendBitLocker

Note

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

Parameter properties

Type:SuspendBitLockerType
Default value:None
Accepted values:Never, Always
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

-UseNewSoftwareCenter

Note

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

Parameter properties

Type:Boolean
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

-UseOnPremisesHealthAttestation

Note

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

Parameter properties

Type:Boolean
Default value:None
Supports wildcards:False
DontShow:False
Aliases:UseOnPremisesHealthAttestationService

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WebsitePointServerName

Note

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

Parameter properties

Type:String
Default value:None
Supports wildcards:False
DontShow:False
Aliases:ApplicationCatalogWebsitePointServerName

Parameter sets

(All)
Position:Named
Mandatory:False
Value from pipeline:False
Value from pipeline by property name:False
Value from remaining arguments:False

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet doesn't run.

Parameter properties

Type:SwitchParameter
Default value:None
Supports wildcards:False
DontShow:False
Aliases:wi

Parameter sets

(All)
Position:Named
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

Microsoft.ConfigurationManagement.ManagementProvider.IResultObject

Outputs

System.Object