Get-NCSIPolicy
Syntax
Get-NCSIPolicyConfiguration
[-PolicyStore <String>]
[-GPOSession <String>]
[-CimSession <CimSession[]>]
[-ThrottleLimit <Int32>]
[-AsJob]
[<CommonParameters>]Description
The Get-NCSIPolicyConfiguration cmdlet gets the Network Connectivity Status indicator configuration on a specified store, either the active store on the local connection or on a Group Policy object.
Examples
Example 1: Get the NCSI configuration of a GPO
PS C:\> Get-NCSIPolicyConfiguration -PolicyStore "contoso\davidchew"
Description : NCSI Configuration
CorporateDNSProbeHostAddress : 2001:4898:1337:1337:1337::1337
CorporateDNSProbeHostName : corp.contoso.com
CorporateSitePrefixList : 2001:4898::/32,2006:1601::/32,2a01:0110::/31
CorporateWebsiteProbeURL : http://web.contoso.com
DomainLocationDeterminationURL : https://io.contoso.comThis command returns the NCSI configuration of the specified GPO.
Optional Parameters
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 aggregates multiple cmdlets to run against a local GPO cache.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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
.
It also supports getting the active configuration on a local computer, using ActiveStore.
| Type: | String |
| Position: | Named |
| Default value: | None |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
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 |
| Accept pipeline input: | False |
| Accept wildcard characters: | False |
Inputs
None
Outputs
Microsoft.Management.Infrastructure.CimInstance#root/StandardCimv2/MSFT_NCSIPolicyConfiguration
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.