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> ] [-CimSession <CimSession[]> ] [-GPOSession <String> ] [-PassThru] [-PolicyStore <String> ] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]

Parameter Set: InputObject (cdxml)
Set-NCSIPolicyConfiguration [[-CorporateDNSProbeHostAddress] <String> ] [[-CorporateDNSProbeHostName] <String> ] [[-CorporateSitePrefixList] <String[]> ] [[-CorporateWebsiteProbeURL] <String> ] [[-DomainLocationDeterminationURL] <String> ] [-CimSession <CimSession[]> ] [-PassThru] [-ThrottleLimit <Int32> ] [-Confirm] [-WhatIf] [ <CommonParameters>] [ <WorkflowParameters>]




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

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


Aliases

Session

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

2

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-CorporateDNSProbeHostName<String>

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.


Aliases

none

Required?

false

Position?

3

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

4

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

5

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

6

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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.


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

-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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

Accept Wildcard Characters?

false

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


Aliases

none

Required?

false

Position?

named

Default Value

none

Accept Pipeline Input?

false

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: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see    about_CommonParameters.

<WorkflowParameters>

This cmdlet supports the following workflow common parameters: -PSParameterCollection, -PSComputerName, -PSCredential, -PSConnectionRetryCount, -PSConnectionRetryIntervalSec, -PSRunningTimeoutSec, -PSElapsedTimeoutSec, -PSPersist, -PSAuthentication, -PSAuthenticationLevel, -PSApplicationName, -PSPort, -PSUseSSL, -PSConfigurationName, -PSConnectionURI, -PSAllowRedirection, -PSSessionOption, -PSCertificateThumbprint, -PSPrivateMetadata, -AsJob, -JobName, and –InputObject. For more information, see    about_WorkflowCommonParameters.

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: Modify the corporate website probe of a GPO

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


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

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

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


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

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

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


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

Related topics

Community Additions

ADD
Show: