Set-CMSystemHealthValidatorPointComponent
Set-CMSystemHealthValidatorPointComponent
Modifies settings of a Configuration Manager system health validator point.
Syntax
Parameter Set: SearchBySiteCodeMandatory
Set-CMSystemHealthValidatorPointComponent -SiteCode <String> [-Date <DateTime> ] [-DesignateActiveDirectoryForest <Boolean> ] [-DomainSuffix <String> ] [-PublishAccount <String> ] [-QueryAccount <String> ] [-QueryInterval <Int32> ] [-Time <DateTime> ] [-UseDateTime <Boolean> ] [-ValidityPeriod <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByNameMandatory
Set-CMSystemHealthValidatorPointComponent -Name <String> [-Date <DateTime> ] [-DesignateActiveDirectoryForest <Boolean> ] [-DomainSuffix <String> ] [-PublishAccount <String> ] [-QueryAccount <String> ] [-QueryInterval <Int32> ] [-Time <DateTime> ] [-UseDateTime <Boolean> ] [-ValidityPeriod <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Parameter Set: SearchByValueMandatory
Set-CMSystemHealthValidatorPointComponent -InputObject <IResultObject> [-Date <DateTime> ] [-DesignateActiveDirectoryForest <Boolean> ] [-DomainSuffix <String> ] [-PublishAccount <String> ] [-QueryAccount <String> ] [-QueryInterval <Int32> ] [-Time <DateTime> ] [-UseDateTime <Boolean> ] [-ValidityPeriod <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>]
Detailed Description
The Set-CMSystemHealthValidatorPointComponent cmdlet modifies settings of a system health validator point. A system health validator point is a Microsoft System Center 2012 Configuration Manager site system role that evaluates system health information reported by Windows clients for security related compliance.
You can modify whether the system health validator point uses the current Active Directory forest or a designated forest. You can specify the accounts that the component uses to publish and query Active Directory Domain Services (AD DS). You can set the validity period for cached statements of health and whether to accept statements of health only after a specific time. Any changes you make apply to all system health validator points in the System Center 2012 Configuration Manager site.
To specify a system health validator point to modify, specify a site code or name, or you can use the Get-CMSystemHealthValidatorPointComponent cmdlet to get a system health validator point to modify.
Parameters
-Date<DateTime>
Specifies a date, as a DateTime object. To obtain a DateTime object, use the Get-DateTime cmdlet. For more information, type "Get-Help Get-DateTime
".
If you specify a value of $True for the UseDateTime parameter, a client must create a statement of health after the date and time specified by using this parameter and the Time parameter. The date and time must be in the past.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DesignateActiveDirectoryForest<Boolean>
Indicates whether the site system server and the system health validator points are in different Active Directory forests. If the value is $True, specify an Active Directory forest by using the DomainSuffix parameter. If no trust relationship exists between the forests, you may need to specify accounts by using the PublishAccount and QueryAccount parameters.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-DomainSuffix<String>
Specifies a domain suffix for a designated Active Directory forest. If no trust relationship exists between this forest and the site system server forest, you may need to specify accounts by using the PublishAccount and QueryAccount parameters.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-InputObject<IResultObject>
Specifies a system health validator point object. To obtain a system health validator point, use the Get-CMSystemHealthValidatorPointComponent cmdlet.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Name<String>
Specifies the name of a system health validator point.
Aliases |
SiteName |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-PublishAccount<String>
Specifies a health state reference publishing account, in the format Domain\User. If you do not specify an account, the component uses the site system server account.
You must specify an account if no trust relationship exists between the site server domain and the domain suffix specified in the DomainSuffix parameter or if there is a trust relationship, but the site system server account lacks Full Control permission for the System Management Active Directory container.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-QueryAccount<String>
Specifies an account, in the format Domain\User, that the system health validator point uses to query AD DS for state references. If you do not specify an account, the component uses the site system server account.
You must specify an account if no trust relationship exists between the site server domain and the domain suffix specified in the DomainSuffix parameter.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-QueryInterval<Int32>
Specifies how often, in minutes, system health validator points get health state references. The acceptable values for this parameter are: 1 to 10080 minutes (7 days). The default value is 120 minutes.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-SiteCode<String>
Specifies a site code in Configuration Manager.
Aliases |
none |
Required? |
true |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-Time<DateTime>
Specifies a time, as a DateTime object. To obtain a DateTime object, use the Get-DateTime cmdlet. For more information, type "Get-Help Get-DateTime
".
If you specify a value of $True for the UseDateTime parameter, a client must create a statement of health after the date and time specified by using this parameter and the Date parameter. The date and time must be in the past.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-UseDateTime<Boolean>
Indicates whether a client must create a statement of health after a specific date and time. If you select a value of $True, specify the date and time by using the Date and Time parameters. The date and time must be in the past. The default value for this parameter is $False.
Aliases |
none |
Required? |
false |
Position? |
named |
Default Value |
none |
Accept Pipeline Input? |
True (ByPropertyName) |
Accept Wildcard Characters? |
false |
-ValidityPeriod<Int32>
Specifies the length of time, in hours, for which system health validator points accept a cached client statement of health. The acceptable values for this parameter are: 1 to 168 hours (7 days). The default value is 26 hours.
Aliases |
none |
Required? |
false |
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: Modify settings of a system health validator point by using a name
This command modifies settings of a system health validator point named SHVPC02.Western.Contoso.com. The command changes the query interval to 60 minutes and the validity period to 24 hours.
PS C:\> Set-CMSystemHealthValidatorPointComponent -Name "SHVPC02.Western.Contoso.com" -QueryInterval 60 -ValidityPeriod 24
Related topics
Get-CMSystemHealthValidatorPointComponent
Set-CMCollectionMembershipEvaluationComponent
Set-CMEmailNotificationComponent
Set-CMManagementPointComponent
Set-CMOutOfBandManagementComponent