Edit

Set-NCSIPolicyConfiguration

  • Reference
Module:
NetworkConnectivity

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

Syntax

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

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

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

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

EXAMPLE 2

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

This example performs the same operation as EXAMPLE 1 using pipelining.

EXAMPLE 3

PS C:\>$Object = Get-NCSIPolicyConfiguration -PolicyStore "contoso\User1"



PS C:\>$Object.CorporateWebsiteProbe = http://ncsi.corp.microsoft.com



PS C:\>Set-NCSIPolicyConfiguration -InputObject $Object

This example performs an identical operation using dot notation.

Parameters

-AsJob

ps_cimcommon_asjob

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-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227967 or Get-CimSessionhttp://go.microsoft.com/fwlink/p/?LinkId=227966 cmdlet. The default is the current session on the local computer.

Type:CimSession
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
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:2
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 PC 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:3
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:4
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:5
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:6
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.

This is a common parameter across networking with very little difference between them.

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

-InputObject

Accepts an object from the pipeline as input.

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

-PassThru

Sends items from the interactive window down the pipeline as input to other cmdlets. By default, this cmdlet does not generate any output. This parameter is equivalent to using the Multiple value of the OutputMode parameter.

To send items from the interactive window down the pipeline, click to select the items and then click OK. Shift-click and Ctrl-click are supported.

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

This is a common parameter across networking with very little difference between them.

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
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