Edit

Share via

Set-NCSIPolicyConfiguration

  • Reference
Module:
NetworkConnectivityStatus

Specifies the policy store from which the cmdlet should pull configuration information.

Syntax

Set-NCSIPolicyConfiguration
   [-PolicyStore <String>]
   [-GPOSession <String>]
   [[-CorporateDNSProbeHostAddress] <String>]
   [[-CorporateDNSProbeHostName] <String>]
   [[-CorporateSitePrefixList] <String[]>]
   [[-CorporateWebsiteProbeURL] <String>]
   [[-DomainLocationDeterminationURL] <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]
Set-NCSIPolicyConfiguration
   -InputObject <CimInstance[]>
   [[-CorporateDNSProbeHostAddress] <String>]
   [[-CorporateDNSProbeHostName] <String>]
   [[-CorporateSitePrefixList] <String[]>]
   [[-CorporateWebsiteProbeURL] <String>]
   [[-DomainLocationDeterminationURL] <String>]
   [-CimSession <CimSession[]>]
   [-ThrottleLimit <Int32>]
   [-AsJob]
   [-PassThru]
   [-WhatIf]
   [-Confirm]
   [<CommonParameters>]

Description

The Set-NCSIPolicyConfiguration cmdlet allows a user to configure NCSI configuration options on a Group Policy Object.

This cmdlet supports getting information from a Group Policy Object, in the form Domain\GPOName.

Examples

Example 1: Modify the corporate website probe of a GPO

PS C:\> Set-NCSIPolicyConfiguration -PolicyStore "contoso\davidchew" -CorporateWebsiteProbe "http://contoso.com"

This command modifies the corporate website probe of the specified GPO.

Example 2: Modify the corporate website probe by using the pipeline

PS C:\> Get-NCSIPolicyConfiguration -PolicyStore "contoso\davidchew" | Set-NCSIPolicyConfiguration -CorporateWebsiteProbe "http://contoso.com"

This command performs the same operation as the first example using the pipeline operator.

Example 2: Modify the corporate website probe by using dot notation

PS C:\> $Object = Get-NCSIPolicyConfiguration -PolicyStore "contoso\davidchew"
PS C:\> $Object.CorporateWebsiteProbe = "http://contoso.com"
PS C:\> Set-NCSIPolicyConfiguration -InputObject $Object

This command performs the same operation as the first example using dot notation.

Parameters

-AsJob

Runs the cmdlet as a background job. Use this parameter to run commands that take a long time to complete.

The cmdlet immediately returns an object that represents the job and then displays the command prompt. You can continue to work in the session while the job completes. To manage the job, use the *-Job cmdlets. To get the job results, use the Receive-Job cmdlet.

For more information about Windows PowerShell background jobs, see about_Jobs.

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

-CimSession

Runs the cmdlet in a remote session or on a remote computer. Enter a computer name or a session object, such as the output of a New-CimSession or Get-CimSession cmdlet. The default is the current session on the local computer.

Type:CimSession[]
Aliases:Session
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

-CorporateDNSProbeHostAddress

Specifies the value to be configured.

This is the expected address of the host name used as for DNS probe. Successful resolution of the host name to this address indicates corporate connectivity, such as 2001::32.

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

-CorporateDNSProbeHostName

Specifies the value to be configured.

This is the host name of a computer known to be on the corporate network. Successful resolution of this host name to the expected address indicates corporate connectivity, such as http://contoso.com.

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

-CorporateSitePrefixList

Specifies the value to be configured.

This is the list of IPv6 corporate site prefixes that should be monitored for corporate connectivity. Reachability of addresses with any of these prefixes indicates corporate connectivity, such as fe90::/9, fe81::/8.

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

-CorporateWebsiteProbeURL

Specifies the value to be configured.

This is the URL of the corporate website that will be used to perform an active probe against, such as http://contoso.com.

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

-DomainLocationDeterminationURL

Specifies the value to be configured.

This is the HTTPS URL of the corporate website that will be used to determine the current domain location, such as inside or outside the corporate domain. Reachability of the URL indicates that the location is inside corporate else it is outside, such as https://contoso.com.

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

-GPOSession

Specifies the Group Policy session for which the cmdlet should pull configuration information from. This parameter can be used in conjunction with the NetGPO cmdlet family to aggregate multiple operations that are performed on a Group Policy Object.

This parameter cannot be used in conjunction with the PolicyStore parameter.

Using this parameter allows multiple cmdlets to be aggregated to run against a local GPO cache.

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

-InputObject

Specifies the input to this cmdlet. You can use this parameter, or you can pipe the input to this cmdlet.

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

-PassThru

Returns an object representing the item with which you are working. 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

-PolicyStore

Specifies the policy store for which the cmdlet should pull configuration information from. This cmdlet supports getting information from a Group Policy Object, in the form Domain\GPOName.

The types of PolicyStore supported by this cmdlet:

  • Domain\GPOName
  • GPO: ComputerName
Type:String
Position:Named
Default value:None
Required:False
Accept pipeline input:False
Accept wildcard characters:False

-ThrottleLimit

Specifies the maximum number of concurrent operations that can be established to run the cmdlet. If this parameter is omitted or a value of 0 is entered, then Windows PowerShell® calculates an optimum throttle limit for the cmdlet based on the number of CIM cmdlets that are running on the computer. The throttle limit applies only to the current cmdlet, not to the session or to the computer.

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

CimInstance

The Microsoft.Management.Infrastructure.CimInstance object is a wrapper class that displays Windows Management Instrumentation (WMI) objects. The path after the pound sign (#) provides the namespace and class name for the underlying WMI object.

Outputs

None