Set-NCSIPolicyConfiguration

Set-NCSIPolicyConfiguration

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

Syntax

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

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

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

Parameters

-AsJob

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

-CorporateDNSProbeHostAddress<String>

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

-CorporateDNSProbeHostName<String>

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 https://contoso.com

-CorporateSitePrefixList<String>

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

-CorporateWebsiteProbeURL<String>

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 https://contoso.com

-DomainLocationDeterminationURL<String>

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

-GPOSession<String>

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.

-InputObject<CimInstance>

Accepts an object from the pipeline as input.

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

-PolicyStore<String>

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.

-ThrottleLimit<Int32>

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.

-Confirm

Prompts you for confirmation before running the cmdlet.

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.

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

• Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_NCSIConfiguration

  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

The output type is the type of the objects that the cmdlet emits.

• None

Examples

EXAMPLE 1

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

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

EXAMPLE 2

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

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

EXAMPLE 3

This example performs an identical operation using dot notation.

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

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

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

Related topics

Get-DAConnectionStatus

Get-NCSIPolicyConfiguration

Reset-NCSIPolicyConfiguration